Overview

• Creates a new beneficiary.
• Supports both individual and business beneficiaries
• Requirements vary by country and ownerType

Validation Rules

• Important: Always check validation rules before creating a beneficiary
• Validation rules endpoint: GET /v1/validation-rules/beneficiaries
• Required query parameters:
  • ownerType=[individual|business]
  • country=[ISO 3166-1 alpha-2 code]
• Example request:

GET /v1/validation-rules/beneficiaries?ownerType=individual&country=PH

Bank Information

• For US beneficiaries with paymentType=bank_account:
  • Routing number is required
  • Bank ID is not needed
• For non-US beneficiaries with paymentType=bank_account:
  • Bank ID is required
  • Fetch bank list using: GET /v1/beneficiaries/banks
  • Required query parameter: countryCode=[ISO 3166-1 alpha-2 code]
• Example request:

GET /v1/beneficiaries/banks?countryCode=PH

• Response includes bank ID and name:

{
  "data": [
    {
      "id": "123",
      "name": "Sample Bank"
    }
  ]
}

• Use the bankId in the paymentInfo object when creating non-US beneficiaries with bank_account payment type