mono-logo

Fetch all Payments

Last updated Sept 24th, 2022

This resource returns all payment data on an account.

API Object

Request

123456789101112131415161718192021222324252627282930313233343536
{
  "payments": [
    
    {
      "_id": "62bd8*****************9",
      "type": "onetime-debit",
      "status": "successful",
      "amount": 20000,
      "description": "description of payment",
      "currency": "NGN",
      "customer": null,
      "reference": "KW9LO016***************3",
      "created_at": "2022-06-30T11:14:10.583Z",
      "updated_at": "2022-06-30T12:06:36.248Z",
       "account": {
        "_id": "62bd85***************",
        "institution": {
          "_id": "5f2d08********8********",
          "name": "KudaBank",
          "type": "PERSONAL_BANKING"
        },
        "name": "JOHN DOE EJIRO",
        "accountNumber": "11********23",
        "currency": "NGN",
        "created_at": "2022-06-30T11:14:09.665Z",
        "updated_at": "2022-06-30T13:00:00.096Z"
      },
    },
  ],
  "paging": {
    "total": 510,
    "pages": 102,
    "previous": null,
    "next": "http://localhost:3000/transactions?page=2"
  }
}

Payment Fields

FieldDescriptionType
paymentsThis is an array of objects which contains all payment data.string
payments._idThe payment Id.string
payment.typeThe payment type.string
payment.statusThe status of the payment.string
payment.amountThe payment's total value in the smallest denomination, such as a Kobo (Nigeria) or a Pesewa (Ghana).number
payment.descriptionThe payment description.string
payment.currencyThe currency of the payment account (NGN, GHS, etc).string
payment.customerThe Customer Id of the connected account.string
payment.referenceThe unique identifier of the payment.string
payment.created_atThe date and time the payment was created.string
payment.updated_atThe date and time when the payment was updated.string
payment.accountThe user information object.string
payment.account._idThe user account ID.string
payment.account.institutionThe user's institution object.string
payment.account.institution._idThe user's institution ID.string
payment.account.institution.nameThe user's institution name.string
payment.account.institution.typeThe user's institution type.string
payment.account.nameThe user's institution object.string
payment.account.accountNumberThe user's account number.number
payment.account.currencyThe user's account currency.string
payment.account.created_atThe date and time the user account was connected.string
payment.account.updated_atThe date and time the user account was updated.string
pagingThis object contains important pagination data such as the total, the current page, the previous and the next page link.object
paging.totalThe total number of payments tied to this account.number
paging.pageThe current page of the fetch all payments API.number
paging.previousThe previous page of the fetch all payments API.string
paging.nextThe next page of the fetch all payments API.object

Did this page help you?