{"openapi":"3.1.0","info":{"title":"Network API","version":"1.0.0"},"paths":{"/brands":{"get":{"operationId":"list-brands","summary":"List brands","description":"Returns a list of brands matching the given query parameters.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `BRANDS_READ`","tags":["brands"],"parameters":[{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of brands to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"reference_id","in":"query","description":"Filters results to only include brands with a `reference_id` matching the given value.","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brands_list-brands_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create-brand","summary":"Create brand","description":"Creates a new brand with the given attributes.\n\n**This endpoint is not rate limited.**\n\nScopes: `BRANDS_WRITE`","tags":["brands"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brands_create-brand_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"brand":{"$ref":"#/components/schemas/BrandsPostRequestBodyContentApplicationJsonSchemaBrand","description":"Details about the brand to create."}},"required":["idempotency_key","brand"]}}}}},"put":{"operationId":"upsert-brand","summary":"Upsert brand","description":"Creates or updates a brand based on the brand's `reference_id`.\n\nIf a brand with a matching `reference_id` is found, \nit will be updated. Ensure proper mapping; if no matching brand is found, \na new one will be created. \n\nThe HTTP response code (`200 OK` or `201 Created`) indicates\nwhether the resource was updated or created, respectively.\n\n<Note>\n\n `brand_id` is the primary unique identifier for all Brand APIs.\n Be cautious when using `reference_id` as a unique identifier. \n</Note>\n\n**This endpoint is not rate limited.**\n\nScopes: `BRANDS_WRITE`","tags":["brands"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brands_upsert-brand_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"$ref":"#/components/schemas/BrandsPutRequestBodyContentApplicationJsonSchemaBrand","description":"Details about the brand to create or update."}},"required":["brand"]}}}}}},"/brands/{brand_id}":{"get":{"operationId":"retrieve-brand","summary":"Retrieve brand","description":"Returns a brand matching the given `brand_id`.\n\n**This endpoint is not rate limited.**\n\nScopes: `BRANDS_READ`","tags":["brands"],"parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brands_retrieve-brand_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"operationId":"update-brand","summary":"Update brand","description":"Updates a brand matching the provided `brand_id` with the given attributes.\n\nTo clear a field, set it to `null`. Fields that are not provided in the request will not be changed.\n\n**This endpoint is not rate limited.**\n\nScopes: `BRANDS_WRITE`","tags":["brands"],"parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brands_update-brand_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"$ref":"#/components/schemas/BrandsBrandIdPatchRequestBodyContentApplicationJsonSchemaBrand","description":"Details about the brand to update"}},"required":["brand"]}}}}}},"/merchants":{"get":{"operationId":"list-merchants","summary":"List merchants","description":"Returns a list of merchants matching the given query parameters.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `MERCHANTS_READ`","tags":["merchants"],"parameters":[{"name":"reference_id","in":"query","description":"Filters results to only include merchants with a `reference_id` matching the given value.","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of merchants to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchants_list-merchants_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List-merchantsRequestBadRequestError"}}}}}},"post":{"operationId":"create-merchant","summary":"Create merchant","description":"Creates a new merchant. Merchants must have an `address` or `site_url` set.\n\n**This endpoint is not rate limited.**\n\nScopes: `MERCHANTS_WRITE`","tags":["merchants"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchants_create-merchant_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"merchant":{"$ref":"#/components/schemas/MerchantsPostRequestBodyContentApplicationJsonSchemaMerchant","description":"Details about the merchant to create."}},"required":["idempotency_key","merchant"]}}}}},"put":{"operationId":"upsert-merchant","summary":"Upsert merchant","description":"Creates or updates a merchant based on the merchant's `reference_id`.\n\nIf a merchant with a matching `reference_id` is found, \nit will be updated. If no matching merchant is found,\na new one will be created.\n\nThe HTTP response code (`200 OK` or `201 Created`) indicates\nwhether the resource was updated or created, respectively.\n\n<Info>\n\n `merchant_id` is the primary unique identifier for all Merchant APIs.\n Be cautious when using `reference_id` as a unique identifier.\n \n Merchants must have an `address` or `site_url` set.\n</Info>  \n\n**This endpoint is not rate limited.**\n\nScopes: `MERCHANTS_WRITE`","tags":["merchants"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchants_upsert-merchant_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/MerchantsPutRequestBodyContentApplicationJsonSchemaMerchant","description":"Details about the merchant to create or update."}},"required":["merchant"]}}}}}},"/merchants/{merchant_id}":{"get":{"operationId":"retrieve-merchant","summary":"Retrieve merchant","description":"Returns a merchant matching the given `merchant_id`.\n\n**This endpoint is not rate limited.**\n\nScopes: `MERCHANTS_READ`","tags":["merchants"],"parameters":[{"name":"merchant_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchants_retrieve-merchant_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"operationId":"update-merchant","summary":"Update merchant","description":"Updates a merchant matching the provided `merchant_id` with the given attributes.\n\nTo clear a field, set it to `null`. Fields that are not provided in the request will not be changed.\n\n**This endpoint is not rate limited.**\n\nScopes: `MERCHANTS_WRITE`","tags":["merchants"],"parameters":[{"name":"merchant_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Merchants_update-merchant_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/MerchantsMerchantIdPatchRequestBodyContentApplicationJsonSchemaMerchant","description":"Details about the merchant to update."}},"required":["merchant"]}}}}}},"/customers":{"get":{"operationId":"list-customers","summary":"List customers","description":"Returns a list of all customers matching the given query parameters who have ever authorized this client to take an action on their account.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `CUSTOMERS_READ`","tags":["customers"],"parameters":[{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of customers to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"cashtag","in":"query","description":"Filters results to only include customers with a matching Cashtag.","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customers_list-customers_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/customers/{customer_id}":{"get":{"operationId":"retrieve-customer","summary":"Retrieve customer","description":"Retrieves a customer by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `CUSTOMERS_READ`","tags":["customers"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customers_retrieve-customer_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/customers/{customer_id}/grants/{grant_id}":{"get":{"operationId":"retrieve-customer-grant","summary":"Retrieve customer grant","description":"Retrieves a customer grant by the ID of the customer that approved it and its own ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `GRANTS_READ`","tags":["customers"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"grant_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customers_retrieve-customer-grant_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/customers/{customer_id}/grants":{"get":{"operationId":"list-customer-grants","summary":"List customer grants","description":"Returns a list of all customer grants for a given customer that match the provided query parameters.\n\n**This endpoint is rate limited to 250 QPS.**\n\nScopes: `GRANTS_READ`","tags":["customers"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of customer grants to return","required":false,"schema":{"type":"integer","default":50}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customers_list-customer-grants_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/customers/{customer_id}/grants/{grant_id}/revoke":{"post":{"operationId":"revoke-customer-grant","summary":"Revoke customer grant","description":"Revokes a customer grant, rendering it unusable. Other endpoints will no longer be able to use the grant to perform its associated action.\n\n<Note> \nYou cannot un-revoke a grant. Use with caution.\n</Note>\n\n**This endpoint is not rate limited.**\n\nScopes: `GRANTS_WRITE`","tags":["customers"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"grant_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customers_revoke-customer-grant_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/payments":{"get":{"operationId":"list-payments","summary":"List payments","description":"Returns a list of payments matching the given query parameters.\n\n**This endpoint is rate limited to 100 QPS.**\n\nScopes: `PAYMENTS_READ`","tags":["payments"],"parameters":[{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"reference_id","in":"query","description":"Filters results to only include payments with a `reference_id` matching the given value.","required":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"Filters results to only include payments made by a customer that matches the the given ID.","required":false,"schema":{"type":"string"}},{"name":"merchant_id","in":"query","description":"Filters results to only include payments made to a merchant that matches the the given ID.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of payments to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_list-payments_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create-payment","summary":"Create payment","description":"Creates a payment from a customer to a merchant.\n\n\n<Note>\n  Creating a payment requires a grant that is associated with the `ON_FILE_PAYMENT` or `ONE_TIME_PAYMENT` actions. To generate a grant, use the Customer Request API.\n</Note>\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_WRITE`","tags":["payments"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_create-payment_Response_201"}}}},"400":{"description":"Bad Request\n\nIf a `PAYMENT_DECLINE_*` error is returned, the payment will still be created, but with a `DECLINED` status. This payment will then appear in the response payload.\n\n<Note> \n**`PAYMENT_DECLINE_*` errors consume one-time use grants.**\n This means you must repeat the Customer Request flow to get a new grant if you want to try taking the payment again. All other errors will not consume grants.\n</Note>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create-paymentRequestBadRequestError"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"payment":{"$ref":"#/components/schemas/PaymentsPostRequestBodyContentApplicationJsonSchemaPayment","description":"Data about the payment to create."}},"required":["idempotency_key","payment"]}}}}}},"/payments/{payment_id}":{"get":{"operationId":"retrieve-payment","summary":"Retrieve payment","description":"Retrieves a payment by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_READ`","tags":["payments"],"parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_retrieve-payment_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Retrieve-paymentRequestNotFoundError"}}}}}}},"/payments/{payment_id}/authorizations":{"post":{"operationId":"create-payment-authorization","summary":"Create incremental authorization","description":"Creates an authorization update for a payment. The authorization amount must be greater than or equal to the current authorized amount.\n\nUse this endpoint for incremental authorization instead of overcapturing using the Capture payment endpoint. By creating additional payment authorizations exceeding the current authorized amount, you can request additional funds without risking the original amount being declined.\n\n**This endpoint is not rate limited.** \n\nScopes: `PAYMENTS_WRITE`","tags":["payments"],"parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_create-payment-authorization_Response_201"}}}},"400":{"description":"Bad Request\n\nIf a AUTHORIZATION_DECLINE_* error is returned, the authorization will still be created, but with a DECLINED status. This authorization will then appear in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create-payment-authorizationRequestBadRequestError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"authorization":{"$ref":"#/components/schemas/PaymentsPaymentIdAuthorizationsPostRequestBodyContentApplicationJsonSchemaAuthorization","description":"Details about the authorization to create."}},"required":["idempotency_key","authorization"]}}}}}},"/payments/{payment_id}/capture":{"post":{"operationId":"capture-payment","summary":"Capture payment","description":"Updates a payment with the given amount and finalizes it so that it can be paid out in the next nightly settlement batch.\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_WRITE`","tags":["payments"],"parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_capture-payment_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"amount":{"type":"integer","description":"The amount of money to collect from the customer, in the lowest denomination of currency for the payment.\n\nTo over-capture or under-capture the payment, set this field to a different value from the current payment amount.\n\nMin value: `1`"}},"required":["idempotency_key","amount"]}}}}}},"/payments/{payment_id}/void":{"post":{"operationId":"void-payment","summary":"Void payment","description":"Moves an authorized payment to the voided state and releases the payment authorization from the customer's Cash App account.\n\n<Note> \nYou can only void an authorized payment. If a payment is captured, refund it instead. You cannot void any payment that has had an attempted capture. Authorizations not captured within seven days are automatically voided.\n</Note>\n\nThis endpoint will return a success message if the payment was successfully voided _or_ if the payment was previously voided.\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_WRITE`\n\nPayment voids can be processed synchronously or asynchronously depending on payment type. The majority of voids are made synchronously.","tags":["payments"],"parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_void-payment_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/payments/void-by-idempotency-key":{"post":{"operationId":"void-payment-by-idempotency-key","summary":"Void payment by idempotency key","description":"Moves an authorized payment to the voided state and releases the payment authorization from the customer's Cash App account.\n\n  <Note>\n  You can only void an authorized payment. If a payment is captured, refund the payment instead.\n  \n   You cannot void any payment that has had an attempted capture. Authorizations not captured within seven days are automatically voided.\n  </Note> \n\nThis endpoint will return a success message if the payment was successfully voided _or_ if the payment was previously voided.\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_WRITE`","tags":["payments"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_void-payment-by-idempotency-key_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"type":"string","description":"Idempotency key used in the [create payment](Network-API.v1.yaml/paths/~1payments/post) request for the payment you want to void."}},"required":["idempotency_key"]}}}}}},"/payouts":{"get":{"operationId":"list-payouts","summary":"List payouts","description":"<Warning title=\"Early Access\" icon=\"robot-astromech\">\nPayouts is an **early access** feature. We're actively improving this API based on your feedback.\n\nEarly access features come with some caveats:\n\n* May evolve rapidly, requiring integration updates\n* Not subject to our 10 year version support policy\n* Not subject to SLAs (unless specified in a contract)\n</Warning>\n\nReturns a list of payouts matching the given query parameters.\n\n**This endpoint is rate limited to 100 QPS.**\n\nScopes: `PAYOUTS_READ`","tags":["payouts"],"parameters":[{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"merchant_id","in":"query","description":"Filters results to include only payouts made to a merchant that matches the given ID.","required":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"Filters results to include only payouts made to a customer that matches the given ID.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of payouts to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_list-payouts_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create-payout","summary":"Create payout","description":"<Warning title=\"Early Access\" icon=\"robot-astromech\">\nPayouts is an **early access** feature. We're actively improving this API based on your feedback.\n\nEarly access features come with some caveats:\n\n* May evolve rapidly, requiring integration updates\n* Not subject to our 10 year version support policy\n* Not subject to SLAs (unless specified in a contract)\n</Warning>\n\nCreates a payout to a customer. A payout allows a merchant to send money to a customer's Cash App account.\n\n**This endpoint is not rate-limited.**\n\nScopes: `PAYOUTS_WRITE`","tags":["payouts"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_create-payout_Response_201"}}}},"400":{"description":"Bad Request\n\nIf a `PAYOUT_DECLINE_*` error is returned, the payout will still be created, but with a `DECLINED` status. This payout will then appear in the response payload.\n\n<Note>\n**`PAYOUT_DECLINE_*` errors consume one-time use grants.**\n This means you must repeat the Customer Request flow to get a new grant if you want to try taking the payout again. All other errors will not consume grants.\n </Note>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create-payoutRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"payout":{"$ref":"#/components/schemas/PayoutsPostRequestBodyContentApplicationJsonSchemaPayout","description":"Data about the payout to create."}},"required":["idempotency_key","payout"]}}}}}},"/payouts/{payout_id}":{"get":{"operationId":"retrieve-payout","summary":"Retrieve payout","description":"<Warning title=\"Early Access\" icon=\"robot-astromech\">\nPayouts is an **early access** feature. We're actively improving this API based on your feedback.\n\nEarly access features come with some caveats:\n\n* May evolve rapidly, requiring integration updates\n* Not subject to our 10 year version support policy\n* Not subject to SLAs (unless specified in a contract)\n</Warning>\n\nRetrieves a payout by its ID.\n\n**This endpoint is not rate-limited.**\n\nScopes: `PAYOUTS_READ`","tags":["payouts"],"parameters":[{"name":"payout_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_retrieve-payout_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Retrieve-payoutRequestNotFoundError"}}}}}}},"/balances":{"get":{"operationId":"list-balances","summary":"List balances","description":"<Warning title=\"Beta\" icon=\"robot-astromech\">\nBalances is a **beta** feature. We're actively improving this API based on your feedback.\n</Warning>\n\nReturns a list of balances for a customer matching the given query parameters.\n\nScopes: `BALANCES_READ`","tags":["balances"],"parameters":[{"name":"customer_id","in":"query","description":"ID of the customer whose balances will be listed.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The type of balances to list.","required":true,"schema":{"$ref":"#/components/schemas/BalancesGetParametersType"}},{"name":"grant_id","in":"query","description":"ID of the grant that authorizes reading the customer's balances. This grant is created when a customer approves a `CHECKING_BALANCE` action in the Customer Request API.","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of balances to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balances_list-balances_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/balances/{balance_id}":{"get":{"operationId":"retrieve-balance","summary":"Retrieve balance","description":"<Warning title=\"Beta\" icon=\"robot-astromech\">\nBalances is a **beta** feature. We're actively improving this API based on your feedback.\n</Warning>\n\nRetrieves a balance by its ID.\n\nScopes: `BALANCES_READ`","tags":["balances"],"parameters":[{"name":"balance_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"grant_id","in":"query","description":"ID of the grant that authorizes reading the customer's balances. This grant is created when a customer approves a `CHECKING_BALANCE` action in the Customer Request API.","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balances_retrieve-balance_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Retrieve-balanceRequestNotFoundError"}}}}}}},"/refunds":{"get":{"operationId":"list-refunds","summary":"List refunds","description":"Returns a list of refunds matching the given query parameters.\n\n**This endpoint is rate limited to 100 QPS.**\n\nScopes: `REFUNDS_READ`","tags":["refunds"],"parameters":[{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"reference_id","in":"query","description":"Filters results to only include refunds with a `reference_id` matching the given value.","required":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"Filters results to only include refunds made to a customer that matches the the given ID.","required":false,"schema":{"type":"string"}},{"name":"merchant_id","in":"query","description":"Filters results to only include refunds made by a merchant that matches the given ID.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of refunds to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refunds_list-refunds_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create-refund","summary":"Create refund","description":"Creates a refund from a merchant to a customer.\n\n- To issue a refund, provide a `payment_id` in the request. \n\nThe grant must be associated with the `ON_FILE_PAYMENT` actions.\n\nTo generate a grant to pass to this field, use the Customer Request API.\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_WRITE`","tags":["refunds"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refunds_create-refund_Response_200"}}}},"400":{"description":"Bad Request\n\nIf a `REFUND_DECLINE_*` error is returned, the refund will still be created, but with a `DECLINED` status. This refund will then appear in the response payload.\n\n<Note> \n**`REFUND_DECLINE_*` errors consume one-time use grants.**\n This means you must repeat the Customer Request flow to get a new grant if you want to try issuing\n the refund again. All other errors will not consume grants.\n</Note>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create-refundRequestBadRequestError"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"refund":{"$ref":"#/components/schemas/RefundsPostRequestBodyContentApplicationJsonSchemaRefund","description":"Details about the refund to create."}},"required":["idempotency_key","refund"]}}}}}},"/refunds/{refund_id}":{"get":{"operationId":"retrieve-refund","summary":"Retrieve refund","description":"Retrieves a refund by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_READ`","tags":["refunds"],"parameters":[{"name":"refund_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refunds_retrieve-refund_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/refunds/{refund_id}/capture":{"post":{"operationId":"capture-refund","summary":"Capture refund","description":"Finalizes a refund so that it can be allocated in the next nightly settlement batch.\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_WRITE`","tags":["refunds"],"parameters":[{"name":"refund_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refunds_capture-refund_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"}},"required":["idempotency_key"]}}}}}},"/refunds/{refund_id}/void":{"post":{"operationId":"void-refund","summary":"Void refund","description":"Moves an authorized refund to the voided state and removes the \"pending refund\" screen from a customer's Cash App account.\n\n<Note> \nYou can only void an authorized refund.\n</Note>\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_WRITE`","tags":["refunds"],"parameters":[{"name":"refund_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refunds_void-refund_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/refunds/void-by-idempotency-key":{"post":{"operationId":"void-refund-by-idempotency-key","summary":"Void refund by idempotency key","description":"Moves an authorized refund to the voided state using the idempotency key specified while creating the refund.\n\n<Note> \nYou can only void an authorized refund. If a refund is captured, there is no way to reverse it.\n</Note>\n\nIn rare cases, an issue with an integration, network connectivity, or the Cash App Pay API may cause an API client to end up in a state where a refund is created in Cash App Pay, but the API client doesn't know the ID of the refund. This endpoint allows an API client to void a refund using _only_ the idempotency key to recover from these situations.\n\nIf you don't have the idempotency key or ID of the refund you want to void, you can use the [list refunds](Network-API.v1.yaml/paths/~1refunds/get) endpoint to try to search for the refund you're looking for.\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_WRITE`","tags":["refunds"],"parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refunds_void-refund-by-idempotency-key_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"}},"required":["idempotency_key"]}}}}}},"/disputes":{"get":{"operationId":"list-disputes","summary":"List disputes","description":"Returns a list of all disputes (matching the given query parameters) associated with payments created by this client.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `DISPUTES_READ`","tags":["disputes"],"parameters":[{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of disputes to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"merchant_id","in":"query","description":"Filters results to only include disputes filed against a merchant that matches the the given ID.","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_list-disputes_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/disputes/{dispute_id}":{"get":{"operationId":"retrieve-dispute","summary":"Retrieve dispute","description":"Retrieves a dispute by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_READ`","tags":["disputes"],"parameters":[{"name":"dispute_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_retrieve-dispute_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/disputes/{dispute_id}/accept":{"post":{"operationId":"accept-dispute","summary":"Accept dispute","description":"Resolves a dispute by having the merchant accept responsibility for it. This leads to a \"loss\" of the dispute from the merchant's perspective, and a \"win\" of the dispute from the customer's perspective.\n\n<Note> \nAfter a dispute is accepted, the decision is final; it can never be changed.\n</Note>\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`","tags":["disputes"],"parameters":[{"name":"dispute_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_accept-dispute_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/disputes/{dispute_id}/challenge":{"post":{"operationId":"challenge-dispute","summary":"Challenge dispute","description":"Submits evidence uploaded to this dispute to Cash App Pay for review.\n\nAfter Cash App Pay reviews the dispute, a final decision will be reached and funds will be settled appropriately. If this endpoint is not called by the `response_due_at` timestamp, the merchant will automatically \"lose\" the dispute.\n\n<Info> \nChallenging a dispute does not guarantee that the merchant will \"win\" it. It only means that it will be reviewed, instead of being automatically accepted by the merchant.\n</Info>\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`","tags":["disputes"],"parameters":[{"name":"dispute_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_challenge-dispute_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/disputes/{dispute_id}/evidence":{"get":{"operationId":"list-dispute-evidence","summary":"List dispute evidence","description":"Returns a list of all pieces of evidence associated with the given dispute.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `DISPUTES_READ`","tags":["disputes"],"parameters":[{"name":"dispute_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of pieces of dispute evidence to return","required":false,"schema":{"type":"integer","default":50}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_list-dispute-evidence_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/disputes/{dispute_id}/evidence-text":{"post":{"operationId":"create-dispute-evidence-text","summary":"Create dispute evidence text","description":"Creates a piece of evidence for the given dispute from a blob of plain text, which can then be submitted with the [challenge dispute](Network-API.v1.yaml/paths/~1disputes~1{dispute_id}~1challenge) endpoint.\n\nIf you have more than 500 characters of text to submit as evidence, split it into multiple pieces where possible.\n\n<Note> \nUploading evidence does not challenge the dispute. Make sure to call the [challenge dispute](Network-API.v1.yaml/paths/~1disputes~1{dispute_id}~1challenge) endpoint before the `response_due_at` timestamp, or else the merchant will automatically \"lose\" the dispute.\n</Note>\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`","tags":["disputes"],"parameters":[{"name":"dispute_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_create-dispute-evidence-text_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"evidence":{"$ref":"#/components/schemas/DisputesDisputeIdEvidenceTextPostRequestBodyContentApplicationJsonSchemaEvidence","description":"Details about the evidence to create."}},"required":["idempotency_key","evidence"]}}}}}},"/disputes/{dispute_id}/evidence-file":{"post":{"operationId":"create-dispute-evidence-file","summary":"Create dispute evidence file","description":"Uploads a binary file as a piece of evidence for the given dispute, which can then be submitted with the [challenge dispute](Network-API.v1.yaml/paths/~1disputes~1{dispute_id}~1challenge) endpoint.\n\nThe file must be one of the supported formats, or else it may not be usable to challenge the dispute:\n\n- `JPEG`\n- `HEIC`\n- `HEIF`\n- `PNG`\n- `PDF`\n- `TIFF`\n\n<Note> \nUploading evidence does not challenge the dispute. Make sure to call the [challenge dispute](Network-API.v1.yaml/paths/~1disputes~1{dispute_id}~1challenge) endpoint before the `response_due_at` timestamp, or else the merchant will automatically \"lose\" the dispute.\n</Note>\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`\n\n---\n\n### Example request payload (cURL)\n\nThe following example shows how to make a request to upload a dispute file. There are two \"parts\" of the request:\n\n- `request`, a JSON blob that contains details about the file to upload\n- `file`, which contains the binary data for the file to be uploaded.\n\nUsing `cURL` to make the request, the request would look like the example below. Please refer to documentation for your particular language / framework and `multipart/form-data` requests to see how you should implement it in your own codebase.\n\nPlease refer to [Signing Multipart Requests](https://developers.cash.app/docs/partner/technical-documentation/api-fundamentals/requests/signing-requests) to compute a signature for the request.\n\n```curl\ncurl --request POST 'https://sandbox.api.cash.app/network/v1/disputes/DSPT_ztqn5hd8wmrzjzavmf60pjbzf/evidence-file' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Client CLIENT_ID API_KEY_ID' \\\n--header 'Content-Type: multipart/form-data' \\\n--header 'X-Region: PDX' \\\n--form 'request={\n  \"idempotency_key\": \"e445c3fb-2caa-46fd-b0d3-aa7c7b00ab41\",\n  \"evidence\": {\n    \"category\": \"AUTHORIZATION_DOCUMENTATION\",\n    \"file\": {\n      \"filename\": \"evidence.pdf\",\n      \"content_type\": \"application/pdf\"\n    }\n  }\n}' \\\n--form 'signature=SIGNATURE' \\\n--form 'file=path-to-file.pdf' \n```","tags":["disputes"],"parameters":[{"name":"dispute_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_create-dispute-evidence-file_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequest","description":"JSON-encoded payload describing the contents of the file uploaded"},"file":{"type":"string","format":"binary","description":"Binary file to upload\n\nMin size: `1 byte`\nMax size: `5 megabytes`"}},"required":["request","file"]}}}}}},"/disputes/{dispute_id}/evidence/{evidence_id}":{"delete":{"operationId":"delete-dispute-evidence","summary":"Delete dispute evidence","description":"Deletes a piece of dispute evidence by the ID of the dispute its for and its own ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`","tags":["disputes"],"parameters":[{"name":"dispute_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"evidence_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_delete-dispute-evidence_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"operationId":"retrieve-dispute-evidence","summary":"Retrieve dispute evidence","description":"Retrieves a piece of dispute evidence by the ID of the dispute its for and its own ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_READ`","tags":["disputes"],"parameters":[{"name":"dispute_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"evidence_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disputes_retrieve-dispute-evidence_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/fee-plans/{fee_plan_id}":{"get":{"operationId":"retrieve-fee-plan","summary":"Retrieve Fee Plan","description":"Retrieves a fee plan by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `FEE_PLANS_READ`","tags":["feePlans"],"parameters":[{"name":"fee_plan_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fee Plans_retrieve-fee-plan_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/fee-plans":{"get":{"operationId":"list-fee-plans","summary":"List fee plans","description":"Returns a list of all fee plans (matching the given query parameters) associated with this client.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `FEE_PLANS_READ`","tags":["feePlans"],"parameters":[{"name":"cursor","in":"query","description":"A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of fee plans to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"currency","in":"query","description":"Filters results to only include fee plans that matches the the given currency.","required":false,"schema":{"$ref":"#/components/schemas/Currency"}},{"name":"status","in":"query","description":"Filters results to only include fee plans that matches the the given status.","required":false,"schema":{"$ref":"#/components/schemas/FeePlansGetParametersStatus"}},{"name":"reference_id","in":"query","description":"Filters results to only include the fee plans that match the given reference ID.","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fee Plans_list-fee-plans_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"servers":[{"url":"https://api.cash.app/network/v1","description":"Production"},{"url":"https://sandbox.api.cash.app/network/v1","description":"Sandbox"}],"webhooks":{"merchant-status-updated":{"post":{"operationId":"merchant-status-updated","summary":"Event: merchant.status.updated","description":"**When is this event triggered?**\n\nThis event is created whenever a merchant's status is changed. The status change can be due to do many different things:\n  - An API client-initiated action to disable / enable the merchant\n  - An asynchronous merchant registration process completing, moving the merchant from pending to active\n  - A compliance ban on the merchant, moving them to disabled","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `merchant.status.updated` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksMerchantStatusUpdatedPayloadContentApplicationJsonSchemaData","description":"Data about the merchant that had a status change."}},"required":["type","event_id","created_at","data"]}}}}}},"grant-created":{"post":{"operationId":"grant-created","summary":"Event: grant.created","description":"**When is this event triggered?**\n\nThis event is created whenever a grant is created. This is caused by a customer request being approved.","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `grant.created` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksGrantCreatedPayloadContentApplicationJsonSchemaData","description":"Data about the grant that was created."}},"required":["type","event_id","created_at","data"]}}}}}},"grant-status-updated":{"post":{"operationId":"grant-status-updated","summary":"Event: grant.status.updated","description":"**When is this event triggered?**\n\nThis event is created whenever a grant's status is changed. The status change can be due to a couple different things:\n  - An API client-initiated action to create a payment or revoke a grant (all opertions which consume a one-time use grant)\n  - A customer revoking an extended-use grant","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `grant.status.updated` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksGrantStatusUpdatedPayloadContentApplicationJsonSchemaData","description":"Data about the grant that had a status change."}},"required":["type","event_id","created_at","data"]}}}}}},"customer-created":{"post":{"operationId":"customer-created","summary":"Event: customer.created","description":"**When is this event triggered?**\n\nThis event is created whenever a new Cash App Pay customer is created. A new Cash App Pay customer is created when a Cash App user approves a client's Cash App Pay request for the first time. This event allows clients to detect customers who are using a client's Cash App Pay integration for the first time.","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `customer.created` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksCustomerCreatedPayloadContentApplicationJsonSchemaData","description":"Data about the Customer that was created."}},"required":["type","event_id","created_at","data"]}}}}}},"customer-updated":{"post":{"operationId":"customer-updated","summary":"Event: customer.updated","description":"**When is this event triggered?**\n\nThis event is created whenever a Cash App Pay customer is updated. The `customer.updated` event can be triggered when:\n  - A customer updates their Cashtag.\n  - A customer approves a request with a `customer_metadata.reference_id` attribute. Upon approval of the request, the customer's `reference_id` attribute is updated.\n\n  > **Note:** If the `customer_metadata.reference_id` is the same as the customer's current `reference_id`, the customer will not be updated and the event will not be triggered.","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `customer.updated` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksCustomerUpdatedPayloadContentApplicationJsonSchemaData","description":"Data about the Customer that was updated."}},"required":["type","event_id","created_at","data"]}}}}}},"customer-deleted":{"post":{"operationId":"customer-deleted","summary":"Event: customer.deleted","description":"**When is this event triggered?**\n\nThis event is created whenever a Cash App Pay customer is deleted. The `customer.deleted` event will be triggered when a customer account is deleted by Cash App.","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `customer.deleted` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksCustomerDeletedPayloadContentApplicationJsonSchemaData","description":"Data about the Customer that was deleted."}},"required":["type","event_id","created_at","data"]}}}}}},"payment-status-updated":{"post":{"operationId":"payment-status-updated","summary":"Event: payment.status.updated","description":"**When is this event triggered?**\n\nThis event is created whenever a payment status is changed. The status change can be due to a couple different things:\n  - An API client-initiated action to void or capture the payment\n  - A payment auto-voiding after 7 days of not being captured","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `payment.status.updated` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksPaymentStatusUpdatedPayloadContentApplicationJsonSchemaData","description":"Data about the payment that had a status change."}},"required":["type","event_id","created_at","data"]}}}}}},"refund-status-updated":{"post":{"operationId":"refund-status-updated","summary":"Event: refund.status.updated","description":"**When is this event triggered?**\n\nThis event is created whenever a refund status is changed. The status change can be due to a couple different things:\n  - An API client-initiated action to void or capture the refund\n  - A refund auto-voiding after 7 days of not being captured","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `refund.status.updated` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksRefundStatusUpdatedPayloadContentApplicationJsonSchemaData","description":"Data about the refund that had a status change."}},"required":["type","event_id","created_at","data"]}}}}}},"dispute-created":{"post":{"operationId":"dispute-created","summary":"Event: dispute.created","description":"**When is this event triggered?**\n\nThis event is created whenever a dispute is created. This is caused by a customer filing a dispute concerning a payment collected by a merchant managed by this API client.","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `dispute.created` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksDisputeCreatedPayloadContentApplicationJsonSchemaData","description":"Data about the dispute that was created."}},"required":["type","event_id","created_at","data"]}}}}}},"dispute-status-updated":{"post":{"operationId":"dispute-status-updated","summary":"Event: dispute.status.updated","description":"**When is this event triggered?**\n\nThis event is created whenever a dispute's state is updated. This can be caused by a variety of things:\n  - An API client-driven change where the dispute is accepted or challenged\n  - Cash App Pay making a final decision on a dispute","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Region","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of event that occurred. `dispute.status.updated` for this event."},"event_id":{"type":"string","description":"A unique identifier provided by Cash App for the event."},"created_at":{"type":"string","format":"date-time","description":"When this event occured in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).\n\nThe time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours."},"data":{"$ref":"#/components/schemas/WebhooksDisputeStatusUpdatedPayloadContentApplicationJsonSchemaData","description":"Data about the dispute that was updated."}},"required":["type","event_id","created_at","data"]}}}}}}},"components":{"schemas":{"Metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Freeform key-value pairs of arbitrary data associated with this resource.\n\nKeys and values must be passed as strings and not contain any personally identifiable information (PII).\n\nMin keys: `0`\nMax keys: `50`\n\n\n> Note: Nested keys are not supported.","title":"Metadata"},"Brand":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the brand issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"name":{"type":"string","description":"Name of the brand to be shown in Cash App next to payments.\n\nMin length: `1`\nMax length: `1024`"},"created_at":{"type":"string","format":"date-time","description":"When this brand was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When this brand was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"reference_id":{"type":"string","description":"A user-defined identifier for this brand, typically used to associate the brand with a record in an external system.  Independent from the [merchant reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-merchant#request-body).\n\nMin length: `1`\nMax length: `1024`"},"color":{"type":"string","description":"Primary color associated with this brand and its logo, in 6-digit hex code format (`#f0f0f0`).\n\nMin length: `7`\nMax length: `7`"},"profile_image_url":{"type":"string","format":"uri","default":"https://example.com","description":"URL to the image that should be shown in Cash App next to payments made to this brand, typically the brand's logo.\n\nThe image should be square and be at least 256x256. It must be less than 2MB in filesize.\n\nAcceptable file formats:\n- `.png`\n- `.jpg`\n- `.jpeg`\n\nMin length: `8`\nMax length: `8000`"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["id","name","created_at","updated_at","reference_id"],"description":"A brand is the entity a customer perceives that they are transacting with.","title":"Brand"},"Brands_list-brands_Response_200":{"type":"object","properties":{"brands":{"type":"array","items":{"$ref":"#/components/schemas/Brand"},"description":"List of brands matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["brands"],"title":"Brands_list-brands_Response_200"},"ErrorCategory":{"type":"string","enum":["API_ERROR","AUTHENTICATION_ERROR","BRAND_ERROR","DISPUTE_ERROR","MERCHANT_ERROR","INVALID_REQUEST_ERROR","PAYMENT_PROCESSING_ERROR","RATE_LIMIT_ERROR","WEBHOOK_ERROR","API_KEY_ERROR","GRANT_ERROR"],"description":"The high-level reason the error occurred.","title":"ErrorCategory"},"Error":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/ErrorCategory","description":"The high-level reason the error occurred."},"code":{"type":"string","description":"A unique identifier for the specific type of error that occurred. For more information, see [Error Code Reference](/cash-app-pay-partner-api/guides/technical-guides/api-fundamentals/errors/error-code-reference).\n\nMin length: `1`"},"detail":{"type":"string","description":"Human-readable description of why the error occurred and how to resolve it.\n\nMin length: `1`"},"field":{"type":"string","description":"The field in the request that caused the error, using array and object dot notation.\n\nMin length: `1`"}},"required":["category","code"],"description":"Represents an error encountered during a request to the API.","title":"Error"},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"A list of errors that occurred while processing the request.\n\nMin number of items: `1`"}},"required":["errors"],"title":"ErrorResponse"},"IdempotencyKey":{"type":"string","description":"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-app-pay-partner-api/guides/technical-guides/api-fundamentals/idempotency).","title":"IdempotencyKey"},"BrandsPostRequestBodyContentApplicationJsonSchemaBrand":{"type":"object","properties":{"name":{"type":"string","description":"Name of the brand to be shown in Cash App next to payments.\n\nMin length: `1`\nMax length: `1024`"},"reference_id":{"type":"string","description":"A user-defined identifier for this brand, typically used to associate the brand with a record in an external system.\n\n**Must be unique across all brands. Independent from the [merchant reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-merchant#request-body)**\n\nMin length: `1`\nMax length: `1024`"},"profile_image_url":{"type":"string","format":"uri","description":"URL to the image that should be shown in Cash App next to payments made to this brand, typically the brand's logo.\n\nThe image should be square and be at least 256x256. It must be less than 2MB in filesize.\n\nAcceptable image formats:\n- `png`\n- `jpg`\n- `jpeg`\n\nMin length: `8`\nMax length: `8000`"},"color":{"type":"string","description":"Primary color associated with this brand and its logo, in 6-digit hex code format.\n\nPattern: `^#[a-fA-F0-9]{6}$`\nMin length: `7`\nMax length: `7`"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["name","reference_id"],"description":"Details about the brand to create.","title":"BrandsPostRequestBodyContentApplicationJsonSchemaBrand"},"Brands_create-brand_Response_201":{"type":"object","properties":{"brand":{"$ref":"#/components/schemas/Brand"}},"title":"Brands_create-brand_Response_201"},"BrandsPutRequestBodyContentApplicationJsonSchemaBrand":{"type":"object","properties":{"name":{"type":"string","description":"Name of the brand to be shown in Cash App next to payments.\n\nMin length: `1`\nMax length: `1024`"},"reference_id":{"type":"string","description":"A user-defined identifier for this brand, typically used to associate the brand with a record in an external system.\n\n**Must be unique across all brands.  Independent from the [merchant reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-merchant#request-body)**\n\nMin length: `1`\nMax length: `1024`"},"profile_image_url":{"type":"string","format":"uri","description":"URL to the image that should be shown in Cash App next to payments made to this brand, typically the brand's logo.\n\nThe image should be square and be at least 256x256. It must be less than 2MB in filesize.\n\nAcceptable image formats:\n- `png`\n- `jpg`\n- `jpeg`\n\nMin length: `8`\nMax length: `8000`"},"color":{"type":"string","description":"Primary color associated with this brand and its logo, in 6-digit hex code format.\n\nPattern: `^#[a-fA-F0-9]{6}$`\nMin length: `7`\nMax length: `7`"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["name","reference_id"],"description":"Details about the brand to create or update.","title":"BrandsPutRequestBodyContentApplicationJsonSchemaBrand"},"Brands_upsert-brand_Response_200":{"type":"object","properties":{"brand":{"$ref":"#/components/schemas/Brand"}},"title":"Brands_upsert-brand_Response_200"},"Brands_retrieve-brand_Response_200":{"type":"object","properties":{"brand":{"$ref":"#/components/schemas/Brand"}},"required":["brand"],"title":"Brands_retrieve-brand_Response_200"},"BrandsBrandIdPatchRequestBodyContentApplicationJsonSchemaBrand":{"type":"object","properties":{"name":{"type":"string","description":"Name of the brand to be shown in Cash App next to payments.\n\n*This field cannot be cleared.*\n\nMin length: `1`\nMax length: `1024`"},"reference_id":{"type":"string","description":"A user-defined identifier for this brand, typically used to associate the brand with a record in an external system.  Independent from the [merchant reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-merchant#request-body).\n\n*This field cannot be cleared, and must be unique across all brands.*\n\nMin length: `1`\nMax length: `1024`"},"profile_image_url":{"type":"string","format":"uri","description":"URL to the image that should be shown in Cash App next to payments made to this brand, typically the brand's logo.\n\nThe image should be square and be at least 256x256. It must be less than 2MB in filesize.\n\nAcceptable image formats:\n- `png`\n- `jpg`\n- `jpeg`\n\n*This field cannot be cleared.*\n\nMin length: `8`\nMax length: `8000`"},"color":{"type":["string","null"],"description":"Primary color associated with this brand and its logo, in 6-digit hex code format.\n\nPattern: `^#[a-fA-F0-9]{6}$`\nMin length: `7`\nMax length: `7`"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"description":"Details about the brand to update","title":"BrandsBrandIdPatchRequestBodyContentApplicationJsonSchemaBrand"},"Brands_update-brand_Response_200":{"type":"object","properties":{"brand":{"$ref":"#/components/schemas/Brand"}},"title":"Brands_update-brand_Response_200"},"Country":{"type":"string","enum":["US"],"description":"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.\n\nCurrent values:\n\n- `US`: United States of America","title":"Country"},"Currency":{"type":"string","enum":["USD"],"description":"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.\n\nCurrent values:\n\n- `USD`: United States Dollar","title":"Currency"},"Category":{"type":"string","description":"The merchant category code associated with the entity. Values are from the [ISO-18245 specification](https://www.iso.org/standard/33365.html).","title":"Category"},"MerchantStatus":{"type":"string","enum":["ACTIVE","RISK_DISABLED","COMPLIANCE_DISABLED","CLIENT_DISABLED","PENDING"],"description":"Whether or not this merchant can be used to accept payments or issue refunds.\n\n- `ACTIVE`: The merchant can accept payments or issue refunds.\n- `RISK_DISABLED`: Cash App Pay blocked this merchant due to them being high risk. There is no way to re-enable them programmaticaly.\n- `COMPLIANCE_DISABLED`: Cash App Pay blocked this merchant due to them not following the terms of service, Program Rules, or local laws. There is no way to re-enable them programmaticaly.\n- `CLIENT_DISABLED`: The client called the [UpdateMerchant](Network-API.v1.yaml/paths/~1merchants~1{merchant_id}/patch) endpoint and disabled this merchant, preventing it from being able to handle payments or refunds. To reverse this, call the endpoint again with the status field set to `ACTIVE`.\n- `PENDING`: The merchant is not ready to accept payments or refunds yet; the registration process is still running.","title":"MerchantStatus"},"Address":{"type":"object","properties":{"address_line_1":{"type":"string","description":"First line of the street address, typically including street number, street name, and / or building name.\n\nMin length: `1`\nMax length: `1024`"},"address_line_2":{"type":"string","description":"Second line of the address, if any.\n\nMin length: `1`\nMax length: `1024`"},"locality":{"type":"string","description":"City or township where the entity is located.\n\nMin length: `1`\nMax length: `1024`"},"country":{"$ref":"#/components/schemas/Country"},"postal_code":{"type":"string","description":"ZIP or postal code.\n\nMin length: `1`\nMax length: `128`"},"administrative_district_level_1":{"type":"string","description":"State or province.\n\nMin length: `1`\nMax length: `1024`"}},"required":["country"],"description":"Where this entity is located","title":"Address"},"MerchantFeePlans":{"type":"object","properties":{"in_app_fee_plan_id":{"type":"string","description":"The fee plan ID identifying the fee plan that will be used for all in-app payments."},"in_person_fee_plan_id":{"type":"string","description":"The fee plan ID identifying the fee plan that will be used for all in-person payments."},"online_fee_plan_id":{"type":"string","description":"The fee plan ID identifying the fee plan that will be used for all online payments."}},"description":"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 processing payments for each channel. You can use the Fee Plans API to get all the fee information for each fee plan.","title":"MerchantFeePlans"},"Merchant":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the merchant issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"brand_id":{"type":"string","description":"ID of the brand associated with this merchant.\n\nMin length: `1`\nMax length: `128`"},"name":{"type":"string","description":"The name of the individual or business entity associated with the merchant.\n\nMin length: `1`\nMax length: `1024`"},"country":{"$ref":"#/components/schemas/Country"},"currency":{"$ref":"#/components/schemas/Currency"},"category":{"$ref":"#/components/schemas/Category"},"reference_id":{"type":"string","description":"A user-defined identifier for this merchant, typically used to associate the merchant with a record in an external system. Independent from the [brand reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-brand#request-body).\n\nMin length: `1`\nMax length: `1024`"},"status":{"$ref":"#/components/schemas/MerchantStatus","description":"Whether or not this merchant can be used to accept payments or issue refunds.\n\n- `ACTIVE`: The merchant can accept payments or issue refunds.\n- `RISK_DISABLED`: Cash App Pay blocked this merchant due to them being high risk. There is no way to re-enable them programmaticaly.\n- `COMPLIANCE_DISABLED`: Cash App Pay blocked this merchant due to them not following the terms of service, Program Rules, or local laws. There is no way to re-enable them programmaticaly.\n- `CLIENT_DISABLED`: The client called the [UpdateMerchant](Network-API.v1.yaml/paths/~1merchants~1{merchant_id}/patch) endpoint and disabled this merchant, preventing it from being able to handle payments or refunds. To reverse this, call the endpoint again with the status field set to `ACTIVE`.\n- `PENDING`: The merchant is not ready to accept payments or refunds yet; the registration process is still running."},"created_at":{"type":"string","format":"date-time","description":"When this merchant was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When this merchant was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"address":{"$ref":"#/components/schemas/Address"},"site_url":{"type":"string","format":"uri","description":"The URL of the website, if this merchant is for an eCommerce site.\n\nMin length: `8`\nMax length: `8000`"},"metadata":{"$ref":"#/components/schemas/Metadata"},"default_fee_plans":{"$ref":"#/components/schemas/MerchantFeePlans"}},"required":["id","brand_id","name","country","currency","category","reference_id","status","created_at","updated_at","address"],"description":"A merchant represents a depository account when processing payments from Cash App customers. Merchants do not have direct access to Cash App, so processed payments are stored in this account until they are ready for settlement.","title":"Merchant"},"Merchants_list-merchants_Response_200":{"type":"object","properties":{"merchants":{"type":"array","items":{"$ref":"#/components/schemas/Merchant"},"description":"List of merchants matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["merchants"],"title":"Merchants_list-merchants_Response_200"},"List-merchantsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}},"required":["errors"],"title":"List-merchantsRequestBadRequestError"},"MerchantsPostRequestBodyContentApplicationJsonSchemaMerchant":{"type":"object","properties":{"name":{"type":"string","description":"The name of the individual or business entity associated with the merchant.\n\nMin length: `1`\nMax length: `1024`"},"brand_id":{"type":"string","description":"ID of the brand associated with this merchant.\n\nMin length: `1`\nMax length: `128`\n"},"country":{"$ref":"#/components/schemas/Country"},"currency":{"$ref":"#/components/schemas/Currency"},"category":{"$ref":"#/components/schemas/Category"},"reference_id":{"type":"string","description":"A user-defined identifier for this merchant, typically used to associate the merchant with a record in an external system.\n\n**Must be unique across all merchants. Independent from the [brand reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-brand#request-body)**\n\nMin length: `1`\nMax length: `1024`"},"address":{"$ref":"#/components/schemas/Address"},"site_url":{"type":"string","format":"uri","description":"The URL of the website, if this merchant is for an eCommerce site.\n\nMin length: `8`\nMax length: `8000`"},"metadata":{"$ref":"#/components/schemas/Metadata"},"default_fee_plans":{"$ref":"#/components/schemas/MerchantFeePlans"}},"required":["name","brand_id","country","currency","category","reference_id","address"],"description":"Details about the merchant to create.","title":"MerchantsPostRequestBodyContentApplicationJsonSchemaMerchant"},"Merchants_create-merchant_Response_201":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"}},"required":["merchant"],"title":"Merchants_create-merchant_Response_201"},"MerchantsPutRequestBodyContentApplicationJsonSchemaMerchant":{"type":"object","properties":{"name":{"type":"string","description":"The name of the individual or business entity associated with the merchant.\n\nMin length: `1`\nMax length: `1024`"},"brand_id":{"type":"string","description":"ID of the brand associated with this merchant.\n\nMin length: `1`\nMax length: `128`"},"country":{"$ref":"#/components/schemas/Country"},"currency":{"$ref":"#/components/schemas/Currency"},"category":{"$ref":"#/components/schemas/Category"},"reference_id":{"type":"string","description":"A user-defined identifier for this merchant, typically used to associate the merchant with a record in an external system.\n\n**Must be unique across all merchants. Independent from the [brand reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-brand#request-body).**\n\nMin length: `1`\nMax length: `1024`"},"address":{"$ref":"#/components/schemas/Address"},"site_url":{"type":"string","format":"uri","description":"The URL of the website, if this merchant is for an eCommerce site.\n\nMin length: `8`\nMax length: `8000`"},"metadata":{"$ref":"#/components/schemas/Metadata"},"default_fee_plans":{"$ref":"#/components/schemas/MerchantFeePlans"}},"required":["name","brand_id","country","currency","category","reference_id","address"],"description":"Details about the merchant to create or update.","title":"MerchantsPutRequestBodyContentApplicationJsonSchemaMerchant"},"Merchants_upsert-merchant_Response_200":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"}},"required":["merchant"],"title":"Merchants_upsert-merchant_Response_200"},"Merchants_retrieve-merchant_Response_200":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"}},"required":["merchant"],"title":"Merchants_retrieve-merchant_Response_200"},"MerchantsMerchantIdPatchRequestBodyContentApplicationJsonSchemaMerchantStatus":{"type":"string","enum":["ACTIVE","CLIENT_DISABLED"],"description":"Whether or not this merchant can be used to accept payments or issue refunds.\n\n**Note:** when the value is `PENDING`, `COMPLIANCE_DISABLED`, or `RISK_DISABLED`, the status of the merchant cannot be changed.\n\nCurrent values:\n- `ACTIVE`: The merchant can accept payments and issue refunds.\n- `CLIENT_DISABLED`: The merchant has been disabled by the API client, and may be re-enabled by the API client at any time.","title":"MerchantsMerchantIdPatchRequestBodyContentApplicationJsonSchemaMerchantStatus"},"MerchantsMerchantIdPatchRequestBodyContentApplicationJsonSchemaMerchant":{"type":"object","properties":{"brand_id":{"type":"string","description":"ID of the brand associated with this merchant.\n\n*This field cannot be cleared.*\n\nMin length: `1`\nMax length: `128`"},"category":{"$ref":"#/components/schemas/Category"},"country":{"$ref":"#/components/schemas/Country"},"currency":{"$ref":"#/components/schemas/Currency"},"name":{"type":"string","description":"The name of the individual or business entity associated with the merchant.\n\n*This field cannot be cleared.*\n\nMin length: `1`\nMax length: `1024`"},"reference_id":{"type":"string","description":"A user-defined identifier for this merchant, typically used to associate the merchant with a record in an external system. Independent from the [brand reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-brand#request-body).\n\n*This field cannot be cleared, and must be unique across all merchants.*\n\nMin length: `1`\nMax length: `1024`"},"address":{"$ref":"#/components/schemas/Address"},"site_url":{"type":["string","null"],"format":"uri","description":"The URL of the website, if this merchant is an eCommerce site.\n\nMin length: `8`\nMax length: `8000`"},"status":{"$ref":"#/components/schemas/MerchantsMerchantIdPatchRequestBodyContentApplicationJsonSchemaMerchantStatus","description":"Whether or not this merchant can be used to accept payments or issue refunds.\n\n**Note:** when the value is `PENDING`, `COMPLIANCE_DISABLED`, or `RISK_DISABLED`, the status of the merchant cannot be changed.\n\nCurrent values:\n- `ACTIVE`: The merchant can accept payments and issue refunds.\n- `CLIENT_DISABLED`: The merchant has been disabled by the API client, and may be re-enabled by the API client at any time."},"metadata":{"$ref":"#/components/schemas/Metadata"},"default_fee_plans":{"$ref":"#/components/schemas/MerchantFeePlans"}},"description":"Details about the merchant to update.","title":"MerchantsMerchantIdPatchRequestBodyContentApplicationJsonSchemaMerchant"},"Merchants_update-merchant_Response_200":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"}},"title":"Merchants_update-merchant_Response_200"},"Customer":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this customer issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"cashtag":{"type":"string","description":"Public identifier for the customer on Cash App. [Learn more](https://cash.app/help/us/en-us/3123-cashtags).\n\nMin length: `1`\nMax length: `1024`"},"reference_id":{"type":"string","description":"A user-defined identifier for this customer, typically used to associate the customer with a record in an external system. This value can be provided via the `CustomerRequest.customer_metadata.reference_id` attribute. Upon approval of the CustomerRequest, a corresponding customer resource is created with the `reference_id` attribute."}},"required":["id","cashtag"],"title":"Customer"},"Customers_list-customers_Response_200":{"type":"object","properties":{"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"},"description":"List of customers matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["customers"],"title":"Customers_list-customers_Response_200"},"Customers_retrieve-customer_Response_200":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"}},"required":["customer"],"title":"Customers_retrieve-customer_Response_200"},"OneTimePaymentActionType":{"type":"string","enum":["ONE_TIME_PAYMENT"],"description":"The type of the action (`ONE_TIME_PAYMENT`).","title":"OneTimePaymentActionType"},"OneTimePaymentAction":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount to charge the customer, in the lowest unit of the associated currency.\n\nMin value: `1`"},"currency":{"$ref":"#/components/schemas/Currency"},"scope_id":{"type":"string","description":"ID of the client, brand, or merchant that will charge the customer.\n\nIf a client ID is passed, the grant from this action can be used to create a payment for any merchant owned by the client.\n\nIf a brand ID is passed, the grant from this action can be used to create a payment for any merchant that has a matching brand ID.\n\nIf a merchant ID is passed, the grant from this action can be used to create a payment for the merchant with a matching ID.\n\nMin length: `1`\nMax length: `128`"},"type":{"$ref":"#/components/schemas/OneTimePaymentActionType","description":"The type of the action (`ONE_TIME_PAYMENT`)."}},"required":["scope_id","type"],"description":"Describes an intent for a client to charge a customer a given amount.\n\nNote the following restrictions when using this action:\n\n- If no amount is provided to the action, the payment charged may be **any** amount.\n- If `amount` is provided, `currency` must be provided too (and vice versa).","title":"OneTimePaymentAction"},"OnFilePaymentActionType":{"type":"string","enum":["ON_FILE_PAYMENT"],"default":"ON_FILE_PAYMENT","description":"The type of the action (`ON_FILE_PAYMENT`).","title":"OnFilePaymentActionType"},"OnFilePaymentAction":{"type":"object","properties":{"scope_id":{"type":"string","description":"ID of the client or brand that will charge customers.\n\nIf a client ID is passed, the grant from this action can be used to create a payment for any merchant owned by the client.\n\nIf a brand ID is passed, the grant from this action can be used to create a payment for any merchant that has a matching brand ID.\n\nMerchant IDs may *not* be passed.\n\nMin length: `1`\nMax length: `128`"},"type":{"$ref":"#/components/schemas/OnFilePaymentActionType","description":"The type of the action (`ON_FILE_PAYMENT`)."},"account_reference_id":{"type":"string","description":"Identifier of the account or customer associated to the on file action."}},"required":["scope_id","type"],"description":"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.","title":"OnFilePaymentAction"},"OnFileDepositActionType":{"type":"string","enum":["ON_FILE_DEPOSIT"],"description":"The type of the action (`ON_FILE_DEPOSIT`).","title":"OnFileDepositActionType"},"OnFileDepositAction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OnFileDepositActionType","description":"The type of the action (`ON_FILE_DEPOSIT`)."},"scope_id":{"type":"string","description":"ID of the client or brand that indicates the set of merchants that will deposit to customers.\n\nIf a client ID is passed, the grant from this action can be used to create a deposit for any merchant owned by the client.\n\nIf a brand ID is passed, the grant from this action can be used to create a deposit for any merchant that has a matching brand ID.\nMin length: `1`\nMax length: `128`"},"account_reference_id":{"type":"string","description":"Identifier of the account or customer associated to the on file action."}},"required":["type","scope_id","account_reference_id"],"description":"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.","title":"OnFileDepositAction"},"LinkAccountActionType":{"type":"string","enum":["LINK_ACCOUNT"],"description":"The type of the action (`LINK_ACCOUNT`).","title":"LinkAccountActionType"},"LinkAccountAction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/LinkAccountActionType","description":"The type of the action (`LINK_ACCOUNT`)."}},"required":["type"],"description":"Describes an intent for a client to manage a customer's merchant profiles in Cash App.","title":"LinkAccountAction"},"Action":{"oneOf":[{"$ref":"#/components/schemas/OneTimePaymentAction"},{"$ref":"#/components/schemas/OnFilePaymentAction"},{"$ref":"#/components/schemas/OnFileDepositAction"},{"$ref":"#/components/schemas/LinkAccountAction"}],"description":"Represents what the client intends to do to a customer if given authorization.","title":"Action"},"GrantStatus":{"type":"string","enum":["ACTIVE","CONSUMED","REVOKED","EXPIRED"],"description":"Describes whether or not this grant can be used to perform the action associated with it.\n\nIf `ACTIVE`, it can be used to perform the action.\n\nIf `EXPIRED`, it may no longer be used to perform the action due to the current time being past the \"expires_at\" time.\n\nIf `CONSUMED`, it was already redeemed to perform the action and cannot be used again.\n\nIf `REVOKED`, the customer or merchant explicitly unauthorized the grant, preventing it from being used to perform the action.","title":"GrantStatus"},"GrantType":{"type":"string","enum":["ONE_TIME","EXTENDED"],"description":"Describes whether this grant can be only be used once (`ONE_TIME`) or repeatedly (`EXTENDED`).","title":"GrantType"},"Channel":{"type":"string","enum":["IN_PERSON","ONLINE","IN_APP"],"description":"How the customer is expected to interact with the request.\n\n- `IN_PERSON`: The customer presents or scans a QR code at a physical location to approve the request.\n- `ONLINE`: The customer scans a QR code or is redirected to Cash App from a browser context.\n- `IN_APP`: The customer scans a QR code or is redirected to Cash App from a native mobile application context.","title":"Channel"},"Grant":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this grant issued by Cash App.\n\nMin length: `1`\nMax length: `256`"},"customer_id":{"type":"string","description":"ID of the customer that approved this grant.\n\nMin length: `1`\nMax length: `128`"},"request_id":{"type":"string","description":"A unique identifier issued by Cash App for the customer request that resulted in the creation of this grant.\n\nMin length: `1`\nMax length: `128`"},"action":{"$ref":"#/components/schemas/Action"},"status":{"$ref":"#/components/schemas/GrantStatus","description":"Describes whether or not this grant can be used to perform the action associated with it.\n\nIf `ACTIVE`, it can be used to perform the action.\n\nIf `EXPIRED`, it may no longer be used to perform the action due to the current time being past the \"expires_at\" time.\n\nIf `CONSUMED`, it was already redeemed to perform the action and cannot be used again.\n\nIf `REVOKED`, the customer or merchant explicitly unauthorized the grant, preventing it from being used to perform the action."},"type":{"$ref":"#/components/schemas/GrantType","description":"Describes whether this grant can be only be used once (`ONE_TIME`) or repeatedly (`EXTENDED`)."},"channel":{"$ref":"#/components/schemas/Channel"},"created_at":{"type":"string","format":"date-time","description":"When this grant was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When this grant was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"expires_at":{"type":"string","format":"date-time","description":"If present, indicates when the grant's status will become `EXPIRED`, preventing a client from using it to create payments or refunds.\n\nThe timestamp is in the [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."}},"required":["id","customer_id","request_id","action","status","type","channel","created_at","updated_at"],"description":"Describes a grant that can be used to perform actions specified in a customer request using the Network API.","title":"Grant"},"Customers_retrieve-customer-grant_Response_200":{"type":"object","properties":{"grant":{"$ref":"#/components/schemas/Grant"}},"required":["grant"],"title":"Customers_retrieve-customer-grant_Response_200"},"Customers_list-customer-grants_Response_200":{"type":"object","properties":{"grants":{"type":"array","items":{"$ref":"#/components/schemas/Grant"},"description":"List of customer grants matching the given query parameters"},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["grants"],"title":"Customers_list-customer-grants_Response_200"},"Customers_revoke-customer-grant_Response_200":{"type":"object","properties":{"grant":{"$ref":"#/components/schemas/Grant"}},"required":["grant"],"title":"Customers_revoke-customer-grant_Response_200"},"PaymentStatus":{"type":"string","enum":["AUTHORIZED","CAPTURED","VOIDED","DECLINED"],"description":"The step of the payment processing lifecycle that this payment is currently at.\n\n- `AUTHORIZED`\n- `CAPTURED`\n- `VOIDED`\n- `DECLINED`","title":"PaymentStatus"},"PaymentEnrichmentsInitiationActor":{"type":"string","enum":["CUSTOMER","MERCHANT"],"description":"The party who initiated the payment.\n\n- `CUSTOMER`\n- `MERCHANT`","title":"PaymentEnrichmentsInitiationActor"},"PaymentEnrichmentsInitiation":{"type":"object","properties":{"actor":{"$ref":"#/components/schemas/PaymentEnrichmentsInitiationActor","description":"The party who initiated the payment.\n\n- `CUSTOMER`\n- `MERCHANT`"}},"required":["actor"],"description":"If present, provides information about transaction initiation.","title":"PaymentEnrichmentsInitiation"},"PaymentEnrichmentsRestrictedCategoriesItems":{"type":"string","enum":["ALCOHOL","FINANCIAL_SERVICES","CANNABIS"],"title":"PaymentEnrichmentsRestrictedCategoriesItems"},"PaymentEnrichments":{"type":"object","properties":{"initiation":{"$ref":"#/components/schemas/PaymentEnrichmentsInitiation","description":"If present, provides information about transaction initiation."},"recurring_series_id":{"type":"string","description":"If present, indicates that this payment is part of a recurring series of payments, such as a subscription.\n\nThe 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.\n\nMin length: `1`\nMax length: `1024`"},"statement_descriptor":{"type":"string","description":"If present, adds the descriptor as line item on to a customer's payment receipt in their in-app Activity page.\nThe descriptor will be present under the header \"On statement as\".\n\nStatement 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 (...).\n\nMin length: `1`\nMax length: `22`"},"restricted_categories":{"type":"array","items":{"$ref":"#/components/schemas/PaymentEnrichmentsRestrictedCategoriesItems"},"description":"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."}},"description":"Describes optional fields beyond core payment information to supplement payment processing.\n\nEnrichments provide additional context about a payment, which can improve the overall payment experience including, but not limited to: \n  - Increased approval rates\n  - Enhanced transaction insights\n  - Better payment flows in Cash App","title":"PaymentEnrichments"},"FeeRate":{"type":"object","properties":{"basis_points":{"type":"integer","description":"The variable fee charged for processing the payment expressed as 1/100th of a percentage."},"fixed_amount":{"type":"integer","description":"The amount charged for processing the payment, in the lowest denomination of currency on the payment.\n **Note: The currency for the fee is found on the fee plan.**"}},"description":"A fee rate contains the components of a fee charged by Cash App to partners for a given payment.","title":"FeeRate"},"AuthorizationStatus":{"type":"string","enum":["AUTHORIZED","DECLINED"],"description":"The step of the authorization processing lifecycle that this authorization is currently at.\n\nAllowed values:\n- AUTHORIZED\n- DECLINED","title":"AuthorizationStatus"},"Authorization":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this authorization issued by Cash App.\n\nMin length: 1 character\nMax length: 128 characters"},"amount":{"type":"integer","description":"Total authorized amount after this authorization was processed, in the lowest denomination of currency on the payment."},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/AuthorizationStatus","description":"The step of the authorization processing lifecycle that this authorization is currently at.\n\nAllowed values:\n- AUTHORIZED\n- DECLINED"},"created_at":{"type":"string","format":"date-time","description":"When this authorization was created, in RFC 3339 format (UTC)."},"payment_id":{"type":"string","description":"ID of the payment associated with this authorization"},"previous_amount":{"type":"integer","description":"Total authorized amount before this authorization was requested"},"reference_id":{"type":"string","description":"A user-defined identifier for this authorization, typically used to associate the authorization with a record in an external system.\n\nMin length: 1\nMax length: 1024"},"metadata":{"$ref":"#/components/schemas/Metadata"},"decline_errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"If the authorization was declined, it contains a list of the reasons why it was declined.\n\nMin number of items: 1"}},"required":["id","amount","currency","status","created_at","payment_id","previous_amount"],"description":"Represents an authorization update for a payment","title":"Authorization"},"Payment":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this payment issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"amount":{"type":"integer","description":"The amount of money to collect, in the lowest denomination of currency on the payment. This is the _original_ amount authorized when the payment was created.\n\nMin value: `1`"},"net_amount":{"type":"integer","description":"The amount remaining after refunds and voided payments are deducted from the amount field. The amount will be in the lowest denomination of the currency on the payment.\nThis is the amount that will be shown to the customer in their Cash App account.\n\n\nMin value: `0`"},"captured_amount":{"type":"integer","description":"The amount of money on this payment that has been allocated for settlement. The amount will be in the lowest denomination of the currency on the payment.\n\nMin value: `0`"},"voided_amount":{"type":"integer","description":"The amount of money on this payment that is no longer authorized and has been released back to the customer. The amount will be in the lowest denomination of the currency on the payment.\n\nMin value: `0`"},"refunded_amount":{"type":"integer","description":"Sum of captured refunds in the lowest denomination of currency on the payment.\n\nMin value: `0`"},"currency":{"$ref":"#/components/schemas/Currency"},"customer_id":{"type":"string","description":"ID of the customer that sent this payment.\n\nMin length: `1`\nMax length: `128`"},"merchant_id":{"type":"string","description":"ID of the merchant that received this payment.\n\nMin length: `1`\nMax length: `128`"},"grant_id":{"type":"string","description":"ID of the grant to used to create this payment.\n\nMin length: `1`\nMax length: `256`"},"status":{"$ref":"#/components/schemas/PaymentStatus","description":"The step of the payment processing lifecycle that this payment is currently at.\n\n- `AUTHORIZED`\n- `CAPTURED`\n- `VOIDED`\n- `DECLINED`"},"created_at":{"type":"string","format":"date-time","description":"When this payment was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When this payment was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"capture_before":{"type":"string","format":"date-time","description":"When this payment should be captured by, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"refund_ids":{"type":"array","items":{"type":"string"},"description":"A list of one or more IDs associated with refunds issued for this payment.\n\nMin array length: `1`\nMin length of IDs: `1`\nMax length of IDs: `128`"},"reference_id":{"type":"string","description":"A user-defined identifier for this payment, typically used to associate the payment with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"},"metadata":{"$ref":"#/components/schemas/Metadata"},"enrichments":{"$ref":"#/components/schemas/PaymentEnrichments"},"decline_errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"If the payment was declined, contains a list of the reasons why it was declined.\n\nMin number of items: `1`"},"fee_amount":{"type":"number","format":"double","description":"The total fee amount that was charged to the merchant for processing this payment."},"fee_rate":{"$ref":"#/components/schemas/FeeRate","description":"The breakdown of the fee that was charged to the merchant for processing this payment."},"authorization_updates":{"type":"array","items":{"$ref":"#/components/schemas/Authorization"},"description":"A list of authorization update attempts associated with this payment, sorted in chronological order.\n\nNote: This field contains only the authorization update attempts, so this field will be empty when \nthe payment is first created (even though the amount is authorized in this flow, it is not an update)."}},"required":["id","amount","net_amount","captured_amount","voided_amount","refunded_amount","currency","customer_id","merchant_id","grant_id","status","created_at","updated_at"],"title":"Payment"},"Payments_list-payments_Response_200":{"type":"object","properties":{"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"},"description":"List of payments matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["payments"],"title":"Payments_list-payments_Response_200"},"PaymentsPostRequestBodyContentApplicationJsonSchemaPayment":{"type":"object","properties":{"amount":{"type":"integer","description":"The amount of money to charge the customer, in the lowest denomination of currency for the payment.\n\nMin value: `1`"},"currency":{"$ref":"#/components/schemas/Currency"},"merchant_id":{"type":"string","description":"ID of the merchant to make the payment to.\n\nMin length: `1`\nMax length: `128`"},"grant_id":{"type":"string","description":"A grant ID from the Customer Request API that indicates permission to take the payment.\n\nMin length: `1`\nMax length: `256`"},"reference_id":{"type":"string","description":"A user-defined identifier for this payment, typically used to associate the payment with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"},"capture":{"type":"boolean","default":true,"description":"Whether or not to automatically capture the payment once it's created.\n\nDefault: `true`"},"metadata":{"$ref":"#/components/schemas/Metadata"},"enrichments":{"$ref":"#/components/schemas/PaymentEnrichments"}},"required":["amount","currency","merchant_id","grant_id"],"description":"Data about the payment to create.","title":"PaymentsPostRequestBodyContentApplicationJsonSchemaPayment"},"Payments_create-payment_Response_201":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"title":"Payments_create-payment_Response_201"},"Create-paymentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"A list of errors indicating why the request failed.\n\nMin number of items: `1`"},"payment":{"$ref":"#/components/schemas/Payment"}},"required":["errors"],"title":"Create-paymentRequestBadRequestError"},"Payments_retrieve-payment_Response_200":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"required":["payment"],"title":"Payments_retrieve-payment_Response_200"},"Retrieve-paymentRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}},"required":["errors"],"title":"Retrieve-paymentRequestNotFoundError"},"PaymentsPaymentIdAuthorizationsPostRequestBodyContentApplicationJsonSchemaAuthorization":{"type":"object","properties":{"amount":{"type":"integer","description":"The updated total amount of money to collect from the customer, in the lowest denomination of currency for the payment.\nThis value must be greater than or equal to the current authorized amount"},"currency":{"$ref":"#/components/schemas/Currency"},"reference_id":{"type":"string","description":"A user-defined identifier for this authorization, typically used to associate the authorization with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["amount","currency"],"description":"Details about the authorization to create.","title":"PaymentsPaymentIdAuthorizationsPostRequestBodyContentApplicationJsonSchemaAuthorization"},"Payments_create-payment-authorization_Response_201":{"type":"object","properties":{"authorization":{"$ref":"#/components/schemas/Authorization"}},"required":["authorization"],"title":"Payments_create-payment-authorization_Response_201"},"Create-payment-authorizationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"A list of errors indicating why the request failed.\n \nMin number of items: `1`"},"authorization":{"$ref":"#/components/schemas/Authorization"}},"required":["errors"],"title":"Create-payment-authorizationRequestBadRequestError"},"Payments_capture-payment_Response_200":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"required":["payment"],"title":"Payments_capture-payment_Response_200"},"Payments_void-payment_Response_200":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"required":["payment"],"title":"Payments_void-payment_Response_200"},"Payments_void-payment-by-idempotency-key_Response_200":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"required":["payment"],"title":"Payments_void-payment-by-idempotency-key_Response_200"},"PayoutStatus":{"type":"string","enum":["CAPTURED","DECLINED","AUTHORIZED","INITIATED"],"description":"The step of the payout processing lifecycle that this payout is currently at.\n\n- `CAPTURED` - Payout is captured and funds have been sent\n- `DECLINED` - Payout was declined\n- `AUTHORIZED` - Payout is authorized but not yet captured\n- `INITIATED` - Payout has been created but no money movement has happened yet","title":"PayoutStatus"},"PayoutPurpose":{"type":"string","enum":["SERVICES"],"description":"The purpose or intent of the payout.","title":"PayoutPurpose"},"Payout":{"type":"object","properties":{"payout_id":{"type":"string","description":"Unique identifier for this payout issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"grant_id":{"type":"string","description":"ID of the grant used to create this payout.\n\nMin length: `1`\nMax length: `256`"},"amount":{"type":"integer","description":"The amount of money to pay, in the lowest denomination of currency on the payout. This is the _original_ amount authorized when the payout was created.\n\nMin value: `1`"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/PayoutStatus"},"merchant_id":{"type":"string","description":"ID of the merchant that made this payout.\n\nMin length: `1`\nMax length: `128`"},"customer_id":{"type":"string","description":"ID of the customer that received this payout.\n\nMin length: `1`\nMax length: `128`"},"purpose":{"$ref":"#/components/schemas/PayoutPurpose"},"authorized_amount":{"type":"integer","description":"The amount of money on this payout that has been authorized. The amount will be in the lowest denomination of the currency on the payout.\n\nMin value: `0`"},"captured_amount":{"type":"integer","description":"The amount of money on this payout that has been allocated for settlement. The amount will be in the lowest denomination of the currency on the payout.\n\nMin value: `0`"},"declined_amount":{"type":"integer","description":"The amount of money on this payout that was declined. The amount will be in the lowest denomination of the currency on the payout.\n\nMin value: `0`"},"voided_amount":{"type":"integer","description":"The amount of money on this payout that is no longer authorized and has been released. The amount will be in the lowest denomination of the currency on the payout.\n\nMin value: `0`"},"reference_id":{"type":"string","description":"A user-defined identifier for this payout, typically used to associate the payout with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"},"fee_amount":{"type":"number","format":"double","description":"The total fee amount that was charged to the merchant for processing this payout."},"fee_rate":{"$ref":"#/components/schemas/FeeRate","description":"The breakdown of the fee that was charged to the merchant for processing this payout."},"note":{"type":"string","description":"A note about the payout that will be shown to the customer.\n\nMin length: `1`\nMax length: `1024`"},"metadata":{"$ref":"#/components/schemas/Metadata"},"decline_errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"If the payout was declined, contains a list of the reasons why it was declined.\n\nMin number of items: `1`"}},"required":["payout_id","grant_id","amount","currency","status","merchant_id","purpose"],"title":"Payout"},"Payouts_list-payouts_Response_200":{"type":"object","properties":{"payouts":{"type":"array","items":{"$ref":"#/components/schemas/Payout"},"description":"List of payouts matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["payouts"],"title":"Payouts_list-payouts_Response_200"},"PayoutsPostRequestBodyContentApplicationJsonSchemaPayout":{"type":"object","properties":{"amount":{"type":"integer","description":"The amount of money to pay the customer, in the lowest denomination of currency for the payout.\n\nMin value: `1`"},"currency":{"$ref":"#/components/schemas/Currency"},"merchant_id":{"type":"string","description":"ID of the merchant making the payout.\n\nMin length: `1`\nMax length: `128`"},"grant_id":{"type":"string","description":"A grant ID from the Customer Request API that indicates permission to make the payout.\n\nMin length: `1`\nMax length: `256`"},"purpose":{"$ref":"#/components/schemas/PayoutPurpose"},"reference_id":{"type":"string","description":"A user-defined identifier for this payout, typically used to associate the payout with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"},"capture":{"type":"boolean","default":true,"description":"Whether or not to automatically capture the payout once it's created. Must be true until authorization and void payout states are supported.\n\nDefault: `true`"},"note":{"type":"string","description":"A note about the payout that will be shown to the customer.\n\nMin length: `1`\nMax length: `1024`"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["amount","currency","merchant_id","grant_id","purpose","capture","note"],"description":"Data about the payout to create.","title":"PayoutsPostRequestBodyContentApplicationJsonSchemaPayout"},"Payouts_create-payout_Response_201":{"type":"object","properties":{"payout":{"$ref":"#/components/schemas/Payout"}},"title":"Payouts_create-payout_Response_201"},"Create-payoutRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"A list of errors indicating why the request failed.\n\nMin number of items: `1`"},"payout":{"$ref":"#/components/schemas/Payout"}},"required":["errors"],"title":"Create-payoutRequestBadRequestError"},"Payouts_retrieve-payout_Response_200":{"type":"object","properties":{"payout":{"$ref":"#/components/schemas/Payout"}},"required":["payout"],"title":"Payouts_retrieve-payout_Response_200"},"Retrieve-payoutRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}},"required":["errors"],"title":"Retrieve-payoutRequestNotFoundError"},"BalancesGetParametersType":{"type":"string","enum":["CHECKING"],"title":"BalancesGetParametersType"},"BalanceType":{"type":"string","enum":["CHECKING"],"description":"The type of balance.","title":"BalanceType"},"Balance":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this balance issued by Cash App.\n\nMin length: `1`\nMax length: `256`"},"customer_id":{"type":"string","description":"ID of the customer associated with this balance.\n\nMin length: `1`\nMax length: `128`"},"type":{"$ref":"#/components/schemas/BalanceType"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"integer","description":"The balance amount, in the lowest denomination of the currency (for example, cents for USD)."},"created_at":{"type":"string","format":"date-time","description":"When this balance was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When this balance was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."}},"required":["id","customer_id","type","currency","amount"],"title":"Balance"},"Balances_list-balances_Response_200":{"type":"object","properties":{"balances":{"type":"array","items":{"$ref":"#/components/schemas/Balance"},"description":"List of balances matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["balances"],"title":"Balances_list-balances_Response_200"},"Balances_retrieve-balance_Response_200":{"type":"object","properties":{"balance":{"$ref":"#/components/schemas/Balance"}},"required":["balance"],"title":"Balances_retrieve-balance_Response_200"},"Retrieve-balanceRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}},"required":["errors"],"title":"Retrieve-balanceRequestNotFoundError"},"RefundStatus":{"type":"string","enum":["AUTHORIZED","CAPTURED","VOIDED","DECLINED"],"description":"The step of the refund processing lifecycle that this refund is currently at.\n\n- `AUTHORIZED`\n- `CAPTURED`\n- `VOIDED`\n- `DECLINED`","title":"RefundStatus"},"Refund":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this refund issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"amount":{"type":"integer","description":"Amount of money to refund, in the lowest denomination of currency on the refund.\n\nMin value: `1`"},"currency":{"$ref":"#/components/schemas/Currency"},"customer_id":{"type":"string","description":"ID of the customer that received this refund.\n\nMin length: `1`\nMax length: `128`"},"merchant_id":{"type":"string","description":"ID of the merchant that issued this refund.\n\nMin length: `1`\nMax length: `128`"},"status":{"$ref":"#/components/schemas/RefundStatus","description":"The step of the refund processing lifecycle that this refund is currently at.\n\n- `AUTHORIZED`\n- `CAPTURED`\n- `VOIDED`\n- `DECLINED`"},"created_at":{"type":"string","format":"date-time","description":"When this refund was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When this refund was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"grant_id":{"type":"string","description":"This is currently unused and empty.\n\nMin length: `1`\nMax length: `256`"},"payment_id":{"type":"string","description":"This is currently unused and empty.\n\nMin length: `1`\nMax length: `128`"},"reference_id":{"type":"string","description":"A user-defined identifier for this refund, typically used to associate the refund with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"},"metadata":{"$ref":"#/components/schemas/Metadata"},"decline_errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"If the refund was declined, contains a list of the reasons why it was declined.\n\nMin number of items: `1`"}},"required":["id","amount","currency","customer_id","merchant_id","status","created_at","updated_at"],"title":"Refund"},"Refunds_list-refunds_Response_200":{"type":"object","properties":{"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"},"description":"List of refunds matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["refunds"],"title":"Refunds_list-refunds_Response_200"},"RefundsPostRequestBodyContentApplicationJsonSchemaRefund":{"type":"object","properties":{"amount":{"type":"integer","description":"The amount of money to refund the customer, in the lowest denomination of currency for the refund.\n\nMin value: `1`"},"currency":{"$ref":"#/components/schemas/Currency"},"merchant_id":{"type":"string","description":"ID of the merchant to make the refund from.\n\nMin length: `1`\nMax length: `128`"},"payment_id":{"type":"string","description":"For refunds, this is the ID of the payment to refund.\n\nMin length: `1`\nMax length: `128`"},"capture":{"type":"boolean","default":true,"description":"Whether or not to automatically capture the refund once it's created.\n\nDefault: `true`"},"reference_id":{"type":"string","description":"A user-defined identifier for this refund, typically used to associate the refund with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["amount","currency","merchant_id"],"description":"Details about the refund to create.","title":"RefundsPostRequestBodyContentApplicationJsonSchemaRefund"},"Refunds_create-refund_Response_200":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"required":["refund"],"title":"Refunds_create-refund_Response_200"},"Create-refundRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"A list of errors that occurred while processing the request."},"refund":{"$ref":"#/components/schemas/Refund"}},"required":["errors"],"title":"Create-refundRequestBadRequestError"},"Refunds_retrieve-refund_Response_200":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"required":["refund"],"title":"Refunds_retrieve-refund_Response_200"},"Refunds_capture-refund_Response_200":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"required":["refund"],"title":"Refunds_capture-refund_Response_200"},"Refunds_void-refund_Response_200":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"required":["refund"],"title":"Refunds_void-refund_Response_200"},"Refunds_void-refund-by-idempotency-key_Response_200":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"required":["refund"],"title":"Refunds_void-refund-by-idempotency-key_Response_200"},"DisputeReason":{"type":"string","enum":["FR10","FR11","PE10","PE11","PE12","CD10","CD11","CD13"],"description":"4-digit code consisting of 2 letters followed by 2 numbers that indicates why the dispute was created, at a high level.\n\nCurrent values:\n\n- `FR10`: Customer has no knowledge of the payment.\n- `FR11`: Customer has no knowledge of the payment and liability has shifted to the merchant due to collusion, fraud monitoring program thresholds, or any other reason.\n- `PE10`: Payment was processed twice.\n- `PE11`: Payment amount differs from agreed amount.\n- `PE12`: Payment was paid for by another means.\n- `CD10`: Cancelled services.\n- `CD11`: Goods or services differ from what was agreed upon for the payment.\n- `CD12`: The goods or services were not received.\n- `CD13`: The purchase was cancelled or returned, but the refund has not been processed.","title":"DisputeReason"},"DisputeSettlementWithholding":{"type":"string","enum":["NOT_WITHHELD","WITHHELD_ALREADY"],"description":"Indicates if the disputed amount has already been withheld from a settlement or not.\n\nCurrent values:\n\n- `NOT_WITHHELD`: The disputed amount has not yet been withheld in a settlement. It may impact future settlements if the dispute is \"lost\" by the merchant.\n\n- `WITHHELD_ALREADY`: The disputed amount was withheld in a prior settlement. This dispute will not impact future settlements.","title":"DisputeSettlementWithholding"},"DisputeState":{"type":"string","enum":["RESPONSE_REQUIRED","NO_RESPONSE_REQUIRED","PROCESSING","ACCEPTED","WON","PARTIALLY_WON","LOST"],"description":"The step in the dispute lifecycle that this dispute is currently at:\n\n- `RESPONSE_REQUIRED`\n- `NO_RESPONSE_REQUIRED`\n- `PROCESSING`\n- `ACCEPTED`\n- `WON`\n- `PARTIALLY_WON`\n- `LOST`","title":"DisputeState"},"Dispute":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the dispute issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"payment_id":{"type":"string","description":"ID of the disputed payment.\n\nMin length: `1`\nMax length: `128`"},"amount":{"type":"integer","description":"Amount of disputed money, in the lowest denomination of currency on the associated payment.\n\nMin value: `1`"},"customer_credited_amount":{"type":["integer","null"],"description":"The amount credited to the Customer after resolving the dispute. \n\nNote: The amount will be in the lowest denomination of the currency used on the associated payment.\n\nMin value: `0`"},"reason":{"$ref":"#/components/schemas/DisputeReason","description":"4-digit code consisting of 2 letters followed by 2 numbers that indicates why the dispute was created, at a high level.\n\nCurrent values:\n\n- `FR10`: Customer has no knowledge of the payment.\n- `FR11`: Customer has no knowledge of the payment and liability has shifted to the merchant due to collusion, fraud monitoring program thresholds, or any other reason.\n- `PE10`: Payment was processed twice.\n- `PE11`: Payment amount differs from agreed amount.\n- `PE12`: Payment was paid for by another means.\n- `CD10`: Cancelled services.\n- `CD11`: Goods or services differ from what was agreed upon for the payment.\n- `CD12`: The goods or services were not received.\n- `CD13`: The purchase was cancelled or returned, but the refund has not been processed."},"settlement_withholding":{"$ref":"#/components/schemas/DisputeSettlementWithholding","description":"Indicates if the disputed amount has already been withheld from a settlement or not.\n\nCurrent values:\n\n- `NOT_WITHHELD`: The disputed amount has not yet been withheld in a settlement. It may impact future settlements if the dispute is \"lost\" by the merchant.\n\n- `WITHHELD_ALREADY`: The disputed amount was withheld in a prior settlement. This dispute will not impact future settlements."},"state":{"$ref":"#/components/schemas/DisputeState","description":"The step in the dispute lifecycle that this dispute is currently at:\n\n- `RESPONSE_REQUIRED`\n- `NO_RESPONSE_REQUIRED`\n- `PROCESSING`\n- `ACCEPTED`\n- `WON`\n- `PARTIALLY_WON`\n- `LOST`"},"created_at":{"type":"string","format":"date-time","description":"When this dispute was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"response_due_at":{"type":["string","null"],"format":"date-time","description":"When the dispute must be challenged by, after which it will be automatically accepted, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When this dispute was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"merchant_id":{"type":"string","description":"ID of the merchant that collected the disputed payment.\n\nMin length: `1`\nMax length: `128`"}},"required":["id","payment_id","amount","reason","settlement_withholding","state","created_at","updated_at","merchant_id"],"description":"Represents a dispute initiated by a customer within Cash App or the customer's linked bank","title":"Dispute"},"Disputes_list-disputes_Response_200":{"type":"object","properties":{"disputes":{"type":"array","items":{"$ref":"#/components/schemas/Dispute"},"description":"List of disputes matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["disputes"],"title":"Disputes_list-disputes_Response_200"},"Disputes_retrieve-dispute_Response_200":{"type":"object","properties":{"dispute":{"$ref":"#/components/schemas/Dispute"}},"required":["dispute"],"title":"Disputes_retrieve-dispute_Response_200"},"Disputes_accept-dispute_Response_200":{"type":"object","properties":{"dispute":{"$ref":"#/components/schemas/Dispute"}},"title":"Disputes_accept-dispute_Response_200"},"Disputes_challenge-dispute_Response_200":{"type":"object","properties":{"dispute":{"$ref":"#/components/schemas/Dispute"}},"required":["dispute"],"title":"Disputes_challenge-dispute_Response_200"},"DisputeEvidenceCategory":{"type":"string","enum":["GENERIC_EVIDENCE","ONLINE_OR_APP_ACCESS_LOG","AUTHORIZATION_DOCUMENTATION","CANCELLATION_OR_REFUND_DOCUMENTATION","CARDHOLDER_COMMUNICATION","CARDHOLDER_INFORMATION","PURCHASE_ACKNOWLEDGEMENT","DUPLICATE_CHARGE_DOCUMENTATION","PRODUCT_OR_SERVICE_DESCRIPTION","RECEIPT","SERVICE_RECEIVED_DOCUMENTATION","PROOF_OF_DELIVERY_DOCUMENTATION","RELATED_TRANSACTION_DOCUMENTATION","REBUTTAL_EXPLANATION","TRACKING_NUMBER"],"description":"Describes what type of information is contained in this piece of evidence.\n\nCurrent values:\n\n- `GENERIC_EVIDENCE`: Default evidence type used if no other category applies.\n- `ONLINE_OR_APP_ACCESS_LOG`: Server or activity logs that show proof of the cardholder’s identity and that the cardholder successfully ordered and received the goods (digitally or otherwise). Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email address linked to a cardholder profile held by the seller, proof the same device and card (used in dispute) were previously used in prior undisputed transaction, and any related detailed activity.\n- `AUTHORIZATION_DOCUMENTATION`: **[File Only]** Evidence that the cardholder did provide authorization for the charge. Example evidence includes a signed credit card authorization.\n- `CANCELLATION_OR_REFUND_DOCUMENTATION`: Evidence that the cardholder acknowledged your refund or cancellation policy. Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your refund or cancellation policy.\n- `CARDHOLDER_COMMUNICATION`: **[File Only]** Evidence that shows relevant communication with the cardholder. Example evidence includes emails or texts that show the cardholder received goods/services or demonstrate cardholder satisfaction.\n- `CARDHOLDER_INFORMATION`: Evidence that validates the customer's identity. Example evidence includes personally identifiable details such as name, email address, purchaser IP address, and a copy of the cardholder ID.\n- `PURCHASE_ACKNOWLEDGEMENT`: Evidence that shows proof of the sale/transaction. Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement of the purchase and your terms.\n- `DUPLICATE_CHARGE_DOCUMENTATION`: **[File Only]** Evidence that shows the charges in question are valid and distinct from one another. Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.\n- `PRODUCT_OR_SERVICE_DESCRIPTION`: A description of the product or service sold.\n- `RECEIPT`: A receipt or message sent to the cardholder detailing the charge. Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.\n- `SERVICE_RECEIVED_DOCUMENTATION`: Evidence that the service was provided to the cardholder or the expected date that services will be rendered. Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.\n- `PROOF_OF_DELIVERY_DOCUMENTATION`: Evidence that shows the product was provided to the cardholder or the expected date of delivery. Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.\n- `RELATED_TRANSACTION_DOCUMENTATION`: Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.\n- `REBUTTAL_EXPLANATION`: An explanation of why the cardholder’s claim is invalid. Example evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim for credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder agreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.\n- `TRACKING_NUMBER`: The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be submitted individually as separate pieces of evidence.","title":"DisputeEvidenceCategory"},"DisputeEvidenceFileContentType":{"type":"string","enum":["application/pdf","image/heic","image/heif","image/jpeg","image/png","image/tiff"],"description":"The MIME type of the uploaded file.\n\nCurrent values:\n\n- `application/pdf`\n- `image/heic`\n- `image/heif`\n- `image/jpeg`\n- `image/png`\n- `image/tiff`","title":"DisputeEvidenceFileContentType"},"DisputeEvidenceFile":{"type":"object","properties":{"filename":{"type":"string","description":"Name of the uploaded file. It should be descriptive enough to indicate what type of information is contained in the uploaded file."},"content_type":{"$ref":"#/components/schemas/DisputeEvidenceFileContentType","description":"The MIME type of the uploaded file.\n\nCurrent values:\n\n- `application/pdf`\n- `image/heic`\n- `image/heif`\n- `image/jpeg`\n- `image/png`\n- `image/tiff`"}},"required":["filename","content_type"],"description":"If the evidence is of type `FILE`, contains metadata about the binary file uploaded as evidence.","title":"DisputeEvidenceFile"},"DisputeEvidenceType":{"type":"string","enum":["FILE","TEXT"],"description":"Indicates if the evidence is a file or plain text.\n\nCurrent values:\n- `TEXT`: The evidence is a blob of text under 500 characters.\n- `FILE`: The evidence is an uploaded binary file.","title":"DisputeEvidenceType"},"DisputeEvidence":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the dispute evidence issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"dispute_id":{"type":"string","description":"ID of the dispute this evidence is associated with.\n\nMin length: `1`\nMax length: `128`"},"category":{"$ref":"#/components/schemas/DisputeEvidenceCategory","description":"Describes what type of information is contained in this piece of evidence.\n\nCurrent values:\n\n- `GENERIC_EVIDENCE`: Default evidence type used if no other category applies.\n- `ONLINE_OR_APP_ACCESS_LOG`: Server or activity logs that show proof of the cardholder’s identity and that the cardholder successfully ordered and received the goods (digitally or otherwise). Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email address linked to a cardholder profile held by the seller, proof the same device and card (used in dispute) were previously used in prior undisputed transaction, and any related detailed activity.\n- `AUTHORIZATION_DOCUMENTATION`: **[File Only]** Evidence that the cardholder did provide authorization for the charge. Example evidence includes a signed credit card authorization.\n- `CANCELLATION_OR_REFUND_DOCUMENTATION`: Evidence that the cardholder acknowledged your refund or cancellation policy. Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your refund or cancellation policy.\n- `CARDHOLDER_COMMUNICATION`: **[File Only]** Evidence that shows relevant communication with the cardholder. Example evidence includes emails or texts that show the cardholder received goods/services or demonstrate cardholder satisfaction.\n- `CARDHOLDER_INFORMATION`: Evidence that validates the customer's identity. Example evidence includes personally identifiable details such as name, email address, purchaser IP address, and a copy of the cardholder ID.\n- `PURCHASE_ACKNOWLEDGEMENT`: Evidence that shows proof of the sale/transaction. Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement of the purchase and your terms.\n- `DUPLICATE_CHARGE_DOCUMENTATION`: **[File Only]** Evidence that shows the charges in question are valid and distinct from one another. Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.\n- `PRODUCT_OR_SERVICE_DESCRIPTION`: A description of the product or service sold.\n- `RECEIPT`: A receipt or message sent to the cardholder detailing the charge. Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.\n- `SERVICE_RECEIVED_DOCUMENTATION`: Evidence that the service was provided to the cardholder or the expected date that services will be rendered. Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.\n- `PROOF_OF_DELIVERY_DOCUMENTATION`: Evidence that shows the product was provided to the cardholder or the expected date of delivery. Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.\n- `RELATED_TRANSACTION_DOCUMENTATION`: Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.\n- `REBUTTAL_EXPLANATION`: An explanation of why the cardholder’s claim is invalid. Example evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim for credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder agreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.\n- `TRACKING_NUMBER`: The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be submitted individually as separate pieces of evidence."},"file":{"$ref":"#/components/schemas/DisputeEvidenceFile","description":"If the evidence is of type `FILE`, contains metadata about the binary file uploaded as evidence."},"text":{"type":"string","description":"If the evidence is of type `TEXT`, contains the blob of text created as evidence.\n\nMin length: `1`\nMax length: `500`"},"type":{"$ref":"#/components/schemas/DisputeEvidenceType","description":"Indicates if the evidence is a file or plain text.\n\nCurrent values:\n- `TEXT`: The evidence is a blob of text under 500 characters.\n- `FILE`: The evidence is an uploaded binary file."},"created_at":{"type":"string","format":"date-time","description":"When this evidence was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["id","dispute_id","category","type","created_at"],"title":"DisputeEvidence"},"Disputes_list-dispute-evidence_Response_200":{"type":"object","properties":{"evidence":{"type":"array","items":{"$ref":"#/components/schemas/DisputeEvidence"},"description":"List of pieces of evidence for the dispute matching the given query parameters"},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["evidence"],"title":"Disputes_list-dispute-evidence_Response_200"},"DisputesDisputeIdEvidenceTextPostRequestBodyContentApplicationJsonSchemaEvidenceCategory":{"type":"string","enum":["GENERIC_EVIDENCE","ONLINE_OR_APP_ACCESS_LOG","AUTHORIZATION_DOCUMENTATION","CANCELLATION_OR_REFUND_DOCUMENTATION","CARDHOLDER_COMMUNICATION","CARDHOLDER_INFORMATION","PURCHASE_ACKNOWLEDGEMENT","DUPLICATE_CHARGE_DOCUMENTATION","PRODUCT_OR_SERVICE_DESCRIPTION","RECEIPT","SERVICE_RECEIVED_DOCUMENTATION","PROOF_OF_DELIVERY_DOCUMENTATION","RELATED_TRANSACTION_DOCUMENTATION","REBUTTAL_EXPLANATION","TRACKING_NUMBER"],"description":"Describes what type of information is contained in this piece of evidence.\n\nCurrent values:\n\n- `GENERIC_EVIDENCE`: Default evidence type used if no other category applies.\n- `ONLINE_OR_APP_ACCESS_LOG`: Server or activity logs that show proof of the cardholder’s identity and that the cardholder successfully ordered and received the goods (digitally or otherwise). Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email address linked to a cardholder profile held by the seller, proof the same device and card (used in dispute) were previously used in prior undisputed transaction, and any related detailed activity.\n- `AUTHORIZATION_DOCUMENTATION`: **[File Only]** Evidence that the cardholder did provide authorization for the charge. Example evidence includes a signed credit card authorization.\n- `CANCELLATION_OR_REFUND_DOCUMENTATION`: Evidence that the cardholder acknowledged your refund or cancellation policy. Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your refund or cancellation policy.\n- `CARDHOLDER_COMMUNICATION`: **[File Only]** Evidence that shows relevant communication with the cardholder. Example evidence includes emails or texts that show the cardholder received goods/services or demonstrate cardholder satisfaction.\n- `CARDHOLDER_INFORMATION`: Evidence that validates the customer's identity. Example evidence includes personally identifiable details such as name, email address, purchaser IP address, and a copy of the cardholder ID.\n- `PURCHASE_ACKNOWLEDGEMENT`: Evidence that shows proof of the sale/transaction. Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement of the purchase and your terms.\n- `DUPLICATE_CHARGE_DOCUMENTATION`: **[File Only]** Evidence that shows the charges in question are valid and distinct from one another. Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.\n- `PRODUCT_OR_SERVICE_DESCRIPTION`: A description of the product or service sold.\n- `RECEIPT`: A receipt or message sent to the cardholder detailing the charge. Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.\n- `SERVICE_RECEIVED_DOCUMENTATION`: Evidence that the service was provided to the cardholder or the expected date that services will be rendered. Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.\n- `PROOF_OF_DELIVERY_DOCUMENTATION`: Evidence that shows the product was provided to the cardholder or the expected date of delivery. Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.\n- `RELATED_TRANSACTION_DOCUMENTATION`: Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.\n- `REBUTTAL_EXPLANATION`: An explanation of why the cardholder’s claim is invalid. Example evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim for credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder agreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.\n- `TRACKING_NUMBER`: The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be submitted individually as separate pieces of evidence.","title":"DisputesDisputeIdEvidenceTextPostRequestBodyContentApplicationJsonSchemaEvidenceCategory"},"DisputesDisputeIdEvidenceTextPostRequestBodyContentApplicationJsonSchemaEvidence":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/DisputesDisputeIdEvidenceTextPostRequestBodyContentApplicationJsonSchemaEvidenceCategory","description":"Describes what type of information is contained in this piece of evidence.\n\nCurrent values:\n\n- `GENERIC_EVIDENCE`: Default evidence type used if no other category applies.\n- `ONLINE_OR_APP_ACCESS_LOG`: Server or activity logs that show proof of the cardholder’s identity and that the cardholder successfully ordered and received the goods (digitally or otherwise). Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email address linked to a cardholder profile held by the seller, proof the same device and card (used in dispute) were previously used in prior undisputed transaction, and any related detailed activity.\n- `AUTHORIZATION_DOCUMENTATION`: **[File Only]** Evidence that the cardholder did provide authorization for the charge. Example evidence includes a signed credit card authorization.\n- `CANCELLATION_OR_REFUND_DOCUMENTATION`: Evidence that the cardholder acknowledged your refund or cancellation policy. Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your refund or cancellation policy.\n- `CARDHOLDER_COMMUNICATION`: **[File Only]** Evidence that shows relevant communication with the cardholder. Example evidence includes emails or texts that show the cardholder received goods/services or demonstrate cardholder satisfaction.\n- `CARDHOLDER_INFORMATION`: Evidence that validates the customer's identity. Example evidence includes personally identifiable details such as name, email address, purchaser IP address, and a copy of the cardholder ID.\n- `PURCHASE_ACKNOWLEDGEMENT`: Evidence that shows proof of the sale/transaction. Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement of the purchase and your terms.\n- `DUPLICATE_CHARGE_DOCUMENTATION`: **[File Only]** Evidence that shows the charges in question are valid and distinct from one another. Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.\n- `PRODUCT_OR_SERVICE_DESCRIPTION`: A description of the product or service sold.\n- `RECEIPT`: A receipt or message sent to the cardholder detailing the charge. Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.\n- `SERVICE_RECEIVED_DOCUMENTATION`: Evidence that the service was provided to the cardholder or the expected date that services will be rendered. Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.\n- `PROOF_OF_DELIVERY_DOCUMENTATION`: Evidence that shows the product was provided to the cardholder or the expected date of delivery. Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.\n- `RELATED_TRANSACTION_DOCUMENTATION`: Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.\n- `REBUTTAL_EXPLANATION`: An explanation of why the cardholder’s claim is invalid. Example evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim for credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder agreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.\n- `TRACKING_NUMBER`: The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be submitted individually as separate pieces of evidence."},"text":{"type":"string","description":"The blob of text to upload as evidence."},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["category","text"],"description":"Details about the evidence to create.","title":"DisputesDisputeIdEvidenceTextPostRequestBodyContentApplicationJsonSchemaEvidence"},"Disputes_create-dispute-evidence-text_Response_201":{"type":"object","properties":{"evidence":{"$ref":"#/components/schemas/DisputeEvidence"}},"title":"Disputes_create-dispute-evidence-text_Response_201"},"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceCategory":{"type":"string","enum":["GENERIC_EVIDENCE","ONLINE_OR_APP_ACCESS_LOG","AUTHORIZATION_DOCUMENTATION","CANCELLATION_OR_REFUND_DOCUMENTATION","CARDHOLDER_COMMUNICATION","CARDHOLDER_INFORMATION","PURCHASE_ACKNOWLEDGEMENT","DUPLICATE_CHARGE_DOCUMENTATION","PRODUCT_OR_SERVICE_DESCRIPTION","RECEIPT","SERVICE_RECEIVED_DOCUMENTATION","PROOF_OF_DELIVERY_DOCUMENTATION","RELATED_TRANSACTION_DOCUMENTATION","REBUTTAL_EXPLANATION","TRACKING_NUMBER"],"description":"Describes what type of information is contained in this piece of evidence.\n\nCurrent values:\n\n- `GENERIC_EVIDENCE`: Default evidence type used if no other category applies.\n- `ONLINE_OR_APP_ACCESS_LOG`: Server or activity logs that show proof of the cardholder’s identity and that the cardholder successfully ordered and received the goods (digitally or otherwise). Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email address linked to a cardholder profile held by the seller, proof the same device and card (used in dispute) were previously used in prior undisputed transaction, and any related detailed activity.\n- `AUTHORIZATION_DOCUMENTATION`: **[File Only]** Evidence that the cardholder did provide authorization for the charge. Example evidence includes a signed credit card authorization.\n- `CANCELLATION_OR_REFUND_DOCUMENTATION`: Evidence that the cardholder acknowledged your refund or cancellation policy. Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your refund or cancellation policy.\n- `CARDHOLDER_COMMUNICATION`: **[File Only]** Evidence that shows relevant communication with the cardholder. Example evidence includes emails or texts that show the cardholder received goods/services or demonstrate cardholder satisfaction.\n- `CARDHOLDER_INFORMATION`: Evidence that validates the customer's identity. Example evidence includes personally identifiable details such as name, email address, purchaser IP address, and a copy of the cardholder ID.\n- `PURCHASE_ACKNOWLEDGEMENT`: Evidence that shows proof of the sale/transaction. Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement of the purchase and your terms.\n- `DUPLICATE_CHARGE_DOCUMENTATION`: **[File Only]** Evidence that shows the charges in question are valid and distinct from one another. Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.\n- `PRODUCT_OR_SERVICE_DESCRIPTION`: A description of the product or service sold.\n- `RECEIPT`: A receipt or message sent to the cardholder detailing the charge. Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.\n- `SERVICE_RECEIVED_DOCUMENTATION`: Evidence that the service was provided to the cardholder or the expected date that services will be rendered. Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.\n- `PROOF_OF_DELIVERY_DOCUMENTATION`: Evidence that shows the product was provided to the cardholder or the expected date of delivery. Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.\n- `RELATED_TRANSACTION_DOCUMENTATION`: Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.\n- `REBUTTAL_EXPLANATION`: An explanation of why the cardholder’s claim is invalid. Example evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim for credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder agreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.\n- `TRACKING_NUMBER`: The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be submitted individually as separate pieces of evidence.","title":"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceCategory"},"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceFileContentType":{"type":"string","enum":["application/pdf","image/png","image/jpeg","image/heic","image/heif","image/tiff"],"description":"The MIME type of the uploaded file.\n\nCurrent values:\n\n- `application/pdf`\n- `image/heic`\n- `image/heif`\n- `image/jpeg`\n- `image/png`\n- `image/tiff`","title":"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceFileContentType"},"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceFile":{"type":"object","properties":{"filename":{"type":"string","description":"Name of the uploaded file. It should be descriptive enough to indicate what type of information is contained in the uploaded file."},"content_type":{"$ref":"#/components/schemas/DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceFileContentType","description":"The MIME type of the uploaded file.\n\nCurrent values:\n\n- `application/pdf`\n- `image/heic`\n- `image/heif`\n- `image/jpeg`\n- `image/png`\n- `image/tiff`"}},"required":["filename","content_type"],"description":"Metadata about the uploaded file.","title":"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceFile"},"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidence":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceCategory","description":"Describes what type of information is contained in this piece of evidence.\n\nCurrent values:\n\n- `GENERIC_EVIDENCE`: Default evidence type used if no other category applies.\n- `ONLINE_OR_APP_ACCESS_LOG`: Server or activity logs that show proof of the cardholder’s identity and that the cardholder successfully ordered and received the goods (digitally or otherwise). Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email address linked to a cardholder profile held by the seller, proof the same device and card (used in dispute) were previously used in prior undisputed transaction, and any related detailed activity.\n- `AUTHORIZATION_DOCUMENTATION`: **[File Only]** Evidence that the cardholder did provide authorization for the charge. Example evidence includes a signed credit card authorization.\n- `CANCELLATION_OR_REFUND_DOCUMENTATION`: Evidence that the cardholder acknowledged your refund or cancellation policy. Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your refund or cancellation policy.\n- `CARDHOLDER_COMMUNICATION`: **[File Only]** Evidence that shows relevant communication with the cardholder. Example evidence includes emails or texts that show the cardholder received goods/services or demonstrate cardholder satisfaction.\n- `CARDHOLDER_INFORMATION`: Evidence that validates the customer's identity. Example evidence includes personally identifiable details such as name, email address, purchaser IP address, and a copy of the cardholder ID.\n- `PURCHASE_ACKNOWLEDGEMENT`: Evidence that shows proof of the sale/transaction. Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement of the purchase and your terms.\n- `DUPLICATE_CHARGE_DOCUMENTATION`: **[File Only]** Evidence that shows the charges in question are valid and distinct from one another. Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.\n- `PRODUCT_OR_SERVICE_DESCRIPTION`: A description of the product or service sold.\n- `RECEIPT`: A receipt or message sent to the cardholder detailing the charge. Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.\n- `SERVICE_RECEIVED_DOCUMENTATION`: Evidence that the service was provided to the cardholder or the expected date that services will be rendered. Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.\n- `PROOF_OF_DELIVERY_DOCUMENTATION`: Evidence that shows the product was provided to the cardholder or the expected date of delivery. Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.\n- `RELATED_TRANSACTION_DOCUMENTATION`: Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.\n- `REBUTTAL_EXPLANATION`: An explanation of why the cardholder’s claim is invalid. Example evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim for credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder agreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.\n- `TRACKING_NUMBER`: The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be submitted individually as separate pieces of evidence."},"file":{"$ref":"#/components/schemas/DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidenceFile","description":"Metadata about the uploaded file."},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["category","file"],"description":"Details about the evidence to create.","title":"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidence"},"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequest":{"type":"object","properties":{"idempotency_key":{"$ref":"#/components/schemas/IdempotencyKey"},"evidence":{"$ref":"#/components/schemas/DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequestEvidence","description":"Details about the evidence to create."}},"description":"JSON-encoded payload describing the contents of the file uploaded","title":"DisputesDisputeIdEvidenceFilePostRequestBodyContentMultipartFormDataSchemaRequest"},"Disputes_create-dispute-evidence-file_Response_201":{"type":"object","properties":{"evidence":{"$ref":"#/components/schemas/DisputeEvidence"}},"required":["evidence"],"title":"Disputes_create-dispute-evidence-file_Response_201"},"Disputes_delete-dispute-evidence_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Disputes_delete-dispute-evidence_Response_200"},"Disputes_retrieve-dispute-evidence_Response_200":{"type":"object","properties":{"evidence":{"$ref":"#/components/schemas/DisputeEvidence"}},"required":["evidence"],"title":"Disputes_retrieve-dispute-evidence_Response_200"},"FeePlan":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the fee plan issued by Cash App."},"rate":{"$ref":"#/components/schemas/FeeRate"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"type":"string","description":"The state is used to determine whether or not this fee plan is currently in use.\n- `ACTIVE`\n- `DISABLED`"},"reference_id":{"type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata"},"description":{"type":"string","description":"A free-form text field that stores information associated with the fee plan."},"created_at":{"type":"string","format":"date-time","description":"When this fee plan was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When this fee plan was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."}},"required":["id","rate","currency","status","created_at","updated_at"],"description":"The full fee plan that PSPs can use to set the buy rates for specific merchants.","title":"FeePlan"},"Fee Plans_retrieve-fee-plan_Response_200":{"type":"object","properties":{"fee_plan":{"$ref":"#/components/schemas/FeePlan"}},"required":["fee_plan"],"title":"Fee Plans_retrieve-fee-plan_Response_200"},"FeePlansGetParametersStatus":{"type":"string","enum":["ACTIVE","DISABLED"],"default":"ACTIVE","title":"FeePlansGetParametersStatus"},"Fee Plans_list-fee-plans_Response_200":{"type":"object","properties":{"fee_plans":{"type":"array","items":{"$ref":"#/components/schemas/FeePlan"},"description":"List of fee plans matching the given query parameters."},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"title":"Fee Plans_list-fee-plans_Response_200"},"WebhooksMerchantStatusUpdatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"}},"required":["merchant"],"description":"A snapshot of the merchant data immediately after the merchant's status changed.","title":"WebhooksMerchantStatusUpdatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksMerchantStatusUpdatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the merchant."},"object":{"$ref":"#/components/schemas/WebhooksMerchantStatusUpdatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the merchant data immediately after the merchant's status changed."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `merchant`."}},"required":["id","object","type"],"description":"Data about the merchant that had a status change.","title":"WebhooksMerchantStatusUpdatedPayloadContentApplicationJsonSchemaData"},"WebhooksGrantCreatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"grant":{"$ref":"#/components/schemas/Grant"}},"required":["grant"],"description":"A snapshot of the grant immediately after the grant was created.","title":"WebhooksGrantCreatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksGrantCreatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the grant."},"object":{"$ref":"#/components/schemas/WebhooksGrantCreatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the grant immediately after the grant was created."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `grant`."}},"required":["id","object","type"],"description":"Data about the grant that was created.","title":"WebhooksGrantCreatedPayloadContentApplicationJsonSchemaData"},"WebhooksGrantStatusUpdatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"grant":{"$ref":"#/components/schemas/Grant"}},"required":["grant"],"description":"A snapshot of the grant immediately after the grant's status changed.","title":"WebhooksGrantStatusUpdatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksGrantStatusUpdatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the grant."},"object":{"$ref":"#/components/schemas/WebhooksGrantStatusUpdatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the grant immediately after the grant's status changed."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `grant`."}},"required":["id","object","type"],"description":"Data about the grant that had a status change.","title":"WebhooksGrantStatusUpdatedPayloadContentApplicationJsonSchemaData"},"WebhooksCustomerCreatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"}},"required":["customer"],"description":"A snapshot of the customer immediately after the customer was created.","title":"WebhooksCustomerCreatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksCustomerCreatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the customer."},"object":{"$ref":"#/components/schemas/WebhooksCustomerCreatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the customer immediately after the customer was created."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `customer`."}},"required":["id","object","type"],"description":"Data about the Customer that was created.","title":"WebhooksCustomerCreatedPayloadContentApplicationJsonSchemaData"},"WebhooksCustomerUpdatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"}},"required":["customer"],"description":"A snapshot of the customer immediately after the customer was updated.","title":"WebhooksCustomerUpdatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksCustomerUpdatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the customer."},"object":{"$ref":"#/components/schemas/WebhooksCustomerUpdatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the customer immediately after the customer was updated."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `customer`."}},"required":["id","object","type"],"description":"Data about the Customer that was updated.","title":"WebhooksCustomerUpdatedPayloadContentApplicationJsonSchemaData"},"WebhooksCustomerDeletedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"}},"required":["customer"],"description":"A snapshot of the customer immediately after the customer was deleted.","title":"WebhooksCustomerDeletedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksCustomerDeletedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the customer."},"object":{"$ref":"#/components/schemas/WebhooksCustomerDeletedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the customer immediately after the customer was deleted."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `customer`."}},"required":["id","object","type"],"description":"Data about the Customer that was deleted.","title":"WebhooksCustomerDeletedPayloadContentApplicationJsonSchemaData"},"WebhooksPaymentStatusUpdatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"required":["payment"],"description":"A snapshot of the payment data immediately after the payment's status changed.","title":"WebhooksPaymentStatusUpdatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksPaymentStatusUpdatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the payment."},"object":{"$ref":"#/components/schemas/WebhooksPaymentStatusUpdatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the payment data immediately after the payment's status changed."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `payment`."}},"required":["id","object","type"],"description":"Data about the payment that had a status change.","title":"WebhooksPaymentStatusUpdatedPayloadContentApplicationJsonSchemaData"},"WebhooksRefundStatusUpdatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"required":["refund"],"description":"A snapshot of the refund immediately after the refund's status changed.","title":"WebhooksRefundStatusUpdatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksRefundStatusUpdatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the refund."},"object":{"$ref":"#/components/schemas/WebhooksRefundStatusUpdatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the refund immediately after the refund's status changed."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `refund`."}},"required":["id","object","type"],"description":"Data about the refund that had a status change.","title":"WebhooksRefundStatusUpdatedPayloadContentApplicationJsonSchemaData"},"WebhooksDisputeCreatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"dispute":{"$ref":"#/components/schemas/Dispute"}},"required":["dispute"],"description":"A snapshot of the dispute immediately after the dispute was created.","title":"WebhooksDisputeCreatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksDisputeCreatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the dispute."},"object":{"$ref":"#/components/schemas/WebhooksDisputeCreatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the dispute immediately after the dispute was created."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `dispute`."}},"required":["id","object","type"],"description":"Data about the dispute that was created.","title":"WebhooksDisputeCreatedPayloadContentApplicationJsonSchemaData"},"WebhooksDisputeStatusUpdatedPayloadContentApplicationJsonSchemaDataObject":{"type":"object","properties":{"dispute":{"$ref":"#/components/schemas/Dispute"}},"required":["dispute"],"description":"A snapshot of the dispute immediately after the dispute's status was updated.","title":"WebhooksDisputeStatusUpdatedPayloadContentApplicationJsonSchemaDataObject"},"WebhooksDisputeStatusUpdatedPayloadContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier provided by Cash App for the dispute."},"object":{"$ref":"#/components/schemas/WebhooksDisputeStatusUpdatedPayloadContentApplicationJsonSchemaDataObject","description":"A snapshot of the dispute immediately after the dispute's status was updated."},"type":{"type":"string","description":"The resource type contained in the `object` field. For this event, it is `dispute`."}},"required":["id","object","type"],"description":"Data about the dispute that was updated.","title":"WebhooksDisputeStatusUpdatedPayloadContentApplicationJsonSchemaData"}}}}