cash-craft-details

GET {{BASE_URL}}/payment/cash-craft/details?transaction_id=FR-TS5LQJELY7UYFGLVA0FB

This API endpoint is used to retrieve the details of a cash craft payment transaction. It is an HTTP GET request to the URL {{BASE_URL}}/payment/cash-craft/details, with the query parameter transaction_id specifying the ID of the transaction.

The response to this request has a status code of 200, indicating a successful request. The response body contains the details of the payment transaction in JSON format. Here is an example of the response:

{
  "status": "",
  "msg": "",
  "data": {
    "webhook_url": null,
    "accountNumber": "",
    "metadata": [
      {
        "email": "",
        "data": {
          "data": {
            "reference": "",
            "amount": "",
            "account_number": "",
            "originator_narration": "",
            "originator_account_number": "",
            "originator_account_name": "",
            "originator_bank": "",
            "timestamp": "",
            "session_id": ""
          }
        }
      }
    ],
    "fee": 0,
    "items": 0,
    "feeInNaira": 0,
    "amountInNaira": 0,
    "isCashCraft": true,
    "_id": "",
    "txId": "",
    "link": "",
    "name": "",
    "amount": 0,
    "status": "",
    "channel": "",
    "type": "",
    "method": "",
    "date": "",
    "description": "",
    "beneficiaries": [
      {
        "amount": 0,
        "fee": 0,
        "_id": "",
        "bankCode": "",
        "accountNumber": "",
        "transactionId": "",
        "resolved": true,
        "status": "",
        "reason": ""
      }
    ],
    "data": {
      "status": "",
      "message": "",
      "accountNumber": "",
      "reference": ""
    },
    "returningBalance": 0
  }
}

Please note that the response may contain empty strings or null values for some properties. The properties in the response include status, msg, data, webhook_url, accountNumber, metadata, fee, items, feeInNaira, amountInNaira, isCashCraft, _id, txId, link, name, amount, status, channel, type, method, date, description, beneficiaries, data, and returningBalance. Each property represents a specific aspect of the payment transaction.

It is important to note that the example response provided here is just a representation of the possible structure of the response. The actual values may vary based on the specific transaction being queried.

Request Params

HEADERS

RESPONSES

status: OK

{"status":"success","msg":"Transaction Found","data":{"webhook_url":null,"accountNumber":"4700030047","metadata":[{"email":"no-reply@figopayment.com","data":{"data":{"reference":"FIGO-IJ6QDAWEAZslGVb3G4VK","amount":"500.0","account_number":"4700030047","originator_narration":"FRM Ifedayo Osun|TESTING ","originator_account_number":"2003230097","originator_account_name":"Ifedayo Osun","originator_bank":"090267","timestamp":"2023-11-16T13:07:16.995","session_id":"0902672311161403245049004330097"}}}],"fee":10500,"items":1,"feeInNaira":105,"amountInNaira":500,"isCashCraft":true,"_id":"655612f0f62fc11f462bd99e","txId":"FR-TS5LQJELY7UYFGLVA0FB","link":"figo_technologies_limited","name":"figo technologies limited link","amount":50000,"status":"successful","channel":"API","type":"primary","method":"Payment Link","date":"2023-11-16T13:02:40.000Z","description":"cash craft payment demo","beneficiaries":[{"amount":10000,"fee":5000,"_id":"655612f0f62fc11f462bd99f","bankCode":"999999","accountNumber":"1012429143","transactionId":"FR8PKIRACO6D","resolved":true,"status":"confirmed","reason":"Successful Transfer"},{"amount":20000,"fee":5000,"_id":"655612f0f62fc11f462bd9a0","bankCode":"090267","accountNumber":"2004330097","transactionId":"FRP61IKFPJ6Q","resolved":true,"status":"confirmed","reason":"1700140053857"}],"data":{"status":"00","message":"Successful","accountNumber":"4700050047","reference":"FIGO-IJ6QDADZqlGVb3G4VK"},"returningBalance":546669}}