Regions and Localization

What are regions used for

The Cash App Pay API requires regions in requests to:

• Improve availability by allowing Cash App Pay to run in multiple, independent regions simultaneously without sacrificing consistency
• Reduce latencies by storing data closer to the geographic location of the API client
• Comply with data sovereignty regulations
• Support strongly consistent, idempotent processing of requests in independent regions; see Idempotency for more details

How do I know which region to use?”

The region you pick should be the one closest to where your own services are hosted. For example, if you are hosting your services in the AWS US West (Oregon) region (also known as us-west-2), you would want to pick PDX as the region code, since Portland is the closest city to Oregon.

Data sovereignty laws overrule physical proximity: If you are serving customers in a country with strict data sovereignty laws, you must pass a region code that is associated with a city within that country. This allows Cash App Pay to comply with data sovereignty regulations before any data is associated with a customer, which is important for privacy laws.”,

How do I set the region on a request

Set the X-Region header to one of the supported values to set the region for the request.

X-Region Header

X-Region: PDX

Supported region / IATA airport codes

The following table contains the list of all region / IATA airport codes that will be accepted by the Cash App Pay API in the X-Region header. Other codes will be rejected with an INVALID REGION error (See General Validation Errors INVALID REGION error code)