Pending Order
Get Pending Order
This GET
endpoint gets a pending order of a third party customer. The publicKey
is passed in the header while only an emailAddress
is passed as a param. See the example below;
Get pending order
GET
https://canary.xendbridge.com/api/PeerToPeerOrder/ThirdParty/PendingOrder?emailAddress=annadoe@gmail.com
Query Parameters
Name | Type | Description |
---|---|---|
emailAddress* | johndoe@gmail.com |
Headers
Name | Type | Description |
---|---|---|
secretKey* | {secretKey} |
{
"data": {
"orderStatus": "ProcessingRequest",
"orderResponse": {
"orderReference": "XB_91ee6ac1b2204022b07b5c17bddc2a35",
"receiveInCurrencyCode": "BUSD",
"payInCurrencyCode": "NGN",
"receivableAmount": 0.1234347,
"payableAmount": 69,
"providerName": "Nnadozie Ohaeri",
"providerFirstName": "Nnadozie",
"providerLastName": "Ohaeri",
"providerEmail": "dozienna4@gmail.com",
"initiatedAt": "2022-02-07T09:59:03.1476901",
"orderExpiryDate": "2022-02-07T10:14:03.1476901",
"initiatedAtTimestamp": 1644227943147,
"orderExpiryTimestamp": 1644228843147,
"fundedProviderAtTimeStamp": 1644230393293,
"fundedCustomerAtTimeStamp": 1644230684456,
"orderCompletedAtTimeStamp": null,
"p2POrderStatus": "FundedUser",
"disputeStatus": "NoDispute",
"disputeReference": "",
"orderType": "Buy",
"providerContact": {
"phoneNumber": "2348062069869",
"whatsappNumber": "2348062069869"
},
"customerContact": {
"email": "JOHNDOE@gmail.com",
"name": "John Doe",
"phoneNumber": "0706346XXXX"
},
"providerPaymentMethods": {
"paymentMethod": "Bank",
"paymentType": "Bank",
"paymentData": [
{
"bankName": "Access",
"accountNumber": "0069888440",
"accountName": "Ohaeri Nnadozie",
"currency": "NGN"
}
],
"orderPaymentMethod": {
"bankName": "Access",
"accountNumber": "0069888440",
"accountName": "Ohaeri Nnadozie",
"currency": "NGN"
}
},
"consumerDepositMethod": {
"paymentMethod": "Bank",
"paymentType": 0,
"paymentData": {
"bankName": "Access Bank",
"accountNumber": "0000187849",
"accountName": "Emmanuel Diala",
"currency": "NGN"
}
},
"consumerReceiptMethod": {
"paymentMethod": "Crypto",
"paymentType": 0,
"paymentData": {
"walletAddress": "QWEVDTWDGVT462E6EFYE9202Y239",
"network": "BEP20",
"currency": "BUSD"
}
},
"providerTransactionMetadata": {
"cryptoPaymentNetwork": "BEP20",
"cryptoTransactionHash": "0xe1577054fcca2dee00081fdd30757aa3c9895da806e26620a62a65cdc2cca375",
"transactionVerificationUrl": "https://testnet.bscscan.com/tx0xe1577054fcca2dee00081fdd30757aa3c9895da806e26620a62a65cdc2cca375"
}
}
},
"status": "OK",
"message": ""
}
Parameter | Type | Definitions |
---|---|---|
emailAddress | string |
|
Parameters | Type | Definitions |
---|---|---|
orderStatus | enum | This the current status of an order when being placed. It can either be |
orderResponse | object | This holds the |
orderReference | string | This the reference to a particular order. |
recieveInCurrencyCode | 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 |
disputeStatus | enum | The status of the dispute on an order. It could either be |
disputeReference | string |
|
orderType | enum | This is the status of the order, whether it's a |
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 properties 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 |
paymentType | enum | This is the type of payment. It could be |
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 |
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 | o | This holds the properties of the transaction metadata of an order. |
Get Pending Order By Reference
This GET
endpoint gets a pending order of a third party customer. The publicKey
is passed in the header while the orderReference
is passed as a param. See the example below;
Get pending order by reference
GET
https://canary.xendbridge.com/api/PeerToPeerOrder/ThirdParty/Order/Reference
Query Parameters
Name | Type | Description |
---|---|---|
orderReference* | string | XB_e1315fb1c9fd419998046ab96062361c |
Headers
Name | Type | Description |
---|---|---|
secretKey* | {secretKey} |
{
"data": {
"appId": "a490997c-a816-40b1-0d4c-08d9667359ad",
"appName": "Xend Finance",
"clientContact": {
"phoneNumber": "07064366723",
"name": "johnfoe",
"emailAddress": "johnfoe@gmail.com"
},
"orderDetail": {
"orderReference": "XB_e1315fb1c9fd419998046ab96062361c",
"thirdPartyAppName": "Xend Finance",
"disputeReference": null,
"orderType": "Buy",
"orderStatus": "Acknowledged",
"disputeStatus": "NoDispute",
"receiveInCurrencyCode": "USDC",
"payInCurrencyCode": "NGN",
"receiveInCurrencyNetwork": "BEP20",
"payInCurrencyNetwork": "LOCAL",
"receivableAmount": 0.11904762,
"receivableAmountWithoutMarkup": 0.11904762,
"payableAmount": 50,
"rate": 420,
"initiatedAt": "2022-08-24T14:49:51.0699807",
"orderExpiryDate": "2022-08-24T14:54:51.0699807",
"initiatedAtTimestamp": 1661352591069,
"orderExpiryTimestamp": 1661352891069,
"fundedProviderAtTimeStamp": null,
"fundedCustomerAtTimeStamp": null,
"estimatedOrderCompletionTimestamp": null,
"orderCompletedAtTimeStamp": null,
"markupDetail": null
},
"providerContact": {
"phoneNumber": "2348181186644",
"whatsappNumber": "",
"name": "John Doe",
"emailAddress": "owolabidamilola98@gmail.com",
"providerReference": "DFDFE062107A43E88B602DA14607A8A3"
},
"clientPaymentMethod": "Bank",
"liquidityProviderPaymentOption": {
"paymentMethod": "Bank",
"paymentType": 0,
"paymentData": [
{
"bankName": "Access",
"accountNumber": "0709876786",
"accountName": "John Doe",
"address": null,
"swiftCode": null,
"iban": null,
"sortCode": null,
"currency": "NGN",
"network": "LOCAL"
}
],
"orderPaymentMethod": {
"bankName": "Access",
"accountNumber": "0709876786",
"accountName": "John Doe",
"address": null,
"swiftCode": null,
"iban": null,
"sortCode": null,
"currency": "NGN",
"network": "LOCAL"
}
},
"clientDepositPaymentOption": {
"paymentMethod": "Bank",
"paymentType": 0,
"paymentData": {
"bankName": "Access Bank",
"accountNumber": "0000187849",
"accountName": "Emmanuel Diala",
"address": null,
"swiftCode": null,
"iban": null,
"sortCode": null,
"currency": "NGN",
"network": "LOCAL"
}
},
"clientReceiptPaymentOption": {
"paymentMethod": "Crypto",
"paymentType": 0,
"paymentData": {
"walletAddress": "0x30b7D85f7CF498D556a9448243a7994bc4660790",
"network": "BEP20",
"currency": "USDC"
}
},
"liquidityProviderTransactionMetadata": null,
"customerTransactionMetadata": null
},
"status": "OK",
"message": ""
}
Last updated