Start Payment

Start a PayLater or PayNow Payment

POST {{base_url}}/v2/apply/

Creates/Send a payment link. A successful request will return a token and a redirect_url. The customer should be redirected to the redirect_url so they can complete payment, and token recorded for later use.

Headers

Name
Type
Description

Content-Type*

application/json

Accept*

application/json

Request Body

Name
Type
Description

amount*

String

The application amount required from the customer.

api_key*

String

This is supplier specific and provided by BUMPER

success_url

String

currency

String

The three character ISO currency code

order_reference

String

The supplier reference

signature*

String

first_name*

String

The first name of the customer

last_name*

String

The last name of the customer

email*

String

The email of the customer

mobile*

String

The mobile number of the customer

flat_number*

String

The flat number section of the customer address

building_name*

String

The building name section of the customer address

building_number*

String

The building number section of the customer address

street

String

The street section of the customer address

town*

String

The town section of the customer address

county*

String

The county section of the customer address

country*

String

The country section of the customer address

postcode*

String

The postcode section part of the customer address

instalments

String

The number of instalments for the application. Values allowed are 3 or 4

product_description*

Array

The description of items paid by customer.

{

"item": "Tyre",

"quantity": "2",

"price": "150.00"

}

is_preapproval_link

String

Flag to indicate if the application needs to be created for a preapproval and the amount is not known

preapproval_token

String

Token to identify the customer if they have been preapproved. Should only be passed if customer already has a credit limit

send_email

Boolean

If true, Bumper sends a link to the customer via email to complete the application.

send_sms

Boolean

If true, Bumper sends a link to the customer via SMS to complete the application.

failure_url

String

vehicle_reg

String

The vehicle registration with which the application will be associated

preferred_product_type*

String

paylater

invoice_number

String

The supplier invoice number

user_email

String

Users email address can be assigned to application.

{
    "message": "Application created successfully",
    "data": {
        "token": "<token>",
        "redirect_url": "<url>"
    },
    "success": true,
    "additional_data": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
}

flat_number, building_name, or building_number are required

PreviousPayLaterNextExample Request

Last updated