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.

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

idstring or null

Unique identifier for the payment.

processorIdstring or null

Identifier of the payment processor.

processorNamestring or null

Name of the payment processor.

processorReferencestring or null

Reference from the payment processor.

processorConfigIdstring or null

Configuration ID of the payment processor.

holderIdstring or null

Identifier of the payment holder.

workspaceIdstring or null

Workspace ID associated with the payment.

instrumentIdstring or null

Identifier of the payment instrument.

paymentMethodTypeenum or null

Type of payment method used.

metadatamap from strings to any or null

Additional metadata for the payment.

1	{
2	"status": "COMPLETED",
3	"createdAt": "2024-03-20T09:00:00Z",
4	"amount": {
5	"value": 10000,
6	"currency": "USD"
7	},
8	"id": "PAY_1234567890",
9	"processorId": "PROC_123",
10	"processorName": "Stripe",
11	"processorReference": "REF_123456",
12	"processorConfigId": "CONFIG_123",
13	"holderId": "HOLDER_123",
14	"workspaceId": "WORKSPACE_123",
15	"instrumentId": "INSTR_123",
16	"paymentMethodType": "Card",
17	"metadata": {
18	"orderId": "ORDER_987654321"
19	}
20	}

Query parameters

Response

Errors