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
    • Welcome
  • Product Overview
    • How Cash App Pay Works
    • Cash App Pay on Desktop and POS Devices
    • Cash App Pay on Mobile Devices
  • Partnerships
    • Partner with Cash App Pay
    • Partner Onboarding Requirements
    • Merchant Use Policy
    • Program Rules
  • Technical Guides
    • Cash App Pay Integration Basics
      • Introduction to Cash App Pay APIs
      • Idempotency
      • Pagination
      • Reference IDs
      • Network API
      • Customer Request API
      • Management API
  • Resources
    • Cash App Pay Assets
    • Glossary of Terms
    • Cash App Pay Status
  • Pay Kit SDK
LogoLogo
On this page
  • Requirements
Technical GuidesAPI Fundamentals

Reference IDs

Was this page helpful?
Previous

Network API

Next
Built with

The Cash App Pay API provides a reference_id field on all create, update, and upsert endpoints which can be used by an API client to set its own identifier for the resource. This allows API clients to establish a “link” between their systems and the Cash App Pay API.

All resources support querying by reference_id using “list” endpoints. If you lose the Cash App Pay-provided ID of a resource but have the reference_id from your systems, you can use this functionality to look up the Cash App Pay IDs of each resource.

Requirements

Reference IDs must:

  • Not contain any PII (personally identifiable information)
  • Have between 1 and 1024 characters.

Reference IDs are required for brands and merchants. This prevents duplicate brands and merchants from being onboarded to Cash App Pay.