Download a refund receipt

Download the PDF receipt for a completed refund.

GEThttps://api.raims.com/v1/refunds/{id}/receipt

Get a temporary URL to download the receipt for a completed refund using its refund ID. Call this endpoint with your API key and use the returned url to download the PDF from files.raims.com, without sending the key in that download. The document shows the amount of that request, including partial refunds.

Pending or failed requests do not have a completion receipt. See Refund receipt for the conditions and how to use the document.

Path Params

idstringrequired

Public refund identifier, received in the request or refund list.

Up to 100 characters

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request GET \
  --url https://api.raims.com/v1/refunds/%7Bid%7D/receipt \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Download a refund receipt

Path Params

Responses

200OK

400Bad Request

404Not Found

409Conflict