Approve Contract

Partners can set up their unique, volume-based buy-rate contract that precisely enforces their commercial agreement with Afterpay. This prevents any mis-billings from day one and has with a full audit trail.

Path Parameters

contractIdstringRequired

ID of the contract to approve

Request

This endpoint expects an object.

contractIdstringRequired

The unique ID for the contract between Afterpay and the partner.

userDetailsobjectRequired

commentstringRequired

Comment specific to the contract request.

statusenumRequired

The de facto approval field that determines whether the contract request by Afterpay is approved or rejected by the partner.

Allowed values:

countryCodestringRequired

Country code in the two-letter ISO 3166-1 alpha-2 standard format, defining the consumer market for which the rates apply.

buyRatesobjectRequired

Response

Contract reviewed successfully

timestampstring or null

Datetime field indicating when the contract request was actioned, using the standard ISO 8601 format, returned in UTC Coordinated Universal Time).

errorstring or null

Shows any errors encountered on the response to the contract approval call.

messagestring or null

Any message that may be attached to the response.

contractDetailsobject or null

1	curl -X POST https://agencyapi.afterpay.com/v1/rates-contract/123457838/review \
2	-H "Accept: application/json" \
3	-H "User-Agent: User-Agent" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"contractId": "785389121238",
7	"userDetails": {
8	"firstName": "John",
9	"lastName": "PSP",
10	"email": "john.psp@psp.com"
11	},
12	"comment": "Approved by X on date Y for reason Z.",
13	"status": "APPROVED",
14	"countryCode": "US",
15	"buyRates": {
16	"defaultRates": {
17	"variableRatePercentage": "5.00",
18	"fixedRate": "0.30",
19	"fixedRateCurrencyCode": "USD",
20	"rateType": "INTRODUCTORY"
21	},
22	"tierDetails": [
23	{
24	"tier": 1,
25	"minimumGmv": "0",
26	"maximumGmv": "1000000",
27	"GmvCurrencyCode": "USD",
28	"tieredRates": [
29	{
30	"variableRatePercentage": "3.5",
31	"fixedRate": "0.3",
32	"fixedRateCurrencyCode": "USD",
33	"rateType": "ONGOING"
34	}
35	]
36	}
37	]
38	}
39	}'

1	{
2	"timestamp": "2023-08-17T21:41:47.341+00:00",
3	"error": "string",
4	"message": "Successfully reviewed agency contract",
5	"contractDetails": {
6	"contractId": "785389121238",
7	"effectiveFrom": "2023-09-17T21:41:47.341+00:00",
8	"status": "APPROVED",
9	"countryCode": "US"
10	}
11	}

Path Parameters

Headers

Request

Response

Errors