本文档由 Apifox 自动生成，推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试！

List Banks

Develop Env

https://echo.apifox.com/anything

GET

/payment/banks

Last modified:2025-02-20 07:53:20

Maintainer:Not configured

This endpoint allows you to list all banks associated with the store to receive payments.

Scopes

payments.read- Payments Read Only

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Query Params

page

integer

optional

The Pagination page number

status

string

optional

Filter the banks list by either active or inactive

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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 (Banks) {4}]

optional

integer

required

A unique alphanumeric code or identifier assigned to each bank.

bank_name

string

required

A pre-defined name associated with the bank.

account_name

string

required

A user defined name associated with the account.

status

enum<string>

required

Whether or not the bank is active.

Allowed values:

activeinactive

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": 0,
    "success": true,
    "data": [
        {
            "id": 0,
            "bank_name": "string",
            "account_name": "string",
            "status": "active"
        }
    ],
    "pagination": {
        "count": 0,
        "total": 0,
        "perPage": 65,
        "currentPage": 0,
        "totalPages": 0,
        "links": {
            "next": "string",
            "previous": "string"
        }
    }
}

🟠401Unauthorized

Modified at 2025-02-20 07:53:20

Available Payment Methods

Payment Bank Details