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.
Unique identifier for this authorization issued by Cash App.
Min length: 1 character
Max length: 128 characters
amountintegerRequired>=0
Total authorized amount after this authorization was processed, in the lowest denomination of currency on the payment.
currencyenumRequired
Indicates the country associated with an entity. Values are from the [ISO-4217 Alpha-3](https://www.iso.org/iso-4217-currency-codes.html) specification.
Current values:
- `USD`: United States Dollar
Allowed values:
statusenumRequired
The step of the authorization processing lifecycle that this authorization is currently at.
Allowed values:
- AUTHORIZED
- DECLINED
Allowed values:
created_atstringRequiredformat: "date-time"
When this authorization was created, in RFC 3339 format (UTC).
payment_idstringRequired1-128 characters
ID of the payment associated with this authorization
previous_amountintegerRequired>=0
Total authorized amount before this authorization was requested
reference_idstringOptional1-1024 characters
A user-defined identifier for this authorization, typically used to associate the authorization with a record in an external system.
Min length: 1
Max length: 1024
metadatamap from strings to stringsOptional
Freeform key-value pairs of arbitrary data associated with this resource.
Keys and values must be passed as strings and not contain any personally identifiable information (PII).
Min keys: `0`
Max keys: `50`
> Note: Nested keys are not supported.
decline_errorslist of objectsOptional
If the authorization was declined, it contains a list of the reasons why it was declined.
Min number of items: 1
