Create Account

5min
A Payout Account represents an actual bank account or a digital wallet that will be used as a source of funds whenever a payout is requested.
Bank Account
To create a payout account using your bank, you will need to use the following API call.
Get a cake by its ID
POST
Request
Header Parameters
Authorization
required
String
Basic YXBpX2tleTo=
Body Parameters
account_type
required
String
Type of account to be added. Should be set to: bank
properties
required
Object
Contains public information for the payout account.
credentials
required
Object
Contains authentication information for the payout account. Different banks require different sets of credentials.

Read the next section for more details.
JSON
{
    "account_type": "bank",
    "properties": {
        "iban": "SA3430000000001234567890"
    },
    "credentials": {
        "client_id": "123",
        "client_secret": "123"
    }
}
{
    "account_type": "bank",
    "properties": {
        "iban": "SA3430000000001234567890"
    },
    "credentials": {
        "client_id": "123",
        "client_secret": "123"
    }
}
Responses
200
400
{
    "type": "validation_error",
    "message": "Data validation failed",
    "errors": {
        "account_type": [
            "The value must be one of bank, wallet."
        ]
    }
}
{
    "type": "validation_error",
    "message": "Data validation failed",
    "errors": {
        "account_type": [
            "The value must be one of bank, wallet."
        ]
    }
}
﻿
﻿
Bank Credential Specification
Each banking institute will have a set of different set of credentials information to authenticate requests to their core banking system. Here is a list of supported banks and required credentials:
Bank
Fields
Arab National Bank
client_id
client_secret
Wallet Account
To create a payout account using your digital wallet, you will need to use the following API call.
Get a cake by its ID
POST
Request
Header Parameters
Authorization
required
String
Basic YXBpX2tleTo=
Body Parameters
account_type
required
String
Type of account to be added. Should be set to: wallet
properties
required
Object
Contains public information for the payout account.
credentials
optional
Object
Contains authentication information for the payout account. Different providers require different sets of credentials.

Read the next section for more details.
JSON
{
    "account_type": "wallet",
    "properties": {
        "type": "stcpay"
    }
}
{
    "account_type": "wallet",
    "properties": {
        "type": "stcpay"
    }
}
Responses
200
400
{
    "type": "validation_error",
    "message": "Data validation failed",
    "errors": {
        "account_type": [
            "The value must be one of bank, wallet."
        ]
    }
}
{
    "type": "validation_error",
    "message": "Data validation failed",
    "errors": {
        "account_type": [
            "The value must be one of bank, wallet."
        ]
    }
}
﻿
﻿
Wallet Credential Specification
Each digitsl wallet provider will have a set of different set of credentials information to authenticate requests to their system. Here is a list of supported banks and required credentials:
Wallet
Fields
STC Pay
merchant_id
﻿
Bank	Fields
Arab National Bank	client_id client_secret
Wallet	Fields
STC Pay	merchant_id
Updated 04 Aug 2024
Did this page help you?
3D Secure
Fetch Account