PayoutRecipientDto

account_name
Type: string
required

Recipient's full name.
account_number
Type: string
required

Bank account number, or mobile-money phone number.
address
Type:
required

Beneficiary address information

Properties: 5
bank_address
Type:

Bank address information (typically required for SWIFT)

Properties: 5
bank_code
Type: string

Bank code (bank payouts). For Nigeria this is the six-digit NIP institution code — GTBank is 000013. The three-digit CBN sort codes (058, 044) are not accepted. Take the code from GET /v1/payouts/banks rather than hard-coding it.
bank_name
Type: string
beneficiary_type
Type: "INDIVIDUAL" or "BUSINESS"enum

Whether the beneficiary is an individual or a business. Defaults to INDIVIDUAL.
business
Type:

A business recipient's registration. Required for SWIFT payouts to a business.

Properties: 5
date_of_birth
Type: string

Recipient's date of birth, YYYY-MM-DD. Required for SWIFT payouts to an individual other than yourself.
gender
Type: "MALE" or "FEMALE" or "OTHERS"enum

Recipient's gender. Required for SWIFT payouts to an individual.
id_expiration
Type: string

Recipient's ID expiry date, YYYY-MM-DD. Required for SWIFT payouts to an individual.
id_number
Type: string
id_type
Type: stringenum

Recipient's ID type. Required for SWIFT payouts to an individual.

values
PASSPORTNATIONAL_IDDRIVING_LICENSERESIDENCE_PERMIT
nationality
Type: string

Recipient's nationality, ISO 3166-1 alpha-2. Required for SWIFT payouts to an individual.
network
Type: string

Mobile-money network (momo payouts).
phone_number
Type: string

Recipient's phone number (SWIFT payouts).
remittance_purpose
Type: stringenum

Remittance purpose. Required for international channels (SWIFT / WIRE / ACH / SEPA_EUR / DOMESTIC_GBP / BANK).
values
- FAMILY_SUPPORT
- EDUCATION
- GIFT_AND_DONATION
- MEDICAL_TREATMENT
- MAINTENANCE_EXPENSES
- TRAVEL
- SMALL_VALUE_REMITTANCE
- LIBERALIZED_REMITTANCE
swift_code
Type: string

AddressDTO

CreatePayoutDto