Bank accounts
Link a bank account
Save a bank beneficiary under a UPA using its country-specific fields.
POST
Read bank account requirements first for each country’s fields and current availability. Linking is available for the United States, the Philippines and Vietnam, and must be enabled for your app. An individual UPA needs approved KYC. A business UPA can link a US/USD bank once its hosted business verification (KYB) is approved.
A linked bank is a saved beneficiary and can belong to a supplier, contractor or the UPA subject. Linking does not prove ownership by the UPA subject.
Only a US linked bank can be paid. Once it is
active, create a send Payment with destination.type: "bank_account"; see Off-ramps. A linked bank cannot receive settlement.
Full bank details are never returned; responses show accountNumberLast4. Idempotency-Key is required and must contain 1–256 characters after trimming surrounding whitespace. Preserve the original body and key after an uncertain response; changed input conflicts.Authorizations
Headers
Required retry key for linking a bank account or rail identifier: 1-256 characters after trimming surrounding whitespace. Retry the identical request with the same key; changed input returns a conflict.
Required string length:
1 - 256Example:
"bank-beneficiary-supplier-123"
Path Parameters
Body
application/json
- United States bank account
- Philippines bank account
- Vietnam bank account
Country-specific bank inputs.