Skip to main content
PATCH
/
payment-codes
/
{id}
Update Payment Code
curl --request PATCH \
  --url https://api.monime.io/payment-codes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '{
  "name": "<string>",
  "isActive": true,
  "status": "cancelled",
  "expireTime": "2023-11-07T05:31:56Z",
  "allowedProviders": [
    "<string>"
  ],
  "metadata": {}
}'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "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 length: 100

Path Parameters

​
id
string
required

A unique identifier for the payment code object.

Body

application/json
​
name
string | null

The name or intent indicating the purpose or use of the payment code.

Maximum length: 100
​
isActive
boolean | null
default:true

Denotes whether the payment code is active.

​
status
enum<string> | null

The status of the payment code.

Available options:
cancelled
​
expireTime
string<date-time>

The expiration time of the payment code.

​
allowedProviders
string[] | null

The list of MoMo provider IDs for which the payment code is allowed to be used.

Required array length: 1 - 10 elements
​
metadata
object | null

The metadata for the payment code.

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
⌘I