GET /payments/statusCodes

Gets a list of valid Payment status codes. Payment status codes are used to identify the state in which a Payment is in. This operation is for reference purposes only.

For a detailed description of common Payment status codes and which operations are allowed for each status, please see Payments.

Request

Ensure the bearer token is included in the Header of the GET operation:

Header
Mandatory
Description

Authorization

Yes

Response

An array of status codes will be returned:

[
  {
    "code": "string",
    "description": "string"
  }
]
Field
Response Type
Description

code

string

Unique status code used for Payments

description

string

Friendly description of the status code.

Example Response
[
  {
    "code": "DRAFT",
    "description": "Payment in draft"
  },
  {
    "code": "SETTLED",
    "description": "Payment settled"
  },
  {
    "code": "CANCELLED",
    "description": "Payment cancelled"
  },
  {
    "code": "PENDING",
    "description": "Payment pending"
  }
]
PreviousDELETE /payments/{id}NextSupport

Last updated