Prepare a logo upload
Get a temporary URL to upload the checkout logo.
Send the image details to get a temporary upload URL. After uploading the file, associate the returned identifier with the checkout settings.
This request does not replace the logo by itself. See how to upload the file and check its progress in Checkout logo and icon.
Headers
Unique key chosen by your system to identify this request. When retrying, send the same key and parameters. Without this header, the request is processed normally. See the idempotency guide for retention and handling pending or uncertain responses.
1 to 255 characters
Body Params
Applying an example replaces the body fields.
File content type: image/png or image/jpeg.
1 to 32 characters
File size in bytes.
From 1 to 524288
Image width in pixels.
From 128 to 2048
Image height in pixels.
From 128 to 2048
Responses
Response Body
Upload authorized until the returned deadline. Send the file to upload_url before associating the ID with the checkout customization.
Temporary authorization to upload a company image file in the authenticated environment.
Upload identifier. Use it in the corresponding PATCH field after uploading the file.
Temporary URL for uploading the file bytes. Do not send the Raims API key to this address.
HTTP method for uploading the file to the returned URL.
Content type to send in the PUT Content-Type header.
Number of bytes to upload, also specified in the PUT Content-Length header.
Upload authorization expiration, in UTC Unix seconds.
Response Body
The image data does not meet the accepted formats, sizes or dimensions. Correct the fields indicated in the details.
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 account was not found for the provided key. Check the credential before repeating the request.
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.