curl --request GET \
--url https://api.monime.io/v1/payment-codes/{id} \
--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": {}
}
}
Retrieve a payment code object by its ID.
curl --request GET \
--url https://api.monime.io/v1/payment-codes/{id} \
--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": {}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The value is the tenancy parameter that Monime uses to determine which space the request is intended for.
64
Unique identifier of the payment code to retrieve.
OK
The response is of type object
.