> For the complete documentation index, see [llms.txt](https://docs.pagsmile.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pagsmile.com/reference/remittance-api/getting-started.md).

# Getting Started

### 1. Onboarding

Business Scenario: The merchant submits onboarding materials (KYC/KYB) and actively polls the Pagsmile API to retrieve the audit results.

<figure><img src="https://4142198059-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MgOGd5QxlX-U1mkQpVU%2Fuploads%2FGAtF2KevKIQCMPO4iTEU%2Fimage.png?alt=media&amp;token=7bac7a68-e450-4891-a64b-7d7c295f9cc3" alt=""><figcaption></figcaption></figure>

### 2.Create Virtual Account

Business Scenario: Conditional VA Issuance Flow The system routes the Virtual Account (VA) application workflow dynamically based on the designated `businessType`:

* Shop Collection : Store creation is a strict prerequisite. The merchant must successfully open a store before the system permits VA allocation.
* B2B Trade : The system bypasses the store validation layer and directly connects to the downstream clearings to issue the VA.

<figure><img src="https://4142198059-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MgOGd5QxlX-U1mkQpVU%2Fuploads%2FfFBQx6efM3fJHYm6u5QW%2Fimage.png?alt=media&amp;token=ef07f626-0939-4080-ada1-754c30f9739d" alt=""><figcaption></figcaption></figure>

### 3.Collection

Business Scenario:Funds Credit Interception & Document Linking

Once funds reach your Virtual Account (VA), automated balance crediting may be suspended due to compliance policies based on your business type:

1. E-Commerce Platforms: A compliance hold is placed on the first-time inbound transaction only.
2. B2B Trade (Goods/Services Trade): A compliance check is enforced on every single transaction.

Action Required: In both scenarios, you must submit and link the requested compliance supporting documents (e.g., invoices, contracts) to the transaction to resume the crediting process.

<figure><img src="https://4142198059-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MgOGd5QxlX-U1mkQpVU%2Fuploads%2FSOKXI8umT5H5vcCT8kcu%2Fimage.png?alt=media&amp;token=f3ce49a3-052a-4f30-ac8c-1036af5a381c" alt=""><figcaption></figcaption></figure>

### 4.Payment

Business Scenario: Balance Deduction & Payment Execution Pipeline To deduct funds from the merchant’s account balance, the system must strictly execute the payout workflow in a sequential pipeline as follows.

<figure><img src="https://4142198059-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MgOGd5QxlX-U1mkQpVU%2Fuploads%2FDFp2lTYcYa2QHixZtjwp%2Fimage.png?alt=media&amp;token=ae3bd2d7-0085-422d-927c-dbc806e1a8bb" alt=""><figcaption></figcaption></figure>

### 5.Transfer

Business Scenario: Internal Fund Transfer & Asset Allocation\
This workflow handles the cross-account fund transfers, multi-currency wallet conversions, and asset rebalancing within the merchant's corporate account ecosystem. It enables seamless fund allocation between the merchant's master account, sub-accounts, or different currency ledgers within the same platform hierarchy.

<figure><img src="https://4142198059-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MgOGd5QxlX-U1mkQpVU%2Fuploads%2FSpbYVjj4weIwn45YyDN6%2Fimage.png?alt=media&amp;token=d370f6f7-622f-45af-9777-44ee0b47e217" alt=""><figcaption></figcaption></figure>