List Payments

GET

/admin/payments

Retrieve a list of payments. The payments can be filtered by fields such as id. The payments can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "payments": [
        {
            "payment_session": {
                "payment": {
                    "id": "string",
                    "amount": 0,
                    "authorized_amount": 0,
                    "currency_code": "string",
                    "provider_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "captured_at": "2019-08-24T14:15:22Z",
                    "canceled_at": "2019-08-24T14:15:22Z",
                    "captured_amount": 0,
                    "refunded_amount": 0,
                    "captures": [
                        {
                            "id": "string",
                            "amount": 0,
                            "created_at": "2019-08-24T14:15:22Z",
                            "created_by": "string",
                            "payment": {}
                        }
                    ],
                    "refunds": [
                        {
                            "refund_reason": {
                                "id": "string",
                                "label": "string",
                                "description": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z"
                            },
                            "id": "string",
                            "amount": 0,
                            "refund_reason_id": "string",
                            "note": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "created_by": "string",
                            "payment": {}
                        }
                    ],
                    "payment_collection": {},
                    "payment_session": {},
                    "data": {}
                },
                "id": "string",
                "amount": 0,
                "currency_code": "usd",
                "provider_id": "string",
                "authorized_at": "2019-08-24T14:15:22Z",
                "payment_collection": {},
                "data": {},
                "status": "authorized",
                "context": {
                    "customer": {
                        "id": "cus_123"
                    }
                }
            },
            "id": "string",
            "amount": 0,
            "authorized_amount": 0,
            "currency_code": "string",
            "provider_id": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "captured_at": "2019-08-24T14:15:22Z",
            "canceled_at": "2019-08-24T14:15:22Z",
            "captured_amount": 0,
            "refunded_amount": 0,
            "captures": [
                {
                    "id": "string",
                    "amount": 0,
                    "created_at": "2019-08-24T14:15:22Z",
                    "created_by": "string",
                    "payment": {}
                }
            ],
            "refunds": [
                {
                    "payment": {
                        "id": "string",
                        "amount": 0,
                        "authorized_amount": 0,
                        "currency_code": "string",
                        "provider_id": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "captured_at": "2019-08-24T14:15:22Z",
                        "canceled_at": "2019-08-24T14:15:22Z",
                        "captured_amount": 0,
                        "refunded_amount": 0,
                        "captures": [
                            {
                                "id": "string",
                                "amount": 0,
                                "created_at": "2019-08-24T14:15:22Z",
                                "created_by": "string",
                                "payment": {}
                            }
                        ],
                        "refunds": [
                            {
                                "refund_reason": {
                                    "id": "string",
                                    "label": "string",
                                    "description": "string",
                                    "metadata": {},
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "updated_at": "2019-08-24T14:15:22Z"
                                },
                                "id": "string",
                                "amount": 0,
                                "refund_reason_id": "string",
                                "note": "string",
                                "created_at": "2019-08-24T14:15:22Z",
                                "created_by": "string",
                                "payment": {}
                            }
                        ],
                        "payment_collection": {},
                        "payment_session": {},
                        "data": {}
                    },
                    "refund_reason": {
                        "id": "string",
                        "label": "string",
                        "description": "string",
                        "metadata": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z"
                    },
                    "id": "string",
                    "amount": 0,
                    "refund_reason_id": "string",
                    "note": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "created_by": "string"
                }
            ],
            "payment_collection": {},
            "data": {}
        }
    ]
}

Request

Authorization

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

optional

Search term to filter the payment's searchable properties.

optional

One of

array[string]

Filter by a payment ID.

payment_session_id

optional

One of

payment_session_id

array[string]

Filter by a payment session ID to retrieve its associated payments.

$ne

array[string]

optional

Filter by values not equal to this parameter.

Example:

["","",""]

$gt

array[string]

optional

Filter by values greater than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$gte

array[string]

optional

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lt

array[string]

optional

Filter by values less than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lte

array[string]

optional

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$like

array[string]

optional

Apply a like filter. Useful for strings only.

Example:

["","",""]

$re

array[string]

optional

Apply a regex filter. Useful for strings only.

Example:

["","",""]

$ilike

array[string]

optional

Apply a case-insensitive like filter. Useful for strings only.

Example:

["","",""]

$fulltext

array[string]

optional

Filter to apply on full-text properties.

Example:

["","",""]

$exists

array[string]

optional

Filter by whether a value for this parameter exists (not null).

Example:

["","",""]

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$in

array[string]

optional

Filter by values in this array.

Example:

["","",""]

$nin

array[string]

optional

Filter by values not in this array.

Example:

["","",""]

$overlap

array[string]

optional

Filter arrays that have overlapping values with this parameter.

Example:

["","",""]

$contains

array[string]

optional

Filter arrays that contain some of the values of this parameter.

Example:

["","",""]

$contained

array[string]

optional

Filter arrays that contain all values of this parameter.

Example:

["","",""]

$eq

array[string]

optional

Example:

["","",""]

$not

array[string]

optional

Example:

["","",""]

Responses

🟢200OK

application/json

Body

The paginated list of payments.

limit

number

limit

required

The maximum number of returned items.

offset

number

offset

required

The number of items skipped before the returned items.

count

number

count

required

The total number of payments.

payments

array[object (AdminPayment) {16}]

required

The list of payments.

payment_session

object

AdminPaymentSession

optional

The payment session's details.

string

required

The payment's ID.

amount

number

amount

required

The payment's amount.

authorized_amount

number

authorized_amount

optional

The amount authorized of the payment.

currency_code

string

currency_code

required

The payment's currency code.

provider_id

string

provider_id

required

The ID of the payment provider used to process this payment.

created_at

string <date-time>

created_at

optional

The date the payment was created.

updated_at

string <date-time>

updated_at

optional

The date the payment was updated.

captured_at

string <date-time>

captured_at

optional

The date the payment was captured.

canceled_at

string <date-time>

canceled_at

optional

The date the payment was canceled.

captured_amount

number

captured_amount

optional

The captured amount of the payment.

refunded_amount

number

captured_amount

optional

The refunded amount of the payment.

captures

array[object (BaseCapture) {5}]

optional

The details of payment captures.

refunds

array[object (AdminRefund) {8}]

optional

The details of payment refunds.

payment_collection

object

optional

data

object

optional

The payment's data, useful for processing by the payment provider.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

List Payment Providers

Cancel a return.