PayStar API Documentation
  1. API DOC | EN
  • MERCHANT
    • PRODUCTS | EN
    • ПРОДУКТЫ | RU
    • Untitled Doc
    • FEATURES | EN
      • Deposits & Payouts
      • Issues (Tickets)
      • Secure data (One-time secret)
      • Summary Report
      • Payment Analytics
      • Payment Form Analytics
      • Unified audit log
      • Export reports
      • Black list
      • Routing & Cascading
      • Limits
      • Commissions
      • Team
      • My Account
      • PayStar in 100 Questions
    • ВОЗМОЖНОСТИ | RU
      • Депозиты и выплаты
      • Issues (Задачи)
      • Защищённые данные (One-time secret)
      • Сводный отчёт
      • Аналитика по платежам
      • Единый журнал событий
      • Аналитика платёжной формы
      • Экспорт отчётов
      • Черный список
      • Мавршрутизация и Каскады
      • Лимиты
      • Комиссии
      • Команда
      • Мой аккаунт
      • PayStar в 100 вопросах
    • API DOC | EN
      • Introduction
      • Glossary
      • Authorization key
      • Sandbox
      • Additional fields
      • Currencies
      • Bank names
      • Telecom operators
      • Callbacks
      • Error descriptions
      • Tech FAQ
      • Events
      • Payment history v2
      • Integratins
        • Stripe
        • Inwizo
        • 2Checkout
        • Adyen
        • AffiniPay
        • Alikassa
        • AlliancePay
        • Amazon Pay
        • AnyMoney
        • AstroPay
        • Aureavia
        • AurisMyChanger
        • Authorize.Net
        • Avatarix
      • Balance H2H
        GET
      • Deposit H2H - Card & P2P
        POST
      • Deposit H2H - Token
        POST
      • Deposit H2C - Card
        POST
      • Deposit status H2H - PayStar ID
        GET
      • Deposit status H2H - Merch ID
        GET
      • Payout H2H
        POST
      • Payout status H2H - PayStar ID
        GET
      • Payout status H2H - Merch ID
        GET
  • AGENT (REFERRAL)
  1. API DOC | EN

Bank names

INFO
The bank name is typically used for payment routing. If the bank is not specified in the request, it will be automatically determined based on the card's BIN.
However, BIN-based detection cannot guarantee 100% accuracy.
If your users are willing to specify the issuing bank of the card, it is recommended to include this field — doing so can improve payment success rates and enhance the reliability of financial flows.
The bank name can be helpful in the following methods:
Deposit H2H - Card & P2P — hosted on the secure subdomain. Requires the merchant to have a PCI DSS certificate and allows direct card data transmission between servers (host-to-host).
Deposit H2H - Token — hosted on the token subdomain. Enables recurring payments using previously obtained tokens.
Deposit H2С - Card — hosted on the init subdomain. Does not require PCI DSS. Used to initiate a payment without card data; the user is then redirected to a web form to enter card details.
Payout H2H — hosted on the secure subdomain.

How to use bankName example#

Bank name is used in the additionalFields for deposit and payout. Here's an example of a query using bankName:
curl --request POST \
 --url https://secure.PayStar.uk/api/v1/integration/deposit-order \
 --header 'Authorization: Bearer YOUR TOKEN' \
 --header 'Content-Type: application/json' \
 --header 'accept: text/plain' \
 --data '{
  "amount": 100
  "currency": "USD"
  "additionalFields": [
    {
      "key": "сardNumber"
      "value": "1234123412341234"
    },
    {
      "key": "bankName"
      "value": "all"
    }
  ]
}'

BankName dictionary#

1. Any bank & Any GEO
2. Azerbaijan (AZN)
3. Kazakhsthan (KZT)
4. Mongolia (MNT)
5. Philippines (PHP)
6. Poland (PLN)
7. Republic of Moldova (MDL)
8. Russia (RUB)
9. Slovakia (EUR)
10. Thailand (THB)
11. Turkey (TRY)
12. Ukraine (UAH)
13. United Kingdom (GBP)
14. Vietnam (VND)
Previous
Currencies
Next
Telecom operators
Built with