GET
/
payments
List all payments
curl --request GET \
  --url https://api.notchpay.co/payments \
  --header 'Authorization: <api-key>'
{
  "code": 200,
  "status": "OK",
  "message": "Payments retrieved",
  "totals": 50,
  "last_page": 2,
  "current_page": 1,
  "selected": 30,
  "items": [
    {
      "id": "pay_123456789",
      "reference": "ref_123456789",
      "amount": 5000,
      "currency": "XAF",
      "status": "complete",
      "customer": "cus_123456789",
      "created_at": "2023-01-01T12:00:00.000Z",
      "completed_at": "2023-01-01T12:05:00.000Z",
      "payment_method": "pm.ndzAfIh555VCPML1"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer
default:30

Number of items per page

​
page
integer
default:1

Page number

​
search
string

Search by reference

​
status
string

Filter by status

​
channels
string

Filter by payment channels

​
date_start
string<date>

Start date (YYYY-MM-DD)

​
date_end
string<date>

End date (YYYY-MM-DD)

Response

200
application/json

Successful response

The response is of type object.