Documentation/API Reference

API REFERENCE

Bank Transfer

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Bank Transfer

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters11

Required fields first

Introduction

request_idRequiredstringdata.request_idUnique request ID; a combination of digits and letters at least 24 characters is recommended
pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodBank Transfer
amountRequiredstringdata.amountNumeric amount. For example, € 24.99 must be written as 24.99; euro amount>=1
currencyRequiredstringdata.currencyEUR
descriptionRequiredstringdata.descriptionOrder description
timeoutRequiredstringdata.timeoutExpiration time in minutes (0-1440)
notify_urlRequiredstringdata.notify_urlAsynchronous notification URL after payment
Optional parameters 3
emailOptionalstringdata.emailUser email address
demoOptionalstringdata.demoCustom field
redirect_urlOptionalstringdata.redirect_urlRedirect URL after payment

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Applies to: user bank transfers

Paybybank is a secure bank transfer payment method offered by YabandPay. Customers pay by transferring funds directly from their bank accounts to YabandPay's designated account.

This solution is ideal for merchants seeking lower costs and reliable transactions without relying on card networks. Once the transfer is received, YabandPay automatically verifies the payment and updates the transaction status, ensuring a smooth payment experience for merchants and customers.

Tip

Paybybank only supports transfers through the SEPA (Single Euro Payments Area) network. SWIFT transfers are not accepted.

ParameterTypeDescriptionRequired
userStringCashier account UIDRequired
signStringSignatureRequired
methodStringv3.BankTransferRequired
timeLongTimestampRequired
  • Parameters
ParameterTypeDescriptionRequired
request_idStringUnique request ID; a combination of digits and letters at least 24 characters is recommendedRequired
pay_methodStringonlineRequired
sub_pay_methodStringBank TransferRequired
order_idStringMerchant order IDRequired
amountStringNumeric amount. For example, € 24.99 must be written as 24.99; euro amount>=1Required
currencyStringEURRequired
descriptionStringOrder descriptionRequired
emailStringUser email addressOptional
demoStringCustom fieldOptional
timeoutStringExpiration time in minutes (0-1440)Required
redirect_urlStringRedirect URL after paymentOptional
notify_urlStringAsynchronous notification URL after paymentRequired

Signature example:

Sorted parameters concatenated into a URL-style query string

"amount=0.1&currency=EUR&demo=test&description=Test&email=info@yabandmedia.com&method=v3.BankTransfer&notify_url=https://www.yabandpay.com/notify&order_id=12455555788&pay_method=online&redirect_url=https://www.yabandpay.com&request_id=001123456789&sub_pay_method=Bank Transfer&time=1653145918&timeout=0&user=YOUR_CASHIER_UID"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
    "user": "YOUR_CASHIER_UID",
    "method": "v3.BankTransfer",
    "time": "1653145918",
    "sign": "YOUR_SIGNATURE",
    "data": {
        "request_id": "001123456789",
        "order_id" : "YOUR_ORDER_ID",
        "pay_method": "online",
        "sub_pay_method": "Bank Transfer",
        "email": "info@yabandmedia.com",
        "description": "Test", 
        "timeout" : "0",
        "amount": "0.1",
        "currency": "EUR",
        "redirect_url": "https://www.yabandpay.com",
        "notify_url" : "https://www.yabandpay.com/notify",
        "demo": "test"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "d3a81009-2b3c-9f2c-8e33-45dc932ee757",
        "amount": "0.10",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/prod/bank_transfer/ZDNhODEwMDktMmIzYy05ZjJjLThlMzMtNDVkYzkzMmVlNzU3",
        "state": "processing"
    },
    "message": "",
    "response_id": "202505131817352897785689"
}

Additional information:

Response result:
  1. A successful request returns "status": true.

  2. A failed request returns "status": false.

We recommend using Asynchronous Notifications to update the payment status and keep payment information accurate in real time.

Response codes:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method