Simulate a payment on a sandbox invoice
curl --request POST \
--url https://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"paid_amount": 1,
"send_webhook": true,
"notify_url": "<string>"
}
'import requests
url = "https://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate"
payload = {
"paid_amount": 1,
"send_webhook": True,
"notify_url": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({paid_amount: 1, send_webhook: true, notify_url: '<string>'})
};
fetch('https://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate', 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.pawpayments.com/api/v2/invoices/{invoice_id}/simulate",
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([
'paid_amount' => 1,
'send_webhook' => true,
'notify_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.pawpayments.com/api/v2/invoices/{invoice_id}/simulate"
payload := strings.NewReader("{\n \"paid_amount\": 1,\n \"send_webhook\": true,\n \"notify_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paid_amount\": 1,\n \"send_webhook\": true,\n \"notify_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paid_amount\": 1,\n \"send_webhook\": true,\n \"notify_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"result": {
"invoice": {
"accepted_coins": [
"usdt_tron",
"usdc_eth"
],
"address_from": null,
"address_to": "TXk2Y5...redacted",
"amount": 49.5,
"asset": "usdt_tron",
"billing_type": "fiat",
"created_at": 1763398800,
"description": "1 month subscription",
"excluded_coins": null,
"expires_at": 1763400600,
"external_id": "f2c8a3d1-4b7e-4f8a-9c1d-2e3b4a5c6d7e",
"extra": "order-12345",
"fee_bearer": "merchant",
"fiat_amount": 50,
"fiat_currency": "USD",
"initial_amount": 49.5,
"initial_asset": "usdt_tron",
"initial_fiat_amount": 50,
"metadata": {
"customer_id": "u_42"
},
"notify_url": "https://shop.example.com/webhook/paw",
"on_cancel_url": "https://shop.example.com/cancel",
"on_paid_url": "https://shop.example.com/thanks",
"order_id": "65f1c3a4e8b1c2d3a4b5c6d7",
"original_amount": 50,
"payer_info": null,
"payment_url": "https://pay.pawpayments.com/checkout/f2c8a3d1-4b7e-4f8a-9c1d-2e3b4a5c6d7e",
"permanent_address_id": null,
"price_modifier": -1,
"processed_at": null,
"received_amount": 0,
"status": "created",
"title": "Premium plan",
"txid": null,
"type": "token",
"underpay_tolerance": 0.01,
"user_id": null
},
"webhook": {
"delivered": true,
"error": null,
"status_code": 200,
"url": "https://shop.example.com/webhook/paw"
}
}
}{
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "amount",
"message": "Field required"
}
],
"message": "Validation failed"
},
"ok": false
}{
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "amount",
"message": "Field required"
}
],
"message": "Validation failed"
},
"ok": false
}{
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "amount",
"message": "Field required"
}
],
"message": "Validation failed"
},
"ok": false
}{
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "amount",
"message": "Field required"
}
],
"message": "Validation failed"
},
"ok": false
}Sandbox
Simulate a payment on a sandbox invoice
POST
/
api
/
v2
/
invoices
/
{invoice_id}
/
simulate
Simulate a payment on a sandbox invoice
curl --request POST \
--url https://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"paid_amount": 1,
"send_webhook": true,
"notify_url": "<string>"
}
'import requests
url = "https://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate"
payload = {
"paid_amount": 1,
"send_webhook": True,
"notify_url": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({paid_amount: 1, send_webhook: true, notify_url: '<string>'})
};
fetch('https://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate', 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.pawpayments.com/api/v2/invoices/{invoice_id}/simulate",
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([
'paid_amount' => 1,
'send_webhook' => true,
'notify_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.pawpayments.com/api/v2/invoices/{invoice_id}/simulate"
payload := strings.NewReader("{\n \"paid_amount\": 1,\n \"send_webhook\": true,\n \"notify_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paid_amount\": 1,\n \"send_webhook\": true,\n \"notify_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pawpayments.com/api/v2/invoices/{invoice_id}/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paid_amount\": 1,\n \"send_webhook\": true,\n \"notify_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"result": {
"invoice": {
"accepted_coins": [
"usdt_tron",
"usdc_eth"
],
"address_from": null,
"address_to": "TXk2Y5...redacted",
"amount": 49.5,
"asset": "usdt_tron",
"billing_type": "fiat",
"created_at": 1763398800,
"description": "1 month subscription",
"excluded_coins": null,
"expires_at": 1763400600,
"external_id": "f2c8a3d1-4b7e-4f8a-9c1d-2e3b4a5c6d7e",
"extra": "order-12345",
"fee_bearer": "merchant",
"fiat_amount": 50,
"fiat_currency": "USD",
"initial_amount": 49.5,
"initial_asset": "usdt_tron",
"initial_fiat_amount": 50,
"metadata": {
"customer_id": "u_42"
},
"notify_url": "https://shop.example.com/webhook/paw",
"on_cancel_url": "https://shop.example.com/cancel",
"on_paid_url": "https://shop.example.com/thanks",
"order_id": "65f1c3a4e8b1c2d3a4b5c6d7",
"original_amount": 50,
"payer_info": null,
"payment_url": "https://pay.pawpayments.com/checkout/f2c8a3d1-4b7e-4f8a-9c1d-2e3b4a5c6d7e",
"permanent_address_id": null,
"price_modifier": -1,
"processed_at": null,
"received_amount": 0,
"status": "created",
"title": "Premium plan",
"txid": null,
"type": "token",
"underpay_tolerance": 0.01,
"user_id": null
},
"webhook": {
"delivered": true,
"error": null,
"status_code": 200,
"url": "https://shop.example.com/webhook/paw"
}
}
}{
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "amount",
"message": "Field required"
}
],
"message": "Validation failed"
},
"ok": false
}{
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "amount",
"message": "Field required"
}
],
"message": "Validation failed"
},
"ok": false
}{
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "amount",
"message": "Field required"
}
],
"message": "Validation failed"
},
"ok": false
}{
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "amount",
"message": "Field required"
}
],
"message": "Validation failed"
},
"ok": false
}Authorizations
Path Parameters
Unique 24-character hex invoice id.
Body
application/json
Drive a SANDBOX invoice into a terminal (or partial) status.
Sandbox only — there is nothing to simulate on a live invoice, whose status is determined by the chain.
Status to move the invoice into.
Available options:
success, partially_paid, paid_over, expired, cancelled, failed, refunded Amount paid in the invoice's fiat_currency. Defaults to a sensible value for the chosen status: the full amount for success, half for partially_paid, 125% for paid_over.
Required range:
x > 0Whether to deliver the webhook for this transition.
Override the webhook destination for this call only.
Response
OK
Result of driving a sandbox invoice into a new status.
Show child attributes
Show child attributes
Example:
{
"invoice": {
"accepted_coins": ["usdt_tron", "usdc_eth"],
"address_from": null,
"address_to": "TXk2Y5...redacted",
"amount": 49.5,
"asset": "usdt_tron",
"billing_type": "fiat",
"created_at": 1763398800,
"description": "1 month subscription",
"excluded_coins": null,
"expires_at": 1763400600,
"external_id": "f2c8a3d1-4b7e-4f8a-9c1d-2e3b4a5c6d7e",
"extra": "order-12345",
"fee_bearer": "merchant",
"fiat_amount": 50,
"fiat_currency": "USD",
"initial_amount": 49.5,
"initial_asset": "usdt_tron",
"initial_fiat_amount": 50,
"metadata": { "customer_id": "u_42" },
"notify_url": "https://shop.example.com/webhook/paw",
"on_cancel_url": "https://shop.example.com/cancel",
"on_paid_url": "https://shop.example.com/thanks",
"order_id": "65f1c3a4e8b1c2d3a4b5c6d7",
"original_amount": 50,
"payer_info": null,
"payment_url": "https://pay.pawpayments.com/checkout/f2c8a3d1-4b7e-4f8a-9c1d-2e3b4a5c6d7e",
"permanent_address_id": null,
"price_modifier": -1,
"processed_at": null,
"received_amount": 0,
"status": "created",
"title": "Premium plan",
"txid": null,
"type": "token",
"underpay_tolerance": 0.01,
"user_id": null
},
"webhook": {
"delivered": true,
"error": null,
"status_code": 200,
"url": "https://shop.example.com/webhook/paw"
}
}
⌘I

