SpareSpare Docs
GuidesAPI Reference
API Reference

Payment Purpose Codes

List valid payment purpose codes for your region.

GET
/payment-purpose-codes
Authorization
Header

Regulatory jurisdiction the request routes to (e.g. `UAE`, `KSA`, `MAIN`). Match it to the market you're integrating.

Query

When true, filter to domestic payments only.

When true, filter to international payments only.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payment-purpose-codes" \  -H "x-tenant: KSA"
{  "data": [    {      "code": "string",      "description": "string",      "id": "string"    }  ],  "error": "string",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "not_found",  "details": {},  "message": "string"}

Payments

List and retrieve settled payments.

Mandates

Schedule, approve, and list transactions for recurring payment mandates.