Create a collection
curl --request POST \
--url https://sandbox-api.platform.chipper.ai/v1/collections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": {
"accountNumber": "<string>",
"code": "<string>",
"amount": "<string>",
"currency": "<string>",
"kyc": {}
},
"externalReference": "<string>",
"to": {
"currency": "<string>"
},
"narration": "<string>",
"metadata": {}
}
'import requests
url = "https://sandbox-api.platform.chipper.ai/v1/collections"
payload = {
"from": {
"accountNumber": "<string>",
"code": "<string>",
"amount": "<string>",
"currency": "<string>",
"kyc": {}
},
"externalReference": "<string>",
"to": { "currency": "<string>" },
"narration": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from: {
accountNumber: '<string>',
code: '<string>',
amount: '<string>',
currency: '<string>',
kyc: {}
},
externalReference: '<string>',
to: {currency: '<string>'},
narration: '<string>',
metadata: {}
})
};
fetch('https://sandbox-api.platform.chipper.ai/v1/collections', 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/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from' => [
'accountNumber' => '<string>',
'code' => '<string>',
'amount' => '<string>',
'currency' => '<string>',
'kyc' => [
]
],
'externalReference' => '<string>',
'to' => [
'currency' => '<string>'
],
'narration' => '<string>',
'metadata' => [
]
]),
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/collections"
payload := strings.NewReader("{\n \"from\": {\n \"accountNumber\": \"<string>\",\n \"code\": \"<string>\",\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"kyc\": {}\n },\n \"externalReference\": \"<string>\",\n \"to\": {\n \"currency\": \"<string>\"\n },\n \"narration\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox-api.platform.chipper.ai/v1/collections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from\": {\n \"accountNumber\": \"<string>\",\n \"code\": \"<string>\",\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"kyc\": {}\n },\n \"externalReference\": \"<string>\",\n \"to\": {\n \"currency\": \"<string>\"\n },\n \"narration\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.platform.chipper.ai/v1/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": {\n \"accountNumber\": \"<string>\",\n \"code\": \"<string>\",\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"kyc\": {}\n },\n \"externalReference\": \"<string>\",\n \"to\": {\n \"currency\": \"<string>\"\n },\n \"narration\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"collection": {
"id": "col_h2sk8dqz4mtv9xnp1wbf",
"type": "mobile_money",
"status": "pending",
"from": {
"accountNumber": "233559630374",
"code": "gh_mtn",
"amount": "150.00",
"currency": "GHS"
},
"to": {
"accountNumber": "GHS12345678",
"amount": "150.00",
"currency": "GHS"
},
"fee": {
"amount": "1.50",
"currency": "GHS"
},
"rate": "1",
"details": {},
"narration": "Order #1042",
"externalReference": "order-1042",
"metadata": {},
"statusMessage": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2026-08-01T09:12:44.000Z"
}
}{
"collection": {
"id": "col_h2sk8dqz4mtv9xnp1wbf",
"type": "mobile_money",
"status": "pending",
"from": {
"accountNumber": "233559630374",
"code": "gh_mtn",
"amount": "150.00",
"currency": "GHS"
},
"to": {
"accountNumber": "GHS12345678",
"amount": "150.00",
"currency": "GHS"
},
"fee": {
"amount": "1.50",
"currency": "GHS"
},
"rate": "1",
"details": {},
"narration": "Order #1042",
"externalReference": "order-1042",
"metadata": {},
"statusMessage": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2026-08-01T09:12:44.000Z"
}
}{
"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": "duplicate",
"message": "Collection with this externalReference already exists",
"requestId": "req_q7vei435zifs51ia0lqr"
}Collections
Create a collection
Charges a payer’s mobile money wallet. from.accountNumber is the payer’s phone number and from.code the rail (e.g. gh_mtn); the payer gets a prompt on their phone and must approve it, so the collection starts pending and finishes completed or failed — listen for the collection.completed / collection.failed webhooks rather than polling. Money is credited in the collected currency (to.currency must match). externalReference is your idempotency key: an identical retry returns the original with status 200; the same reference with a different amount, payer, or method is rejected with 409.
POST
/
v1
/
collections
Create a collection
curl --request POST \
--url https://sandbox-api.platform.chipper.ai/v1/collections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": {
"accountNumber": "<string>",
"code": "<string>",
"amount": "<string>",
"currency": "<string>",
"kyc": {}
},
"externalReference": "<string>",
"to": {
"currency": "<string>"
},
"narration": "<string>",
"metadata": {}
}
'import requests
url = "https://sandbox-api.platform.chipper.ai/v1/collections"
payload = {
"from": {
"accountNumber": "<string>",
"code": "<string>",
"amount": "<string>",
"currency": "<string>",
"kyc": {}
},
"externalReference": "<string>",
"to": { "currency": "<string>" },
"narration": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from: {
accountNumber: '<string>',
code: '<string>',
amount: '<string>',
currency: '<string>',
kyc: {}
},
externalReference: '<string>',
to: {currency: '<string>'},
narration: '<string>',
metadata: {}
})
};
fetch('https://sandbox-api.platform.chipper.ai/v1/collections', 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/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from' => [
'accountNumber' => '<string>',
'code' => '<string>',
'amount' => '<string>',
'currency' => '<string>',
'kyc' => [
]
],
'externalReference' => '<string>',
'to' => [
'currency' => '<string>'
],
'narration' => '<string>',
'metadata' => [
]
]),
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/collections"
payload := strings.NewReader("{\n \"from\": {\n \"accountNumber\": \"<string>\",\n \"code\": \"<string>\",\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"kyc\": {}\n },\n \"externalReference\": \"<string>\",\n \"to\": {\n \"currency\": \"<string>\"\n },\n \"narration\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox-api.platform.chipper.ai/v1/collections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from\": {\n \"accountNumber\": \"<string>\",\n \"code\": \"<string>\",\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"kyc\": {}\n },\n \"externalReference\": \"<string>\",\n \"to\": {\n \"currency\": \"<string>\"\n },\n \"narration\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.platform.chipper.ai/v1/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": {\n \"accountNumber\": \"<string>\",\n \"code\": \"<string>\",\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"kyc\": {}\n },\n \"externalReference\": \"<string>\",\n \"to\": {\n \"currency\": \"<string>\"\n },\n \"narration\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"collection": {
"id": "col_h2sk8dqz4mtv9xnp1wbf",
"type": "mobile_money",
"status": "pending",
"from": {
"accountNumber": "233559630374",
"code": "gh_mtn",
"amount": "150.00",
"currency": "GHS"
},
"to": {
"accountNumber": "GHS12345678",
"amount": "150.00",
"currency": "GHS"
},
"fee": {
"amount": "1.50",
"currency": "GHS"
},
"rate": "1",
"details": {},
"narration": "Order #1042",
"externalReference": "order-1042",
"metadata": {},
"statusMessage": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2026-08-01T09:12:44.000Z"
}
}{
"collection": {
"id": "col_h2sk8dqz4mtv9xnp1wbf",
"type": "mobile_money",
"status": "pending",
"from": {
"accountNumber": "233559630374",
"code": "gh_mtn",
"amount": "150.00",
"currency": "GHS"
},
"to": {
"accountNumber": "GHS12345678",
"amount": "150.00",
"currency": "GHS"
},
"fee": {
"amount": "1.50",
"currency": "GHS"
},
"rate": "1",
"details": {},
"narration": "Order #1042",
"externalReference": "order-1042",
"metadata": {},
"statusMessage": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2026-08-01T09:12:44.000Z"
}
}{
"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": "duplicate",
"message": "Collection with this externalReference already exists",
"requestId": "req_q7vei435zifs51ia0lqr"
}Authorizations
Your API key: sk_test_… (sandbox) or sk_live_… (production).
Body
application/json
Response
Idempotent replay — this externalReference was already used with the same details, the original collection is returned.
Show child attributes
Show child attributes
⌘I