Skip to main content

Payout Account Details

Introduction​

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

Live payout accounts are set up by Moyasar

You can create payout accounts through the API in the sandbox only, using your test secret key (sk_test_).

Live payout accounts are set up by the Moyasar team. A request to POST /v1/payout_accounts made with a live secret key (sk_live_) is rejected with a 403 error of type live_payout_account_setup_restricted. To go live, follow the steps in Getting The Credentials.

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:

  1. Ask your bank or wallet provider to enable the B2B service for your account. Moyasar customer care can help you with that.
  2. Share the B2B details listed below with Moyasar customer care through a secure channel. Don't send credentials over email or chat in plain text.
  3. The Moyasar team sets up and tests your live payout account, then shares its id with you.
  4. Use that id as the source_id when you create payouts with your live secret key.

The tables below list the information the Moyasar team needs for each provider. In the sandbox, any values in the right format are accepted.

Banks Details​

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

Wallets Details​

WalletPropertiesCredentials
STC Paymerchant_idcert
key