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
  • Network API
      • GETList payments
      • POSTCreate payment
      • GETRetrieve payment
      • POSTCreate incremental authorization
      • POSTCapture payment
      • POSTVoid payment
      • POSTVoid payment by idempotency key
      • Payment
      • Enrichments
      • POSTEvent: payment.status.updated
  • Customer Request API
  • Management API
LogoLogo
Network APIPayments

Enrichments

Example
1{
2 "initiation": {
3 "actor": "CUSTOMER"
4 },
5 "recurring_series_id": "string",
6 "statement_descriptor": "string",
7 "restricted_categories": [
8 "ALCOHOL"
9 ]
10}
Was this page helpful?
Previous

Event: payment.status.updated

Next
Built with

Response

initiationobjectOptional
If present, provides information about transaction initiation.
recurring_series_idstringOptional1-1024 characters
If present, indicates that this payment is part of a recurring series of payments, such as a subscription. The value should contain a unique identifier for the recurring series that is constant across all of its payments, so it can be used to group them together. Min length: `1` Max length: `1024`
statement_descriptorstringOptional
If present, adds the descriptor as line item on to a customer's payment receipt in their in-app Activity page. The descriptor will be present under the header "On statement as". Statement descriptor requirements vary by platform. If the input for this field exceeds the character limit, it will be truncated to the limit, then suffixed with an ellipsis (...). Min length: `1` Max length: `22`
restricted_categorieslist of enumsOptional
If present, indicates that this payment is associated with one or more restricted categories. Contact the Cash App Pay support team to use this field.
Allowed values: