Skip to main content

Get a list of Payouts [GET]

By means of a call parameter (merchant_id or reference_id) you can find out whether the settlement of the payment (reference_id) or of all payments of a Merchant (merchant_id) was executed and completed.

Endpoints​

Staging environment

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

Production/Live environment

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

Schema​

merchant_id (query, string)
reference_id (query, string)

Examples of returns​

Success response (201)​

{
  "total_payouts": 2,
  "payouts": [
    {
      "id": 1,
      "payment_reference": "TP5E3QJWIY",
      "status": "new",
      "payout_amount": "0.0",
      "payment_method": "bank",
      "merchant_name": "Hahn-Walter",
      "merchant_id": 1,
      "created_at": "2022-12-01T12:40:34.911+00:00"
    },
    {
      "id": 3,
      "payment_reference": "DA3DOHQ3U2",
      "status": "new",
      "payout_amount": "0.0",
      "payment_method": "crypto",
      "merchant_name": "Hahn-Walter",
      "merchant_id": 1,
      "created_at": "2022-12-01T12:40:34.977+00:00"
    }
  ]
}

Error response (422)​

{
  "errors": "Not found"
}