Cash App Network API is one of 19 APIs that Cash App publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Network API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
0 operations
across 0 paths,
and defines 59 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.cash.app/network/v1, https://sandbox.api.cash.app/network/v1.
The identity and technical contract details declared by the specification.
Category
string
The merchant category code associated with the entity. Values are from the [ISO-18245 specification](https://www.iso.org/standard/33365.html).
PaymentEnrichmentsInitiationActor
string
The party who initiated the payment. - CUSTOMER - MERCHANT
WebhooksGrantCreatedPayloadContentApplicationJsonSchemaData
object
Data about the grant that was created.
3 properties
3 required
WebhooksCustomerUpdatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the customer immediately after the customer was updated.
1 property
1 required
WebhooksGrantStatusUpdatedPayloadContentApplicationJsonSchemaData
object
Data about the grant that had a status change.
3 properties
3 required
Payment
object
22 properties
13 required
Country
string
Indicates the country associated with an entity. Values are from the [ISO-3166 Alpha-2](https://www.iso.org/iso-3166-country-codes.html) specification. Current…
WebhooksPaymentStatusUpdatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the payment data immediately after the payment's status changed.
1 property
1 required
Merchant
object
A merchant represents a depository account when processing payments from Cash App customers. Merchants do not have direct access to Cash App, so processed paym…
14 properties
11 required
DisputeSettlementWithholding
string
Indicates if the disputed amount has already been withheld from a settlement or not. Current values: - NOTWITHHELD: The disputed amount has not yet been withhe…
Action
Represents what the client intends to do to a customer if given authorization.
Channel
string
How the customer is expected to interact with the request. - INPERSON: The customer presents or scans a QR code at a physical location to approve the request.…
WebhooksCustomerDeletedPayloadContentApplicationJsonSchemaData
object
Data about the Customer that was deleted.
3 properties
3 required
FeeRate
object
A fee rate contains the components of a fee charged by Cash App to partners for a given payment.
2 properties
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
Customer
object
3 properties
2 required
WebhooksCustomerCreatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the customer immediately after the customer was created.
1 property
1 required
WebhooksDisputeCreatedPayloadContentApplicationJsonSchemaData
object
Data about the dispute that was created.
3 properties
3 required
WebhooksPaymentStatusUpdatedPayloadContentApplicationJsonSchemaData
object
Data about the payment that had a status change.
3 properties
3 required
WebhooksRefundStatusUpdatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the refund immediately after the refund's status changed.
1 property
1 required
RefundStatus
string
The step of the refund processing lifecycle that this refund is currently at. - AUTHORIZED - CAPTURED - VOIDED - DECLINED
MerchantStatus
string
Whether or not this merchant can be used to accept payments or issue refunds. - ACTIVE: The merchant can accept payments or issue refunds. - RISKDISABLED: Cash…
Error
object
Represents an error encountered during a request to the API.
4 properties
2 required
PaymentStatus
string
The step of the payment processing lifecycle that this payment is currently at. - AUTHORIZED - CAPTURED - VOIDED - DECLINED
WebhooksGrantStatusUpdatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the grant immediately after the grant's status changed.
1 property
1 required
Refund
object
13 properties
8 required
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…
WebhooksMerchantStatusUpdatedPayloadContentApplicationJsonSchemaData
object
Data about the merchant that had a status change.
3 properties
3 required
WebhooksDisputeStatusUpdatedPayloadContentApplicationJsonSchemaData
object
Data about the dispute that was updated.
3 properties
3 required
WebhooksCustomerDeletedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the customer immediately after the customer was deleted.
1 property
1 required
GrantType
string
Describes whether this grant can be only be used once (ONETIME) or repeatedly (EXTENDED).
ErrorCategory
string
The high-level reason the error occurred.
OneTimePaymentActionType
string
The type of the action (ONETIMEPAYMENT).
WebhooksCustomerUpdatedPayloadContentApplicationJsonSchemaData
object
Data about the Customer that was updated.
3 properties
3 required
PaymentEnrichmentsRestrictedCategoriesItems
string
OnFileDepositActionType
string
The type of the action (ONFILEDEPOSIT).
WebhooksRefundStatusUpdatedPayloadContentApplicationJsonSchemaData
object
Data about the refund that had a status change.
3 properties
3 required
AuthorizationStatus
string
The step of the authorization processing lifecycle that this authorization is currently at. Allowed values: - AUTHORIZED - DECLINED
OnFilePaymentAction
object
Describes an intent for a client to store a customer's account, allowing a client to create payments or issue refunds for it on a recurring basis.
3 properties
2 required
WebhooksCustomerCreatedPayloadContentApplicationJsonSchemaData
object
Data about the Customer that was created.
3 properties
3 required
OneTimePaymentAction
object
Describes an intent for a client to charge a customer a given amount. Note the following restrictions when using this action: - If no amount is provided to the…
4 properties
2 required
LinkAccountActionType
string
The type of the action (LINKACCOUNT).
WebhooksDisputeCreatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the dispute immediately after the dispute was created.
1 property
1 required
OnFilePaymentActionType
string
The type of the action (ONFILEPAYMENT).
Dispute
object
Represents a dispute initiated by a customer within Cash App or the customer's linked bank
11 properties
9 required
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…
WebhooksDisputeStatusUpdatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the dispute immediately after the dispute's status was updated.
1 property
1 required
Authorization
object
Represents an authorization update for a payment
10 properties
7 required
WebhooksMerchantStatusUpdatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the merchant data immediately after the merchant's status changed.
1 property
1 required
MerchantFeePlans
object
Merchant fee plans contains the IDs of the different fee plans for a merchant. These IDs represent the processing fees that merchants will be charged for proce…
3 properties
GrantStatus
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…
DisputeState
string
The step in the dispute lifecycle that this dispute is currently at: - RESPONSEREQUIRED - NORESPONSEREQUIRED - PROCESSING - ACCEPTED - WON - PARTIALLYWON - LOST
PaymentEnrichmentsInitiation
object
If present, provides information about transaction initiation.
1 property
1 required
Grant
object
Describes a grant that can be used to perform actions specified in a customer request using the Network API.
10 properties
9 required
OnFileDepositAction
object
Describes an intent for a client to deposit funds into the Cash App account balances in perpetuity until the Cash App account revokes the grant.
3 properties
3 required
WebhooksGrantCreatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the grant immediately after the grant was created.
1 property
1 required
DisputeReason
string
4-digit code consisting of 2 letters followed by 2 numbers that indicates why the dispute was created, at a high level. Current values: - FR10: Customer has no…
Address
object
Where this entity is located
6 properties
1 required
LinkAccountAction
object
Describes an intent for a client to manage a customer's merchant profiles in Cash App.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cash App publishes across the network.
