| Parameters | Type | Definitions |
|---|---|---|
| payInCurrencyCode | string | Required The currency to be paid in. |
| payInCurrencyNetwork | string | Required The network of the currency to be paid in. |
| receiveInCurrencyCode | string | Required The currency to be received in. |
| receiveInCurrencyNetwork | string | Required The network of the currency to be receieved in. |
| orderAmount | string | Required The amount of the order. |
| Parameters | Type | Definitions |
|---|---|---|
| exchangeRate | decimal | This is the exchange rate at which an order could be exchanged for |
| maximumAmount | decimal | This is the maximum amount a customer can order. |
| minimumAmount | decimal | This is the minimum amount a customer can order. |
| providerRateReference | string | This is the reference of the rates of a provider. |
| rateValidityInSeconds | int | This is the validity of an order rate of a provider in seconds. |
| 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 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 |
|---|---|---|
| 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. |
| Parameter | 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, DisputeResolvedor CouldNotBeResolved. |
| orderType | enum | This is the status of the order, whether it's a Buy or Sell. |
| providerContact | object | This is holds props 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 props 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 props 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 props of the payment method in which the order is to be made to. |
| consumerDepositMethod | object | This holds the props of the consumer deposit details. |
| consumerrReceiptMethod | object | This holds the props 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 | obj | This holds the props of the transaction metadata of an order. |
| Parameter | 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, DisputeResolvedor CouldNotBeResolved. |
| orderType | enum | This is the status of the order, whether it's a Buy or Sell. |
| providerContact | object | This is holds props 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 props 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 props 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 props of the payment method in which the order is to be made to. |
| consumerDepositMethod | object | This holds the props of the consumer deposit details. |
| consumerrReceiptMethod | object | This holds the props 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 props of the transaction metadata of an order. |
| Parameter | Type | Definitions |
|---|---|---|
| emailAddress | string | Required This is the consumer's email address. |
| Parameters | Type | Definitions |
|---|---|---|
| orderStatus | enum | This the current status of an order when being placed. It can either be ProcessingRequest or Available. |
| orderResponse | object | This holds the orderReference objects and properties. |
| 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 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. |
| disputeReference | string | Required This is the reference value of a dispute on an order. |
| 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 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 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 | o | This holds the properties of the transaction metadata of an order. |
| Parameters | Type | Definitions |
|---|---|---|
| emailAddress | string | Required The email address of the third party client. |
| orderReference | string | Required The order reference of an order made. |
| transactionHash | string | Required The unique hash of a transaction on the blockchain network |
| Parameters | Type | Definitions |
|---|---|---|
| data | bool | This can either be true or false. |
| status | string | This returns a status message of the request. |
| message | string | This returns either Payment updated successfully if success, or Failed to update payment status. Please try again later if failed. |
| Parameters | Type | Definitions |
|---|---|---|
| emailAddress | string | Required The email address of the third party client. |
| orderReference | string | Required The order reference of an order made. |
| Parameters | Type | Definitions |
|---|---|---|
| data | bool | This can either be true or false. |
| status | string | This returns a status message of the request. |
| message | string | This returns an empty string if successful. |
| Parameters | Type | Definitions |
|---|---|---|
| orderReference | string | Required The order reference number made by the consumer. |
| paymentNetwork | string | Required The payment network on which the crypto payment was made on. |
| transactionalHash | string | Required The hash string that validates a particular order in the system. |
| Parameters | Type | Definitions |
|---|---|---|
| data | bool | This can either be true or false. |
| status | string | This returns a status message of the request. |
| message | string | This returns either P2P payment updated successfully if success, or Failed to update payment status. Please try again later if failed. |
| Parameters | Type | Definitions |
|---|---|---|
| emailAddress | string | Required The email address of the third party client. |
| orderReference | string | Required The order reference of an order made. |
| remark | string | Required This is a remark to be left by the consumer. |
| base64Attachment | string | This is a base64 converted string of an uploaded document. |
| Parameters | Type | Definitions |
|---|---|---|
| data | object | This holds the properties: IsSuccessful and reason. |
| isSuccessful | bool | This returns either true or false. |
| reason | string | This returns empty if successful. |
| status | string | The status of the request. |
| message | string | This returns empty if successful. |
| disputeReference | string | This is a unqiue reference of any dispute raised in the system. |
| Parameters | Type | Definitions |
|---|---|---|
| startDate | double | Required The date and time of the start of a dispute in milliseconds. |
| endDate | double | Required The end date and time of the end of dispute in milliseconds. |
| disputeStatus | enum | RequiredThe status of the dispute on an order. It could either be OpenDispute, DisputeBeingAttendedTo or DisputeResolved. |
| page | int | Required This is the number of a page with a specific page size of disputes. |
| pageSize | int | Required This is the number of the size of disputes on a page. |
| Parameters | Type | Definitions |
|---|---|---|
| data | object | This holds the properties; records, pageSize, currentPage, totalPages & totalRecords. |
| id | guid | This is the id of the record in the database. |
| attachmentUrl | string | This is any media url attachment posted in a dispute. |
| orderReference | string | The order reference of an order made. |
| orderId | guid | The guid of an order record in the database. |
| orderDate | long | The date and time when that order was made in milliseconds. |
| disputeRaisedAt | long | The date and time the dispute was raised at in milliseconds. |
| disputeLastUpdatedAt | long | The last date and time update on a dispute in milliseconds |
| disputeStatus | enum | The status of the dispute on an order. It could either be OpenDispute, DisputeBeingAttendedTo or DisputeResolved. |
| disputeRaisedBy | enum | This is the entity who raised the dispute. |
| disputeRemark | string | This is the remark on a dispute by any participant. |
| disputeComment | string | This is the comment by the consumer of the dispute. |
| payinCurrency | enum | This is the currency in which the order is paid in. |
| recieveInCurrency | enum | This is the currency in which the order is received in. |
| payInAmount | decimal | This is the amount of the order to be paid to. |
| receiveInAmount | decimal | This is the amount of the order to be received in. |
| clientPaymentMethod | enum | This is the customer's payment method. |
| thirdPartyAppName | string | This is the Third party app integrated with XendBridge. |
| providerName | string | This is the name of the provider. |
| providerEmail | string | This is the email address of the provider. |
| providerPhone | string | This is the provider's phone number. |
| customerName | string | This is the customer's name. |
| customerEmail | string | This is the customer's email. |
| customerPhone | string | This is the customer's phone number. |
| disputeChats | array | This is holds the objects of the different chats in a dispute |
| id | guid | The id of the chat record in the database. |
| receivedAt | DateTime | This is the date the chat message was received. |
| receivedAtTimeStamp | double | This is the time date the chat message was received at in milliseconds. |
| sentBy | enum | This is the participant who sent the message. |
| sentTo | enum | This is the participant who the message is being sent to. |
| senderName | string | This is the participant's name who sent the message. |
| message | string | This the content of the message sent. |
| pageSize | int | This is the number of disputes chats in a page. |
| currentPage | int | This is the current page number. |
| totalPages | int | This is the total number of pages of the disputes for a third party app. |
| totalRecords | int | This is the total number of records of the disputes in third party app. |
| status | string | This is the status of the request. |
| message | string | This returns empty if no errors occurs. |
| Key | Type | Description |
|---|---|---|
CheckSum | string | This is a hash property signed with the merchant secretkey. |
Data | object | This holds the properties of the payload data details. |
CustomerEmailAddress | string | This is the customer's email address. |
LiquidityProviderName | string | This is the name of the liquidity provider. |
OrderDetails | object | This is an object that holds the properties of the order details. |
PayInCurrency | enum | This is the symbol of a particular currency used in paying for an order. Values range from NGN = 1, USD = 2, BUSD = 6& XEND = 9. |
RecieveInCurrency | enum | This is the symbol of a particular currency used in receiving. Values range from NGN = 1, USD = 2, BUSD = 6& XEND = 9. |
AmountPaidByCustomer | decimal | This is the amount paid by the customer. |
AmountPaidToCustomer | decimal | This is the amount paid to the customer. |
OrderReference | string | This is the reference value of an order. |
OrderType | enum | This is the type of order made. It can either be a Buy or Sell. |
OrderStatus | enum | This is the status of an order at a particular time. It can either be Submitted = 1, Canceled = 2, Acknowledge = 3, FundedProvider = 4, FundRecievedFromUser = 5, FundedUser = 6, Completed = 7 or OrderTimeOut = 8. |
OrderDisputeStatus | enum | This is the dispute status of an order. It can either be NoDispute, DisputeRaisedbyCustomer, DisputeRaisedByProvider, DisputeRaisedByBothParties , DisputeResolved or CouldNotResolve. |
PaidBy | enum | This is the entity by which the order is paid by. It could be the Customer = 1 or Provider = 2. |
PaymentMethod | enum | This is the payment method which is used in transacting. It can be Bank = 1 or Crypto = 2. |
PaymentDate | double | This is the date by which the payment was made in milliseconds. |
RecepientAccountDetails | object | This holds the properties of the recepient's account details. |
WalletAddress | string | This is the wallet address of the customer. |
Network | string | This is the cryptocurrency network name. |
Currency | string | This is the currency the order was transacted with. |
TransactionMetaData | object | This is an object that holds the metadata of the transaction. |
CryptoPaymentNetwork | string | This is the cryptocurrency network which was paid with. |
CryptoTransactionHash | string | This is the security hash of a particular transaction in the network. |
TransactionVerificationUrl | string | is is the url of the transaction. It's nullable. |
| Key | Type | Description |
|---|---|---|
Checksum | string | This is a hash property signed with the merchant secretkey. |
Data | object | This holds the properties of the payload data details. |
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 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. |
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, 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 props 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. It can be null. |
| Key | Type | Description |
|---|---|---|
Checksum | string | This is a hash property signed with the merchant secretkey. |
Data | object | This holds the properties of the payload data details. |
OrderId | guid | This is the order id in the database. |
OrderReference | string | This is the reference of the order in the database. |
OrderStatus | enum | This is the status of an order at a particular time. It can be Submitted = 1, Cancelled = 2, Acknowledged = 3, FundedProvider = 4, FundReceivedFromUser = 5, FundedUser = 6 or Completed = 7. |
| Key | Type | Description |
|---|---|---|
| orderReference | string | Required The order reference number made by the consumer. |
| webHookType | string | Required The type of event triggered of the order. It can be orderMatched , LPPayment & orderCanceled. |
| Key | Type | Description |
|---|---|---|
checkSum | string | The algorithmic validation of our system to the third party application about an order. |
| 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 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 |
|---|---|---|
| checkoutReference | string | This is the reference to the checkout order. |
| orderReference | string | This the reference to a particular order. |
| checkoutUrl | string | This is the url created from the request and can be used to contiue |
| accessToken | string | |
| 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. |
| Parameter | Type | Definitions |
|---|---|---|
| checkoutReference | string | This is the reference to the checkout order. |
| orderReference | string | This is the reference to a particular order. |
| checkoutUrl | string | This is the url link used to access and complete an order |
| accessToken | string | This is the token generated for the order to be used to access the portal |
| 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 props 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 props 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 props 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 props of the payment method in which the order is to be made to. |
| consumerDepositMethod | object | This holds the props of the consumer deposit details. |
| consumerrReceiptMethod | object | This holds the props 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 props of the transaction metadata of an order. |
| Parameter | Type | Definitions |
|---|---|---|
| checkoutReference | string | This is the refernce to the checkout 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 props 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 props 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 props 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 props of the payment method in which the order is to be made to. |
| consumerDepositMethod | object | This holds the props of the consumer deposit details. |
| consumerrReceiptMethod | object | This holds the props 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 props of the transaction metadata of an order. |
| Parameters | Type | Definitions |
|---|---|---|
| payInCurrencyCode | string | Required The currency to be paid in. |
| payInCurrencyNetwork | string | Required The network of the currency to be paid in |
| receiveInCurrencyCode | string | Required The currency to be received in. |
| receiveInCurrencyNetwork | string | Required The network of the currency to be received in |
| orderAmount | double | Required The amount of the order. |
| Parameters | Type | Definitions |
|---|---|---|
| exchangeRate | decimal | This is the exchange rate at which an order could be exchanged for |
| maximumAmount | decimal | This is the maximum amount a customer can order. |
| minimumAmount | decimal | This is the minimum amount a customer can order. |
| providerRateReference | string | This is the reference of the rates of a provider. |
| rateValidityInSeconds | int | This is the validity of an order rate of a provider in seconds. |
| Parameters | Type | Definitions |
|---|---|---|
| payInCurrencyCode | string | Required The currency to be paid in. |
| payInCurrencyNetwork | string | Required The network of the currency to be paid in |
| receiveInCurrencyCode | string | Required The currency to be received in. |
| receiveInCurrencyNetwork | string | Required The network of the currency to be received in |
| orderAmount | double | Required The amount of the order. |
| Parameters | Type | Definitions |
|---|---|---|
| exchangeRate | decimal | This is the exchange rate at which an order could be exchanged for |
| maximumAmount | decimal | This is the maximum amount a customer can order. |
| minimumAmount | decimal | This is the minimum amount a customer can order. |
| providerRateReference | string | This is the reference of the rates of a provider. |
| rateValidityInSeconds | int | This is the validity of an order rate of a provider in seconds.Rate Bounds |
"XendBridgeSDKConfig": {
"BaseUrl": "https://canary.xendbridge.com",
"PublicKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXX",
"SecretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
| Status Code | Meaning |
|---|---|
| 200, 201, 204 | Everything works as expected. API request was successful |
| 400 | Bad request. Review the data sent in the request. Usually, this means a required piece of information is missing |
| 401 | Unauthorized. This happens when you provide an invalid or non-existent API key |
| 404 | Resource not found. This could happen when you try to retrieve an item with a non-existent ID |
| 403 | Not enough permission to perform this operation |
| 5XX | Something went wrong on XendBridge end. Doesn't happen often :) |