Monime Documentation

PATCH

payment-codes

{id}

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

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

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.

metadata

object | null

The metadata for the payment code.

Response

200 - application/json

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

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 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.

result.customerTarget

object | null

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

result.financialTarget

object | null

The financial target for this payment code.

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.

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

The expiration time of the payment code.

result.createTime

string

The creation time of the payment code.

result.metadata

object | null

The metadata for the payment code.

Was this page helpful?

Suggest edits Raise issue

Get Payment Code Delete 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": {}
  }
}

API Documentation

Core Resources

Checkout

Payments

Transfers

Embedded Finance

Extra Resources

Update Payment Code

Authorizations

Headers

Path Parameters

Body

Response