Local payouts to bank accounts in the UK

Overview

Local payouts to bank accounts in the UK is a payment method that allows you to perform payouts to customers by local bank transfers in the United Kingdom. You can perform payouts through this method by using Gate and Dashboard (Old Dashboard).

General information

Payment method type bank transfers
Countries and regions GB
Payment currencies GBP
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 Local payouts to bank accounts in the UK 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, GBP Times**
Payment Page CMS Plug-ins Gate Dashboard (Old 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 Local payouts to bank accounts in the UK 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 Local payouts to bank accounts in the UK 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

  1. A customer requests a payout through the Local payouts to bank accounts in the UK method.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the provider service.
  7. The payout is processed on the provider side.
  8. The provider sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. 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 Local payouts to bank accounts in the UK 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 Local payouts to bank accounts in the UK method:
  1. You send payout requests by sending the /v2/payment/bank-transfer/uk/payout request by using HTTP method POST. This request refers to the bank transfer requests group: /v2/payment/bank-transfer/{payment_method}/payout
  2. 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:
      • bank_code—SORT bank code of the recipient
      • number—recipient bank account number in domestic format
    • Object payment—payout information:
      • amount—payout amount
      • currency—payout currency in the ISO-4217 alpha-3 format
      • description—payout description
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Local payouts to bank accounts in the UK 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_": "1.2.3.4",
     "first_name": "John Doe"
  },
   "account": {
     "bank_code": "123",
     "number": "1020304010"
  },
   "payment": {
     "amount": 10000,
     "currency": "GBP",
     "description": "test payout"
  }
}

Callback format

The Local payouts to bank accounts in the UK 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 305.00 GBP payout made in the 4991 project.

Figure: Example of a successful payout callback

 {
        "project_id": 4991,
        "payment": {
            "id": "85777022",
            "type": "payout",
            "status": "success",
            "date": "2021-02-22T13:47:30+0000",
            "method": "bank-transfer-uk",
            "sum": {
                "amount": 30500,
                "currency": "GBP"
            },
            "description": "test payout"
        },
        "account": {
            "number": "5345765"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 4205000000072,
            "type": "payout",
            "status": "success",
            "date": "2021-02-22T13:47:30+0000",
            "created_date": "2021-02-22T13:47:09+0000",
            "request_id": "d61112fb05c3c558a5b77dde36fa41b649d-00004206",
            "sum_initial": {
                "amount": 30500,
                "currency": "GBP"
            },
            "sum_converted": {
                "amount": 30500,
                "currency": "GBP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2944,
                "payment_id": "j29UpFMgQ0",
                "auth_code": ""
            }
        },
        "signature": "EaiGnnSGbZ20U0wmq1x1v/UiIDbzAAxECZegwQqZlYUA=="
    }

The following is the example of a callback for a declined payout.

Figure: Example of a declined payout callback

 {
        "project_id": 4991,
        "payment": {
            "id": "31596106",
            "type": "payout",
            "status": "decline",
            "date": "2021-02-22T13:57:40+0000",
            "method": "bank-transfer-uk",
            "sum": {
                "amount": 23400,
                "currency": "GBP"
            },
            "description": "test payout"
        },
        "account": {
            "number": "312312543"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 7033000000070,
            "type": "payout",
            "status": "decline",
            "date": "2021-02-22T13:57:40+0000",
            "created_date": "2021-02-22T13:57:37+0000",
            "request_id": "c84225facb18f7218f76b053af8b717f946-00007034",
            "sum_initial": {
                "amount": 23400,
                "currency": "GBP"
            },
            "sum_converted": {
                "amount": 23400,
                "currency": "GBP"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2944,
                "payment_id": "j29ih8EBLQ",
                "auth_code": ""
            }
        },
        "signature": "9PcGBHYLfgObqD1cUHXN/iGInDB0KVS2RFVyht5k5wIei75g=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Payouts by using Dashboard (Old Dashboard)

To make a payout through Dashboard (Old Dashboard), the merchant sends a request, and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard (Old Dashboard):
  • as a single payout—in this case, you must specify the currency and amount for a payout available for this method, and fill in all fields required on the Dashboard (Old Dashboard) interface in accordance with the selected payment method
  • as a part of a mass payment—in this case, all parameters are specified in a CSV file in accordance with the requirements in the Payouts by using Gate section (except for the signature)

Information about performed payouts is displayed in the Payments section of Dashboard (Old Dashboard).

More detailed information on the payout processing by using Dashboard (Old Dashboard) is provided in the Performing payouts section.

Analysis of payments results

As with other payment methods ECommPay offers, when using the Local payouts to bank accounts in the UK 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.