GET
/
payments
curl --request GET \
  --url https://api.live.paisr.tech/{version}/payments \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "payments": [
      {
        "id": "pmt_123456",
        "sid": 680297,
        "invoice_id": "inv_123456",
        "description": "Payment for Invoice #600783",
        "currency": "SRD",
        "status": "approved",
        "payment_method": {
          "provider": "Paisr Pay",
          "type": "platform"
        },
        "amount": {
          "sub_total": 135,
          "tax": {
            "rate": 0,
            "type": "percentage",
            "total": 0
          },
          "due_total": 135,
          "fee_total": 2.56,
          "output_total": 132.44
        },
        "billing_details": {
          "name": "Jane Smith",
          "phone": "5978123456",
          "line_1": "Example Street 10",
          "line_2": "Example Street 11",
          "city": "Paramaribo",
          "state": "Kwatta",
          "zip_code": "<string>",
          "country": "SR"
        },
        "notes": null,
        "metadata": null,
        "initiated_at": "2023-11-07T05:31:56Z",
        "approved_at": "2023-11-07T05:31:56Z",
        "settled_at": null,
        "cancelled_at": null,
        "cancelled_by": null,
        "reversed_at": null,
        "reversed_by": null
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
invoice_id
string

The ID of the invoice you want to filter based on.

​
currency
string

The currency you want to filter based on.

​
status
enum<string>
Available options:
pending,
approved,
settled,
refunded,
cancelled
Example:

"approved"

Response

200
application/json
Successfully retrieved the list of payments.

The response is of type object.