Update a payment page
curl --request PATCH \
--url https://sandbox-api.platform.chipper.ai/v1/payment-pages/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "closed",
"allowedMethods": [],
"allowedCryptoAssets": [
"<string>"
],
"customFields": [
{
"name": "<string>",
"type": "<string>",
"required": true
}
],
"redirectUrl": "<string>",
"branding": {
"logoUrl": "<string>",
"accentColor": "<string>",
"businessName": "<string>"
},
"expiresAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://sandbox-api.platform.chipper.ai/v1/payment-pages/{id}"
payload = {
"status": "closed",
"allowedMethods": [],
"allowedCryptoAssets": ["<string>"],
"customFields": [
{
"name": "<string>",
"type": "<string>",
"required": True
}
],
"redirectUrl": "<string>",
"branding": {
"logoUrl": "<string>",
"accentColor": "<string>",
"businessName": "<string>"
},
"expiresAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'closed',
allowedMethods: [],
allowedCryptoAssets: ['<string>'],
customFields: [{name: '<string>', type: '<string>', required: true}],
redirectUrl: '<string>',
branding: {logoUrl: '<string>', accentColor: '<string>', businessName: '<string>'},
expiresAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://sandbox-api.platform.chipper.ai/v1/payment-pages/{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://sandbox-api.platform.chipper.ai/v1/payment-pages/{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([
'status' => 'closed',
'allowedMethods' => [
],
'allowedCryptoAssets' => [
'<string>'
],
'customFields' => [
[
'name' => '<string>',
'type' => '<string>',
'required' => true
]
],
'redirectUrl' => '<string>',
'branding' => [
'logoUrl' => '<string>',
'accentColor' => '<string>',
'businessName' => '<string>'
],
'expiresAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://sandbox-api.platform.chipper.ai/v1/payment-pages/{id}"
payload := strings.NewReader("{\n \"status\": \"closed\",\n \"allowedMethods\": [],\n \"allowedCryptoAssets\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": true\n }\n ],\n \"redirectUrl\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"businessName\": \"<string>\"\n },\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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://sandbox-api.platform.chipper.ai/v1/payment-pages/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"closed\",\n \"allowedMethods\": [],\n \"allowedCryptoAssets\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": true\n }\n ],\n \"redirectUrl\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"businessName\": \"<string>\"\n },\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.platform.chipper.ai/v1/payment-pages/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"closed\",\n \"allowedMethods\": [],\n \"allowedCryptoAssets\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": true\n }\n ],\n \"redirectUrl\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"businessName\": \"<string>\"\n },\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"paymentPage": {
"id": "pp_x7kd92mfn3qp8wz4t6vb",
"url": "https://chipper-platform-checkout-web.onrender.com/pp_x7kd92mfn3qp8wz4t6vb",
"amount": "250.00",
"currency": "GHS",
"title": "Zouk Inc. — Donations",
"description": "Support our Accra chapter.",
"status": "active",
"allowedMethods": [
"mobile_money",
"bank_transfer"
],
"allowedCryptoAssets": null,
"customFields": [
{
"name": "orderNumber",
"type": "text",
"required": true
}
],
"branding": {
"accentColor": "#6642D1",
"businessName": "Zouk Inc."
},
"redirectUrl": "https://zouk.example/thanks",
"metadata": {},
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2026-08-01T09:12:44.000Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paymentCount": 12,
"totalCollected": "3000.00"
}
}{
"error": "validation_error",
"message": "Request validation failed",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "unauthorized",
"message": "Invalid API key",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "forbidden",
"message": "API key does not have the required scope",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "not_found",
"message": "Payment page not found",
"requestId": "req_q7vei435zifs51ia0lqr"
}Payment pages
Update a payment page
Change what the checkout accepts or how it looks. Set status: "closed" to stop new checkouts; child links already in progress are unaffected. Amount and currency are fixed — create a new page to change them.
PATCH
/
v1
/
payment-pages
/
{id}
Update a payment page
curl --request PATCH \
--url https://sandbox-api.platform.chipper.ai/v1/payment-pages/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "closed",
"allowedMethods": [],
"allowedCryptoAssets": [
"<string>"
],
"customFields": [
{
"name": "<string>",
"type": "<string>",
"required": true
}
],
"redirectUrl": "<string>",
"branding": {
"logoUrl": "<string>",
"accentColor": "<string>",
"businessName": "<string>"
},
"expiresAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://sandbox-api.platform.chipper.ai/v1/payment-pages/{id}"
payload = {
"status": "closed",
"allowedMethods": [],
"allowedCryptoAssets": ["<string>"],
"customFields": [
{
"name": "<string>",
"type": "<string>",
"required": True
}
],
"redirectUrl": "<string>",
"branding": {
"logoUrl": "<string>",
"accentColor": "<string>",
"businessName": "<string>"
},
"expiresAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'closed',
allowedMethods: [],
allowedCryptoAssets: ['<string>'],
customFields: [{name: '<string>', type: '<string>', required: true}],
redirectUrl: '<string>',
branding: {logoUrl: '<string>', accentColor: '<string>', businessName: '<string>'},
expiresAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://sandbox-api.platform.chipper.ai/v1/payment-pages/{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://sandbox-api.platform.chipper.ai/v1/payment-pages/{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([
'status' => 'closed',
'allowedMethods' => [
],
'allowedCryptoAssets' => [
'<string>'
],
'customFields' => [
[
'name' => '<string>',
'type' => '<string>',
'required' => true
]
],
'redirectUrl' => '<string>',
'branding' => [
'logoUrl' => '<string>',
'accentColor' => '<string>',
'businessName' => '<string>'
],
'expiresAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://sandbox-api.platform.chipper.ai/v1/payment-pages/{id}"
payload := strings.NewReader("{\n \"status\": \"closed\",\n \"allowedMethods\": [],\n \"allowedCryptoAssets\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": true\n }\n ],\n \"redirectUrl\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"businessName\": \"<string>\"\n },\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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://sandbox-api.platform.chipper.ai/v1/payment-pages/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"closed\",\n \"allowedMethods\": [],\n \"allowedCryptoAssets\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": true\n }\n ],\n \"redirectUrl\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"businessName\": \"<string>\"\n },\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.platform.chipper.ai/v1/payment-pages/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"closed\",\n \"allowedMethods\": [],\n \"allowedCryptoAssets\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"required\": true\n }\n ],\n \"redirectUrl\": \"<string>\",\n \"branding\": {\n \"logoUrl\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"businessName\": \"<string>\"\n },\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"paymentPage": {
"id": "pp_x7kd92mfn3qp8wz4t6vb",
"url": "https://chipper-platform-checkout-web.onrender.com/pp_x7kd92mfn3qp8wz4t6vb",
"amount": "250.00",
"currency": "GHS",
"title": "Zouk Inc. — Donations",
"description": "Support our Accra chapter.",
"status": "active",
"allowedMethods": [
"mobile_money",
"bank_transfer"
],
"allowedCryptoAssets": null,
"customFields": [
{
"name": "orderNumber",
"type": "text",
"required": true
}
],
"branding": {
"accentColor": "#6642D1",
"businessName": "Zouk Inc."
},
"redirectUrl": "https://zouk.example/thanks",
"metadata": {},
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2026-08-01T09:12:44.000Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paymentCount": 12,
"totalCollected": "3000.00"
}
}{
"error": "validation_error",
"message": "Request validation failed",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "unauthorized",
"message": "Invalid API key",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "forbidden",
"message": "API key does not have the required scope",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "not_found",
"message": "Payment page not found",
"requestId": "req_q7vei435zifs51ia0lqr"
}Authorizations
Your API key: sk_test_… (sandbox) or sk_live_… (production).
Path Parameters
Payment page id.
Example:
"pp_x7kd92mfn3qp8wz4t6vb"
Body
application/json
Available options:
closed Minimum array length:
1Available options:
mobile_money, bank_transfer, crypto Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
The updated page.
Show child attributes
Show child attributes
⌘I