Payout And Remittance Guide

Before initiating payments (payouts) to external bank accounts, merchants must follow two-step process: first register payee information in system, then specify remittance clearing network (such as ACH, FedWire, or SWIFT) to initiate payout orders. Guide details integration parameter differences across various remittance types.

Step 1: Create Payee

Before initiating any payout, must first call Create Payee endpoint to register target account as system payee. Based on different remittance networks, provide specific underlying routing parameters:

  • ACH / FedWire (Domestic US): Must accurately provide payee local bank code (bankCode, e.g., 9-digit ABA Routing Number or Wires Code) and bank account number (accountNumber).
  • SWIFT (International Wire): Must provide receiving bank BIC/SWIFT code (bicSwift). Strongly recommend providing complete bank address (bankAddress) and payee physical address (payeeAddress) to satisfy strict Anti-Money Laundering (AML) review requirements.

Create Payee Payload Example

{
    "currency": "USD",
    "country": "US",
    "firstName": "John",
    "lastName": "Doe",
    "accountNumber": "31139750168449",
    "bankName": "JP Morgan Chase NA",
    "bankCode": "028000024",
    "bicSwift": "CHASUS33",
    "payeeAddress": {
        "line1": "123 Business Rd",
        "postCode": "10001",
        "city": "New York",
        "state": "NY",
        "country": "US"
    },
    "bankAddress": {
        "line1": "270 Park Avenue",
        "postCode": "10017",
        "city": "New York",
        "state": "NY",
        "country": "US"
    },
    "label": "Supplier Q3"
}

Step 2: Create Payout Order

After successfully creating payee and obtaining id, call Create Payout Order endpoint to initiate payment. Must explicitly specify underlying clearing network via receiveType field:

  • ACH Network (receiveType: ACH): Domestic US low-cost, non-real-time transfers (typically requires 1-3 business days to arrive).
  • FedWire Network (receiveType: WIRE): Domestic US high-value, real-time wire transfers (typically arrives same day).
  • SWIFT Network (receiveType: SWIFT): Cross-border, cross-currency international wire transfers.
📘

Amount & Currency Rules

When initiating cross-currency payouts, deduction currency (paymentCurrency) and receiving currency (payeeCurrency) are both required. However, for amount specification, system adopts strict "either-or" mode:

  • Fixed Payment Amount: Only pass paymentAmount (e.g., you fix payment at 10,000 USD, system automatically calculates EUR amount recipient receives based on exchange rate).
  • Fixed Payee Amount: Only pass payeeAmount (e.g., you want recipient to strictly receive 9,200.50 EUR, system reverse-calculates required USD deduction based on exchange rate).
    Do not pass both amount fields simultaneously.

Create Payout Payload Example (Fixed Payment Amount)

{
    "callId": "req_8899aabbcc1122",
    "payeeId": "payee_550e8400-e29b-41d4-a716-446655440000",
    "receiveType": "SWIFT",
    "paymentCurrency": "USD",
    "payeeCurrency": "EUR",
    "paymentAmount": 10000.00,
    "purpose": "13",
    "reason": "Consulting Services",
    "paymentMaterial": [
        "123e4567-e89b-12d3-a456-426614174000"
    ]
}

Risk Control And Compliance Limits

When integrating payout endpoints, strictly handle following core business logic within your system:

📘

Cross-Currency Auto-FX

System supports seamless cross-currency payouts. By specifying paymentCurrency (deduction currency) and payeeCurrency (receiving currency) in endpoint, underlying system automatically settles at real-time exchange rates, requiring no manual conversion beforehand. Account only supports receiving USD transfers; non-USD transfers automatically convert to USD upon receipt.

🚧

Compliance Declarations And Purpose

For strictly regulated countries or high-value SWIFT cross-border remittances, strictly pass correct Payment Purpose Code via purpose field and supplement detailed notes in reason field. Failure to comply risks returned funds. If invoice contracts are involved, first call Upload File endpoint to upload materials, and populate returned ID into paymentMaterial.

🔒

Idempotency Requirement

When creating payout orders, callId is mandatory parameter. Strictly pass unique business order number from internal system to prevent duplicate payout losses caused by network timeouts and retries.

Appendix: Routing Parameter Examples For Remittance Networks

Below are core routing field parameter specifications and examples required when calling API to create payees for different networks:

1. ACH Remittance Network Example

Suitable for domestic US low-value clearing.

  • Payee Name (lastName): ccn me a
  • Bank Account (accountNumber): 31139750168449
  • Bank Code (bankCode): 028000024 (Note: Must pass valid ACH Routing Number)
  • Bank Name (bankName): JP Morgan Chase NA
  • Payee Country (country): US

2. FedWire Remittance Network Example

Suitable for domestic US high-value real-time wire transfers.

  • Payee Name (lastName): ccn me a
  • Bank Account (accountNumber): 31139750168449
  • Bank Code (bankCode): 021000021 (Note: Must pass valid Wires Code)
  • Bank Name (bankName): JP Morgan Chase NA
  • Payee Country (country): US

3. SWIFT Remittance Network Example

Suitable for international wire transfers.

  • Payee Name (lastName): HONGKONG HIGHFORT LIMITED
  • Bank Account (accountNumber): 20000000222
  • International Wire Code (bicSwift): ZEITPRSJXXX
  • Bank Name (bankName): Zenus Bank International Inc
  • Intermediary Bank Special Instructions: If target receiving account contains Intermediary Bank information, strictly supplement Intermediary Bank SWIFT and Routing instructions into reason field of payout order creation endpoint to prevent international routing failures.