FIfincra

Get Collection record by reference

Changed on

This endpoint returns details of a payment into your Fincra position. You can use this endpoint to verify the status and details of a payment after receiving the collection.successful webhook.

get/collections/reference/{reference}

Request

Path parameters

referencestring required

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Collection fetched successfully",
  "data": {
    "id": 20833,
    "_id": "20833",
    "sourceAmount": 52000,
    "destinationAmount": 52000,
    "sourceAmountSettled": 51990,
    "destinationAmountSettled": 51990,
    "sourceCurrency": "KES",
    "destinationCurrency": "KES",
    "sourceFee": 10,
    "destinationFee": 10,
    "payeeName": "FINCRA TECHNOLOGIES LTD (XT)",
    "payeeAccountNumber": "55010160017435",
    "status": "successful",
    "approvalStatus": "approved",
    "reference": "b7b73b5e-181a-4be6-b1ec-6488b1a99c9d",
    "description": "NIP:STEPHEN DAMILOLA IBIDUN-1291189564/FINCRA TECHNOLOGIES (Pty) LTD (XT)",
    "paymentMethod": "virtual_account",
    "merchantReference": "testing-pool-collection419",
    "settlementDestination": "wallet",
    "payer": {
      "name": "STEPHEN DAMILOLA IBIDUN",
      "account_number": "2280495927",
      "bank_code": "000004",
      "bank_name": "UNITED BANK FOR AFRICA"
    },
    "virtualAccountId": "6706b9056f8e7084abbe90bb",
    "initiatedAt": "2024-10-09T21:32:51.000Z",
    "createdAt": "2024-10-09T21:32:51.000Z",
    "updatedAt": "2024-10-09T21:32:51.000Z",
    "businessId": 2919
  }
}

Changes