[lightMode]

Payment Bank Details

GET/payment/banks/{bank_id}

[updatedIn] 2 months ago

This endpoint allows you to fetch the details of the bank associated with the store to recieve payments by passing the bank_id as a path parameter.

`payments.read`- Payments Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.pathParameter]

bank_id

string

required

Bank ID. List of Bank ID can be found here

Request samples

[api.label.responses]

Success(200)

Unauthorized (401)

Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

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

object (Banks)

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

[app.settings.hasNoSetting]

[updatedIn] 2 months ago