Add a receive account

Search…
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.
POST /users/{{user_id}}/receive-users/{{receiveUserId}}/accounts
Request Parameters
Request Sample
Response Sample
Wallet
Field
Required
Type
Description
msisdn
Yes
String
Receive user wallet account number
wallet_type
No
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
No
String
Branch location.
payout_method
Yes
String
Enumerated value - BANK_DEPOSIT
Wallet
1
curl --location -g --request POST '{{url}}/users/{{user_id}}/receive-users/{{receive_user_id}}/accounts' \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
    "msisdn" : "233543225243",
7
    "wallet_type" : "TEL",
8
    "payer_id" : "100",
9
    "payout_method" : "WALLET"
10
    }'
Copied!
Bank
1
curl --location -g --request POST '{{url}}/users/{{user_id}}/receive-users/{{receiveUserId}}/accounts' \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
  "account_number":"99999999",
7
  "rtn_number":"102007558",
8
  "account_type":"SAVINGS",
9
  "bank_id":4,
10
  "branch_location":null,
11
  "branch_id":4,
12
  "payout_method":"BANK_DEPOSIT"
13
}'
Copied!
Wallet
1
{
2
"created_at": "2021-12-07T09:16:33.947037",
3
"id": "94e7db9e-f49d-4573-a9e0-639714248b6f",
4
"msisdn": "233543225243",
5
"payout_method": "WALLET",
6
"status": "VERIFIED",
7
"user_id": "f319cd8a-f4f3-465b-bbd8-8457d51f8c57",
8
"wallet_type": "TEL"
9
}
Copied!
Bank
1
{
2
    "account_number": "99999999",
3
    "account_type": "SAVINGS",
4
    "bank_id": 4,
5
    "branch_id": 4,
6
    "created_at": "2021-12-01T03:14:54.481686",
7
    "id": "83682ebe-cad7-4197-b75e-5e5218d9b912",
8
    "payout_method": "BANK_DEPOSIT",
9
    "rtn_number": "102007558",
10
    "status": "UNVERIFIED"
11
}
Copied!
Delete user funding account
Get receive accounts
Last modified 13d ago
Copy link
Contents