Update Payment Code

PATCH /payment-codes/{id}

Try it

Update Payment Code

cURL

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": {}
}
'

200

{
  "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. 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. 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 string 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

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

Show child attributes

result. id · string

A unique identifier for the payment code object.

Example:

"pmc-TJh76H8hj778hftdtu66gjio"

result. name · string | null

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

Maximum string length: 100

Example:

"Home EDSA Meter Top-up"

result. mode · enum<string> · default: oneTime

Specifies whether the payment code can be used only once or multiple times.

Available options: oneTime, recurrent

result. isActive · boolean · default: true

Indicates whether the payment code is currently active and available for use.

result. status · enum<string> · default: pending

The current status of the payment code, indicating its state in the payment process

Available options: pending, processing, expired, cancelled, completed

result. ussdCode · string

The USSD code that users can dial on their mobile money device to make a payment using this payment code.

Example:

"\\*715\\*1\\*0123456789#"

result. amount · object

The monetary amount assigned to the payment code. If mode is recurrent, and financial target sum is also set, this represents the amount to be paid for every instance of payment for this code.

Show child attributes

result.amount. currency · string

The 3-letter ISO currency code.

result.amount. value · integer

The value representation in the currency's minor unit. E.g. For 1 Leone (SLE 1), the value should be 100, denoting cents, the minor unit.

result. customerTarget · object

Information about the specific customer that this payment code is targeting/

Show child attributes

result.customerTarget. name · string | null

Name of the customer to pay for this code.

Maximum string length: 100

Example:

"Musa Kamara"

result.customerTarget. reference · string | null

Reference that may identify this customer in some external system.

Maximum string length: 100

Example:

"0123456789"

result.customerTarget. payingPhoneNumber · string | null

The phone number that should dial to pay for this code.

Maximum string length: 30

Example:

"078000000"

result. financialTarget · object

The financial target for this payment code.

Show child attributes

result.financialTarget. expectedPaymentCount · integer | null

The number of payments expected after which the code gets completed.

Required range: x >= 1

Example:

10

result.financialTarget. expectedPaymentSum · object

The sum of payment amounts expected after which the code gets completed.

Show child attributes

result.financialTarget.expectedPaymentSum. currency · string

The 3-letter ISO currency code.

result.financialTarget.expectedPaymentSum. value · integer

The value representation in the currency's minor unit. E.g. For 1 Leone (SLE 1), the value should be 100, denoting cents, the minor unit.

result. allowedProviders · string[] | null

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

Example:

["m17", "m18"]

result. progress · object

The progress of the payment code.

Show child attributes

result.progress. isCompleted · boolean

Indicate whether the payment code is completed or not.

result.progress. totalPaymentCount · integer

Represents the total number of payments made using this code.

result.progress. totalPaymentSum · object

Represents the total sum of payment amounts made using this code.

Show child attributes

result.progress.totalPaymentSum. currency · string

The 3-letter ISO currency code.

result.progress.totalPaymentSum. value · integer

The value representation in the currency's minor unit. E.g. For 1 Leone (SLE 1), the value should be 100, denoting cents, the minor unit.

result. financialAccountId · string | null

The ID of the financial account where the amount is settled to. This default to the owner's Main financial account.'

result. expireTime · string<date-time>

The expiration time of the payment code.

result. createTime · string<date-time>

The creation time of the payment code.

result. metadata · object

The metadata for the payment code.