Request an upload URL for a settlement report

Access: this endpoint is enabled per partner. Please contact your account manager before using it. Until it is enabled for your account, requests are refused with 403.

Requests a pre-signed S3 URL to upload a settlement report. Once you have the upload URL, PUT your file bytes directly to S3 — no API key is needed for the S3 upload itself.

Accepted file types: CSV, XLS, XLSX

Maximum file size: 50 MB

Uploading the file:

  • Send the raw file bytes as the body of the PUT, within expiresIn seconds.
  • The Content-Length of the PUT must be exactly the fileSizeBytes you declared in this request, otherwise S3 rejects the upload with 403 SignatureDoesNotMatch. If that happens, request a new URL.
  • Set the Content-Type header to the same contentType you declared here.
  • S3's 200 OK response to the PUT confirms that we have received your file. There is no status endpoint or webhook for settlement reports.

Each request returns a new URL for one file. To send several files, request a URL for each.

Body Params

File metadata for generating the upload URL

Request body for generating a settlement report upload URL

string
required

Name of the file to upload (including extension)

string
enum
required

MIME type of the file

Allowed:
integer
required
1 to 52428800

Exact size of the file in bytes. Must equal the Content-Length of your upload. Maximum 50 MB.

Headers
string
required

Your API key for authentication.

Responses

401

Unauthorized - Missing or invalid API key

500

Internal server error. Please contact support if the issue persists.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json