Order Payment Confirmation

This sends a notification to the third-party application with a payload of the details of an acknowledged receipt of funds either from the third-party user to the provider or vice-versa using the POST endpoint you provide. See an example and its payload properties meanings below.

{
  "CheckSum": "E94077842C4080E431CAFCF8D213DE333D604B1032772647C17F56692ECB165DF4C0F72A0E098137C7188D0723483380757FB1F8E16280E7F02B88CF4354F112",
  "Data": {
    "CustomerEmailAddress": "JOHNDOEE@gmail.com",
    "LiquidityProviderName": "Nnadozie Ohaeri",
    "OrderDetails": {
      "PayInCurrency": 1,
      "ReceiveInCurrency": 6,
      "AmountPaidByCustomer": 6969,
      "AmountPaidToCustomer": 12.46690519,
      "OrderReference": "XB_f303e68cf02d4683bb281671796f9fb4",
      "OrderType": 1,
      "OrderStatus": 6,
      "DisputeStatus": 1
    },
    "PaidBy": 2,
    "PaymentMethod": 2,
    "PaymentDate": 1644321238268.8464,
    "RecepientAccountDetails": {
      "WalletAddress": "0x30b7D85f7CF498D556a9448243a7994bc4660790",
      "Network": "BEP20",
      "Currency": "BUSD"
    },
    "TransactionMetaData": {
      "CryptoPaymentNetwork": "BEP20",
      "CryptoTransactionHash": "0x875bc17de7f0c46b593e1c414d579f8e95ddb278f82df0c43392a7f445808a6e",
      "TransactionVerificationUrl": 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.

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.

Last updated