Invoice

List the merchant's invoices (drafts are hidden — customers see ISSUED+ only)

Changed on

List the merchant's invoices (drafts are hidden — customers see ISSUED+ only)

get/api/v1/merchants/{merchantId}/invoices

Request

Path parameters

merchantIdstring uuid required

The merchantId parameter

Query parameters

'draft'
OR
'issued'
OR
'paid'
OR
'void'

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "currency": "GBP",
      "total_amount": "1234.56",
      "amount_paid": "0.00",
      "outstanding_amount": "1234.56",
      "payments": [
        {
          "amount": "125.00",
          "currency": "GBP"
        }
      ],
      "fx_rates": [
        {
          "source_currency": "GBP",
          "rate": "0.85120000",
          "provider": "openexchangerates"
        }
      ]
    }
  ]
}

Changes