v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Payments

List payments

Get a list of the payments that your application has initiated on behalf of the user within the start and end time range.

️ ℹ️ Time range defaults to the last 30 days.

For more details about payments see:

📖 Making a payment guide
📚 Payment lifecycle guide
📚 Payment webhooks

get/payments

Query parameters

startstring date-time

ISO 8601 Date

endstring date-time

ISO 8601 Date

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "items": [
    {
      "_id": "payment_1111111111111111111111111",
      "from": "acc_1111111111111111111111111",
      "to": {
        "account_number": "12-1234-1234567-12",
        "name": "John Smith"
      },
      "amount": 9.51,
      "meta": {
        "destination": {
          "particulars": "destPart",
          "code": "destCode",
          "reference": "destRef"
        },
        "source": {
          "code": "sourceCode",
          "reference": "sourceRef"
        }
      },
      "sid": "akp111111111",
      "status": "READY",
      "status_text": "This payment has just been created and is ready to be sent",
      "timeline": [
        {
          "status": "READY",
          "time": "2020-01-01T01:00:00.000Z",
          "eta": "2020-01-01T01:00:00.000Z"
        }
      ],
      "created_at": "2020-01-01T01:00:00.000Z",
      "updated_at": "2020-01-01T01:00:00.000Z",
      "received_at": "2020-01-01T01:00:00.000Z"
    }
  ]
}