Get Settlement Batch Files | Welcome to Afterpay Documentation

Returns signed S3 urls to the settlement file and aggregation file for specified batch IDs.

idsstringRequired

Comma separated ids of batches to fetch.

Successful response with signed S3 URLs for the settlement and aggregation files.

batcheslist of objects

meta_dataobject

401

Unauthorized Error

404

Not Found Error

503

Service Unavailable Error

1	curl -G https://agencyapi.afterpay.com/v1/settlement/batch \
2	-H "Accept: application/json" \
3	-H "User-Agent: User-Agent" \
4	--data-urlencode ids=id1,id2,id3

1	{
2	"batches": [
3	{
4	"id": "2020-07-10Z_sud294dgzb",
5	"settlement_file": "https://s3.amazonaws.com/settlements/transaction.csv?token",
6	"aggregation_file": "https://s3.amazonaws.com/settlements/aggregated.csv?token"
7	}
8	],
9	"meta_data": {
10	"computed_at": "2024-02-21T19:25:44Z",
11	"link_expiry": "2024-03-06T19:25:44Z"
12	}
13	}