Bumper API Documentation
  • BUMPER API Documentation
  • Reference
    • Payment Solutions
      • PayByLink
        • PayLater
          • Start Payment
            • Example Request
          • Products
          • Status
          • Update
            • Example Request
          • Cancel
            • Example Request
        • PayNow
          • Start Payment
            • Example Request
          • Status
          • Update
            • Example Request
          • Cancel
            • Example Request
          • Refund
            • Example Request
      • PayInStore
        • Start Payment
          • Example Request
        • Status
        • Update
          • Example Request
        • Cancel
          • Example Request
        • Refund
          • Example Request
  • Webhooks
  • Authentication
  • Redirect Flow
  • Redirection
  • Tracking & Impressions
  • Test Environment
  • Best Practice
  • Calculator iFrame
  • FAQ
  • Changelog
Powered by GitBook
On this page
  1. Reference
  2. Payment Solutions
  3. PayInStore

Start Payment

POST {{base_url}}/v2/apply/

Creates a payment request in the payment list for site to select on PayPad. A successful request will return a token. The token should be recorded for later use.

Headers

Name
Type
Description

Content-Type*

application/json

Accept*

application/json

Request Body

Name
Type
Description

amount*

String

The payment amount required from the customer.

api_key*

String

This is supplier specific and provided by BUMPER

currency

String

The three character ISO currency code

order_reference

String

The supplier reference

signature*

String

product_description*

Array

The description of items paid by customer.

{

"item": "Tyre",

"quantity": "2",

"price": "150.00"

}

preferred_product_type*

String

paypad

invoice_number

String

The supplier invoice number

user_email

String

Users email address can be assigned to payment.

{
    "message": "Payment created successfully",
    "data": {
        "token": "<token>",
        "redirect_url": "<url>"
    },
    "success": true,
    "additional_data": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
}
{
    "success": false,
    "message": "Signature provided is Invalid"
}
{
    "success": false,
    "message": "[key] not provided"
}

flat_number, building_name, or building_number are required

PreviousPayInStoreNextExample Request

Last updated 5 months ago

created through all the parameters of this request body

Hash