Update Tier

Allows partners to pass a new tier and use a new contractId between the partner and the seller for audit purposes.

Path Parameters

onboardingIdstringRequired

The ID returned during a successful create an onboarding call.

Request

This endpoint expects an object.

tierintegerRequired

GMV tier of the seller that informs the buy rate as defined in the commercial contract.

gmvCurrencyCodestringRequired

Currency of the gmv volume in ISO 4217 currency code. Please use currency that is defined in the commercial contract only (e.g., USD-equivalent volume for UK sellers).

agencyMerchantContractDetailsobjectRequired

gmvinteger or nullOptional

Actual transaction volume that informs the tier. Estimated or addressable seller volume accepted when actuals are not available.

Response

Tier update request was successfully actioned.

onboardingIdstring or null

The id that is returned during a successful create an onboarding call.

timestampstring or null

Datetime field indicating when the tier update request was actioned, returned using the standard ISO 8601 format, 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.

rateDetailslist of objects or null

1	import requests
2
3	url = "https://agencyapi.afterpay.com/v1/onboardings/12345769/capabilities/buy-rate"
4
5	payload = {
6	"tier": 3,
7	"gmvCurrencyCode": "USD",
8	"agencyMerchantContractDetails": {
9	"contractId": "785389121238",
10	"contractDate": "2023-09-17T00:00:00.000Z"
11	}
12	}
13	headers = {
14	"Accept": "application/json",
15	"User-Agent": "User-Agent",
16	"Content-Type": "application/json"
17	}
18
19	response = requests.post(url, json=payload, headers=headers)
20
21	print(response.json())

1	{
2	"onboardingId": "123snc-d83jndnv-38djcxnxn",
3	"timestamp": "2023-08-17T21:41:47.341Z",
4	"error": "string",
5	"message": "string",
6	"rateDetails": [
7	{
8	"variableRatePercentage": "5.00",
9	"fixedRate": "0.30",
10	"fixedRateCurrencyCode": "USD",
11	"rateType": "INTRODUCTORY",
12	"durationInMonths": 1,
13	"effectiveFrom": "2023-09-17T21:41:47.341+00:00"
14	}
15	]
16	}

Path Parameters

Headers

Request

Response

Errors