Payments APIManage Payments

Search Payments

Retrieves a list of payments based on the provided query parameters. This operation supports pagination and filtering by various attributes such as status, payment method type, processor, currency, and more. Results are paginated, with a maximum of 100 payments per page. Use the cursor query parameter to navigate through pages.

Query parameters

statusenumOptional

Filter payments by their status.

Allowed values:
payment_method_typestringOptional

Filter payments by their method type.

processorstringOptional

Filter payments by processor.

Response

Payments retrieved successfully.

statusstring

Current status of the payment.

createdAtdatetime

Timestamp when the payment was created.

amountobject
idstringOptional

Unique identifier for the payment.

processorIdstringOptional

Identifier of the payment processor.

processorNamestringOptional

Name of the payment processor.

processorReferencestringOptional

Reference from the payment processor.

processorConfigIdstringOptional

Configuration ID of the payment processor.

holderIdstringOptional

Identifier of the payment holder.

workspaceIdstringOptional

Workspace ID associated with the payment.

instrumentIdstringOptional

Identifier of the payment instrument.

paymentMethodTypeenumOptional

Type of payment method used.

metadatamap from strings to anyOptional

Additional metadata for the payment.

Errors