Local payouts to bank accounts in the UK

Overview

Introduction

Local payouts to bank accounts in the UK is a payment method which allows you to process payments in pounds sterling by using bank accounts in the UK. This method supports payouts. You can also perform purchases by using Open Banking in the UK as a complementary payment method.

This article provides information about working with the Local payouts to bank accounts in the UK 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

Payment method type bank payments
Payment instruments bank accounts
Countries and regions GB
Payment currencies GBP
Currency conversion –
One-time purchases –
Credential-on-file purchases –
Full refunds –
Partial refunds –
Payouts +
Chargebacks –
Special considerations performing purchases is possible with the use of the complementary payment method Open Banking in the UK
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 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 Local payouts to bank accounts in the UK 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 Local payouts to bank accounts in the UK the following properties and limitations are applicable.

Amounts, GBP ¹ Times ²
minimum maximum basic threshold
Payouts * * * *
Note:
  1. Amount limits and processing times depend on banks.
  2. The base and threshold times are defined as follows:
    • The base 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 web service. The base 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 the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

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

Figure 1. Payout by using Gate


Payouts by using Gate

General information

To process a payout through Gate by using the Local payouts to bank accounts in the UK 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.



Figure 2. Payout processing by using Gate: step-by-step description
  1. A customer initiates a payout by using the Local payouts to bank accounts in the UK method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the provider service.
  7. The payout is processed on the side of the provider service.
  8. The provider service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the Local payouts to bank accounts in the UK 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 Local payouts to bank accounts in the UK method:

  1. To initiate each payout send a separate POST request to the /v2/payment/bank-transfer/uk/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:
      • bank_code—SORT bank code of the recipient
      • number—recipient bank account number in domestic format
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Local payouts to bank accounts in the UK method must contain the project identifier, basic payment information (identifier, amount, and currency code), payout description, recipient information, account number, SORT code of the bank, as well as signature.

 {
  "general": {
    "project_id": 3027,
    "payment_id": "payout1",
    "signature": "M1vT4q9c8hA8xCjEwH6bgBOp8DTf8d/XdoV+vd7Q=="
  },
   "customer": {
     "id": "customer1",
     "ip_address": "192.0.2.0",
     "first_name": "John Doe"
  },
   "account": {
     "bank_code": "123",
     "number": "1020304010"
  },
   "payment": {
     "amount": 10000,
     "currency": "GBP",
     "description": "test payout"
  }
}
Figure 3. Example of sufficient data in a payout request
 {
  "general": {
    "project_id": 3027,
    "payment_id": "payout1",
    "signature": "M1vT4q9c8hA8xCjEwH6bgBOp8DTf8d/XdoV+vd7Q=="
  },
   "customer": {
     "id": "customer1",
     "ip_address": "192.0.2.0",
     "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 information about a 305.00 GBP payout made in the 4991 project.

Figure 4. Example of callback data indicating that the payout has been processed
 {
        "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 with information about a declined payout.

Figure 5. Example of callback data indicating that the payout has been declined
 {
        "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=="
    }

Useful links

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

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the Local payouts to bank accounts in the UK 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

To analyse information about payments made with the Local payouts to bank accounts in the UK method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.