API Docs
API referencePayment requests

List payment requests

GET/api/v2/payment-requests

Newest first by createdAt, id as tie-breaker. Needs payment-requests:read.

Query Parameters

status?|array<>

Only payment requests in this status. Repeat for several values.

payerCounterpartyId?string

Only requests to this counterparty: its id (counterparty_…) or your customId.

invoiceNumber?string

Only the request with this invoice number, such as the reference of a deposit transaction.

tag?|array<string>

Only requests with this tag. Repeat for several values; a request matches any of them.

createdFrom?string

Only requests created at or after this time. Inclusive.

Formatdate-time
createdBefore?string

Only requests created before this time. Exclusive, so windows that share a boundary do not overlap.

Formatdate-time
limit?between(1, 100)

Page size, 1 to 100. Default 20.

cursor?string

The nextCursor of the previous page. Opaque: never build or decode it.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/payment-requests"
{  "object": "list",  "data": [    {      "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"    }  ],  "hasMore": true,  "nextCursor": "string"}

Get a transaction GET

Needs `transactions:read`.

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`.