Local payouts to bank accounts in the UK

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

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.

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: Payout 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.

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

 {
  "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.

 {
        "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.

 {
        "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:

• 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.