Download a settlement report

GET

/api/v1/settlements/{id}/report

const url = 'https://example.com/api/v1/settlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/report';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/settlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/report \
  --header 'Authorization: Bearer <token>'

Streams the generated settlement report file for the given settlement. The response body is a binary stream; use the Content-Disposition header to determine the suggested filename.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

ID of the settlement whose report to download

Responses

200

Report file stream

application/octet-stream

string format: binary

Headers

Content-Disposition

string

Example

attachment; filename="report-<id>.pdf"

Suggested filename for the downloaded file

401

Unauthorized

application/json

object

error_code

required

string

Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT

message

required

string

Example

{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}

404

Settlement or report not found

application/json

object

error_code

required

string

Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT

message

required

string

Example

{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}

500

Internal server error

application/json

object

error_code

required

string

Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT

message

required

string

Example

{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}