For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference - Partner API
      • POSTEvent: rates-contract.created
LogoLogo
Reference - Partner APIRates

Event: rates-contract.created

Payload
1{
2  "contractId": "785389121238",
3  "afterpayUserDetails": {
4    "firstName": "John",
5    "lastName": "Doe",
6    "email": "john.doe@squareup.com"
7  },
8  "status": "APPROVED",
9  "countryCode": "US",
10  "buyRates": {
11    "defaultRates": {
12      "variableRatePercentage": "5.00",
13      "fixedRate": "0.30",
14      "fixedRateCurrencyCode": "USD",
15      "rateType": "INTRODUCTORY"
16    },
17    "tierDetails": [
18      {
19        "tier": 1,
20        "minimumGmv": "0",
21        "maximumGmv": "1000000",
22        "GmvCurrencyCode": "USD",
23        "tieredRates": [
24          {
25            "variableRatePercentage": "3.5",
26            "fixedRate": "0.3",
27            "fixedRateCurrencyCode": "USD",
28            "rateType": "ONGOING"
29          }
30        ]
31      }
32    ]
33  }
34}

When is this event triggered?

This event is created whenever a new rates contract has been created by Afterpay. Partners can review the details of the rates contract and use the Approve Contract endpoint to approve.

Was this page helpful?
Previous
Built with

Payload

The payload of this webhook request is an object.
contractIdstringRequired
The unique ID for the contract between Afterpay and the partner.
afterpayUserDetailsobjectRequired
The info of the Afterpay user who is creating Afterpay's contract request. This info can be made generic or anonymized.
statusstringRequired

Contract status: approved, rejected, or pending

countryCodestringRequired

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

buyRatesobjectRequired

Response

200
any
Return a 200 status to indicate that the data was received successfully.