> For the complete documentation index, see [llms.txt](https://pivot-payment.gitbook.io/pivot-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/international-payout.md).

# International Payout

| Parameter           | Data Type                         | Requirement | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                                                                                                                               |                                                                                                                           |
| ------------------- | --------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| uuid                | <p>String<br>Generated</p>        | M           | Object unique identifier                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                               |                                                                                                                           |
| merchantId          | String Generated                  | M           | Merchant unique identifier                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                               |                                                                                                                           |
| referenceId         | String                            | M           | Merchant payout reference ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                                                                                                                               |                                                                                                                           |
| remitterId          | String                            | M           | Remitter ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                                                                                                                               |                                                                                                                           |
| beneficiaryId       | String                            | M           | Beneficiary ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                                                                                                                               |                                                                                                                           |
| sourceCurrency      | <p>Enum </p><p><br></p><p></p>    | M           | <p>Three-letter source currency code based on ISO 4217<br><br>Value: Should be IDR</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                                                                                                                               |                                                                                                                           |
| destinationCurrency | Enum                              | M           | Three-letter destination currency code based on ISO 4217                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                               |                                                                                                                           |
| destinationAmount   | <p>String Required</p><p><br></p> | M           | <p>Amount to be received by beneficiary in destination currency<br><br></p><p>For others</p><ul><li>Max decimal 2</li><li>Min amount 1</li></ul><p></p><p>For KR & JP</p><ul><li>Max decimal 0</li><li>Max amount KRW 5,500,000</li></ul><p></p><p>For US</p><ul><li>Max amount USD 1,000,000</li></ul>                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                               |                                                                                                                           |
| purposeCode         | <p>Enum </p><p><br></p>           | M           | <p>Purpose of payout<br><br>Value:</p><p></p><p>Should be either</p><ul><li>IR001</li><li>IR002</li><li>IR003</li><li>IR004</li><li>IR005</li><li>IR006</li><li>IR007</li><li>IR008</li><li>IR009</li><li>IR010</li><li>IR011</li><li>IR012</li><li>IR013</li><li>IR014</li><li>IR015</li><li>IR016</li><li>IR017</li><li>IR020</li><li>IR01801</li><li>IR01802</li><li>IR01803</li><li>IR01804</li><li>IR01805</li><li>IR01806</li><li>IR01807</li><li>IR01808</li><li>IR01809</li><li>IR01810</li><li>IR01811</li></ul>                                                                                                  |                                                                                                                                                               |                                                                                                                           |
| remarks             | <p>String</p><p></p>              | M           | <p>Payout remarks<br><br>^\[a-zA-Z0-9\_\s]+$</p><p><br></p><p>Max 20</p><p>Can only include special character \_</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                               |                                                                                                                           |
| routingValue        | String                            | C           | <p>SWIFT or ACH or BSB code, depending on the selected country and currency<br><br></p><p>For SG, MY, TH, JP, CN:</p><ul><li>To local currency: SWIFT Code</li><li>To foreign currency: SWIFT Code</li></ul><p><br></p><p>For AU:</p><ul><li>To local currency: BSB Code</li><li>To foreign currency: SWIFT Code</li></ul><p><br></p><p>For US:</p><ul><li>To local currency: ACH Code</li><li>To foreign currency: SWIFT Code</li></ul><p><br></p><p>For KR:</p><ul><li>To local currency: No code required</li><li>To foreign currency: No code required</li></ul><p><br></p><p>SWIFT Codes</p><ul><li>^\[A-Za-z0-9]{8}$ | ^\[A-Za-z0-9]{11}$</li><li>Length: 8 or 11</li><li>Special Character: None allowed</li></ul><p><br></p><p>BSB Code</p><ul><li>^\[0-9]{6}$ , ^\[A-Za-z0-9]{8}$ | ^\[A-Za-z0-9]{11}$</li><li>Length: 6</li></ul><p><br></p><p>ACH Code</p><ul><li>/^\[0-9]{9}$/</li><li>Length: 9</li></ul> |
| cnaps               | String Generated                  | C           | <p>Mandatory if destination currency is CNY and payout method is BANK\_ACCOUNT</p><ul><li>Length: 12</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                                                                                                                               |                                                                                                                           |
| fxRate              | Number Generated                  | M           | Conversion rate from source currency to destination currency                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                                                                                                                               |                                                                                                                           |
| destinationFxRate   | Number Generated                  | M           | Conversion rate from destination currency to source currency                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                                                                                                                               |                                                                                                                           |
| fee                 | Number Generated                  | M           | Payout fee                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                               |                                                                                                                           |
| totalAmount         | Number Generated                  | M           | Total amount to be paid                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                               |                                                                                                                           |
| createdAt           | String Generated                  | M           | Payout object created time in ISO-8601 format. i.e. 2024-10-02T08:21:44.967496538Z                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                                                                                                                               |                                                                                                                           |
| expiredAt           | String Generated                  | M           | Payout object expired time in ISO-8601 format. i.e. 2024-10-02T08:36:44.967496538Z                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                                                                                                                               |                                                                                                                           |
| status              | Enum Generated                    | M           | Payout status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                                                                                                                               |                                                                                                                           |
| payoutMethod        | Enum                              | O           | <p>Specify as WALLET if want to perform payout to Alipay</p><p>If not specified, then default will be BANK\_ACCOUNT</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                               |                                                                                                                           |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/object/international-payout.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.