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
      • POSTApprove Contract
      • POSTApprove Custom Rate
      • POSTUpdate Tier
      • GETGet Contract
      • GETGet Custom Rate
      • BuyRates
      • Contract
      • CustomRate
      • POSTEvent: custom-rate.created
      • BaseRate
      • RateObjDuration
      • RateObjDurationEffectiveFrom
      • User
LogoLogo
Reference - Partner APIRates

Event: custom-rate.created

Payload
1{
2  "customRateId": "712123123556455",
3  "afterpayUserDetails": {
4    "firstName": "John",
5    "lastName": "Doe",
6    "email": "john.doe@squareup.com"
7  },
8  "status": "APPROVED",
9  "customRateType": "MERCHANT",
10  "merchantId": "100405604504",
11  "reference": "ac_advkasdvasfbaadf:US",
12  "rateDetails": {
13    "countryCode": "US",
14    "rates": [
15      {
16        "variableRatePercentage": 4.5,
17        "fixedRate": 0.45,
18        "fixedRateCurrencyCode": "USD",
19        "rateType": "ONGOING"
20      }
21    ]
22  }
23}

When is this event triggered?

This event is created whenever a new custom rate has been created by Afterpay. Partners can review the details of the custom rate and use the Approve Custom Rate endpoint to approve.

Was this page helpful?
Previous

BaseRate

Next
Built with

Payload

The payload of this webhook request is an object.
customRateIdstringRequired
The unique ID for the custom rate 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.
statusenumRequired
The de facto approval field that determines whether the rate request by Afterpay is approved or rejected by the partner.
Allowed values:
customRateTypeenumRequired
Defines whether the custom rate applies to only one seller or applies to multiple sellers under the same platform or brand.
Allowed values:
merchantIdstringRequired

Afterpay merchant id (MID); this will only be available for existing sellers; for new sellers please use the reference field.

referencestringRequired

Seller or brand reference to which the custom rate is being applied; this defines the unique seller or the unique platform or brand and iswill be requested from the partner manually before the custom rate request is created.

rateDetailsobjectRequired

Response

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