Skip to content

Bank Transfer

YP Integration option

Payment flow

  1. The customer initiates a payment on the merchant's website and selects the bank for the payment.
  2. The merchant sends a payment request with bank_transfer_de method type if the customer is from Germany or with bank_transfer_alt method type if the customer is from a EU country other than Germany. The merchant specifies the ID of the selected bank and additional parameters depending on the customer's country. You need to request a list of bank IDs from your account manager. customer object is not required for the following countries: Spain (ES), France (FR), Portugal (PT), Germany (DE), the United Kingdom (GB) and Ireland (IE).
  3. Demo PSP sends a response with a link to the QR code (for all countries except Germany) and the redirect URL.
  4. The merchant displays the QR code (for all countries except Germany) and the URL from redirect_url to the customer.
  5. The customer scans the QR code (for all countries except Germany) or follows the payment URL and completes the payment.
  6. Demo PSP sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Demo PSP with the status query.
  7. The merchant displays the payment status to the customer.

Info

This integration option supports only EUR and GBP currencies.

Payment (DE)

Request

Send a payment request with the following additional parameters:
object
return_url
required

 string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method.
type
required

 string
bank_transfer_de
Request example 
{
  "request": {
    "amount": 2000,
    "currency": "EUR",
    "description": "description",
    "test": true,
    "return_url": "https://your_return_url.com",
    "method": {
      "type": "bank_transfer_de"
    }
  }
}
Response

The bank_transfer_de object in the response will contain the redirect_url parameter with the link to which the customer needs to be redirected.

Response example 
{
  "transaction": {
    "uid": "3a824724-82a7-4123-b960-d1a2c437211d",
    "type": "payment",
    "status": "pending",
    "amount": 2000,
    "currency": "EUR",
    "description": "description",
    "created_at": "2024-03-10T20:17:27Z",
    "updated_at": "2024-03-10T20:17:27Z",
    "method_type": "bank_transfer_de",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/3a824724-82a7-4123-b960-d1a2c437211d/8143cc7527cb27ad7147d721b0f0224a7ff416aa484dd63d438ea4fc45b94c24",
    "payment": {
      "status": "pending",
      "gateway_id": 3797,
      "message": "Transaction was initialized."
    },
    "bank_transfer_de": {
      "type": "bank_transfer_de",
      "qr_code": null,
      "redirect_url": "https://redirect_url",
      "country": null,
      "id_number": null,
      "bic": null
    },
    "customer": {
      "email": null,
      "ip": null
    },
    "manually_corrected_at": null,
    "message": "Transaction was initialized.",
    "test": true,
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": false
    }
  }
}

Payment (EU except DE)

Request

Send a payment request with the following additional parameters:
object
return_url
required

 string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method.
type
required

 string
bank_transfer_alt
channel
required
 string
The ID of the bank selected by the customer. Request the list of IDs from your account manager.
id_number
conditionally required
 string
IBAN for the following countries: Austria (AT), Belgium (BE), Bulgaria (BG), Croatia (HR), Cyprus (CY), Czech Republic (CZ), Denmark (DK), Estonia (EE), Finland (FI), Greece (GR), Hungary (HU), Italy (IT), Latvia (LV), Lithuania (LT), Luxembourg (LU), Malta (MT), Netherlands (NL), Poland (PL), Romania (RO), Slovakia (SK), Slovenia (SI);

BBAN for Sweden (SE).

The parameter is not required for Spain (ES), France (FR), the United Kingdom (GB), Portugal (PT) and Ireland (IE).
bic
conditionally required
 string
BIC of the customer's bank (Bank Identifier Code).

The parameter is required for the following countries: Austria (AT), Belgium (BE), Bulgaria (BG), Croatia (HR), Cyprus (CY), Czech Republic (CZ), Denmark (DK), Estonia (EE), Finland (FI), Greece (GR), Hungary (HU), Italy (IT), Latvia (LV), Lithuania (LT), Luxembourg (LU), Malta (MT), Netherlands (NL), Poland (PL), Romania (RO), Slovakia (SK), Slovenia (SI).
country
required
 string (2)
The customer's billing country in the ISO 3166-1 Alpha-2 format. For example, AT.
conditionally required
 object
A section of information about the customer. The object is required for the following countries: Austria (AT), Belgium (BE), Bulgaria (BG), Croatia (HR), Cyprus (CY), Czech Republic (CZ), Denmark (DK), Estonia (EE), Finland (FI), Greece (GR), Hungary (HU), Italy (IT), Latvia (LV), Lithuania (LT), Luxembourg (LU), Malta (MT), Netherlands (NL), Poland (PL), Romania (RO), Slovakia (SK), Slovenia (SI) and Sweden (SE).
first_name
conditionally required
 string
The customer's first name.
last_name
conditionally required
 string
The customer's last name.
Request example 
{
  "request": {
    "amount": 2000,
    "currency": "GBP",
    "description": "description",
    "test": true,
    "return_url": "https://your_return_url.com",
    "notification_url": "https://your_notification_url.com",
    "method": {
      "type": "bank_transfer_alt",
      "channel": "bank ID",
      "country": "GB"
    }
  }
}
Request example for countries other than ES, FR, PT, DE, GB and IE 
{
  "request": {
    "amount": 2000,
    "currency": "EUR",
    "description": "description",
    "test": true,
    "return_url": "https://your_return_url.com",
    "notification_url": "https://your_notification_url.com",
    "customer": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "method": {
      "type": "bank_transfer_alt",
      "channel": "bank_id",
      "id_number": "NL91ABNA0417164300",
      "bic": "INGBNL2A",
      "country": "NL"
    }
  }
}
Response

The bank_transfer_alt object in the response will include qr_code and redirect_url parameters that contain values to be displayed to the customer.

Response example 
{
  "transaction": {
    "uid": "8b598b5c-1ef0-4d3e-b5a9-9381caa9dc7e",
    "type": "payment",
    "status": "pending",
    "amount": 2000,
    "currency": "GBP",
    "description": "description",
    "created_at": "2024-02-23T13:43:08Z",
    "updated_at": "2024-02-23T13:43:09Z",
    "method_type": "bank_transfer",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/8b598b5c-1ef0-4d3e-b5a9-9381caa9dc7e/4dbcae1c56ec5529d0a4b8a6b2c7187bc642ab8fd276ed95f9e741a60b45bace",
    "payment": {
      "status": "pending",
      "gateway_id": 3762,
      "ref_id": "ff2d41c6-1da3-4dc2-a70a-ed427da28054",
      "message": "Transaction was initialized."
    },
    "bank_transfer_alt": {
      "type": "bank_transfer_alt",
      "qr_code": "https://images.yp.com/image/458bb8ed-123c-4e40-ba6d-48c295049ffb/1708695789?size=0",
      "redirect_url": "https://payment-link.com",
      "country": "GB"
    },
    "customer": {
      "email": null,
      "ip": null
    },
    "manually_corrected_at": null,
    "message": "Transaction was initialized.",
    "test": true,
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": false
    }
  }
}

Payment with Revolut

  1. The customer initiates the payment with Revolut on the merchant's website.
  2. The merchant sends a payment request with bank_transfer_revolut method type.
  3. Demo PSP sends a response with a link to the QR code and the redirect URL.
  4. The merchant displays the QR code and the URL from redirect_url to the customer.
  5. The customer scans the QR code or follows the payment URL, signs into their Revolut account and completes the payment.
  6. Demo PSP sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Demo PSP with the status query.
  7. The merchant displays the payment status to the customer.
Request

Send a payment request with the following additional parameters:
object
return_url
required

 string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method.
type
required

 string
bank_transfer_revolut
country
required
 string (2)
The customer's billing country in the ISO 3166-1 Alpha-2 format. For example, PL.
Request example 
{
    "request": {
        "amount": 2000,
        "currency": "EUR",
        "description": "description",
        "test": true,
        "return_url": "https://your_return_url.com",
        "notification_url": "https://your_notification_url.com",
        "method": {
            "type": "bank_transfer_revolut",
            "country": "PL"
        }
    }
}
Response

The bank_transfer_revolut object in the response will include qr_code and redirect_url parameters that contain values to be displayed to the customer.

Response example 
{
  "transaction": {
    "uid": "90ca56dc-cea2-461c-ac0d-fd02da341de3",
    "type": "payment",
    "status": "pending",
    "amount": 2000,
    "currency": "EUR",
    "description": "TEST",
    "created_at": "2024-10-11T09:25:00Z",
    "updated_at": "2024-10-11T09:25:00Z",
    "method_type": "bank_transfer_revolut",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/90ca56dc-cea2-461c-ac0d-fd02da341de3/371904f3a972b724d538df0202df4066bc7336dc4bf40c1df12039ec625f375e?language=en",
    "payment": {
      "status": "pending",
      "gateway_id": 3853,
      "ref_id": "ref_id-2323265351",
      "message": "Transaction was initialized."
    },
    "bank_transfer_revolut": {
      "type": "bank_transfer_revolut",
      "qr_code": "https://yp/image/dc6cee8d-418c-4b79-a51e-aca8f762be62/1703157089?size=0",
      "redirect_url": "payment-url",
      "country": "PL",
      "reference": "1728638700701564",
      "name": ""
    },
    "customer": {
      "email": null,
      "ip": null
    },
    "manually_corrected_at": null,
    "version": 0,
    "message": "Transaction was initialized.",
    "tracking_id": "your_uniq_number",
    "test": true,
    "language": "en",
    "billing_address": {},
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": false
    }
  }
}

Payment with Wise

  1. The customer initiates the payment with Wise on the merchant's website.
  2. The merchant sends a payment request with bank_transfer_wise method type.
  3. Demo PSP sends a response with a link to the QR code and the redirect URL.
  4. The merchant displays the QR code and the URL from redirect_url to the customer.
  5. The customer scans the QR code or follows the payment URL, signs into their Wise account and completes the payment.
  6. Demo PSP sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Demo PSP with the status query.
  7. The merchant displays the payment status to the customer.
Request

Send a payment request with the following additional parameters:
object
return_url
required

 string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method information.
type
required
 string
bank_transfer_wise.
Request example 
{
    "request": {
        "amount": 2000,
        "currency": "EUR",
        "description": "description",
        "test": true,
        "return_url": "https://your_return_url.com",
        "notification_url": "https://your_notification_url.com",
        "method": {
            "type": "bank_transfer_wise"                
        }
    }
}
Response

The bank_transfer_wise object in the response will include qr_code and redirect_url parameters that contain values to be displayed to the customer.

Response example 
{
  "transaction": {
    "uid": "42fc4210-ccb1-4b60-8035-77d329b90abb",
    "type": "payment",
    "status": "pending",
    "amount": 20400,
    "currency": "EUR",
    "description": "TEST",
    "created_at": "2024-10-11T09:26:02Z",
    "updated_at": "2024-10-11T09:26:02Z",
    "method_type": "bank_transfer_wise",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/42fc4210-ccb1-4b60-8035-77d329b90abb/c181f7c0657bf4982a7e8673683a7ceb398663d5be4ef7fb8c25bb59c620a3ca?language=tg",
    "payment": {
      "status": "pending",
      "gateway_id": 3853,
      "ref_id": "ref_id-8361483988",
      "message": "Transaction was initialized."
    },
    "bank_transfer_wise": {
      "type": "bank_transfer_wise",
      "qr_code": "https://yp/image/dc6cee8d-418c-4b79-a51e-aca8f762be62/1703157089?size=0",
      "redirect_url": "payment_url",
      "reference": "1728638762497314",
      "name": ""
    },
    "customer": {
      "email": null,
      "ip": null
    },
    "manually_corrected_at": null,
    "version": 0,
    "message": "Transaction was initialized.",
    "tracking_id": "your_uniq_number",
    "test": false,
    "language": "tg",
    "billing_address": {},
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": false
    }
  }
}