Skip to content

Payments

Retrieve
experimental.payments.retrieve(strpayment_ref) -> PaymentRetrieveResponse
GET/payments/{payment_ref}
Search
experimental.payments.search(PaymentSearchParams**kwargs) -> PaymentSearchResponse
POST/payments/search
ModelsExpand Collapse
class Payment:

Payment object.

id: str

FRAGMENT generated unique ID.

amount: str

Amount in smallest currency unit.

created: str

Timestamp when the payment was created.

currency: str

Currency code.

direction: str

Direction of the payment.

modified: str

Timestamp when the payment was last modified.

payment_account_id: str

Payment account ID.

payment_flow_id: str

Payment flow ID.

status: str

Status of the payment.

transaction_ids: List[str]

Associated transaction IDs.

external_id: Optional[str]

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