Order Matched Notification

This sends a notification to the third-party application when an order is placed to be sold or bought by a customer. This is done using the POST method. See examples and descriptions below;

{
  "CheckSum": "E8A935C3BDE4E47938A01CA3C2166A6B256733CF2E91E1FDE0473F693999BADCCA5C30E9F0D8A7CF61CFEEC2FC58CFB3EAEFD2754D16BA0EB5314ACFF01A67CA",
  "Data": {
    "OrderReference": "XB_37a483f890dc4c1bb9f48524c41ad47b",
    "ReceiveInCurrencyCode": 6,
    "PayInCurrencyCode": 1,
    "ReceivableAmount": 0.44364937,
    "PayableAmount": 248,
    "ProviderName": "Nnadozie Ohaeri",
    "ProviderFirstName": "Nnadozie",
    "ProviderLastName": "Ohaeri",
    "ProviderEmail": "dozienna4@gmail.com",
    "InitiatedAt": "2022-02-08T13:02:42.1580578Z",
    "OrderExpiryDate": "2022-02-08T13:16:40.1541528Z",
    "InitiatedAtTimestamp": 1644325300154,
    "OrderExpiryTimestamp": 1644326200154,
    "FundedProviderAtTimeStamp": null,
    "FundedCustomerAtTimeStamp": null,
    "OrderCompletedAtTimeStamp": null,
    "P2POrderStatus": 3,
    "DisputeStatus": 1,
    "OrderType": 1,
    "ProviderContact": {
      "PhoneNumber": "2348062069869",
      "WhatsappNumber": "2348062069869"
    },
    "CustomerContact": {
      "Email": "JOHNDOEE@gmail.com",
      "Name": "John Doe",
      "PhoneNumber": "0706346XXXX"
    },
    "ProviderPaymentMethods": {
      "PaymentMethod": 1,
      "PaymentType": 1,
      "PaymentData": [
        {
          "BankName": "Access",
          "AccountNumber": "0069888440",
          "AccountName": "Ohaeri Nnadozie",
          "Currency": "NGN"
        }
      ],
      "OrderPaymentMethod": {
        "BankName": "Access",
        "AccountNumber": "0069888440",
        "AccountName": "Ohaeri Nnadozie",
        "Currency": "NGN"
      }
    },
    "ConsumerDepositMethod": {
      "PaymentMethod": 1,
      "PaymentType": 0,
      "PaymentData": {
        "BankName": "Access Bank",
        "AccountNumber": "0000187849",
        "AccountName": "Emmanuel Diala",
        "Currency": "NGN"
      }
    },
    "ConsumerReceiptMethod": {
      "PaymentMethod": 2,
      "PaymentType": 0,
      "PaymentData": {
        "WalletAddress": "QWEVDTWDGVT462E6EFYE9202Y239",
        "Network": "BEP20",
        "Currency": "BUSD"
      }
    },
    "ProviderTransactionMetadata": null
  }
}
KeyTypeDescription

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.

Last updated