Pay a bank-transfer checkout
curl --request POST \
--url https://sandbox-api.platform.chipper.ai/v1/simulations/checkout-deposit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"checkoutSessionId": "<string>",
"externalReference": "<string>",
"amount": "<string>"
}
'import requests
url = "https://sandbox-api.platform.chipper.ai/v1/simulations/checkout-deposit"
payload = {
"checkoutSessionId": "<string>",
"externalReference": "<string>",
"amount": "<string>"
}
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({
checkoutSessionId: '<string>',
externalReference: '<string>',
amount: '<string>'
})
};
fetch('https://sandbox-api.platform.chipper.ai/v1/simulations/checkout-deposit', 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/simulations/checkout-deposit",
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([
'checkoutSessionId' => '<string>',
'externalReference' => '<string>',
'amount' => '<string>'
]),
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/simulations/checkout-deposit"
payload := strings.NewReader("{\n \"checkoutSessionId\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"amount\": \"<string>\"\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/simulations/checkout-deposit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"checkoutSessionId\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"amount\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.platform.chipper.ai/v1/simulations/checkout-deposit")
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 \"checkoutSessionId\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"amount\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"simulation": {
"depositId": "vad_x7kd92mfn3qp8wz4t6vb",
"collectionId": "col_x7kd92mfn3qp8wz4t6vb",
"virtualAccountId": "va_h4n7q2vm8kp3r9zt5wbx",
"amount": "5000",
"currency": "NGN",
"requestedOutcome": "completed",
"replayed": true,
"checkoutSessionId": "cs_test_x7kd92mfn3qp8wz4t6vb",
"paymentLinkId": "pl_test_h4n7q2vm8kp3r9zt5wbx"
}
}{
"error": "bad_request",
"message": "Only bank-transfer checkout sessions accept simulated deposits",
"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": "Simulation endpoint not found",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "conflict",
"message": "externalReference was already used for different balance funding",
"requestId": "req_q7vei435zifs51ia0lqr"
}Simulations
Pay a bank-transfer checkout
Sandbox only — responds 404 on production. Completes a bank-transfer checkout session by depositing into its pooled virtual account. amount defaults to the payment link’s remaining balance; pass less to test underpayment or more for overpayment. Same externalReference replays with 200.
POST
/
v1
/
simulations
/
checkout-deposit
Pay a bank-transfer checkout
curl --request POST \
--url https://sandbox-api.platform.chipper.ai/v1/simulations/checkout-deposit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"checkoutSessionId": "<string>",
"externalReference": "<string>",
"amount": "<string>"
}
'import requests
url = "https://sandbox-api.platform.chipper.ai/v1/simulations/checkout-deposit"
payload = {
"checkoutSessionId": "<string>",
"externalReference": "<string>",
"amount": "<string>"
}
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({
checkoutSessionId: '<string>',
externalReference: '<string>',
amount: '<string>'
})
};
fetch('https://sandbox-api.platform.chipper.ai/v1/simulations/checkout-deposit', 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/simulations/checkout-deposit",
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([
'checkoutSessionId' => '<string>',
'externalReference' => '<string>',
'amount' => '<string>'
]),
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/simulations/checkout-deposit"
payload := strings.NewReader("{\n \"checkoutSessionId\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"amount\": \"<string>\"\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/simulations/checkout-deposit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"checkoutSessionId\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"amount\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.platform.chipper.ai/v1/simulations/checkout-deposit")
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 \"checkoutSessionId\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"amount\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"simulation": {
"depositId": "vad_x7kd92mfn3qp8wz4t6vb",
"collectionId": "col_x7kd92mfn3qp8wz4t6vb",
"virtualAccountId": "va_h4n7q2vm8kp3r9zt5wbx",
"amount": "5000",
"currency": "NGN",
"requestedOutcome": "completed",
"replayed": true,
"checkoutSessionId": "cs_test_x7kd92mfn3qp8wz4t6vb",
"paymentLinkId": "pl_test_h4n7q2vm8kp3r9zt5wbx"
}
}{
"error": "bad_request",
"message": "Only bank-transfer checkout sessions accept simulated deposits",
"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": "Simulation endpoint not found",
"requestId": "req_q7vei435zifs51ia0lqr"
}{
"error": "conflict",
"message": "externalReference was already used for different balance funding",
"requestId": "req_q7vei435zifs51ia0lqr"
}Authorizations
Your API key: sk_test_… (sandbox) or sk_live_… (production).
Body
application/json
Response
Idempotent replay — same body shape as 201 with replayed: true.
⌘I