Download a payment receipt
Download a PDF receipt for a confirmed payment.
Get a temporary URL to download the charge's payment receipt.
Call this endpoint with your API key or OAuth session and use the returned url to download
the PDF from files.raims.com without sending the key in that download.
The receipt is issued by Raims and does not replace a tax invoice or bank payment receipt. See the conditions in Payment data and receipt.
Path Params
The public ID of the charge whose receipt you want to download.
Up to 100 characters
Responses
Response Body
Temporary URL for the payment receipt. Send a GET request to the returned address to download the PDF, without sending the API key. Sandbox receipts identify the simulated payment.
Temporary URL for downloading a financial document as a PDF. Anyone with the URL can access it until expires_at and reuse it within that period. Share it only with authorized people and do not record it in logs. After expiration, query the authenticated endpoint again to obtain another link. Downloading an invalid or expired link may return HTTP 403 without the API JSON error envelope.
Temporary HTTPS URL on files.raims.com. Send a GET to the full URL to download the PDF, without Authorization or the API key. Do not change its parameters.
Link expiration in UTC Unix seconds. After this time, query the document endpoint again with the API key.
Response Body
The charge ID is invalid. Use the ID returned by the API.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
Response Body
Charge not found in the authenticated company and environment.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
Response Body
The payment does not meet the conditions for issuing a receipt. Retrieve the charge before trying again.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
For common errors, see HTTP response codes.