Skip to main content
GET
/
payment-codes
/
{id}
Get Payment Code
curl --request GET \
  --url https://api.monime.io/payment-codes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "pmc-TJh76H8hj778hftdtu66gjio",
    "name": "Home EDSA Meter Top-up",
    "mode": "oneTime",
    "isActive": true,
    "status": "pending",
    "ussdCode": "\\*715\\*1\\*0123456789#",
    "amount": {
      "currency": "<string>",
      "value": 123
    },
    "customerTarget": {
      "name": "Musa Kamara",
      "reference": "0123456789",
      "payingPhoneNumber": "078000000"
    },
    "financialTarget": {
      "expectedPaymentCount": 10,
      "expectedPaymentSum": {
        "currency": "<string>",
        "value": 123
      }
    },
    "allowedProviders": [
      "m17",
      "m18"
    ],
    "progress": {
      "isCompleted": true,
      "totalPaymentCount": 123,
      "totalPaymentSum": {
        "currency": "<string>",
        "value": 123
      }
    },
    "financialAccountId": "<string>",
    "expireTime": "2023-11-07T05:31:56Z",
    "createTime": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

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 used to determine which space the request is intended for.

Maximum string length: 100

Path Parameters

​
id
string
required

A unique identifier for the payment code object.

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
object