API Docs
API referencePayment requests

Get a payment request

GET/api/v2/payment-requests/{id}

{id} is the payment request id or your customId. Needs payment-requests:read.

Path Parameters

id*string

The payment request id (payment_request_…) or your customId.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/payment-requests/payment_request_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e"
{  "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"}

Create a payment request POST

Creates a payment request in status `draft`. Nothing reaches the payer, and no invoice is issued, before `finalize`. `andThen` runs `finalize`, and then `send`, in the same request and fails with their codes. A currency your team cannot receive bank transfers in fails with `CURRENCY_NOT_RECEIVABLE`. Needs `payment-requests:write`.

Update a payment request PATCH

Allowed while `status` is `draft`. A body with only `tags` is allowed in every status. An omitted field is unchanged; `payer` is replaced as a whole. Needs `payment-requests:write`.