List Withdrawal Purposes

Returns the list of valid withdrawal purpose codes for a currency. Some corridors (notably AED, INR, and other regulated currencies) require a purpose code on every outgoing payment.

Prerequisites

None — this is a reference-data endpoint you can call at any time.

Notes

Call this before building your withdrawal UI so users can pick a valid purpose.

If the currency has no purpose requirement, the list is empty and you may omit purpose from the withdrawal.

Results are stable and safe to cache for ~24 hours.

Related endpoints: POST /api/v1/accountwithdrawal/quote · POST /api/v1/accountwithdrawal/withdraw

📤 Response Fields

Field	Type	Nullable	Description
`data[].code`	`string`	No	Machine-readable purpose code to send with the withdrawal
`data[].description`	`string`	No	Human-readable label for display in your UI
`data[].currency`	`string`	No	Currency the code applies to
`pagination.total`	`integer`	No	Total number of purpose codes
`pagination.limit`	`integer`	No	Page size
`pagination.offset`	`integer`	No	Page offset
`pagination.hasMore`	`boolean`	No	Whether more results exist

curl --location '/api/v1/accountwithdrawal/purpose?currency=AED' \ --header 'X-API-Key: ak_live_8f3a9b2c1d4e5f6a7b8c' \ --header 'X-Signature: q2h8Zx0kPz5mVw7Yb3Nc1Rt6Ue9Ia4Od2Sf8Gk0Jl4=' \ --header 'X-Timestamp: 1754812800' \ --header 'X-Nonce: f47ac10b-58cc-4372-a567-0e02b2c3d479' \ --header 'X-Body-Hash: n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg='

{ "data": [ { "code": "SAL", "description": "Salary payment", "currency": "AED" }, { "code": "FAM", "description": "Family support", "currency": "AED" }, { "code": "GDS", "description": "Payment for goods", "currency": "AED" } ], "pagination": { "total": 3, "limit": 20, "offset": 0, "hasMore": false } }

Request

Responses