API Explorer

Create Order

post
https://uat1.billdesk.com/u2/payments/ve1_2/orders/create

This API can be used to initiate a payment or to set up a mandate along with a payment in the BillDesk Hosted Payment Page or BillDesk Web SDK workflow

Body Params
string
required

Unique ID generated by the merchant for each request

string
required

Unique identifier as defined by BillDesk for each merchant

date-time
required

Merchant order generation date and time in YYYY-MM-DDThh:mm:ssTZD format

string
required

Transaction amount in two decimals, eg. 299.28

string
required

ISO currency code of the transaction amount, for INR this value will be 356

string
required

Merchants URL where the customer will be redirected after a transaction is completed

string
required

Itemcode value as provided by BillDesk, with a default value DIRECT

string

Settlement line of business preconfigured by BillDesk for funds settlement to merchant account

string
enum

Value which represents if the customer is to be givrn the option to not set a mandate on the BillDesk Hosted Payment Page or Web SDK. Applicable for the One time payment & Mandate workflow

Y- Represents that setting the Mandate is mandatory and the customer does not have an option to turn off the mandate

N- Represents that setting the Mandate is optional and the customer has an option to turn off the mandate. In this case, a one time payment will be made without the mandate

Allowed:
customer
object
avs
object

This API can be used to verify the bank account number by initiating a penny drop to the account. For upi, validation is done at acquiring bank end

device
object

Device

invoice
object
split_payment
object

This object is applicable in case a merchant has opted to receive the settlement in multiple settlement accounts

mandate
object
additional_info
object

Array of 7 additional_info values that can be attached to the transaction. Note: Merchant is advised to not pass customer PII information in additional info fields.

Headers
string
required

BD-TraceID is a unique identifier passed by the merchant to ensure request idempotency. Requests with identical BD-TraceID within a 24 hour window would fail.

string
required

Request timestamp to identify date and time of origin of request. Example, a value of BD-Timestamp 20210113180403 identifies the request to have originated on 13th January 2021 at 06:04:03 PM.

string
required

Request Content-Type to take the values application/jose

string
required

Accept Response Content-Type to take the values application/jose

Responses

Updated 6 months ago

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

Updated 6 months ago