Monime Documentation

PATCH

payment-codes

{id}

Update Payment Code

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": [],
  "authorizedPhoneNumber": "<string>",
  "recurrentPaymentTarget": {
    "expectedPaymentCount": 10,
    "expectedPaymentTotal": {
      "currency": "<string>",
      "value": 123
    }
  },
  "financialAccountId": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api.monime.io/v1/payment-codes/{id}"

payload = {
    "name": "<string>",
    "amount": {
        "currency": "<string>",
        "value": 123
    },
    "duration": "<string>",
    "enable": True,
    "customer": { "name": "Musa Kamara" },
    "reference": "<string>",
    "authorizedProviders": [],
    "authorizedPhoneNumber": "<string>",
    "recurrentPaymentTarget": {
        "expectedPaymentCount": 10,
        "expectedPaymentTotal": {
            "currency": "<string>",
            "value": 123
        }
    },
    "financialAccountId": "<string>",
    "metadata": {}
}
headers = {
    "Monime-Space-Id": "<monime-space-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Monime-Space-Id': '<monime-space-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    amount: {currency: '<string>', value: 123},
    duration: '<string>',
    enable: true,
    customer: {name: 'Musa Kamara'},
    reference: '<string>',
    authorizedProviders: [],
    authorizedPhoneNumber: '<string>',
    recurrentPaymentTarget: {
      expectedPaymentCount: 10,
      expectedPaymentTotal: {currency: '<string>', value: 123}
    },
    financialAccountId: '<string>',
    metadata: {}
  })
};

fetch('https://api.monime.io/v1/payment-codes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.monime.io/v1/payment-codes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'amount' => [
        'currency' => '<string>',
        'value' => 123
    ],
    'duration' => '<string>',
    'enable' => true,
    'customer' => [
        'name' => 'Musa Kamara'
    ],
    'reference' => '<string>',
    'authorizedProviders' => [
        
    ],
    'authorizedPhoneNumber' => '<string>',
    'recurrentPaymentTarget' => [
        'expectedPaymentCount' => 10,
        'expectedPaymentTotal' => [
                'currency' => '<string>',
                'value' => 123
        ]
    ],
    'financialAccountId' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Monime-Space-Id: <monime-space-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.monime.io/v1/payment-codes/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value\": 123\n  },\n  \"duration\": \"<string>\",\n  \"enable\": true,\n  \"customer\": {\n    \"name\": \"Musa Kamara\"\n  },\n  \"reference\": \"<string>\",\n  \"authorizedProviders\": [],\n  \"authorizedPhoneNumber\": \"<string>\",\n  \"recurrentPaymentTarget\": {\n    \"expectedPaymentCount\": 10,\n    \"expectedPaymentTotal\": {\n      \"currency\": \"<string>\",\n      \"value\": 123\n    }\n  },\n  \"financialAccountId\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Monime-Space-Id", "<monime-space-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.monime.io/v1/payment-codes/{id}")
  .header("Monime-Space-Id", "<monime-space-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value\": 123\n  },\n  \"duration\": \"<string>\",\n  \"enable\": true,\n  \"customer\": {\n    \"name\": \"Musa Kamara\"\n  },\n  \"reference\": \"<string>\",\n  \"authorizedProviders\": [],\n  \"authorizedPhoneNumber\": \"<string>\",\n  \"recurrentPaymentTarget\": {\n    \"expectedPaymentCount\": 10,\n    \"expectedPaymentTotal\": {\n      \"currency\": \"<string>\",\n      \"value\": 123\n    }\n  },\n  \"financialAccountId\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.monime.io/v1/payment-codes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value\": 123\n  },\n  \"duration\": \"<string>\",\n  \"enable\": true,\n  \"customer\": {\n    \"name\": \"Musa Kamara\"\n  },\n  \"reference\": \"<string>\",\n  \"authorizedProviders\": [],\n  \"authorizedPhoneNumber\": \"<string>\",\n  \"recurrentPaymentTarget\": {\n    \"expectedPaymentCount\": 10,\n    \"expectedPaymentTotal\": {\n      \"currency\": \"<string>\",\n      \"value\": 123\n    }\n  },\n  \"financialAccountId\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "<string>",
    "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": "<unknown>"
        }
      }
    },
    "metadata": {}
  }
}

Authorizations

Authorization

string

header

required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

Monime-Version

enum<string> | null

Specifies which version of the Monime API will handle this request.

Available options:

caph.2025-08-23,

caph.2025-06-20

Monime-Space-Id

string

required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum string length: 64

Pattern: ^spc-.*$

Path Parameters

string

required

The unique ID of the payment code to update.

Pattern: ^pmc-.*$

Body

application/json

Partially updates an existing payment code with new values, rules, or account bindings.

name

string | null

Updated display name or label for the payment code.

Required string length: 3 - 64

amount

object | null

Updated amount to charge per use.

Show child attributes

duration

string | null

New expiration duration for the code.

enable

boolean | null

Flag to activate or deactivate the payment code.

customer

object | null

Updated customer information for this payment code.

Show child attributes

reference

string | null

New reference string for tagging the payment code.

Maximum string length: 64

authorizedProviders

enum<string>[] | null

Updated list of mobile money providers allowed to use this code.

Required array length: 1 - 10 elements

The ID of the MOMO as identified by Monime. E.g. m17 to denote Orange Money SL

Available options:

m17,

m18

authorizedPhoneNumber

string | null

New MSISDN authorized to use this payment code exclusively.

recurrentPaymentTarget

object | null

Updated target count or amount for completing a recurrent payment code.

Show child attributes

financialAccountId

string | null

Updated destination financial account for funds settlement.

Maximum string length: 64

Pattern: ^fac-.*$

metadata

object | null

Updated metadata for storing additional context about the payment code.

Show child attributes

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

Payment Code · object

A Payment Code is a programmable, short-lived token that allows users to collect payments from others.
It is especially useful in USSD-like or QR-based flows, where the payer enters or scans a code to complete a transaction.

Payment Codes provide flexibility for both one-time and recurrent collections, with configurable restrictions and targets.

Use Cases

USSD Payment Collection
A merchant generates a Payment Code and displays it in USSD. Customers enter the code to make payments.
Example: A vendor creates a one-time code for SLE 50 which a customer redeems via their mobile money wallet.
QR Code at Point of Sale
The Payment Code is encoded as a QR displayed at checkout. Customers scan the QR to pay.
Example: A shop generates a QR-based Payment Code for SLE 200, which is redeemed on the spot.
Recurring Subscription Collection
A fitness center issues a recurrent Payment Code for monthly fees.
Example: The code accepts up to 12 payments of SLE 500 each, after which it auto-completes.
Targeted Collection
Restrict a Payment Code to a specific MSISDN or provider.
Example: Only customers on Orange Money with a registered number can redeem the code.

Show child attributes

Delete Payment CodeDeletes a payment code by ID. This operation is only allowed if the code hasn't been used.

Update Payment Code

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": [],
  "authorizedPhoneNumber": "<string>",
  "recurrentPaymentTarget": {
    "expectedPaymentCount": 10,
    "expectedPaymentTotal": {
      "currency": "<string>",
      "value": 123
    }
  },
  "financialAccountId": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api.monime.io/v1/payment-codes/{id}"

payload = {
    "name": "<string>",
    "amount": {
        "currency": "<string>",
        "value": 123
    },
    "duration": "<string>",
    "enable": True,
    "customer": { "name": "Musa Kamara" },
    "reference": "<string>",
    "authorizedProviders": [],
    "authorizedPhoneNumber": "<string>",
    "recurrentPaymentTarget": {
        "expectedPaymentCount": 10,
        "expectedPaymentTotal": {
            "currency": "<string>",
            "value": 123
        }
    },
    "financialAccountId": "<string>",
    "metadata": {}
}
headers = {
    "Monime-Space-Id": "<monime-space-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Monime-Space-Id': '<monime-space-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    amount: {currency: '<string>', value: 123},
    duration: '<string>',
    enable: true,
    customer: {name: 'Musa Kamara'},
    reference: '<string>',
    authorizedProviders: [],
    authorizedPhoneNumber: '<string>',
    recurrentPaymentTarget: {
      expectedPaymentCount: 10,
      expectedPaymentTotal: {currency: '<string>', value: 123}
    },
    financialAccountId: '<string>',
    metadata: {}
  })
};

fetch('https://api.monime.io/v1/payment-codes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.monime.io/v1/payment-codes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'amount' => [
        'currency' => '<string>',
        'value' => 123
    ],
    'duration' => '<string>',
    'enable' => true,
    'customer' => [
        'name' => 'Musa Kamara'
    ],
    'reference' => '<string>',
    'authorizedProviders' => [
        
    ],
    'authorizedPhoneNumber' => '<string>',
    'recurrentPaymentTarget' => [
        'expectedPaymentCount' => 10,
        'expectedPaymentTotal' => [
                'currency' => '<string>',
                'value' => 123
        ]
    ],
    'financialAccountId' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Monime-Space-Id: <monime-space-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.monime.io/v1/payment-codes/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value\": 123\n  },\n  \"duration\": \"<string>\",\n  \"enable\": true,\n  \"customer\": {\n    \"name\": \"Musa Kamara\"\n  },\n  \"reference\": \"<string>\",\n  \"authorizedProviders\": [],\n  \"authorizedPhoneNumber\": \"<string>\",\n  \"recurrentPaymentTarget\": {\n    \"expectedPaymentCount\": 10,\n    \"expectedPaymentTotal\": {\n      \"currency\": \"<string>\",\n      \"value\": 123\n    }\n  },\n  \"financialAccountId\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Monime-Space-Id", "<monime-space-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.monime.io/v1/payment-codes/{id}")
  .header("Monime-Space-Id", "<monime-space-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value\": 123\n  },\n  \"duration\": \"<string>\",\n  \"enable\": true,\n  \"customer\": {\n    \"name\": \"Musa Kamara\"\n  },\n  \"reference\": \"<string>\",\n  \"authorizedProviders\": [],\n  \"authorizedPhoneNumber\": \"<string>\",\n  \"recurrentPaymentTarget\": {\n    \"expectedPaymentCount\": 10,\n    \"expectedPaymentTotal\": {\n      \"currency\": \"<string>\",\n      \"value\": 123\n    }\n  },\n  \"financialAccountId\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.monime.io/v1/payment-codes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value\": 123\n  },\n  \"duration\": \"<string>\",\n  \"enable\": true,\n  \"customer\": {\n    \"name\": \"Musa Kamara\"\n  },\n  \"reference\": \"<string>\",\n  \"authorizedProviders\": [],\n  \"authorizedPhoneNumber\": \"<string>\",\n  \"recurrentPaymentTarget\": {\n    \"expectedPaymentCount\": 10,\n    \"expectedPaymentTotal\": {\n      \"currency\": \"<string>\",\n      \"value\": 123\n    }\n  },\n  \"financialAccountId\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "<string>",
    "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": "<unknown>"
        }
      }
    },
    "metadata": {}
  }
}

API Reference

Core Resources

Payins

Payouts

Utilities

Extra Resources

Financial Providers

Update Payment Code

Authorizations

Headers

Path Parameters

Body

Response

Use Cases