API referencePayment requests
Simulate the payer's bank transfer
POST
/api/v2/payment-requests/{id}/sandbox-transferSandbox only. Deposits amountDue with the invoice number as reference, as the payer's bank would, and runs it through the real matching and crediting. Returns the request with its new bank_transfer settlement. Needs an open request with an invoice. Outside the sandbox the request fails with SANDBOX_ONLY. Needs payment-requests:write.
Path Parameters
id*string
The payment request id (payment_request_…) or your customId.
Header Parameters
idempotency-key?maxLength(255)
Client-chosen key, 1 to 255 characters (a UUID is recommended). The same key on the same endpoint within 24 hours replays the stored response with Idempotent-Replayed: true.
Length
1 <= length <= 255Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/payment-requests/payment_request_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e/sandbox-transfer"{ "object": "payment_request", "id": "payment_request_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e", "customId": "campaign-42", "description": "string", "amount": "100.00", "currency": "USD", "amountDue": "100.00", "amountRemaining": "100.00", "payer": { "type": "email", "email": "jane@example.com" }, "status": "draft", "tags": [ "string" ], "paymentUrl": "string", "invoice": { "number": "string", "url": "string", "issuedAt": "string", "vatRate": "19.00", "vatAmount": "100.00", "creditNote": { "number": "string", "url": "string", "issuedAt": "string" } }, "settlements": [ { "type": "bank_transfer", "transactionId": "transaction_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e_out", "status": "pending", "amount": "100.00", "createdAt": "2026-09-24T10:00:00.000Z" } ], "sentAt": "2026-09-24T10:00:00.000Z", "firstViewedAt": "2026-09-24T10:00:00.000Z", "transferAnnouncedAt": "2026-09-24T10:00:00.000Z", "paidAt": "2026-09-24T10:00:00.000Z", "cancelledAt": "2026-09-24T10:00:00.000Z", "createdAt": "2026-09-24T10:00:00.000Z", "updatedAt": "2026-09-24T10:00:00.000Z"}