List payment purposes

List payment purposes to select from when creating or verifying a payout contact. Public metadata; no authentication required.

get

/api/v1/payment-purposes

Responses

200

Standard envelope. data carries the payment purpose list.

application/json

Standard UR OpenAPI response envelope. code 0 means success; a non-zero code is a business error described by message.

codeintegerRequired

0 on success; non-zero business error code.

messagestringRequired

Human-readable explanation. May be empty on success.

dataanyOptional

Endpoint-specific metadata payload.

get/api/v1/payment-purposes

GET /api/v1/payment-purposes HTTP/1.1
Host: openapi.ur.app
Accept: */*

200

Standard envelope. data carries the payment purpose list.

{
  "code": 1,
  "message": "text",
  "data": null
}