Transaction Model
Field | Type | Description | Nullable |
---|---|---|---|
id | Integer | A unique identifier for transaction | false |
uid | Integer | A unique Identifier for transaction | false |
businessId | Integer | Unique identifier for business associated with transaction | false |
request | String | Request sent to customer | false |
msisdn | String(Digits) | Phone number of customer to whom request is sent | false |
amount | String(Double) | Amount requested by merchant | false |
requestamount | String(Double) | Total amount requested from customer | false |
refid | String | Unique reference identifier for interacting with transaction | false |
vendref | String | Internal reference identifier | True |
debitref | String | Internal debit reference identifier | True |
reason | String | Reason for failure of transaction | True |
raw_reason | String | Internal reason for failure of transaction | True |
channel | String | Channel on which transaction is processed | False |
page | String | Current page/stage of transaction with customer | True |
currency | String | 3 letters ISO currency code in which transaction is processed | false |
method | Enum(String) | Payment checkout channel where transaction is processed; 'ussd' or 'whatsapp' | false |
delivered | Integer | Flag is "1" when request is successfully delivered to customer | false |
vended | Integer | Internal flag | false |
reversed | Integer | Flag is "1" when transaction is successfully reversed | false |
debited | Integer | Flag is "1" when customer is successfully debited | false |
debited_date | Date(String) | Date customer is debited for transaction | True |
failed | Integer | Flag is "1" if transaction fails, flag is "0" if transaction is successful | false |
isreversing | Integer | Flag is "1" if transaction is currently reversing | false |
processing | Integer | Flag is "1" when transaction is processing | false |
flag | Integer | Internal flag | false |
delivered_date | Date(String) | Date transaction is delivered to customer | True |
reversed_date | Date(String) | Date transaction is reversed, if reversed | True |
meta | JSON | Extra data on transaction | true |
walletId | Integer | Unique identifier for sales wallet where funds from transaction is paid into | false |
commissionWallet | Integer | Unique identifier for commission wallet where commissions from transaction is paid into | false |
staffId | Integer | Internal unique identifier | true |
created_on | Date(String) | Date of creation of transaction | false |
updated_on | Date(String) | Most recent date of update on transaction | false |
deletedAt | Date(String) | Date of deletion of transaction | true |
Sample Business Model response
{
"id": 605511755,
"uid": 60,
"businessId": 52,
"request": "",
"msisdn": "254708980456",
"amount": "100.0000",
"requestamount": "100.0000",
"refid": "8818794595836821394",
"vendref": null,
"debitref": "47785833",
"reason": null,
"raw_reason": null,
"channel": "beyonic",
"page": null,
"currency": "NGN",
"method": "USSD",
"delivered": 1,
"vended": -1,
"reversed": -1,
"debited": 1,
"debited_date": "2022-12-14 19:28:54",
"failed": 0,
"isreversing": -1,
"processing": 0,
"flag": -1,
"delivered_date": "2022-12-14 19:27:26",
"reversed_date": null,
"meta": {
"fee": 0,
"total": 100,
"commission": 0,
"fee_structure": {
"fee": 0,
"percent": true,
"threshold": {
"max": 100,
"min": 0
},
"commission": 0,
"charge_customer": true
},
"charge_customer": true
},
"walletId": 3,
"commissionWallet": 4,
"staffId": null,
"created_on": "2022-12-14T19:27:26.000Z",
"updated_on": "2022-12-14T19:28:59.000Z",
"deletedAt": null
}