Available Payment Methods

This endpoint allows you to list all available payment methods.

Scopes

payments.read- Payments Read Only

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (Payment) {3}]

optional

number

required

A unique code assigned to a payment option for accurate transaction tracking and management.

slug

string

required

A short identifier for a payment option, simplifying transaction tracking and management

name

string

required

A brief label for a payment option, supporting easy recognition and organization in a payment system.

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 1473353380,
            "slug": "credit_card",
            "name": "creditCard"
        },
        {
            "id": 1939592358,
            "slug": "paypal",
            "name": "paypal"
        },
        {
            "id": 1298199463,
            "slug": "mada",
            "name": "mada"
        },
        {
            "id": 525144736,
            "slug": "free",
            "name": "free"
        },
        {
            "id": 1764372897,
            "slug": "bank",
            "name": "BankTransfer"
        },
        {
            "id": 989286562,
            "slug": "cod",
            "name": "COD"
        },
        {
            "id": 349994915,
            "slug": "apple_pay",
            "name": "ApplePay"
        },
        {
            "id": 1723506348,
            "slug": "stc_pay",
            "name": "StcPay"
        },
        {
            "id": 814202285,
            "slug": "tamara_installment",
            "name": "TamaraInstallment"
        },
        {
            "id": 40688814,
            "slug": "tabby_installment",
            "name": "TabbyInstallment"
        }
    ]
}

🟠401Unauthorized

Request

Request samples

Responses