Cash App Payments API is one of 25 APIs that Cash App publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
18 operations
across 16 paths,
and defines 64 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: https://api.cash.app/network/v1, https://sandbox.api.cash.app/network/v1, https://global-api-sandbox.afterpay.com, https://global-api.afterpay.com.
The identity and technical contract details declared by the specification.
PaymentsPostRequestBodyContentApplicationJsonSchemaPayment
object
Data about the payment to create.
8 properties
4 required
PaymentsPaymentIdAuthorizationsPostRequestBodyContentApplicationJsonSchemaAuthorization
object
Details about the authorization to create.
4 properties
2 required
Payments_create-payment-authorization_Response_201
object
1 property
1 required
Retrieve-paymentRequestNotFoundError
object
1 property
1 required
Payment
object
22 properties
13 required
Payments_void-payment_Response_200
object
1 property
1 required
Payments_capture-payment_Response_200
object
1 property
1 required
IdempotencyKey
string
A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see [Idempotency](/cash-…
Authorization
object
Represents an authorization update for a payment
10 properties
7 required
Create-paymentRequestBadRequestError
object
2 properties
1 required
PaymentStatus
string
The step of the payment processing lifecycle that this payment is currently at. - AUTHORIZED - CAPTURED - VOIDED - DECLINED
AuthorizationStatus
string
The step of the authorization processing lifecycle that this authorization is currently at. Allowed values: - AUTHORIZED - DECLINED
FeeRate
object
A fee rate contains the components of a fee charged by Cash App to partners for a given payment.
2 properties
Payments_void-payment-by-idempotency-key_Response_200
object
1 property
1 required
Error
object
Represents an error encountered during a request to the API.
4 properties
2 required
ErrorResponse
object
1 property
1 required
PaymentEnrichmentsInitiation
object
If present, provides information about transaction initiation.
1 property
1 required
ErrorCategory
string
The high-level reason the error occurred.
Payments_retrieve-payment_Response_200
object
1 property
1 required
PaymentEnrichments
object
Describes optional fields beyond core payment information to supplement payment processing. Enrichments provide additional context about a payment, which can i…
4 properties
PaymentEnrichmentsInitiationActor
string
The party who initiated the payment. - CUSTOMER - MERCHANT
Metadata
object
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…
Create-payment-authorizationRequestBadRequestError
object
2 properties
1 required
PaymentEnrichmentsRestrictedCategoriesItems
string
Currency
string
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. Curren…
Payments_list-payments_Response_200
object
2 properties
1 required
Payments_create-payment_Response_201
object
1 property
PaymentAuthStatus
string
represents the status of the order
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaEvents
object
Event list for for merchant's order. See Events.
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaOpenToCaptureAmount
object
Total amount that can be captured for order. See Money.
list-payments_Response_200
object
4 properties
Payment_2
object
Describes the schema for a (read-only) payment object
11 properties
ShippingCourierPriority
string
SubscriptionInterval
string
Payment-Event
object
Each payment event has a unique ID, creation timestamp, and type (e.g., "AUTHAPPROVED", "AUTHDECLINED"). For "AUTHAPPROVED" events, an expiration timestamp is…
6 properties
Shipping-Courier
object
Essential information for tracking a shipment. The shippedAt key represents the date and time when the item was shipped. This value follows the [ISO 8601 stand…
4 properties
PaymentAuthPaymentState
string
is the current state for capturing payments
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaOriginalAmount
object
Total amount for the order. See Money.
Initiation
object
1 property
1 required
Contact
object
This data model is used for storing an individual's contact information. Mandatory fields such as name, line1, area1, region, postcode, and countryCode help in…
9 properties
6 required
Consumer
object
The consumer data model is used for gathering essential user information. It captures details such as the individual's first name, represented by givenNames, a…
4 properties
1 required
PaymentStatus_2
string
represents the status of the order
Item
object
This data model is used to store crucial product details. The price.amount field represents the unit price of the individual item. The quantity field shows the…
9 properties
3 required
Enrichments
object
2 properties
1 required
Money
object
Object containing amount and currency
2 properties
2 required
AuthorizePayment
object
10 properties
1 required
reverse-payment-by-token_Response_204
object
Empty response body
update-payment-by-order-id_Response_201
object
11 properties
ContactCountryCode
string
V2PaymentsOrderIdCourierPutParametersAccept
string
Discount
object
Discount applied to an order
2 properties
PaymentPaymentState
string
is the current state for capturing payments
Subscription
object
3 properties
Order-Details
object
This comprehensive schema is designed to store an entire transaction's detail, covering crucial aspects like consumer information, billing and shipping details…
7 properties
CreateRefund
object
To guarantee safe retries, the merchant should offer their refund ID or reference, aligning with their internal records Unique values for the requestID and mer…
4 properties
PaymentAuth
object
Describes the schema for a (read-only) payment object
11 properties
InitiationActor
string
The party who initiated the order
Refund
object
To guarantee safe retries, the merchant should offer their refund ID or reference, aligning with their internal records Unique values for the requestID and mer…
6 properties
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaRefunds
object
The refund details for merchant's order. See Refund.
CapturePayment
object
4 properties
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaOrderDetails
object
The order bound to the payment. See Order Details.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cash App publishes across the network.
