Update Payment Code
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": {}
}
'import requests
url = "https://api.monime.io/payment-codes/{id}"
payload = {
"name": "<string>",
"isActive": True,
"status": "cancelled",
"expireTime": "2023-11-07T05:31:56Z",
"allowedProviders": ["<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>',
isActive: true,
status: 'cancelled',
expireTime: '2023-11-07T05:31:56Z',
allowedProviders: ['<string>'],
metadata: {}
})
};
fetch('https://api.monime.io/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/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>',
'isActive' => true,
'status' => 'cancelled',
'expireTime' => '2023-11-07T05:31:56Z',
'allowedProviders' => [
'<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/payment-codes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"isActive\": true,\n \"status\": \"cancelled\",\n \"expireTime\": \"2023-11-07T05:31:56Z\",\n \"allowedProviders\": [\n \"<string>\"\n ],\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/payment-codes/{id}")
.header("Monime-Space-Id", "<monime-space-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"isActive\": true,\n \"status\": \"cancelled\",\n \"expireTime\": \"2023-11-07T05:31:56Z\",\n \"allowedProviders\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.monime.io/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 \"isActive\": true,\n \"status\": \"cancelled\",\n \"expireTime\": \"2023-11-07T05:31:56Z\",\n \"allowedProviders\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"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
Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>
Headers
The value is the tenancy parameter that Monime used to determine which space the request is intended for.
Maximum string length:
100Pattern:
^spc-.*$Path Parameters
A unique identifier for the payment code object.
Body
application/json
The name or intent indicating the purpose or use of the payment code.
Maximum string length:
100Denotes whether the payment code is active.
The status of the payment code.
Available options:
cancelled The expiration time of the payment code.
The list of MoMo provider IDs for which the payment code is allowed to be used.
Required array length:
1 - 10 elementsThe metadata for the payment code.
Response
200 - application/json
OK
Was this page helpful?
⌘I
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": {}
}
'import requests
url = "https://api.monime.io/payment-codes/{id}"
payload = {
"name": "<string>",
"isActive": True,
"status": "cancelled",
"expireTime": "2023-11-07T05:31:56Z",
"allowedProviders": ["<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>',
isActive: true,
status: 'cancelled',
expireTime: '2023-11-07T05:31:56Z',
allowedProviders: ['<string>'],
metadata: {}
})
};
fetch('https://api.monime.io/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/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>',
'isActive' => true,
'status' => 'cancelled',
'expireTime' => '2023-11-07T05:31:56Z',
'allowedProviders' => [
'<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/payment-codes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"isActive\": true,\n \"status\": \"cancelled\",\n \"expireTime\": \"2023-11-07T05:31:56Z\",\n \"allowedProviders\": [\n \"<string>\"\n ],\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/payment-codes/{id}")
.header("Monime-Space-Id", "<monime-space-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"isActive\": true,\n \"status\": \"cancelled\",\n \"expireTime\": \"2023-11-07T05:31:56Z\",\n \"allowedProviders\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.monime.io/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 \"isActive\": true,\n \"status\": \"cancelled\",\n \"expireTime\": \"2023-11-07T05:31:56Z\",\n \"allowedProviders\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"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": {}
}
}