> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.afterpay.com/afterpay-partner-api/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.afterpay.com/_mcp/server. # Afterpay Partner API ## Docs - [](https://developers.afterpay.com/afterpay-online-developer/home.md) - [Introduction](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/welcome/introduction.md) - [Request Signing](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/welcome/request-signing.md) - [Errors](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/welcome/errors.md) - [Onboarding](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/onboarding.md) - [Capabilities](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/capabilities.md) - [Overview](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/rates/overview.md) - [Set Up Default and Tier Rates](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/rates/set-up-default-and-tier-rates.md) - [Set Up Custom Rates](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/rates/set-up-custom-rates.md) - [Overview](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/settlements/overview.md) - [Settlement Contract ID](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/settlements/settlement-contract-id.md) - [Settlement File Schema](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/settlements/settlement-file-schema.md) - [Retrieving Settlement Batch Files](https://developers.afterpay.com/afterpay-partner-api/guides/technical-guides/settlements/retrieving-settlement-batch-files.md) - [Capabilities](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/capabilities.md) - [Channel](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/channel.md) - [Owner](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/owner.md) - [Business](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/business.md) - [Onboarding](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/onboarding.md) - [PostOnboardingResponse](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/post-onboarding-response.md) - [OnboardingPostPut](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/onboarding-post-put.md) - [Lending](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/capabilities/lending.md) - [ProductConfiguration](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/capabilities/product-configuration.md) - [BuyRates](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/buy-rates.md) - [Contract](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/contract.md) - [CustomRate](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/custom-rate.md) - [BaseRate](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/base-rate.md) - [RateObjDuration](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/rate-obj-duration.md) - [RateObjDurationEffectiveFrom](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/rate-obj-duration-effective-from.md) - [User](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/user.md) - [BatchSettlement](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/settlements/batch-settlement.md) - [400Response](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/schemas/400-response.md) - [400Response2](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/schemas/400-response-2.md) - [401Response](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/schemas/401-response.md) - [409Response](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/schemas/409-response.md) - [404Response](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/schemas/404-response.md) - [503Response](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/schemas/503-response.md) ## API Docs - Reference - Partner API > Onboardings [Create an Onboarding](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/create-onboarding.md) - Reference - Partner API > Onboardings [Get an Onboarding by Merchant Reference](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/get-onboarding-by-merchant-reference.md) - Reference - Partner API > Onboardings [Get an Onboarding by Onboarding ID](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/get-onboarding-by-id.md) - Reference - Partner API > Onboardings [Update an Onboarding](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/update-onboarding.md) - Reference - Partner API > Onboardings [Get Activations](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/onboardings/get-onboarding-status.md) - Reference - Partner API > Capabilities [Get Capabilities](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/capabilities/get-capabilities.md) - Reference - Partner API > Capabilities [Enable or Disable Payment Method](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/capabilities/update-pm-capabilities.md) - Reference - Partner API > Capabilities [Enable or Disable Cross Border Trade](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/capabilities/configure-cbt.md) - Reference - Partner API > Rates [Approve Contract](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/review-contract.md) - Reference - Partner API > Rates [Approve Custom Rate](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/review-custom-rate.md) - Reference - Partner API > Rates [Update Tier](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/update-rate.md) - Reference - Partner API > Rates [Get Contract](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/get-contract.md) - Reference - Partner API > Rates [Get Custom Rate](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/get-custom-rate.md) - Reference - Partner API > Rates [Event: custom-rate.created](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/custom-rate-created.md) - Reference - Partner API > Settlements [Get Settlement Batches](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/settlements/get-settlement-batches.md) - Reference - Partner API > Settlements [Get Settlement Batches by Date](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/settlements/get-settlement-batches-by-date.md) - Reference - Partner API > Settlements [Get Settlement Batch Files](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/settlements/get-settlement-batch-files.md) - Reference - Partner API > Rates [Event: rates-contract.created](https://developers.afterpay.com/afterpay-partner-api/api-reference/reference-partner-api/rates/contract-created.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.afterpay.com/afterpay-partner-api/openapi.json) - [OpenAPI YAML](https://developers.afterpay.com/afterpay-partner-api/openapi.yaml)