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

Approve Custom Rate

POST
/v1/custom-rate/:customRateId/review
POST
/v1/custom-rate/:customRateId/review
$curl -X POST https://agencyapi.afterpay.com/v1/custom-rate/123457838/review \
>     -H "Accept: application/json" \
>     -H "User-Agent: User-Agent" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "customRateId": "712123123556455",
>  "userDetails": {
>    "firstName": "John",
>    "lastName": "PSP",
>    "email": "john.psp@psp.com"
>  },
>  "comment": "Approved by X on date Y for reason Z.",
>  "status": "APPROVED",
>  "customRateType": "MERCHANT",
>  "merchantId": "100405604504",
>  "reference": "ac_advkasdvasfbaadf:US",
>  "rateDetails": {
>    "countryCode": "US",
>    "rates": [
>      {
>        "variableRatePercentage": 5,
>        "fixedRate": 0.3,
>        "fixedRateCurrencyCode": "USD",
>        "rateType": "INTRODUCTORY",
>        "durationInMonths": 3
>      }
>    ]
>  }
>}'
1{
2  "timestamp": "2023-08-17T21:41:47.341+00:00",
3  "error": "string",
4  "message": "string",
5  "customRateDetails": {
6    "customRateId": "785389121238",
7    "status": "APPROVED",
8    "customRateType": "MERCHANT",
9    "reference": "ac_advkasdvasfbaadf:US",
10    "effectiveFrom": "2023-08-17T21:41:47.341+00:00"
11  }
12}

Partners can set up a unique, custom buy-rate for a unique managed seller, such as enterprise, mid-market, or a platform. To set up a custom rate, Afterpay teams will create a custom rate via internal Afterpay tooling.

Was this page helpful?
Previous

Update Tier

Next
Built with

Path parameters

customRateIdstringRequired
ID of the custom rate to approve

Headers

User-AgentstringRequired
AcceptstringRequiredDefaults to application/json
Specifies media types that are acceptable for the response.

Request

This endpoint expects an object.
customRateIdstringRequired
The unique ID for the custom rate between Afterpay and the partner.
userDetailsobjectRequired
commentstringRequired
Comment specific to the custom rate request.
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

Custom rate reviewed successfully
timestampstring

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

errorstring
Shows any errors encountered on the response to the contract approval call.
messagestring
Any message that may be attached to the response.
customRateDetailsobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
503
Service Unavailable Error