The identity and technical contract details declared by the specification.
ConsumerOffersNoPaymentUpfront
object
Information about the no payment upfront feature eligibility
2 properties
2 required
Offer
object
Represents an offer with payment details
8 properties
PaymentAuth
object
Describes the schema for a (read-only) payment object
11 properties
PaymentAuthPaymentState
string
is the current state for capturing payments
PaymentPaymentState
string
is the current state for capturing payments
Payment
object
Describes the schema for a (read-only) payment object
11 properties
GetBillingAgreementRequest
object
Request to retrieve a billing agreement by token
1 property
1 required
Money
object
Object containing amount and currency
2 properties
2 required
RecurringPaymentRequestPaymentMethodType
string
The payment method type
ConsumerOffers
object
Consumer offers
1 property
AgreementApproval
object
Details about the agreement to be created.
2 properties
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
AgreementApprovalType
string
Agreement Type for approval.
Discount
object
Discount applied to an order
2 properties
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
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
PaymentStatus
string
represents the status of the order
CreateAgreementRequest
object
3 properties
1 required
RecurringPaymentRequestEnrichmentsInitiation
object
Describes who initiated the transaction
1 property
AgreementEventResponseType
string
Type of event
RecurringPaymentRequest
object
17 properties
3 required
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
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
BillingAgreementResponse
object
Response type for billing agreements
11 properties
4 required
BillingAgreementAliasResponse
object
Response containing the payment schedule token and its expiry
2 properties
2 required
RecurringPaymentRequestPaymentMethod
object
2 properties
2 required
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
BillingAgreementAliasRequest
object
Request to create an alias for a billing agreement
2 properties
1 required
ContactCountryCode
string
BillingAgreementResponseType
string
Type of agreement
ShippingCourierPriority
string
RecurringPaymentRequestEnrichments
object
1 property
LinkStartResponse
object
Response containing the billing agreement link details
4 properties
4 required
RecurringPaymentRequestMerchant
object
1 property
AgreementEventResponseStatus
string
Status of the agreement at the time of the event
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
PaymentAuthStatus
string
represents the status of the order
BillingAgreementApprovalResponse
object
Response from initiating a billing agreement approval process
3 properties
3 required
LinkStartResponseDeliveryType
string
How the verification code was delivered to the consumer
PaymentSchedule
object
Represents a scheduled payment installment
2 properties
2 required
OfferType
string
Type of the offer
AgreementEventResponse
object
Response type for agreement events
6 properties
CancelBillingAgreementRequest
object
Request to cancel a billing agreement
1 property
1 required
BillingAgreementApprovalRequestMerchant
object
4 properties
2 required
LinkStartRequest
object
Request to start a billing agreement link flow
2 properties
2 required
BillingAgreementResponseStatus
string
Current status of the agreement
OffersResponse
object
Response containing available offers for the consumer
3 properties
OffersRequest
object
Request to retrieve available billing agreement offers
3 properties
3 required
BillingAgreementApprovalRequest
object
Request body for initiating a billing agreement approval process
4 properties
1 required
RecurringPaymentRequestEnrichmentsInitiationActor
string
The actor initiating the transaction. Use MERCHANT when the customer is not present.
CheckoutRequestMerchant
object
4 properties
2 required
get-checkout_Response_200
object
16 properties
2 required
Checkout-Request
object
Individual Checkout
13 properties
2 required
Checkout-Response
object
3 properties
MerchantLimitConsumerLending
object
Returned only when include=consumerlending is requested. Indicates whether consumer lending is enabled for the merchant's online channel and, when enabled, the…
3 properties
MerchantLimitPayByInstallment
object
Returned only when include=paybyinstallment is requested and pay by installment is configured for the merchant. Contains the eligible order amount range for pa…
2 properties
Get-configuration-mappingsRequestForbiddenError
object
4 properties
Get-configurationRequestUnauthorizedError
object
4 properties
Merchant-limit
object
5 properties
Get-configuration-mappingsRequestUnauthorizedError
object
4 properties
ConfigurationMappings
object
2 properties
2 required
upload-file_Response_200
object
3 properties
evidence
object
11 properties
meta
object
4 properties
2 required
DisputeStatus
string
The current state of the dispute. Values depend on how the dispute state machine is modeled.
retrieve-file_Response_200
object
2 properties
DisputeClosingReason
string
A reason indicating how the final decision on the dispute was reached. Recommended possible values listed in Closing Reasons.
DisputeReason
string
The reason for the dispute.
dispute
object
Dispute object
17 properties
13 required
retrieve-dispute_Response_200
object
4 properties
GrantApprovalRequestMerchant
object
4 properties
2 required
GrantStartRequest
object
2 properties
2 required
GrantStartResponse
object
4 properties
4 required
GrantStartResponseDeliveryType
string
How the verification code was delivered to the consumer
GrantStatus
string
Current status of the grant
GrantResponse
object
1 property
1 required
GrantApprovalRequest
object
3 properties
2 required
GrantAliasResponse
object
2 properties
2 required
Grant
object
10 properties
4 required
GrantAliasRequest
object
2 properties
1 required
GrantApprovalResponse
object
3 properties
3 required
GrantType
string
Type of grant
GrantApprovalType
object
Details about the grant to be created.
2 properties
1 required
CreateGrantRequest
object
3 properties
2 required
GrantApprovalTypeType
string
Grant Type for approval.
CashGrantType
string
CASHAPP for all Cash App Pay transactions
RetrieveGrantRequest
object
2 properties
2 required
Retrieve-grantRequestUnauthorizedError
object
4 properties
CashGrantDetails
object
5 properties
5 required
CashGrant
object
Describes a grant provided by Cash App.
4 properties
4 required
CashGrantDetailsCashapp
object
2 properties
2 required
CashGrantDetailsStatus
string
Describes whether or not this grant can be used to perform the action associated with it. If ACTIVE, it can be used to perform the action. If EXPIRED, it may n…
CashGrantIntent
string
Either ONFILE or ONETIME
retrieve-grant_Response_200
object
1 property
1 required
Revoke-grantRequestUnauthorizedError
object
4 properties
revoke-grant_Response_200
object
1 property
1 required
Retrieve-grantRequestForbiddenError
object
4 properties
Revoke-grantRequestForbiddenError
object
4 properties
CreateOrderResponse
object
3 properties
2 required
Initiation
object
1 property
1 required
OrderRequest
object
15 properties
4 required
SubscriptionInterval
string
OrderRequestPaymentScheduleType
string
The payment schedule type for the order.
Enrichments
object
2 properties
1 required
Subscription
object
3 properties
InitiationActor
string
The party who initiated the order
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
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaEvents
object
Event list for for merchant's order. See Events.
CapturePayment
object
4 properties
update-payment-by-order-id_Response_201
object
11 properties
V2PaymentsOrderIdCourierPutParametersAccept
string
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaOriginalAmount
object
Total amount for the order. See Money.
reverse-payment-by-token_Response_204
object
Empty response body
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaOpenToCaptureAmount
object
Total amount that can be captured for order. See Money.
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaOrderDetails
object
The order bound to the payment. See Order Details.
AuthorizePayment
object
10 properties
1 required
V2PaymentsOrderIdPutResponsesContentApplicationJsonSchemaRefunds
object
The refund details for merchant's order. See Refund.
list-payments_Response_200
object
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cash App publishes across the network.