Skip to main content

Payout Account Details

Introduction

Creating a payout account is the first step in order to start sending payouts.

There are two types of payout accounts:

  • Bank
  • Wallet

The following sample is for adding ANB bank account

Verb, Path, and Headers

POST /v1/payout_accounts
Authorization: Basic {BASE64 encoded secret key}

JSON Body

{
"account_type": "bank",
"properties": {
"iban": "SA8430400108057386290038"
},
"credentials": {
"client_id": "client_id",
"client_secret": "client_secret"
}
}

Response

{
"id": "ceb461ea-3f35-4027-b20a-beb89f5ee574",
"account_type": "bank",
"currency": "SAR",
"properties": {
"iban": "SA8430400108057386290038"
},
"created_at": "2025-04-08T06:47:00.135Z"
}
info

In the example request above, the client_id and client_secret are secret information provided by the ANB bank team after enabling B2B service for your bank account. Each bank or wallet will share their on type of credentials. More on that in the coming sections.

Create Payout Account Request Details

FieldDescription
account_typeIndicates the type of the payout account. It can be either bank or wallet
propertiesAn object that contains the public information relevant to the payout account. For example, the IBAN of the bank account
credentialsAn object that contains the secret information relevant to the payout account. For example, the private key configured for this account

All information under properties and credentials relates to the payout account and is acquired from your service provider.

Getting The Credentials

To use the service in the live environment, you should first acquire your B2B service credentials from your bank or wallet provider. Please reach out to your account manager to assist you with that.

Banks Details

BankPropertiesCredentials
Al Rajhi Bankibancompany_code
cert
key
Arab National Bank (ANB)ibanclient_id
client_secret
Saudi National Bank (SNB)iban
corporate_id
client_id
client_secret
key

Wallets Details

WalletPropertiesCredentials
STC Paymerchant_idcert
key