API Reference

Experimental

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Payments

Retrieve

client.experimental.payments.retrieve(stringpaymentRef, RequestOptionsoptions?): PaymentRetrieveResponse { data }

GET/payments/{payment_ref}

Search

client.experimental.payments.search(PaymentSearchParams { page_info, payment_flow_id } body?, RequestOptionsoptions?): PaymentSearchResponse { data }

POST/payments/search

ModelsExpand Collapse

Payment { id, amount, created, 8 more }

Payment object.

id: string

FRAGMENT generated unique ID.

amount: string

Amount in smallest currency unit.

created: string

Timestamp when the payment was created.

currency: string

Currency code.

direction: string

Direction of the payment.

modified: string

Timestamp when the payment was last modified.

payment_account_id: string

Payment account ID.

payment_flow_id: string

Payment flow ID.

status: string

Status of the payment.

transaction_ids: Array<string>

Associated transaction IDs.

external_id?: string

User-provided unique ID when the payment was created with one.