Buy Order

Initiate Buy Order

The buy order POST api takes your secretKey as a required parameter which should be in your environment variables as it verifies the integrity of your third-party application.

You will send a POST request containing properties like the customer's email, phone number, customer deposit and receipt methods, etc. See example below

Initates a buy order

POST https://canary.xendbridge.com/api/peertopeerorder/buy/initiate

Headers

Name	Type	Description
secretKey*	string	{your_secretKey}

Name

Type

Description

secretKey*

string

{your_secretKey}

Request Body

Name	Type	Description
email*	string	annadoe@gmail.com
phoneNumber	string	07012345678
userName	string	annadoe
payInCurrencyCode*	string	NGN
payInCurrencyNetwork*	string	LOCAL
receieveInCurrencyCode*	string	BUSD
receieveInCurrencyNetwork*	string	BEP20
orderAmount*	decimal	50
consumerDepositMethod	object
paymentMethod*	string	Bank
paymentData	object
accountName*	string	John Doe
accountNumber*	string	0000187454
bankName*	string	Access Bank
consumerReceiptMethod	object
paymentMethod*	string	Crypto
paymentData	object
walletAddress*	String	0x52434Ac4BE04393e020c9b16C327d04d4367Cbcd
network*	string	BEP-20

Name

Type

Description

email*

string

annadoe@gmail.com

phoneNumber

string

07012345678

userName

string

annadoe

payInCurrencyCode*

string

NGN

payInCurrencyNetwork*

string

LOCAL

receieveInCurrencyCode*

string

BUSD

receieveInCurrencyNetwork*

string

BEP20

orderAmount*

decimal

consumerDepositMethod

object

paymentMethod*

string

Bank

paymentData

object

accountName*

string

John Doe

accountNumber*

string

0000187454

bankName*

string

Access Bank

consumerReceiptMethod

object

paymentMethod*

string

Crypto

paymentData

object

walletAddress*

String

0x52434Ac4BE04393e020c9b16C327d04d4367Cbcd

network*

string

BEP-20

{
    "data": {
        "orderReference": "XB_0877e5692ee946f491bafab275d3d522",
        "receiveInCurrencyCode": "BUSD",
        "payInCurrencyCode": "NGN",
        "receivableAmount": 0.11988108,
        "payableAmount": 50,
        "receivableAmountWithoutMarkup": 0,
        "providerName": "John Doe",
        "providerFirstName": "John",
        "providerLastName": "Doe",
        "providerEmail": "owolabidamilola98@gmail.com",
        "initiatedAt": "2022-05-06T10:56:29.8070515Z",
        "orderExpiryDate": "2022-05-06T11:11:26.3811357Z",
        "initiatedAtTimestamp": 1651834586381,
        "orderExpiryTimestamp": 1651835486381,
        "fundedProviderAtTimeStamp": null,
        "fundedCustomerAtTimeStamp": null,
        "orderCompletedAtTimeStamp": null,
        "p2POrderStatus": "Acknowledged",
        "disputeStatus": "NoDispute",
        "disputeReference": null,
        "orderType": "Buy",
        "providerContact": {
            "phoneNumber": "2348181186644",
            "whatsappNumber": ""
        },
        "customerContact": {
            "email": "annadoe@gmail.com",
            "name": "annadoe",
            "phoneNumber": "07064366723"
        },
        "providerPaymentMethods": {
            "paymentMethod": "Bank",
            "paymentType": "Bank",
            "paymentData": [
                {
                    "bankName": "Access",
                    "accountNumber": "0709876786",
                    "accountName": "John Doe",
                    "currency": "NGN",
                    "network": "LOCAL"
                }
            ],
            "orderPaymentMethod": {
                "bankName": "Access",
                "accountNumber": "0709876786",
                "accountName": "John Doe",
                "currency": "NGN",
                "network": "LOCAL"
            }
        },
        "consumerDepositMethod": {
            "paymentMethod": "Bank",
            "paymentType": 0,
            "paymentData": {
                "bankName": "Access Bank",
                "accountNumber": "0000187849",
                "accountName": "Emmanuel Diala",
                "currency": "NGN",
                "network": "LOCAL"
            }
        },
        "consumerReceiptMethod": {
            "paymentMethod": "Crypto",
            "paymentType": 0,
            "paymentData": {
                "walletAddress": "0x52434Ac4BE04393e020c9b16C327d04d4367Cbcd",
                "network": "BEP20",
                "currency": "BUSD"
            }
        },
        "providerTransactionMetadata": null
    },
    "status": "OK",
    "message": ""
}

{
    "Status": 2,
    "Message": "You Have A Pending Buy Order",
    "Data": null
}

JSON Request Format

{
  "emailAddress": "annadoe@gmail.com",
  "phoneNumber": "07064366723",
  "userName": "annadoe",
  "payInCurrencyCode": "NGN",
  "payInCurrencyNetwork": "LOCAL",
  "receiveInCurrencyCode": "BUSD",
  "receiveInCurrencyNetwork": "BEP20",
  "orderAmount": 50,
  "consumerDepositMethod": {
    "paymentMethod": "Bank",
    "paymentData": {
      "accountName": "Anna doe",
      "accountNumber": "0000187849",
      "bankName": "Access Bank"
    }
  },
  "consumerReceiptMethod": {
    "paymentMethod": "Crypto",
    "paymentData": {
      "walletAddress": "0x52434Ac4BE04393e020c9b16C327d04d4367Cbcd",
      "network": "BEP20"
    }
  }
}

Parameters Type Definitions

Parameters	Type	Definitions
emailAddress	string	`Required` This is the consumer's email address.
phoneNumber	string	`Required` This is the consumer's phone number.
userName	string	`Required` This is the consumer's username
payInCurrencyCode	enum	`Required` This is the currency code to pay with. Must be `NGN` for buy order.
receiveInCurrencyCode	enum	`Required` This is the currency code to receive the currency in. Must be `BUSD` for buy order.
orderAmount	decimal	`Required` The order amount by the consumer.
consumerDepositMethod	object	`Required` This holds the properties of the deposit method of the consumer which is are the bank details.
paymentMethod	enum	`Required` The payment method by which transactions are made. It should be `BANK`for buy order.
paymentData	object	`Required` This holds the properties of the bank details of the consumer.
accountName	string	`Required` This is the account name of the consumer.
accountNumber	string	`Required` The local account number of the consumer
bankName	string	`Required` This is the bank name of the consumer.
consumerReceiptMethod	object	`Required` This holds the properties of the consumer receiving method. The `paymentMethod` prop must be `Crypto` .
paymentData	object	`Required` This holds the properties of the consumer receiving account details.
walletAddress	string	`Required` The crypto wallet address of the consumer.
network	string	`Required` This is the network on which the address is on.

emailAddress

string

Required This is the consumer's email address.

phoneNumber

string

Required This is the consumer's phone number.

userName

string

Required This is the consumer's username

payInCurrencyCode

enum

Required This is the currency code to pay with. Must be NGN for buy order.

receiveInCurrencyCode

enum

Required This is the currency code to receive the currency in. Must be BUSD for buy order.

orderAmount

decimal

Required The order amount by the consumer.

consumerDepositMethod

object

Required This holds the properties of the deposit method of the consumer which is are the bank details.

paymentMethod

enum

Required The payment method by which transactions are made. It should be BANKfor buy order.

paymentData

object

Required This holds the properties of the bank details of the consumer.

accountName

string

Required This is the account name of the consumer.

accountNumber

string

Required The local account number of the consumer

bankName

string

Required This is the bank name of the consumer.

consumerReceiptMethod

object

Required This holds the properties of the consumer receiving method. The paymentMethod prop must be Crypto .

paymentData

object

Required This holds the properties of the consumer receiving account details.

walletAddress

string

Required The crypto wallet address of the consumer.

network

string

Required This is the network on which the address is on.

Parameters Type Definitions

Parameters	Type	Definitions
orderReference	string	This the reference to a particular order.
receiveInCurrencyCode	enum	This is the currency code to receive the currency in.
payInCurrencyCode	enum	This is the currency code to pay with.
receivableAmount	decimal	This the receivable amount of the currency.
payableAmount	decimal	This is the payable amount of the currency.
providerName	string	This the provider's name.
providerFirstName	string	This is the provider's first name.
providerLastName	string	This is the provider's last name.
providerEmail	string	This is the provider's email address.
initiatedAt	DateTime	The date time the order was made.
orderExpiryDate	DateTime	The expiry date time of the order.
initiatedAtTimestamp	long	The time in milliseconds an order was made
orderExpiryTimestamp	long	The time in milliseconds of when thee order will expire.
fundedProviderAtTimeStamp	long	The time of when a customer indicates payment for an order in milliseconds.
fundedCustomerAtTimeStamp	long	The time of when a provider indicates payment of order to the customer in milliseconds
orderCompletedAtTimeStamp	long	The time in milliseconds an order was completed.
p2POrderStatus	enum	The status of the order at the curent time. It could be `Submitted`, `Cancelled`, `Acknowledged`, `FundedProvider`, `FundReceivedFromUser`, `FundedUser`, `Completed`, `OrderTimedOut`
disputeStatus	enum	The status of the dispute on an order. It could either be `NoDispute`, `DisputeRaisedByCustomer`, `DisputeRaisedByProvider`, `DisputeRaisedByBothParties`, `DisputeResolved`or `CouldNotBeResolved`.
orderType	enum	This is the status of the order, whether it's a `Buy` or `Sell`.
providerContact	object	This is holds properties of a provider's contact information.
phoneNumber	string	The phone number of either the provider or customer.
whatsappNumber	string	The whatsapp number of either the provider or customer.
customerContact	object	This holds the props of the contact information.
email	string	This is an email address of the customer.
name	string	This is the name of the customer.
phoneNumber	string	The phone number of the customer
providerPaymentMethods	object	This holds the properties of the payment methods of the provider.
paymentMethod	enum	This is the method of payment. It could be `Bank` or `Crypto`
paymentType	enum	This is the type of payment. It could be `Bank`, `Crypto`, `UserName`or `MobileMoney`.
paymentData	object	This holds the properties of the payment method.
bankName	string	The bank name of the the provider or customer.
accountNumber	string	The bank account number of the provider or customer.
accountName	string	The bank account name of the provider or customer.
currency	enum	The currency in which the order was made. It could be `BUSD` or `NGN`.
orderPaymentMethod	object	This holds properties of the payment method in which the order is to be made to.
consumerDepositMethod	object	This holds the properties of the consumer deposit details.
consumerrReceiptMethod	object	This holds the properties of the consumer receiving method details.
walletAddress	string	This is the crypto wallet address of the consumer.
network	enum	This is the network currently supported in the system which the wallet address is based on.
providerTransactionMetadata	object	This holds the properties of the transaction metadata of an order.

orderReference

string

This the reference to a particular order.

receiveInCurrencyCode

enum

This is the currency code to receive the currency in.

payInCurrencyCode

enum

This is the currency code to pay with.

receivableAmount

decimal

This the receivable amount of the currency.

payableAmount

decimal

This is the payable amount of the currency.

providerName

string

This the provider's name.

providerFirstName

string

This is the provider's first name.

providerLastName

string

This is the provider's last name.

providerEmail

string

This is the provider's email address.

initiatedAt

DateTime

The date time the order was made.

orderExpiryDate

DateTime

The expiry date time of the order.

initiatedAtTimestamp

long

The time in milliseconds an order was made

orderExpiryTimestamp

long

The time in milliseconds of when thee order will expire.

fundedProviderAtTimeStamp

long

The time of when a customer indicates payment for an order in milliseconds.

fundedCustomerAtTimeStamp

long

The time of when a provider indicates payment of order to the customer in milliseconds

orderCompletedAtTimeStamp

long

The time in milliseconds an order was completed.

p2POrderStatus

enum

The status of the order at the curent time. It could be Submitted, Cancelled, Acknowledged, FundedProvider, FundReceivedFromUser, FundedUser, Completed, OrderTimedOut

disputeStatus

enum

The status of the dispute on an order. It could either be NoDispute, DisputeRaisedByCustomer, DisputeRaisedByProvider, DisputeRaisedByBothParties, DisputeResolvedor CouldNotBeResolved.

orderType

enum

This is the status of the order, whether it's a Buy or Sell.

providerContact

object

This is holds properties of a provider's contact information.

phoneNumber

string

The phone number of either the provider or customer.

whatsappNumber

string

The whatsapp number of either the provider or customer.

customerContact

object

This holds the props of the contact information.

string

This is an email address of the customer.

name

string

This is the name of the customer.

phoneNumber

string

The phone number of the customer

providerPaymentMethods

object

This holds the properties of the payment methods of the provider.

paymentMethod

enum

This is the method of payment. It could be Bank or Crypto

paymentType

enum

This is the type of payment. It could be Bank, Crypto, UserNameor MobileMoney.

paymentData

object

This holds the properties of the payment method.

bankName

string

The bank name of the the provider or customer.

accountNumber

string

The bank account number of the provider or customer.

accountName

string

The bank account name of the provider or customer.

currency

enum

The currency in which the order was made. It could be BUSD or NGN.

orderPaymentMethod

object

This holds properties of the payment method in which the order is to be made to.

consumerDepositMethod

object

This holds the properties of the consumer deposit details.

consumerrReceiptMethod

object

This holds the properties of the consumer receiving method details.

walletAddress

string

This is the crypto wallet address of the consumer.

network

enum

This is the network currently supported in the system which the wallet address is based on.

providerTransactionMetadata

object

This holds the properties of the transaction metadata of an order.

PreviousRate NextSell Order

Last updated 1 year ago