curl --request PATCH \
--url https://api.monime.io/v1/payment-codes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Monime-Space-Id: <monime-space-id>' \
--data '{
"name": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"duration": "<string>",
"enable": true,
"customer": {
"name": "Musa Kamara"
},
"reference": "<string>",
"authorizedProviders": [
"m17"
],
"authorizedPhoneNumber": "<string>",
"recurrentPaymentTarget": {
"expectedPaymentCount": 10,
"expectedPaymentTotal": {
"currency": "<string>",
"value": 123
}
},
"financialAccountId": "<string>",
"metadata": {}
}'
{
"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": {}
}
}
Partially updates an existing payment code with new values, rules, or account bindings.
curl --request PATCH \
--url https://api.monime.io/v1/payment-codes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Monime-Space-Id: <monime-space-id>' \
--data '{
"name": "<string>",
"amount": {
"currency": "<string>",
"value": 123
},
"duration": "<string>",
"enable": true,
"customer": {
"name": "Musa Kamara"
},
"reference": "<string>",
"authorizedProviders": [
"m17"
],
"authorizedPhoneNumber": "<string>",
"recurrentPaymentTarget": {
"expectedPaymentCount": 10,
"expectedPaymentTotal": {
"currency": "<string>",
"value": 123
}
},
"financialAccountId": "<string>",
"metadata": {}
}'
{
"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
The unique ID of the payment code to update.
Partially updates an existing payment code with new values, rules, or account bindings.
OK
The response is of type object
.