Buy Order
This POST
endpoint is responsible for making a buy order and returns the checkout url and access token.
The buy order POST
api takes your publicKey
as a required parameter in the header and a body containing properties like the customer's email, phone number, customer deposit, receipt methods, etc. Unlike the standard buy endpoint, this will return additional properties like checkoutUrl
, and accessToken
which can be used to redirect your users and continue the order flow.
A boolean property called deferPaymentMethod
is added to the request body which can be set to true to delay providing your users' payment methods to initiate any of the order endpoints. It can also be set to false if you intend to provide the details and require a confirmation of the request immediately.
When deferPaymentMethod
is set to true, a call to Initiate Order Created With Deferred Payment Method should be made to complete the order initiation.
See the example below
Initiates a buy order
POST
https://checkout-api-sandbox.xendbridge.com/api/ThirdPartyUI/Buy/Initiate
Headers
Name | Type | Description |
---|---|---|
publicKey* | {publicKey} |
Request Body
Name | Type | Description |
---|---|---|
emailAddress* | annadoe@gmail.com | |
phoneNumber* | 07064366723 | |
userName* | annadoe | |
payInCurrencyCode* | NGN | |
payInCurrencyNetwork* | LOCAL | |
receiveInCurrencyCode* | BUSD | |
receiveInCurrencyNetwork* | BEP20 | |
orderAmount* | 50 | |
consumerDepositMethod* | Object | |
paymentMethod* | Bank | |
paymentData* | Object | |
accountName* | John Doe | |
accountNumber* | 0000187849 | |
bankName* | Access Bank | |
consumerReceiptMethod* | Object | |
paymentMethod* | Crypto | |
paymentData* | Object | |
walletAddress* | 0x52434Ac4BE04393e020c9b16C327d04d4367Cbcd | |
network* | BEP-20 | |
deferPaymentMethod* | bool | false |
If deferPaymentMethod
is set to true, you can provide the minimum payload below which starts the order initiation process and returns the checkoutUrl .
Parameters | Type | Definitions |
---|---|---|
emailAddress | string |
|
phoneNumber | string |
|
userName | string |
|
payInCurrencyCode | enum |
|
receiveInCurrencyCode | enum |
|
orderAmount | decimal |
|
consumerDepositMethod | object |
|
paymentMethod | enum |
|
paymentData | object |
|
accountName | string |
|
accountNumber | string |
|
bankName | string |
|
consumerReceiptMethod | object |
|
paymentData | object |
|
walletAddress | string |
|
network | string |
|
Last updated