Add a Receive Account

Read on adding a receive account for a receive user

You can add receive accounts for users with receive type bank or wallet. You will have to also provide the recipient account information. Please note that you can only deposit business payment transactions to bank accounts.

`POST /users/{{user_id}}/receive-users/{{receiveUserId}}/accounts`

Wallet

Field

Required

Type

Description

msisdn

Yes

String

Receive user wallet account number

wallet_type

String

Enumerated value, Type of receive user wallet: 1. Available value: TEL 2. Default value: TEL

payer_id

Yes

Long

Id of payer associated with the wallet

payout_method

Yes

String

Enumerated value - WALLET

Bank

Field

Required

Type

Description

account_number

Yes

Alpha-numeric

Bank account number.

account_type

Yes

String

Account type. Enumerated value - CHECKING, SAVINGS

bank_id

Yes

numeric

Bank ID

branch_id

Yes

numeric

Branch ID

branch_location

String

Branch location

swift_bic_code

String

SWIFT code of bank

payout_method

Yes

String

Enumerated value - BANK_DEPOSIT

Wallet

curl --location -g --request POST '{{url}}/users/{{user_id}}/receive-users/{{receive_user_id}}/accounts' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "msisdn" : "233543225243",
    "wallet_type" : "TEL",
    "payer_id" : "100",
    "payout_method" : "WALLET"
    }'

Bank

curl --location -g --request POST '{{url}}/users/{{user_id}}/receive-users/{{receiveUserId}}/accounts' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "account_number":"99999999",
  "account_type":"SAVINGS",
  "bank_id":4,
  "branch_location":null,
  "branch_id":4,
  "payout_method":"BANK_DEPOSIT"
}'

Wallet

{
"created_at": "2021-12-07T09:16:33.947037",
"id": UUID,
"msisdn": "233543225243",
"payout_method": "WALLET",
"status": "VERIFIED",
"user_id": UUID,
"wallet_type": "TEL"
}

Bank

{
    "account_number": "99999999",
    "account_type": "SAVINGS",
    "bank_id": 4,
    "branch_id": 4,
    "created_at": "2021-12-01T03:14:54.481686",
    "id": UUID,
    "payout_method": "BANK_DEPOSIT",
    "status": "UNVERIFIED",
    "user_id": UUID
}

PreviousDelete User Funding Account NextUpdate a Receive Account

Last updated 3 years ago

hashtagPOST /users/{{user_id}}/receive-users/{{receiveUserId}}/accounts

`POST /users/{{user_id}}/receive-users/{{receiveUserId}}/accounts`