These docs are for v2.0. Click to read the latest docs for v3.1.

📘

Terminology

Invoice within this doc refer to invoice generated by a client within the Shine app.
Receipt is a receipt for a payin or payout transaction attached by the client

For a given transaction, if you need to get an linked receipt:

  • case 1: there is no receipt attached. In this case hasReceipts = false
  • case 2: the client used another tool to generate his invoice and manually linked it to a transaction by uploading a file. In this case, hasReceipts = true and to get the receipt, you can query the Receipt service using the transactionId as described there. If the query return no results, then see case 3
  • case 3: the client used Shine to generate his invoice. Use the follow endpoint to retrieve the linked invoice