Get transaction - QShop API Documentation

Get transaction

curl --request GET \
  --url http://staging.qshop.ng/apiv2/{transactionId}

{
  "data": {
    "__v": 0,
    "_id": "62ea571509bd2e9be7de9edd",
    "amount": 18500,
    "breakdown": {
      "aggregate": 816.875,
      "amount": 18500,
      "bankCharge": 76.875,
      "payout": 17683.125,
      "qshopCharge": 740
    },
    "createdAt": "2022-08-03T11:08:05.921Z",
    "meta": {
      "accountNumber": "9978770274",
      "channelId": "1",
      "currency": "NGN",
      "feeAmount": "500",
      "initiationTranRef": "",
      "sessionId": "0000042103011805345648005069266636442358859209",
      "settledAmount": "18500",
      "settlementId": "202210301006807500001631",
      "sourceAccountName": "CASAFINA CREDIT-EASY LOAN",
      "sourceAccountNumber": "2093566866",
      "sourceBankName": "UNITED BANK FOR AFRICA",
      "tranDateTime": "2021-03-01 18:06:20.000",
      "tranRemarks": "FROM UBA/ CASAFINA CREDIT-EASY LOAN-NIP/SEYI OLUFEMI/CASAFINA CAP/0000042103015656180548005069266636",
      "transactionAmount": "19000",
      "vatAmount": "0",
      "virtualBankAccount": {
        "__v": 0,
        "_id": "62ea499b1908431f9caf727b",
        "accountName": "MERCHANT(Qshop/Egoli)",
        "accountNumber": "9978770274",
        "created": "2022-08-03T10:10:35.667Z",
        "isUsed": true,
        "meta": {
          "account_name": "MERCHANT(Qshop/Egoli)",
          "account_number": "9978770274",
          "bvn": "",
          "requestSuccessful": true,
          "responseCode": "00",
          "responseMessage": "Reserved Account Generated Successfully"
        },
        "order": "62ea498e1908431f9caf7276",
        "orderTotal": 22000,
        "platformKey": "providus",
        "platformName": "Providus",
        "shop": "61a956d91a113f7e13c45c15"
      }
    },
    "paymentPlatform": {
      "__v": 1,
      "_id": "61a6406c18ae008099246a8d",
      "image": "providus-logo.png",
      "imageId": "8dea64c5-21b3-4106-9f94-17372c5788b3",
      "imageUrl": "https://ucarecdn.com/8dea64c5-21b3-4106-9f94-17372c5788b3/-/resize/",
      "key": "providus",
      "name": "Providus bank",
      "subscription": {
        "supportedCurrencies": []
      },
      "supportedCountries": [
        "628c8d3c21ce8313e6293c8e"
      ],
      "supportedCurrencies": [
        "60aa6cd79aed9f2aa1b677db"
      ],
      "supportsRecurringPayments": false
    },
    "shop": {
      "_id": "61a956d91a113f7e13c45c15",
      "domainActive": false,
      "domainName": "staar.pre",
      "name": "Egoli",
      "slug": "egoli-3"
    },
    "status": {
      "__v": 0,
      "_id": "62597ba57b912008a11e1206",
      "key": "pending",
      "name": "Pending",
      "notes": "Transaction has been created but no action as been taken at all"
    },
    "statusLogs": [
      {
        "__v": 0,
        "_id": "62597ba57b912008a11e1206",
        "key": "pending",
        "name": "Pending",
        "notes": "Transaction has been created but no action as been taken at all"
      }
    ],
    "transactionReference": "202210301006807500001631",
    "type": "order-payment",
    "virtualBankAccount": {
      "__v": 0,
      "_id": "62ea499b1908431f9caf727b",
      "accountName": "MERCHANT(Qshop/Egoli)",
      "accountNumber": "9978770274",
      "created": "2022-08-03T10:10:35.667Z",
      "isUsed": true,
      "meta": {
        "account_name": "MERCHANT(Qshop/Egoli)",
        "account_number": "9978770274",
        "bvn": "",
        "requestSuccessful": true,
        "responseCode": "00",
        "responseMessage": "Reserved Account Generated Successfully"
      },
      "order": "62ea498e1908431f9caf7276",
      "orderTotal": 22000,
      "platformKey": "providus",
      "platformName": "Providus",
      "shop": "61a956d91a113f7e13c45c15"
    }
  },
  "msg": "Transaction found",
  "success": true
}

GET

{transactionId}

Get transaction

curl --request GET \
  --url http://staging.qshop.ng/apiv2/{transactionId}

{
  "data": {
    "__v": 0,
    "_id": "62ea571509bd2e9be7de9edd",
    "amount": 18500,
    "breakdown": {
      "aggregate": 816.875,
      "amount": 18500,
      "bankCharge": 76.875,
      "payout": 17683.125,
      "qshopCharge": 740
    },
    "createdAt": "2022-08-03T11:08:05.921Z",
    "meta": {
      "accountNumber": "9978770274",
      "channelId": "1",
      "currency": "NGN",
      "feeAmount": "500",
      "initiationTranRef": "",
      "sessionId": "0000042103011805345648005069266636442358859209",
      "settledAmount": "18500",
      "settlementId": "202210301006807500001631",
      "sourceAccountName": "CASAFINA CREDIT-EASY LOAN",
      "sourceAccountNumber": "2093566866",
      "sourceBankName": "UNITED BANK FOR AFRICA",
      "tranDateTime": "2021-03-01 18:06:20.000",
      "tranRemarks": "FROM UBA/ CASAFINA CREDIT-EASY LOAN-NIP/SEYI OLUFEMI/CASAFINA CAP/0000042103015656180548005069266636",
      "transactionAmount": "19000",
      "vatAmount": "0",
      "virtualBankAccount": {
        "__v": 0,
        "_id": "62ea499b1908431f9caf727b",
        "accountName": "MERCHANT(Qshop/Egoli)",
        "accountNumber": "9978770274",
        "created": "2022-08-03T10:10:35.667Z",
        "isUsed": true,
        "meta": {
          "account_name": "MERCHANT(Qshop/Egoli)",
          "account_number": "9978770274",
          "bvn": "",
          "requestSuccessful": true,
          "responseCode": "00",
          "responseMessage": "Reserved Account Generated Successfully"
        },
        "order": "62ea498e1908431f9caf7276",
        "orderTotal": 22000,
        "platformKey": "providus",
        "platformName": "Providus",
        "shop": "61a956d91a113f7e13c45c15"
      }
    },
    "paymentPlatform": {
      "__v": 1,
      "_id": "61a6406c18ae008099246a8d",
      "image": "providus-logo.png",
      "imageId": "8dea64c5-21b3-4106-9f94-17372c5788b3",
      "imageUrl": "https://ucarecdn.com/8dea64c5-21b3-4106-9f94-17372c5788b3/-/resize/",
      "key": "providus",
      "name": "Providus bank",
      "subscription": {
        "supportedCurrencies": []
      },
      "supportedCountries": [
        "628c8d3c21ce8313e6293c8e"
      ],
      "supportedCurrencies": [
        "60aa6cd79aed9f2aa1b677db"
      ],
      "supportsRecurringPayments": false
    },
    "shop": {
      "_id": "61a956d91a113f7e13c45c15",
      "domainActive": false,
      "domainName": "staar.pre",
      "name": "Egoli",
      "slug": "egoli-3"
    },
    "status": {
      "__v": 0,
      "_id": "62597ba57b912008a11e1206",
      "key": "pending",
      "name": "Pending",
      "notes": "Transaction has been created but no action as been taken at all"
    },
    "statusLogs": [
      {
        "__v": 0,
        "_id": "62597ba57b912008a11e1206",
        "key": "pending",
        "name": "Pending",
        "notes": "Transaction has been created but no action as been taken at all"
      }
    ],
    "transactionReference": "202210301006807500001631",
    "type": "order-payment",
    "virtualBankAccount": {
      "__v": 0,
      "_id": "62ea499b1908431f9caf727b",
      "accountName": "MERCHANT(Qshop/Egoli)",
      "accountNumber": "9978770274",
      "created": "2022-08-03T10:10:35.667Z",
      "isUsed": true,
      "meta": {
        "account_name": "MERCHANT(Qshop/Egoli)",
        "account_number": "9978770274",
        "bvn": "",
        "requestSuccessful": true,
        "responseCode": "00",
        "responseMessage": "Reserved Account Generated Successfully"
      },
      "order": "62ea498e1908431f9caf7276",
      "orderTotal": 22000,
      "platformKey": "providus",
      "platformName": "Providus",
      "shop": "61a956d91a113f7e13c45c15"
    }
  },
  "msg": "Transaction found",
  "success": true
}

Path Parameters

transactionId

string

required

Example:

"62ea571509bd2e9be7de9edd"

Response

200 - application/json

Get transaction

data

object

Show child attributes

data.__v

number

Example:

0

data._id

string

Example:

"62ea571509bd2e9be7de9edd"

data.amount

number

Example:

18500

data.breakdown

object

Show child attributes

data.breakdown.aggregate

number

Example:

816.875

data.breakdown.amount

number

Example:

18500

data.breakdown.bankCharge

number

Example:

76.875

data.breakdown.payout

number

Example:

17683.125

data.breakdown.qshopCharge

number

Example:

740

data.createdAt

string

Example:

"2022-08-03T11:08:05.921Z"

data.meta

object

Show child attributes

data.meta.accountNumber

string

Example:

"9978770274"

data.meta.channelId

string

Example:

"1"

data.meta.currency

string

Example:

"NGN"

data.meta.feeAmount

string

Example:

"500"

data.meta.initiationTranRef

string

Example:

""

data.meta.sessionId

string

Example:

"0000042103011805345648005069266636442358859209"

data.meta.settledAmount

string

Example:

"18500"

data.meta.settlementId

string

Example:

"202210301006807500001631"

data.meta.sourceAccountName

string

Example:

"CASAFINA CREDIT-EASY LOAN"

data.meta.sourceAccountNumber

string

Example:

"2093566866"

data.meta.sourceBankName

string

Example:

"UNITED BANK FOR AFRICA"

data.meta.tranDateTime

string

Example:

"2021-03-01 18:06:20.000"

data.meta.tranRemarks

string

Example:

"FROM UBA/ CASAFINA CREDIT-EASY LOAN-NIP/SEYI OLUFEMI/CASAFINA CAP/0000042103015656180548005069266636"

data.meta.transactionAmount

string

Example:

"19000"

data.meta.vatAmount

string

Example:

"0"

data.meta.virtualBankAccount

object

Show child attributes

data.meta.virtualBankAccount.__v

number

Example:

0

data.meta.virtualBankAccount._id

string

Example:

"62ea499b1908431f9caf727b"

data.meta.virtualBankAccount.accountName

string

Example:

"MERCHANT(Qshop/Egoli)"

data.meta.virtualBankAccount.accountNumber

string

Example:

"9978770274"

data.meta.virtualBankAccount.created

string

Example:

"2022-08-03T10:10:35.667Z"

data.meta.virtualBankAccount.isUsed

boolean

Example:

true

data.meta.virtualBankAccount.meta

object

Show child attributes

data.meta.virtualBankAccount.meta.account_name

string

Example:

"MERCHANT(Qshop/Egoli)"

data.meta.virtualBankAccount.meta.account_number

string

Example:

"9978770274"

data.meta.virtualBankAccount.meta.bvn

string

Example:

""

data.meta.virtualBankAccount.meta.requestSuccessful

boolean

Example:

true

data.meta.virtualBankAccount.meta.responseCode

string

Example:

"00"

data.meta.virtualBankAccount.meta.responseMessage

string

Example:

"Reserved Account Generated Successfully"

data.meta.virtualBankAccount.order

string

Example:

"62ea498e1908431f9caf7276"

data.meta.virtualBankAccount.orderTotal

number

Example:

22000

data.meta.virtualBankAccount.platformKey

string

Example:

"providus"

data.meta.virtualBankAccount.platformName

string

Example:

"Providus"

data.meta.virtualBankAccount.shop

string

Example:

"61a956d91a113f7e13c45c15"

data.paymentPlatform

object

Show child attributes

data.paymentPlatform.__v

number

Example:

1

data.paymentPlatform._id

string

Example:

"61a6406c18ae008099246a8d"

data.paymentPlatform.image

string

Example:

"providus-logo.png"

data.paymentPlatform.imageId

string

Example:

"8dea64c5-21b3-4106-9f94-17372c5788b3"

data.paymentPlatform.imageUrl

string

Example:

"https://ucarecdn.com/8dea64c5-21b3-4106-9f94-17372c5788b3/-/resize/"

data.paymentPlatform.key

string

Example:

"providus"

data.paymentPlatform.name

string

Example:

"Providus bank"

data.paymentPlatform.subscription

object

Show child attributes

data.paymentPlatform.subscription.supportedCurrencies

any[]

Example:

[]

data.paymentPlatform.supportedCountries

string[]

Example:

["628c8d3c21ce8313e6293c8e"]

data.paymentPlatform.supportedCurrencies

string[]

Example:

["60aa6cd79aed9f2aa1b677db"]

data.paymentPlatform.supportsRecurringPayments

boolean

Example:

false

data.shop

object

Show child attributes

data.shop._id

string

Example:

"61a956d91a113f7e13c45c15"

data.shop.domainActive

boolean

Example:

false

data.shop.domainName

string

Example:

"staar.pre"

data.shop.name

string

Example:

"Egoli"

data.shop.slug

string

Example:

"egoli-3"

data.status

object

Show child attributes

data.status.__v

number

Example:

0

data.status._id

string

Example:

"62597ba57b912008a11e1206"

data.status.key

string

Example:

"pending"

data.status.name

string

Example:

"Pending"

data.status.notes

string

Example:

"Transaction has been created but no action as been taken at all"

data.statusLogs

object[]

Show child attributes

data.statusLogs.__v

number

Example:

0

data.statusLogs._id

string

Example:

"62597ba57b912008a11e1206"

data.statusLogs.key

string

Example:

"pending"

data.statusLogs.name

string

Example:

"Pending"

data.statusLogs.notes

string

Example:

"Transaction has been created but no action as been taken at all"

Example:

[
  {
    "__v": 0,
    "_id": "62597ba57b912008a11e1206",
    "key": "pending",
    "name": "Pending",
    "notes": "Transaction has been created but no action as been taken at all"
  }
]

data.transactionReference

string

Example:

"202210301006807500001631"

data.type

string

Example:

"order-payment"

data.virtualBankAccount

object

Show child attributes

data.virtualBankAccount.__v

number

Example:

0

data.virtualBankAccount._id

string

Example:

"62ea499b1908431f9caf727b"

data.virtualBankAccount.accountName

string

Example:

"MERCHANT(Qshop/Egoli)"

data.virtualBankAccount.accountNumber

string

Example:

"9978770274"

data.virtualBankAccount.created

string

Example:

"2022-08-03T10:10:35.667Z"

data.virtualBankAccount.isUsed

boolean

Example:

true

data.virtualBankAccount.meta

object

Show child attributes

data.virtualBankAccount.meta.account_name

string

Example:

"MERCHANT(Qshop/Egoli)"

data.virtualBankAccount.meta.account_number

string

Example:

"9978770274"

data.virtualBankAccount.meta.bvn

string

Example:

""

data.virtualBankAccount.meta.requestSuccessful

boolean

Example:

true

data.virtualBankAccount.meta.responseCode

string

Example:

"00"

data.virtualBankAccount.meta.responseMessage

string

Example:

"Reserved Account Generated Successfully"

data.virtualBankAccount.order

string

Example:

"62ea498e1908431f9caf7276"

data.virtualBankAccount.orderTotal

number

Example:

22000

data.virtualBankAccount.platformKey

string

Example:

"providus"

data.virtualBankAccount.platformName

string

Example:

"Providus"

data.virtualBankAccount.shop

string

Example:

"61a956d91a113f7e13c45c15"

msg

string

Example:

"Transaction found"

success

boolean

Example:

true

Get transaction status Update transaction

⌘I