List Payment Providers

GET

/admin/payments/payment-providers

Payments

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

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "payment_providers": [
        {
            "id": "string",
            "is_enabled": true
        }
    ]
}

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 -.

required

One of

array[string]

Filter by a payment provider's ID.

is_enabled

boolean

is_enabled

optional

Filter by whether the payment provider is enabled.

$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.

$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.

Responses

🟢200OK

application/json

Body

The paginated list of payment providers.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before the returned items.

count

number

count

required

The total number of items.

payment_providers

array[object (AdminPaymentProvider) {2}]

required

The list of payment providers.

string

required

The payment provider's ID.

is_enabled

boolean

is_enabled

required

Whether the payment provider is enabled.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

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

Refund Payment

List Payments