Reports

Retrieve your reconciliation reports programmatically with the Reports API.

Get all reports

Returns the list of reports and their details.

SecurityOAuth2: OAuth or API Key: ApiSecretKey

Request

query Parameters

created_after	string <date-time> Filters reports to those created on or after the specified timestamp, in UTC. Format – ISO 8601 code Example: created_after=2025-02-17T00:00:00
created_before	string <date-time> Filters reports to those created before the specified timestamp, in UTC. Format – ISO 8601 code Example: created_before=2025-02-19T00:00:00
entity_id	string^(ent)_(\w{26})$ Filters reports to those created for the specified entity. Sub-entity IDs are not supported. Example: entity_id=ent_znj4ih5kn4fuxiaquoudv5mvwy
limit	integer <int32> [ 1 .. 100 ] Default: 100 The number of results you want to include per page. For example, if there are 50 results and you set limit=10, you receive 5 pages each containing 10 results. Example: limit=5
pagination_token	string A token used to paginate multiple pages of results.

Responses

200

Reports retrieved successfully

401

Unauthorized – Access token may be invalid or missing

422

Unprocessable entity

get/reports

Request samples

Go
curl
Java
C#
Python

// For more information please refer to https://github.com/checkout/checkout-sdk-go
import (
	"github.com/checkout/checkout-sdk-go"
	"github.com/checkout/checkout-sdk-go/configuration"
	"github.com/checkout/checkout-sdk-go/reports"
)

// API Keys
api, err := checkout.
			Builder().
			StaticKeys().
			WithSecretKey("secret_key").
			WithEnvironment(configuration.Sandbox()). // or Environment.PRODUCTION
                        WithEnvironmentSubdomain("{prefix}"). // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints.
			Build()
if err != nil {
	return nil, err
}

// OAuth
api, err := checkout.
			Builder().
			OAuth().
			WithClientCredentials("client_id", "client_secret").
			WithScopes([]string{configuration.Reports}).
			WithEnvironment(configuration.Sandbox()). // or Environment.PRODUCTION
                        WithEnvironmentSubdomain("{prefix}"). // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints.
			Build()
if err != nil {
	return nil, err
}

query := reports.QueryFilter{
	CreatedAfter:  time.Parse("2006-01-02", time.Now().AddDate(0, 0, -10).Format("2006-01-02")),
	CreatedBefore: time.Parse("2006-01-02", time.Now().Format("2006-01-02")),
	EntityId:      "entity_id",
	Limit:         20,
}

response, err := api.Reports.GetAllReports(query)
if err != nil {
	return nil, err
}

return response, nil

Response samples

application/json

{"count": 1,
"limit": 5,
"data": [{"id": "rpt_lmmldzousk7etoqijqundqexa4",
"created_on": "2022-02-18T13:00:12.357Z",
"last_modified_on": "2022-02-18T13:16:12.357Z",
"type": "Authentication",
"description": "Reconciliation Report for X.",
"account": {"client_id": "cli_bvaelhppmfiufdnatam37wrfc4",
"entity_id": "ent_znj4ih5kn4fuxiaquoudv5mvwy"
},
"tags": ["payout_id:pay_123456789"
],
"from": "2022-02-17T12:00:00Z",
"to": "2022-02-18T12:00:00Z",
"files": [{"id": "file_7ysmgfkj4ipunduud22uf73iey",
"filename": "financial-actions_ent_znj4ih5kn4fuxiaquoudv5mvwy_20220218_000000001drl_1.csv",
"format": "CSV",
"_links": {"self": {"href": "https://{prefix}.api.checkout.com/reports/rpt_lmmldzousk7etoqijqundqexa4/files/file_lmmldzousk7etoqijqundqexa4"
}
}
}
],
"_links": {"self": {"href": "https://{prefix}.api.checkout.com/reports/rpt_lmmldzousk7etoqijqundqexa4"
}
}
}
],
"_links": {"self": {"href": "https://{prefix}.api.checkout.com/reports?entity_id=ent_znj4ih5kn4fuxiaquoudv5mvwy&created_after=2022-02-17T00:00:00.000Z&limit=5"
},
"next": {"href": "https://{prefix}.api.checkout.com/reports?pagination_token=NaZMwq3KbreYcXg0dg752Dg8ps4orkwVK9pj9WFzkXk8rPoR32Wf74QWX0EkZ&entity_id=ent_znj4ih5kn4fuxiaquoudv5mvwy&created_after=2022-02-17T00:00:00.000Z&limit=5"
}
}
}

Get report details

Use this endpoint to retrieve a specific report using its ID.

SecurityOAuth2: OAuth or API Key: ApiSecretKey

Request

path Parameters

required

string^(rpt)_(\w{26})$

The ID of the report to retrieve.

Example: rpt_lmmldzousk7etoqijqundqexa4

Responses

200

Report details retrieved successfully

401

Unauthorized. Likely causes include an invalid or unspecified access token.

404

No report with the specified ID was found.

get/reports/{id}

Request samples

Go
curl
Java
C#
Python

// For more information please refer to https://github.com/checkout/checkout-sdk-go
import (
	"github.com/checkout/checkout-sdk-go"
	"github.com/checkout/checkout-sdk-go/configuration"
)

// API Keys
api, err := checkout.
			Builder().
			StaticKeys().
			WithSecretKey("secret_key").
			WithEnvironment(configuration.Sandbox()). // or Environment.PRODUCTION
                        WithEnvironmentSubdomain("{prefix}"). // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints.
			Build()
if err != nil {
	return nil, err
}

// OAuth
api, err := checkout.
			Builder().
			OAuth().
			WithClientCredentials("client_id", "client_secret").
			WithScopes([]string{configuration.Reports}).
			WithEnvironment(configuration.Sandbox()). // or Environment.PRODUCTION
                        WithEnvironmentSubdomain("{prefix}"). // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints.
			Build()
if err != nil {
	return nil, err
}

response, err := api.Reports.GetReportDetails("report_id")
if err != nil {
	return nil, err
}

return response, nil

Response samples

application/json

{"id": "rpt_lmmldzousk7etoqijqundqexa4",
"created_on": "2022-02-18T13:00:12.357Z",
"last_modified_on": "2022-02-18T13:16:12.357Z",
"type": "Authentication",
"description": "Reconciliation Report for X.",
"account": {"client_id": "cli_bvaelhppmfiufdnatam37wrfc4",
"entity_id": "ent_znj4ih5kn4fuxiaquoudv5mvwy"
},
"tags": ["payout_id:pay_123456789"
],
"from": "2022-02-17T12:00:00Z",
"to": "2022-02-18T12:00:00Z",
"files": [{"id": "file_7ysmgfkj4ipunduud22uf73iey",
"filename": "financial-actions_ent_znj4ih5kn4fuxiaquoudv5mvwy_20220218_000000001drl_1.csv",
"format": "CSV",
"_links": {"self": {"href": "https://{prefix}.api.checkout.com/reports/rpt_lmmldzousk7etoqijqundqexa4/files/file_lmmldzousk7etoqijqundqexa4"
}
}
}
],
"_links": {"self": {"href": "https://{prefix}.api.checkout.com/reports/rpt_lmmldzousk7etoqijqundqexa4"
}
}
}

Get report file

Use this endpoint to retrieve a specific file from a given report using their respective IDs.

SecurityOAuth2: OAuth or API Key: ApiSecretKey

Request

path Parameters

id required	string^(rpt)_(\w{26})$ The ID of the report that the file belongs to. Example: rpt_lmmldzousk7etoqijqundqexa4
fileId required	string^(file)_(\w{26})$ The ID of the file to retrieve. Example: file_7ysmgfkj4ipunduud22uf73iey

Responses

302

Redirect to the report file download location.

401

Unauthorized. Likely causes include an invalid or unspecified access token.

404

No report with the specified ID was found.

get/reports/{id}/files/{fileId}

Request samples

Go
curl
Java
C#
Python

// For more information please refer to https://github.com/checkout/checkout-sdk-go
import (
	"github.com/checkout/checkout-sdk-go"
	"github.com/checkout/checkout-sdk-go/configuration"
)

// API Keys
api, err := checkout.
			Builder().
			StaticKeys().
			WithSecretKey("secret_key").
			WithEnvironment(configuration.Sandbox()). // or Environment.PRODUCTION
                        WithEnvironmentSubdomain("{prefix}"). // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints.
			Build()
if err != nil {
	return nil, err
}

// OAuth
api, err := checkout.
			Builder().
			OAuth().
			WithClientCredentials("client_id", "client_secret").
			WithScopes([]string{configuration.Reports}).
			WithEnvironment(configuration.Sandbox()). // or Environment.PRODUCTION
                        WithEnvironmentSubdomain("{prefix}"). // Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see https://www.checkout.com/docs/developer-resources/api/api-endpoints.
			Build()
if err != nil {
	return nil, err
}

response, err := api.Reports.GetReportFile("report_id", "file_id")
if err != nil {
	return nil, err
}

return response, nil

Response samples

application/json

{"request_id": "0HMJGFVAQ35TL:00000117",
"error_type": "not_found",
"error_codes": ["report_file_not_found"
]
}

➔ Next to Financial actions