Skip to main content
GET
List purpose codes

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Query Parameters

relation
string

Optional. SELF returns only the self-transfer code; anything else returns the rest.

Response

The purpose codes. Unwrapped.

codes
object[]