Skip to main content
GET
/
v1
/
payment-codes
List Payment Codes
curl --request GET \
  --url https://api.monime.io/v1/payment-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": [
    {
      "id": "<string>",
      "mode": "one_time",
      "status": "pending",
      "name": "Home EDSA Meter Top-up",
      "amount": {
        "currency": "<string>",
        "value": 123
      },
      "enable": true,
      "expireTime": "2023-11-07T05:31:56Z",
      "customer": {
        "name": "Musa Kamara"
      },
      "ussdCode": "<string>",
      "reference": "<string>",
      "authorizedProviders": [
        "m17",
        "m18"
      ],
      "authorizedPhoneNumber": "<string>",
      "recurrentPaymentTarget": {
        "expectedPaymentCount": 10,
        "expectedPaymentTotal": {
          "currency": "<string>",
          "value": 123
        }
      },
      "financialAccountId": "<string>",
      "processedPaymentData": {
        "amount": {
          "currency": "<string>",
          "value": 123
        },
        "orderId": "<string>",
        "paymentId": "<string>",
        "orderNumber": "<string>",
        "channelData": {
          "providerId": "<string>",
          "accountId": "<string>",
          "reference": "<string>"
        },
        "financialTransactionReference": "<string>",
        "metadata": {}
      },
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z",
      "ownershipGraph": {
        "owner": {
          "id": "<string>",
          "type": "<string>",
          "metadata": {},
          "owner": {
            "id": "<string>",
            "type": "<string>",
            "metadata": {},
            "owner": {}
          }
        }
      },
      "metadata": {}
    }
  ],
  "pagination": {
    "count": 123,
    "next": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

​
Monime-Space-Id
string
required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum length: 64
​
Monime-Version
enum<string> | null

Specifies which version of the Monime API will handle this request.

Available options:
caph.2025-08-23,
caph.2025-06-20

Query Parameters

​
ussd_code
string | null

Filter by the USSD code assigned to the payment code (if applicable).

​
mode
enum<string> | null

Filter by usage mode: 'one_time' for single-use codes, or 'recurrent' for reusable ones.

Available options:
one_time,
recurrent
​
status
enum<string> | null

Filter by payment code status: 'pending' (not yet used), 'processing' (in use), 'expired' (duration elapsed), 'cancelled' (manually cancelled), or 'completed' (fulfilled as intended).

Available options:
pending,
cancelled,
processing,
expired,
completed
​
limit
integer
default:10

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

Required range: 1 <= x <= 50
​
after
string | null

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Maximum length: 2000

Response

200 - application/json

OK

​
success
boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

​
messages
any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

​
result
Payment Code · object[] | null

The list of items in the response

​
pagination
object

The pagination info associated with the response

⌘I