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.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • GETGet Configuration
      • GETGet Configuration Mappings
LogoLogo
ReferenceConfiguration

Get Configuration Mappings

GET
/v2/configuration/mappings
GET
/v2/configuration/mappings
$curl https://global-api-sandbox.afterpay.com/v2/configuration/mappings \
> -H "User-Agent: User-Agent" \
> -u "<username>:<password>"
1{
2 "name": "Good Pour Coffee",
3 "externalBrandId": "BRAND_bmxk000ucdrvljq0000yhild"
4}

To set-up Cash App Pay on file, use this endpoint to retrieve your Cash App Pay brand ID.

Was this page helpful?
Previous

Merchant limits

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json
Accept

Response

OK
namestring1-255 characters
Name of the brand to be shown in Cash App next to payments.
externalBrandIdstring

The brand identifier for the Afterpay <> Cash App Pay merchant mapping.

Errors

401
Unauthorized Error
403
Forbidden Error