POSTAdd Settlement Bank Account

POST/user/payment/aeps/settlement/account

Adds and name-verifies a bank account to which an agent can settle AePS funds. On success a recipient_id is returned — pass it to Initiate Settlement. If the account holder name does not match, the response reports the mismatch. An agent can register up to 3 settlement accounts, and only banks that offer account verification are accepted.

Request

Body parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`client_ref_id`	string	optional	Unique reference ID per API call, generated by your system (max 20 characters).e.g. 2026010100123456789
`user_code`	string	required	Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your userse.g. 20810200
`bank_id`	integer	required	Unique identifier for the bank.e.g. 12
`ifsc`	string	required	IFSC code of the bank account.e.g. SBIN0000000
`service_code`	integer	required	Service code for AePS fund settlement. Value: 39.e.g. 39
`account`	string	required	Account number of the user's bank account.e.g. 00000000000002

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

client_ref_idstringoptional

Unique reference ID per API call, generated by your system (max 20 characters).

example: 2026010100123456789

user_codestringRequired

Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your users

example: 20810200

bank_idintegerRequired

Unique identifier for the bank.

example: 12

ifscstringRequired

IFSC code of the bank account.

example: SBIN0000000

service_codeintegerRequired

Service code for AePS fund settlement. Value: 39.

example: 39

accountstringRequired

Account number of the user's bank account.

example: 00000000000002

These headers authenticate and sign every request. See How Auth Works for details.

Field	Type	Required	Description
`developer_key`	string	required	Static API key issued to your account after KYC.
`secret-key`	string	required	Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
`secret-key-timestamp`	string	required	Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
`content-type`	string	required	application/jsone.g. application/json

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Responses

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobject
API-specific response payload.
- recipient_idnumber
  Settlement recipient identifier — pass to Initiate Settlement.

Next steps

NextGETGet Settlement Bank AccountsList an agent's registered AePS settlement recipients with unsettled funds and remaining limit.

Request

Body parameters

Responses

Next steps

Related