Buy Now Pay Later

Introduction

Buy Now Pay Later is a payment method which allows to process installment payments in pounds in the United Kingdom. The terms of the installment payment plan are determined as a result of interaction between the customer and the provider. This method supports purchases.

This article provides information about working with the Buy Now Pay Later 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 Buy Now Pay Later 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 Buy Now Pay Later method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links). At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the Buy Now Pay Later the following amount limits are applicable.

Processing scenarios

To perform a purchase by using the Buy Now Pay Later method, you need to redirect customer to the provider service.

Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

General information

To process a purchase through Payment Page by using the Buy Now Pay Later method, the merchant's web service is required to 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 purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the Buy Now Pay Later method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Buy Now Pay Later method:

1. The following parameters required for any payment must be specified:
   • project_id—project identifier obtained from ecommpay during integration
   • payment_id—payment identifier unique within the project
   • payment_currency—payment currency code in the ISO-4217 alpha-3 format
   • payment_amount—payment amount in the smallest currency unit
   • customer_id—customer identifier unique within the project
2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. It is required to specify the first and last names of the customer in the parameters customer_first_name and customer_last_name.
4. If you need to have the payment form displayed with the Buy Now Pay Later method selected, set the force_payment_method parameter to bnpl-humm.
5. Additionally, any other parameters available for working with Payment Page can be used (details).
6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Buy Now Pay Later method must contain the project identifier, basic payment information (identifier, amount, and currency code), information about the customer and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 3000,
   "payment_currency": "GBP",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 3000,
   "payment_currency": "GBP",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The Buy Now Pay Later method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks. It should be noted that the bnpl value can be specified in the type parameter of the payment object.

The following is the example of a callback with information about a 10.00 GBP purchase that was processed in the 59051 project.

{
        "customer": {
            "id": "zxc",
            "phone": "07811123331"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_600055",
            "type": "bnpl",
            "status": "success",
            "date": "2024-11-14T11:20:31+0000",
            "method": "bnpl",
            "sum": {
                "amount": 1000,
                "currency": "GBP"
            },
            "description": "TEST_PAYMENT_600055"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "GBP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "GBP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 16891,
                "payment_id": "Twp7saulXXF05mzi",
                "auth_code": ""
            },
            "id": 29741010169841,
            "type": "sale",
            "status": "success",
            "date": "2024-11-14T11:20:31+0000",
            "created_date": "2024-11-14T11:08:10+0000",
            "request_id": "497a5edb8ba907ae27d12f508c3d2ba096-00029742"
        },
        "signature": "XV7CVXtQv7n53zvg3jlt1ThyVdedpUKg3UX/9i6jWLPiA=="
    }

The following is the example of a callback with information about a declined purchase.

{
        "customer": {
            "id": "zxc"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_577285",
            "type": "bnpl",
            "status": "decline",
            "date": "2024-11-14T11:49:55+0000",
            "method": "bnpl",
            "sum": {
                "amount": 1000,
                "currency": "GBP"
            },
            "description": "TEST_PAYMENT_577285"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "GBP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "GBP"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 16891,
                "payment_id": "xAIr1FeVlr1QGo4h",
                "auth_code": ""
            },
            "id": 35876010169968,
            "type": "sale",
            "status": "decline",
            "date": "2024-11-14T11:49:55+0000",
            "created_date": "2024-11-14T11:39:57+0000",
            "request_id": "f5313e75fade8bb5076a05692a9c82-00035877"
        },
        "signature": "C3I7F8GCUMf/7MJjQszBerLdVWYncTyi+ZAD9uKDQDg=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

• Interaction concepts—about the interaction with the payment platform by using Payment Page.
• 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.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

To process a purchase through Gate by using the Buy Now Pay Later method, the merchant's web service is required to do the following:

1. Send a request with all the required parameters and signature to the ecommpay URL.
2. Receive an intermediate callback from the payment platform and redirect the customer to the provider service.
3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the Buy Now Pay Later 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 purchase requests by using the Buy Now Pay Later method:

1. To initiate each purchase, send a separate POST request to the /v2/payment/bnpl/humm/sale endpoint.
2. Each request must include the following objects and parameters:
   • Object general—general purchase 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—payment amount in the smallest currency unit
     • currency—payment currency code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payment
     • first_name—customer first name
     • last_name—customer last name
3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Buy Now Pay Later method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, as well as signature.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej/UG0Di8hTng6JvipTv+AWoXW/9MTO8yJA=="
  },
  "payment": {
    "amount": 30000,
    "currency": "GBP"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "John",
    "last_name": "Doe"
  }
}

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej/UG0Di8hTng6JvipTv+AWoXW/9MTO8yJA=="
  },
  "payment": {
    "amount": 30000,
    "currency": "GBP"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "John",
    "last_name": "Doe"
  }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the Buy Now Pay Later method requires redirection of customers from the merchant's web service to the provider service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

• body—object with data to be sent in the request body
• method—parameter specifying the HTTP method for sending the request (GET or POST)
• url—parameter containing a link for redirection

  "redirect_data": {
    "body": {},
    "method": "POST",
    "url": "https://www.example.com/pay"
  }

Callback format

The Buy Now Pay Later method uses the standard format for callbacks to deliver results. For more information, see Callbacks. It should be noted that the bnpl value can be specified in the type parameter of the payment object.

The following is the example of a callback with information about a 10.00 GBP purchase that was processed in the 59051 project.

{
        "customer": {
            "id": "zxc",
            "phone": "07811123331"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_600055",
            "type": "bnpl",
            "status": "success",
            "date": "2024-11-14T11:20:31+0000",
            "method": "bnpl",
            "sum": {
                "amount": 1000,
                "currency": "GBP"
            },
            "description": "TEST_PAYMENT_600055"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "GBP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "GBP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 16891,
                "payment_id": "Twp7saulXXF05mzi",
                "auth_code": ""
            },
            "id": 29741010169841,
            "type": "sale",
            "status": "success",
            "date": "2024-11-14T11:20:31+0000",
            "created_date": "2024-11-14T11:08:10+0000",
            "request_id": "497a5edb8ba907ae27d12f508c3d2ba096-00029742"
        },
        "signature": "XV7CVXtQv7n53zvg3jlt1ThyVdedpUKg3UX/9i6jWLPiA=="
    }

The following is the example of a callback with information about a declined purchase.

{
        "customer": {
            "id": "zxc"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_577285",
            "type": "bnpl",
            "status": "decline",
            "date": "2024-11-14T11:49:55+0000",
            "method": "bnpl",
            "sum": {
                "amount": 1000,
                "currency": "GBP"
            },
            "description": "TEST_PAYMENT_577285"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "GBP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "GBP"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 16891,
                "payment_id": "xAIr1FeVlr1QGo4h",
                "auth_code": ""
            },
            "id": 35876010169968,
            "type": "sale",
            "status": "decline",
            "date": "2024-11-14T11:49:55+0000",
            "created_date": "2024-11-14T11:39:57+0000",
            "request_id": "f5313e75fade8bb5076a05692a9c82-00035877"
        },
        "signature": "C3I7F8GCUMf/7MJjQszBerLdVWYncTyi+ZAD9uKDQDg=="
    }

Useful links

The following articles can be useful when implementing purchases 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.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.