Payouts to bank accounts in SEPA
Overview
Payouts to bank accounts in SEPA is a payment method that allows you to perform payouts to customers by bank transfers in SEPA countries. You can perform payouts through this method in euros via the banks of European countries.
The ecommpay payment platform supports processing payouts made with the Payouts to bank accounts in SEPA payment method. You can also perform purchases by using the Open Banking complementary payment methods.
General information
Payment method type | bank payments |
---|---|
Payment instruments | bank accounts |
Countries and regions | AD, AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LI, LT, LU, MT, MC, NL, NO, PL, PT, RO, SM, SK, SI, ES, SE, CH, GB, VA |
Payment currencies | EUR |
Currency conversion | – |
Purchases | – |
Payouts | + |
Stored credentials payments | – |
Full refunds | – |
Partial refunds | – |
Chargebacks | – |
Special considerations |
|
Obtaining access to the payment method and access fee | refer to your ecommpay key account manager |
Interaction diagram
Payment processing by using the Payouts to bank accounts in SEPA payment method requires merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as the technical facilities of the provider.
Operations support
Interfaces | Amounts, EUR | Times** | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | minimum | maximum | basic | threshold | |
Payouts | – | – | + | + | * | * | * | * |
* Amount limits and processing times depend on banks.
** The basic and threshold times are defined as follows:
- The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
- The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ecommpay technical support.
Processing scenarios
In the Payouts to bank accounts in SEPA method to initiate a payout, you need to notify customer via merchant's web service.
Figure: Payout by using Gate
The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.
Payouts by using Gate
General information
To perform a payout through the Payouts to bank accounts in SEPA method, merchant's web service sends a request with all the required parameters and signature to ecommpay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.
Figure: Payout by using Gate
- A customer requests a payout through the Payouts to bank accounts in SEPA method.
- Merchant's web service sends the request for the payout processing by using Gate to the appropriate ecommpay URL.
- Gate redirects the request to the ecommpay payment platform.
- The payment platform performs all the necessary checks and processes the request.
- The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
- The payment platform redirects the payout request to the provider service.
- The payout is processed on the provider side.
- The provider sends the result notification to the payment platform.
- The payment platform sends a callback with the payment result to the web service.
- The customer receives the notification about the payout result from the web service.
The sections that follow discuss in more details the request format and the Gate parameters to use in the Payouts to bank accounts in SEPA payment method and provide the information on the format of callbacks with payout results.
Request format
There are several things you must consider when using payout requests in the Payouts to bank accounts in SEPA method:- You send payout requests by sending the
/v2/payment/bank-transfer/world/payout
request by using HTTP method POST. This request refers to the bank transfer requests group: /v2/payment/bank-transfer/{payment_method}/payout - The following objects and parameters must be specified in any request:
- Object general—general payout information:
- project_id—project identifier
- payment_id—unique payout identifier
- signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
- Object customer—recipient information:
- id—identifier
- ip_address—IP address
- first_name—full name of the recipient or name of the company
- Object account—recipient account information:
- number—recipient bank account number (IBAN)
- Object payment—payout information:
- amount—payout amount
- currency—payout currency in the ISO-4217 alpha-3 format
- description—payout description
- Object general—general payout information:
- If required, you can also add any other additional parameters Gate supports.
Thus, a correct payment request in the Payouts to bank accounts in SEPA method must include project and payment IDs, recipient and account information, currency and amount of the payout, as shown in the following example:
Figure: Example of a payout request
{ "general": { "project_id": 3027, "payment_id": "payout1", "signature": "M1vT4q9c8hA8xCjEwGFSANI+9XAaq7/Jkn+aJmGA4jH6bgBOp8DTf8d/XdoV+vd7Q==" }, "customer": { "id": "customer1", "ip_address": "192.0.2.0", "first_name": "John Doe" }, "account": { "number": "FI1410093000123458" }, "payment": { "amount": 10000, "currency": "EUR", "description": "test payout" } }
Callback format
The Payouts to bank accounts in SEPA method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.
The following is the example of a callback with an information about successful 211.00 EUR
payout made in the 4990
project.
Figure: Example of a successful payout callback
{ "project_id": 4990, "payment": { "id": "53923_33600681", "type": "payout", "status": "success", "date": "2021-02-22T13:39:45+0000", "method": "world", "sum": { "amount": 21100, "currency": "EUR" }, "description": "test description" }, "account": { "number": "123456" }, "customer": { "id": "customer1" }, "operation": { "id": 6325000000075, "type": "payout", "status": "success", "date": "2021-02-22T13:39:45+0000", "created_date": "2021-02-22T13:39:23+0000", "request_id": "9a9c4985044f5927dae77daac4b8e488b2-00006326", "sum_initial": { "amount": 21100, "currency": "EUR" }, "sum_converted": { "amount": 21100, "currency": "EUR" }, "code": "0", "message": "Success", "provider": { "id": 2945, "payment_id": "j29vEXRSAd", "auth_code": "" } }, "signature": "7bxR3Ssoemv3o5mpabmg529+/NkpdYPLMN1sBw==" }
The following is the example of a callback for a declined payout.
Figure: Example of a declined payout callback
{ "project_id": 4990, "payment": { "id": "21571027", "type": "payout", "status": "decline", "date": "2021-02-22T13:30:44+0000", "method": "world", "sum": { "amount": 30400, "currency": "EUR" }, "description": "test description" }, "account": { "number": "1234567" }, "customer": { "id": "customer2" }, "operation": { "id": 9698000000069, "type": "payout", "status": "decline", "date": "2021-02-22T13:30:44+0000", "created_date": "2021-02-22T13:30:23+0000", "request_id": "3c6027f04491e63df2d67f755e3b45f64-00009699", "sum_initial": { "amount": 30400, "currency": "EUR" }, "sum_converted": { "amount": 30400, "currency": "EUR" }, "code": "20000", "message": "General decline", "provider": { "id": 2945, "payment_id": "j29KmZH29J", "auth_code": "" } }, "signature": "KTCGrXiG/cQzANBw2s730kE6toB+EDa619tqB9qQeg==" }
Related topics
The following topics might be useful when implementing payments through Gate:
Payouts by using Dashboard
When working with Dashboard, you can process single and mass payouts by using the Payouts to bank accounts in SEPA 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.
Analysis of payments results
As with other payment methods ecommpay offers, when using the Payouts to bank accounts in SEPA method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.
You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.
Also, you can export the information for further analysis by using third party analytical tools. The following options are available:
- Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
- Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.
If you have any further questions regarding payment data analysis, contact ecommpay technical support.