v1
latestOpenAPI 3.1.02026-07-24680631.6 KBGET Purpose List
The Get Purpose List API allows the API User to retrieve the Purpose and Sub-purpose for the international remittence. The purpose of the transaction determines the Transfer code under which the transaction is to be considered.
get/v1/client/accounts/purpose
Headers
api-keystring required
API Key
auth-keystring required
The Auth key from theGenerate Auth Key API
userIdstring required
User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.
Response
200
Example response
{
"status": 200,
"message": "Success",
"data": [
{
"purposeId": "cff5a25c-342f-4bf9-855e-3de89fcfd9fd",
"title": "Education",
"slug": "education",
"subPurpose": [
{
"purposeId": "f92acce9-c2ed-4af5-ae03-0a15427beb49",
"title": "Rent Payment and Expenses",
"slug": "rent_payment_and_expenses",
"description": {
"Instructions for Remittance": [
"Fund remittance for Rent and Expenses are only permissible to the Student’s own account"
]
}
}
],
"description": "Remit funds for Education Abroad. Pay for Tuition, Rent, etc."
}
]
}