API Reference

post

post
https://api-sandbox.caddipay.com/v1/create-instore

Prepares a new in-store order flow and sends an SMS to the customer with a unique link to complete payment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

❗️

BETA API

This is a BETA API not available to all merchants. Please speak to your Caddipay account manager before beginning an integration.

Body Params
string
required

A unique reference for this order in your POS which will be included in the confirmation postback

double
required

The total USD value of all items in the order, excluding tax and shipping

double
required
double
required
customer
object
required
billingAddress
object
cartItems
array of objects
cartItems
string
required

The webhook URL which will receive a POST upon payment confirmation
For security, we recommend you add a unique ?nonce= or other parameter to the URL
If provided to us, you should then validate this parameter is the same in our postback to your system

Response

Updated over 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago