BankList
Parameter description
Request
| name | type | required | desc | example |
|---|---|---|---|---|
| param | JSONObject | YES | ||
| ─epayAccount | string | YES | Merchant Epay Account | test2020@epay.com |
| ─version | string | YES | Version number | V2.0.0 |
| ─currency | string | YES | Currency | RUB |
| ─countryCode | string | YES | Country | RU |
| ─category | string | YES | BANK or CASH | BANK |
| ─pageNum | integer | YES | Current page | 1 |
| ─pageSize | integer | YES | Size per page | 10 |
| ─transactionType | string | YES | Transaction mode(C2C,B2C,B2B,C2B) | C2C |
| ─type | string | NO | RECEIVE,PAYMENT | PAYMENT |
| sign | string | YES | Signature |
Response
| name | type | required | desc | example |
|---|---|---|---|---|
| sign | string | YES | Signature | |
| epayAccount | string | YES | Merchant Epay Account | test2020@epay.com |
| version | string | YES | Version number | V2.0.0 |
| code | integer | YES | Response code 1: Success | 1 |
| message | string | YES | Message info | success |
| data | JSONObject | YES | ||
| ─page | JSONObject | YES | ||
| ─ ─pageNum | integer | YES | Start page number | 1 |
| ─ ─pageSize | integer | YES | Numbers of items per page | 10 |
| ─ ─total | integer | YES | Total numbers | 1 |
| ─ ─pages | integer | YES | Total pages | 1 |
| ─nextPage | integer | YES | Next page | 0 |
| ─ ─prePage | integer | YES | Previous page | 0 |
| ─bankList | JSONOarray | |||
| ─locationId | string | YES | Bank branch locationId | RUTPS00002-2 |
| ─bankId | string | YES | Bank ID | RUTPS00002-2 |
| ─bankName | string | YES | Bank name | Central Bank of Russia |
| ─bankBranch | string | YES | Branch name | Central Bank of Russia |
| ─address | string | YES | Address | Russia |
| ─city | string | YES | City | ALL CITIES |
| ─currency | string | YES | Currency | RUB |
| ─countryCode | string | YES | Country code | RU |
| ─transactionType | string | YES | Supported transaction mode | C2C |
| ─channelCode | string | YES | Channel Code | 50 |
Parameter example
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/getBankList' \
--header 'Content-Type: application/json' \
--data-raw '{
"param":{
"epayAccount":"test2020@epay.com",
"category":"BANK",
"transactionType": "C2C",
"currency":"RUB",
"countryCode":"RU",
"pageNum":"1",
"pageSize":"10",
"version":"V2.0.0"
},
"sign":"{{sign}}"
}
'
RequestExample
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payoutApi/getBankList' \
--header 'Content-Type: application/json' \
--data-raw '{
"param":{
"epayAccount":"test2020@epay.com",
"category":"BANK",
"transactionType": "C2C",
"currency":"RUB",
"countryCode":"RU",
"pageNum":"1",
"pageSize":"10",
"version":"V2.0.0"
},
"sign":"{{sign}}"
}
'
ResponseExample
{
"sign": "",
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"code": 1,
"message": "success",
"data": {
"page": {
"pageNum": 1,
"pageSize": 10,
"total": 1,
"pages": 1,
"nextPage": 0,
"prePage": 0
},
"bankList": [
{
"locationId": "RUTPS00002-2",
"bankId": "RUTPS00002-2",
"bankName": "Central Bank of Russia",
"bankBranch": "Central Bank of Russia",
"address": "Russia",
"city": "ALL CITIES",
"currency": "RUB",
"countryCode": "RU",
"transactionType": "C2C",
"channelCode": "50"
}
]
}
}