Skip to main content
POST
Add bank payout method
Adds a new bank payout method (either merchant-owned or customer-specific).
  • Include customer_id to create for a specific customer
  • Omit customer_id to create merchant-owned bank account

Request Body:

Headers

x-api-key
string
required

Body

application/json
type
enum<string>
default:BANK
required

Must be 'BANK' for this endpoint

Available options:
BANK
account_name
string
required
Example:

"John Doe"

account_number
string
required
Example:

"1234567890"

bank_name
string
required
Example:

"Test Bank"

currency
enum<string>
required
Available options:
NGN,
ZAR
Example:

"NGN"

bank_code
string
required
Example:

"000006"

customer_id
string | null

Required only for customer-specific payout methods

Example:

"85b148ab-3f6b-4d55-917f-3c8de668a48e"

sort_code
string
Example:

"202524"

swift_code
string
Example:

""

routing_number
string
Example:

""

iban
string
Example:

""

Response

Bank account added successfully

status
string
Example:

"success"

data
object
message
string
Example:

"Payout method added successfully"