Purposes List

GET

/remit-api/v1/lookups/purposes

This method provides list of available Purpose Codes on the system

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://gateway-sandbox.balad.tech/remit-api/v1/lookups/purposes' \
--header 'X-Country-Code;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "data": [
        {
            "code": "XXX",
            "description": "PURPOSE 1"
        },
        {
            "code": "XXX",
            "description": "PURPOSE 2"
        }
    ],
    "errors": null
}

Transaction Lifecycle V2

Sources List