6DOT50 APIs
  • Redemptions API
    • Overview
    • Process Flow
    • Requests
    • Response Models
    • Payment Codes
    • Authentication
      • POST /authentication/getToken
  • Accounts
    • GET /accounts
    • GET /accounts/{id}/transactions
  • Initiate Payment
    • POST /payments
  • User Payment Pages
    • Authentication
    • Payment Confirmation
    • Payment Status
  • Payment Status
    • GET /payments/{id}
  • List Payments
    • GET /payments
  • Support
  • PAY API
    • Overview
    • API Keys
    • Endpoints
    • Process Flow
    • Requests
    • Response Models
    • Authentication
      • POST /authentication/getToken
    • Accounts
      • GET /accounts
    • Batches
      • POST /batches
      • GET /batches
      • GET /batches/{id}
      • PUT /batches/{id}
      • GET /batches/statusCodes
      • POST /batches/{id}/payments
      • GET /batches/{id}/payments
      • POST /batches/{id}/submit
      • POST /batches/{id}/cancel
    • Members
      • GET /members/{msisdn}/exists
    • Payments
      • GET /payments/{id}
      • DELETE /payments/{id}
      • GET /payments/statusCodes
  • Support
Powered by GitBook
On this page
  • Request
  • Response
  1. PAY API
  2. Payments

GET /payments/statusCodes

PreviousDELETE /payments/{id}NextSupport

Last updated 2 years ago

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 .

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"
  }
]

Bearer token from

Payments
/authentication/getToken