Skip to main content

Get a list of Payments [GET]

To retrieve the payments, we can use the following endpoints (for both Staging and Production environments), in addition, you can recover all payments or only the payment you want.

Endpoints​

All payments (List)​

Staging environment

  • Staging URL: https://staging.sylq.io/api/v1/payments

Production/Live environment

  • Production/Live URL: https://app.sylq.io/api/v1/payments

Payment by reference ID (single payment)​

Staging environment

  • Staging URL: https://staging.sylq.io/api/v1/payments/{payment_reference}

Production/Live environment

  • Production/Live URL: https://app.sylq.io/api/v1/payments/{payment_reference}

Parameters​

page (query, string)
limit (query, string)

Examples of returns​

Success response for All payments (200)​

{
  "total_payments": 1,
  "total_of_pages": 1,
  "current_page": 1,
  "payments": [
    {
      "id": 208,
      "reference": "7EBOEYINPF",
      "description": "Voluptates similique voluptatem a.",
      "amount": 92.05,
      "currency": "EUR",
      "status": "confirmed",
      "type": "bank",
      "latitude": null,
      "longitude": null,
      "merchant_id": 68656379
    }
  ]
}

Success response for a single payment (200)​

{
  "reference": "Y5EV5P7HQT",
  "description": "Officia ipsa qui praesentium.",
  "amount": 35.06,
  "paid_amount": 35.06,
  "fee_amount": -0.3506,
  "currency": "EUR",
  "status": "confirmed",
  "type": "bank",
  "checkout_url": "http://localhost:3000/payment/Y5EV5P7HQT/checkout",
  "created_at": "2024-06-06T10:00:46.896Z",
  "merchant_id": 63173818,
  "payer_name": null,
  "qr_image": "http://localhost:3000/payment/Y5EV5P7HQT/qr",
  "metadata": {
    "internal_reference": "F2FLQG34MO"
  },
  "underpaid_amount": null,
  "exchange_rate": null,
  "underpaid": 0
}

Error response: "Invalid auth token" (401)​

{
  "errors": "Invalid auth token"
}

Error response: "Not found" (404)​

{ "errors": "Not found" }