Payout
The customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.
| Countries and regions | Basic availability: AT, BE, EE, ES, FI, FR, DE, GR, HU, IT, IE, LT, LV, NL, NO, PL, PT, RO, SE |
| Payment currencies | EUR |
| Payment amount limits | Contact your key account manager at Openpayze for details. Also you can check the payment amount limits in your project by using Dashboard. |
| Payment processing time | Contact your key account manager at Openpayze for details. |
| Currency conversion | Contact your key account manager at Openpayze for details. |
| Refund |  |
| Onboarding and access fee | Contact your key account manager at Openpayze for details. |
Operations support
| Interfaces | |||
|---|---|---|---|
| Payment Page | Gate | Dashboard | |
| Payout | |
 |
|
You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.
The following sections provide more information about the payment processing flow and the analysis of completed payments.
Payout by using Gate
General information
To perform a payout by using Gate with the Open Banking payment method:
- Send a request with all the required parameters and signature to the Openpayze URL.
- Accept the callback with the payout result from the payment platform.
The following picture provides the details of the payout processing flow in the Open Banking payment method.
- The customer initiates a payout in your system.
- Your system sends the payout request to the Openpayze payment platform.
- The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response format.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service informs the payment platform about the payout result.
- The payment platform sends a callback with the payout result to your system.
- Your system sends the payout result to the customer.
Request
This section provides the instructions on how to build the request for payout with the Open Banking payment method.
| HTTP request method | POST |
| Request body format | JSON |
| API endpoint | /v2/payment/bank-transfer/world/payout |
| Full API endpoint specification | /v2/payment/bank-transfer/{payment_method}/payout |
|
|||
|---|---|---|---|
| Object | Parameter | Description | |
general | project_id | Project ID you obtained from Openpayze when integrating. Example: | |
payment_id | Payment ID unique within your project. Example: | ||
signature | Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | ||
customer | id | Unique ID of the customer within your project. Example: | |
ip_address | IP address of the customer's device. Example: | ||
first_name | Customer first name. Customer's name must match the bank account holder's information, otherwise, the customer will not be able to complete the payment. Example: | ||
last_name | Customer last name. Customer's name must match the bank account holder's information, otherwise, the customer will not be able to complete the payment. Example: | ||
address | Customer address. Example: | ||
country | Customer country in the ISO 3166-1 alpha-2 format. Example: | ||
account | number | Customer's account number (IBAN). Example: | |
bank_code | Customer's bank code (BIC/SWIFT). Example: | ||
payment | currency | Code of the payment currency in the ISO-4217 alpha-3 format. Example: | |
amount | Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units. If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency units and Currency codes. Example: 100.00 EUR must be sent as | ||
description | Payment description. Example: | ||
| You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference. | |||
Here is an example of the data from a request to initiate a payout with the Open Banking payment method:
{
"general": {
"project_id": 1234,
"payment_id": "payment_47",
"signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
},
"customer": {
"id": "customer_123",
"ip_address": "198.51.100.47",
"first_name": "John",
"last_name": "Doe",
"address": "4 Privet Drive",
"country": "GB"
},
"account": {
"number": "AB123456789012345678",
"bank_code": "AB123CDE456"
},
"payment": {
"currency": "EUR",
"amount": 10000,
"description": "Payment description."
}
}
Callback
In the Open Banking payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks.
The following is an example of a callback body with the information about a successfully completed payout.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "payout",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"method": "world",
"sum": {
"amount": 10000,
"currency": "EUR"
},
"description": ""
},
"customer": {
"id": "customer_123"
},
"operation": {
"id": 47,
"type": "payout",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"created_date": "2024-12-07T19:08:05+0000",
"request_id": "1a23456bc7890de",
"sum_initial": {
"amount": 10000,
"currency": "EUR"
},
"sum_converted": {
"amount": 10000,
"currency": "EUR"
},
"code": "0",
"message": "Success",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
The following is an example of a callback for a declined payout.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "payout",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"method": "world",
"sum": {
"amount": 10000,
"currency": "EUR"
},
"description": ""
},
"customer": {
"id": "customer_123"
},
"operation": {
"id": 47,
"type": "payout",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"created_date": "2024-12-07T19:08:05+0000",
"request_id": "1a23456bc7890de",
"sum_initial": {
"amount": 10000,
"currency": "EUR"
},
"sum_converted": {
"amount": 10000,
"currency": "EUR"
},
"code": "20000",
"message": "General decline",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
Payouts by using Dashboard
When working with Dashboard, you can process single and mass payouts by using the Open Banking method.
- To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.
-
To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.
Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).
More information about processing payouts by using Dashboard is presented in a separate section.