Payouts to bank accounts in SEPA

Introduction

Payouts to bank accounts in SEPA is a payment method which allows you to process payments in euros by using bank accounts in SEPA countries. This method supports payouts. You can also perform purchases by using the Open Banking complementary payment methods.

This article provides information about working with the Payouts to bank accounts in SEPA method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Interaction diagram

Payment processing by using the Payouts to bank accounts in SEPA method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the provider service.

Operations support

Various platform interfaces can be used to process payments and perform operations using the Payouts to bank accounts in SEPA method. Payouts can be processed by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the Payouts to bank accounts in SEPA the following properties and limitations are applicable.

Processing scenarios

To process a payout by using the Payouts to bank accounts in SEPA method, you need to notify the customer via the web service.

General information

To process a payout through Gate by using the Payouts to bank accounts in SEPA method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.

Information about the formats of requests and callbacks used for processing payouts by using the Payouts to bank accounts in SEPA method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the Payouts to bank accounts in SEPA method:

1. To initiate each payout send a separate POST request to the /v2/payment/bank-transfer/world/payout endpoint. This endpoint belongs to the group /v2/payment/bank-transfer/{payment_method}/payout.
2. Each request must include the following objects and parameters:
   • Object general—general payout information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
   • Object payment—payment information:
     • amount—payout amount in the smallest currency unit
     • currency—payout currency code in the ISO-4217 alpha-3 format
     • description—payout description
   • Object customer—recipient information:
     • id—recipient identifier unique within the project
     • ip_address—recipient IP address relevant for the initiated payout
     • first_name—full name of the recipient or name of the company
   • Object account—recipient account information:
     • number—recipient bank account number (IBAN)
3. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Payouts to bank accounts in SEPA method must contain the project identifier, basic payment information (identifier, amount, and currency code), payment description, recipient identifier, IP address and name, as well as account number and signature.

 {
  "general": {
    "project_id": 3027,
    "payment_id": "payout1",
    "signature": "M1vT4q9XAaq7/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"
  }
}

 {
  "general": {
    "project_id": 3027,
    "payment_id": "payout1",
    "signature": "M1vT4q9XAaq7/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 information about a 211.00 EUR payout made in the 4990 project.

{
        "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 with information about a declined payout.

{
        "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=="
    }

Useful links

The following articles can be useful when implementing payouts via Gate:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• Payouts—about processing of payouts by using Gate.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.