{"openapi":"3.1.0","info":{"title":"Management API","version":"1.0.0"},"paths":{"/api-keys":{"get":{"operationId":"list-api-keys","summary":"List API keys","description":"Returns a list of active API keys matching the given query parameters.\n\n**This endpoint is rate limited to 5 QPS.**\n\nScopes: `API_KEYS_READ`","tags":["apiKeys"],"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 API keys 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/apiKeys_list-api-keys_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create-api-key","summary":"Create API key","description":"Creates a new API key and secret to use in the `Authorization` and `X-Signature` headers for requests to the Cash App Pay API. This key will automatically expire at the date and time specified in the `expires_at` field in the response payload.\n\n<Note title=\"Note\">\n The `secret` returned in the response payload is what you use to calculate the `X-Signature` header. The API key ID is only used to keep track of which API keys are active, and isn't considered secret.\n Keep in mind that the `secret` can never be retrieved in subsequent requests to the API, so make sure to store it immediately!\n</Note>\n**This endpoint is rate limited to 5 QPS.**\n\nScopes: `API_KEYS_WRITE`","tags":["apiKeys"],"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/apiKeys_create-api-key_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"},"api_key":{"$ref":"#/components/schemas/ApiKeysPostRequestBodyContentApplicationJsonSchemaApiKey","description":"Details about the API key to create."}},"required":["idempotency_key","api_key"]}}}}}},"/api-keys/{api_key_id}":{"get":{"operationId":"retrieve-api-key","summary":"Retrieve API key","description":"Retrieves an API key by ID.\n\n**This endpoint is rate limited to 10 QPS.**\n\nScopes: `API_KEYS_READ`","tags":["apiKeys"],"parameters":[{"name":"api_key_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/apiKeys_retrieve-api-key_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"operationId":"delete-api-key","summary":"Delete API key","description":"Deletes an API key. After an API key is deleted, it can no longer be used for authentication. All API clients using the secret associated with this API key  will immediately be forbidden from talking to the Cash App Pay API.\n\n<Note title=\"Note\">\n There is no way to un-delete an API key, so treat this endpoint with caution in production environments.\n</Note>\n\n**This endpoint is rate limited to 5 QPS.**\n\nScopes: `API_KEYS_WRITE`","tags":["apiKeys"],"parameters":[{"name":"api_key_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/apiKeys_delete-api-key_Response_200"}}}}}}},"/webhook-endpoints":{"get":{"operationId":"list-webhook-endpoints","summary":"List webhook endpoints","description":"Returns a list of webhook endpoints matching the query parameters provided.\n\nScopes: `WEBHOOK_CONFIG_READ`","tags":["Webhooks"],"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 webhook endpoints to return.","required":false,"schema":{"type":"integer","default":50}},{"name":"reference_id","in":"query","description":"A user-defined identifier for this webhook endpoint, typically used to associate the webhook endpoint with a record in an external system.","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/webhooks_list-webhook-endpoints_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create-webhook-endpoint","summary":"Create webhook endpoint","description":"Creates a new webhook endpoint which Cash App can send events to.\n\n<Note title=\"Note\">\n Webhook events will not be successfully delivered for new domains until the new domain is allow-listed. New domains must be manually reviewed and allow-listed. It will typically take 1 business day to allow-list new domains.\n</Note>\n\nScopes: `WEBHOOK_CONFIG_WRITE`","tags":["Webhooks"],"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/webhooks_create-webhook-endpoint_Response_201"}}}},"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"},"webhook_endpoint":{"$ref":"#/components/schemas/WebhookEndpointsPostRequestBodyContentApplicationJsonSchemaWebhookEndpoint"}},"required":["idempotency_key","webhook_endpoint"]}}}}}},"/webhook-endpoints/{webhook_endpoint_id}":{"get":{"operationId":"retrieve-webhook-endpoint","summary":"Retrieve webhook endpoint","description":"Returns the webhook endpoint matching the `webhook_endpoint_id` provided.\n\nScopes: `WEBHOOK_CONFIG_READ`","tags":["Webhooks"],"parameters":[{"name":"webhook_endpoint_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/webhooks_retrieve-webhook-endpoint_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"operationId":"update-webhook-endpoint","summary":"Update webhook endpoint","description":"Updates the webhook endpoint matching the `webhook_endpoint_id` provided.\n\nScopes: `WEBHOOK_CONFIG_WRITE`","tags":["Webhooks"],"parameters":[{"name":"webhook_endpoint_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/webhooks_update-webhook-endpoint_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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"webhook_endpoint":{"$ref":"#/components/schemas/WebhookEndpointsWebhookEndpointIdPatchRequestBodyContentApplicationJsonSchemaWebhookEndpoint"}},"required":["webhook_endpoint"]}}}}},"delete":{"operationId":"delete-webhook-endpoint","summary":"Delete webhook endpoint","description":"Deletes the webhook endpoint matching the `webhook_endpoint_id` provided. Note: Events that are created before the webhook endpoint was deleted will still be delivered after the webhook endpoint gets deleted.\n\nScopes: `WEBHOOK_CONFIG_WRITE`","tags":["Webhooks"],"parameters":[{"name":"webhook_endpoint_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/webhooks_delete-webhook-endpoint_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/webhook-events":{"get":{"operationId":"list-webhook-events","summary":"List webhook events","description":"Returns a list of all webhook events matching the query parameters provided. Expired events are not included.\n\nScopes: `WEBHOOK_EVENTS_READ`","tags":["Webhooks"],"parameters":[{"name":"webhook_endpoint_id","in":"query","description":"Events delivered to this webhook endpoint ID.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The status of an event that was delivered to a webhook endpoint. The status can either be PENDING, SUCCESS, or FAILED.","required":false,"schema":{"$ref":"#/components/schemas/WebhookEventsGetParametersStatus"}},{"name":"event_type","in":"query","description":"The type of event that will be sent to the webhook endpoint.","required":false,"schema":{"$ref":"#/components/schemas/WebhookEventsGetParametersEventType"}},{"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 webhook events to return.","required":false,"schema":{"type":"integer","default":100}},{"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/webhooks_list-webhook-events_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/request-chains":{"post":{"operationId":"create-request-chain","summary":"Create request chain","description":"Executes multiple requests, grouped into \"chains\", in a single call. The API Client (Client) can use multiple chains and specify sub-requests within each chain to run sequentially or in parallel. However the chains, themselves, will only run sequentially.\n\n### Accessing a previous response's value\n\nClients can access a previous response's value by using the format: `$[previous request's uid]:[key path]`. Clients can use this in the value fields of:\n- `requests[].body`\n- `requests[].path_params`\n- `requests[].query_params`\n\nThe request's path `requests[].path` has an extra step to access a previous response's value. In the request's path, the Client will first refer to a key in the `requests[].path_params` field using the format: `{[path_params key name]}`. From there `requests[].path_params` can use the pattern described in **Accessing a previous response's value** to obtain a previous response's value.\n\n<Warning>\nThe initial security headers will be passed to all requests.\n\nScopes are not required for this endpoint. However, the API key must contain the appropriate scopes required by the individual requests to execute.\n</Warning>\n\nFor FAQs and performance improvement details, visit [Optimizing Performance with Request Chaining](../docs/partner-onboarding/optimizing-performance-with-request-chaining.md).\n","tags":["requestChains"],"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/requestChains_create-request-chain_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItems"},"description":"Requests to execute"},"chains":{"type":"array","items":{"$ref":"#/components/schemas/RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItems"},"description":"Chains control the order and execution modes of requests"}},"required":["requests","chains"]}}}}}}},"servers":[{"url":"https://api.cash.app/management/v1","description":"Production"},{"url":"https://sandbox.api.cash.app/management/v1","description":"Sandbox"}],"components":{"schemas":{"ScopesItems":{"type":"string","enum":["PAYMENTS_READ","PAYMENTS_WRITE","PAYOUTS_READ","PAYOUTS_WRITE","REFUNDS_READ","REFUNDS_WRITE","DISPUTES_READ","DISPUTES_WRITE","CUSTOMERS_READ","FEE_PLANS_READ","GRANTS_READ","GRANTS_WRITE","API_KEYS_READ","API_KEYS_WRITE","BRANDS_READ","BRANDS_WRITE","MERCHANTS_READ","MERCHANTS_WRITE","WEBHOOK_CONFIG_READ","WEBHOOK_CONFIG_WRITE","WEBHOOK_EVENTS_READ"],"title":"ScopesItems"},"Scopes":{"type":"array","items":{"$ref":"#/components/schemas/ScopesItems"},"description":"An array of permissions granted to the API key.\n\nCurrent values:\n\n- `API_KEYS_READ`: Permits listing API keys and retrieving individual keys.\n- `API_KEYS_WRITE`: Permits creating and deleting API keys.\n- `BRANDS_READ`: Permits listing brands and retrieving individual brands.\n- `BRANDS_WRITE`: Permits creating, upserting, and updating brands.\n- `CUSTOMERS_READ`: Permits listing customers and retrieving individual customers.\n- `DISPUTES_READ`: Permits listing disputes / dispute evidence and retrieving details about individual disputes / dispute evidence.\n- `DISPUTES_WRITE`: Permits uploading dispute evidence, accepting disputes, and challenging disputes.\n- `FEE_PLANS_READ`: Permits listing fee plans and retrieving individual fee plans.\n- `GRANTS_READ`: Permits listing grants for a customer and retrieving individual grants.\n- `GRANTS_WRITE`: Permits revoking a grant.\n- `MERCHANTS_READ`: Permits listing merchants and retrieving individual merchants.\n- `MERCHANTS_WRITE`: Permits creating, upserting, and updating merchants.\n- `PAYMENTS_READ`: Permits listing payments and retrieving individual payments.\n- `PAYMENTS_WRITE`: Permits taking payments, capturing payments, and voiding payments.\n- `PAYOUTS_READ`: Permits listing payouts and retrieving individual payouts.\n- `PAYOUTS_WRITE`: Permits creating payouts.\n- `REFUNDS_READ`: Permits listing refunds and retrieving individual refunds.\n- `REFUNDS_WRITE`: Permits issuing refunds, capturing refunds, and voiding refunds.\n- `WEBHOOK_CONFIG_READ`: Permits listing webhook delivery settings and retrieving individual configurations.\n- `WEBHOOK_CONFIG_WRITE`: Permits creating and updating webhook delivery settings.\n- `WEBHOOK_EVENTS_READ`: Permits listing webhook events and retrieving individual events.\n\nMin number of items: `1`","title":"Scopes"},"ApiKey":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this API key issued by Cash App. This is the API key value that is passed in the `Authorization` header."},"created_at":{"type":"string","format":"date-time","description":"When this API key was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"expires_at":{"type":"string","format":"date-time","description":"When this API key will be automatically deleted and become unusable, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"scopes":{"$ref":"#/components/schemas/Scopes"},"reference_id":{"type":"string","description":"A user-defined identifier for this API key, typically used to associate the API key with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"}},"required":["id","created_at","expires_at","scopes"],"title":"ApiKey"},"apiKeys_list-api-keys_Response_200":{"type":"object","properties":{"api_keys":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"},"description":"List of API keys for 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":["api_keys"],"title":"apiKeys_list-api-keys_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. See the Error Code Reference for more information.\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. Learn more about [idempotency](../docs/api/technical-documentation/api-fundamentals/idempotency) in the API.","title":"IdempotencyKey"},"ApiKeysPostRequestBodyContentApplicationJsonSchemaApiKey":{"type":"object","properties":{"scopes":{"$ref":"#/components/schemas/Scopes"},"reference_id":{"type":"string","description":"A user-defined identifier for this API key, typically used to associate the API key with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"}},"required":["scopes"],"description":"Details about the API key to create.","title":"ApiKeysPostRequestBodyContentApplicationJsonSchemaApiKey"},"apiKeys_create-api-key_Response_201":{"type":"object","properties":{"api_key":{"$ref":"#/components/schemas/ApiKey"},"secret":{"type":"string","description":"Secret value to use when calculating the `X-Signature` header of requests.\n\nThis value is not returned when retrieving an API key, so make sure to store it immediately.\n\nMin length: `32`\nMax length: `256`"}},"required":["api_key","secret"],"title":"apiKeys_create-api-key_Response_201"},"apiKeys_retrieve-api-key_Response_200":{"type":"object","properties":{"api_key":{"$ref":"#/components/schemas/ApiKey"}},"required":["api_key"],"title":"apiKeys_retrieve-api-key_Response_200"},"apiKeys_delete-api-key_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"apiKeys_delete-api-key_Response_200"},"EventType":{"type":"string","enum":["customer.created","customer.deleted","customer.updated","customer_request.state.updated","dispute.created","dispute.state.updated","grant.created","grant.status.updated","merchant.status.updated","payment.status.updated","refund.status.updated"],"description":"The type of event that will be sent to the webhook endpoint.","title":"EventType"},"ApiVersion":{"type":"string","enum":["v1"],"description":"Represents the API version. ","title":"ApiVersion"},"EventConfiguration":{"type":"object","properties":{"event_type":{"$ref":"#/components/schemas/EventType"},"api_version":{"$ref":"#/components/schemas/ApiVersion"}},"required":["event_type","api_version"],"description":"Represents a supported event type and the API version that the event of this type should be serialized to.","title":"EventConfiguration"},"WebhookEndpointStatus":{"type":"string","enum":["APPROVED","ENDPOINT_URL_UNDER_REVIEW"],"description":"The approval status of a webhook endpoint. Once a webhook endpoint is approved, Cash App will deliver events to that webhook endpoint.","title":"WebhookEndpointStatus"},"WebhookEndpoint":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID for a webhook endpoint issued by Cash App."},"api_key_id":{"type":"string","description":"The API key ID which will be used to sign requests made to this webhook endpoint."},"reference_id":{"type":"string","description":"A user-defined identifier for this webhook endpoint, typically used to associate the webhook endpoint with a record in an external system."},"url":{"type":["string","null"],"format":"uri","description":"The events are delivered to this endpoint URL. If NULL, events will be not be delivered to an endpoint but will still be persisted and accessible via the List Webhook Events API."},"event_configurations":{"type":"array","items":{"$ref":"#/components/schemas/EventConfiguration"},"description":"The list of supported event types for this webhook endpoint. Events of a particular type will only be sent to endpoints that contain the type in this list."},"created_at":{"type":"string","format":"date-time","description":"The timestamp of when this webhook endpoint was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp of when this endpoint was last updated."},"delivery_timeout":{"type":"number","format":"double","default":5000,"description":"The duration, in milliseconds, that Cash App will take to deliver an event to this endpoint before timing out."},"max_delivery_frequency":{"type":["number","null"],"format":"double","description":"The maximum number of events per second that will be delivered to this endpoint before rate limiting kicks in. The default for this field is unset (NULL) which means no rate limiting. However, if you enable rate limiting, the values can range from 1 to 100000."},"status":{"$ref":"#/components/schemas/WebhookEndpointStatus"}},"required":["id","api_key_id","url","event_configurations","created_at","updated_at","delivery_timeout","status"],"description":"The events will be sent to this webhook endpoint.","title":"WebhookEndpoint"},"webhooks_list-webhook-endpoints_Response_200":{"type":"object","properties":{"webhook_endpoints":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEndpoint"}},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["webhook_endpoints"],"title":"webhooks_list-webhook-endpoints_Response_200"},"WebhookEndpointsPostRequestBodyContentApplicationJsonSchemaWebhookEndpoint":{"type":"object","properties":{"api_key_id":{"type":"string","description":"The API key ID which will be used to sign requests made to this webhook endpoint."},"event_configurations":{"type":"array","items":{"$ref":"#/components/schemas/EventConfiguration"},"description":"The list of supported event types for this webhook endpoint. Events of a particular type will only be sent to endpoints that contain the type in this list."},"url":{"type":["string","null"],"description":"The URL of the endpoint which events will be delivered to. If NULL is specified, events will be not be delivered to an endpoint but will still be persisted and accessible via the List Webhook Events API."},"reference_id":{"type":"string","description":"A user-defined identifier for this webhook endpoint, typically used to associate the webhook endpoint with a record in an external system."},"delivery_timeout":{"type":"number","format":"double","default":5000,"description":"The duration, in milliseconds, that Cash App will take to deliver an event to this endpoint before timing out."},"max_delivery_frequency":{"type":"number","format":"double","description":"The maximum number of events per second that will be delivered to this endpoint before rate limiting kicks in. The default for this field is unset (NULL) which means no rate limiting. However, if you enable rate limiting, the values can range from 1 to 100000."}},"required":["api_key_id","event_configurations","url"],"title":"WebhookEndpointsPostRequestBodyContentApplicationJsonSchemaWebhookEndpoint"},"webhooks_create-webhook-endpoint_Response_201":{"type":"object","properties":{"webhook_endpoint":{"$ref":"#/components/schemas/WebhookEndpoint"}},"required":["webhook_endpoint"],"title":"webhooks_create-webhook-endpoint_Response_201"},"webhooks_retrieve-webhook-endpoint_Response_200":{"type":"object","properties":{"webhook_endpoint":{"$ref":"#/components/schemas/WebhookEndpoint"}},"required":["webhook_endpoint"],"title":"webhooks_retrieve-webhook-endpoint_Response_200"},"WebhookEndpointsWebhookEndpointIdPatchRequestBodyContentApplicationJsonSchemaWebhookEndpoint":{"type":"object","properties":{"url":{"type":["string","null"],"format":"uri","description":"The events are delivered to this endpoint URL."},"reference_id":{"type":["string","null"],"description":"A user-defined identifier for this webhook endpoint, typically used to associate the webhook endpoint with a record in an external system."},"api_key_id":{"type":"string","description":"The API key ID which will be used to sign requests made to this webhook endpoint."},"event_configurations":{"type":"array","items":{"$ref":"#/components/schemas/EventConfiguration"},"description":"The list of supported event types for this webhook endpoint. Events of a particular type will only be sent to endpoints that contain the type in this list."},"delivery_timeout":{"type":"number","format":"double","default":5000,"description":"The duration, in milliseconds, that Cash App will take to deliver an event to this endpoint before timing out."},"max_delivery_frequency":{"type":["number","null"],"format":"double","description":"The maximum number of events per second that will be delivered to this endpoint before rate limiting kicks in. The default for this field is unset (NULL) which means no rate limiting. However, if you enable rate limiting, the values can range from 1 to 100000."}},"title":"WebhookEndpointsWebhookEndpointIdPatchRequestBodyContentApplicationJsonSchemaWebhookEndpoint"},"webhooks_update-webhook-endpoint_Response_200":{"type":"object","properties":{"webhook_endpoint":{"$ref":"#/components/schemas/WebhookEndpoint"}},"required":["webhook_endpoint"],"title":"webhooks_update-webhook-endpoint_Response_200"},"webhooks_delete-webhook-endpoint_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"webhooks_delete-webhook-endpoint_Response_200"},"WebhookEventsGetParametersStatus":{"type":"string","enum":["PENDING","SUCCESS","FAILED"],"title":"WebhookEventsGetParametersStatus"},"WebhookEventsGetParametersEventType":{"type":"string","enum":["customer.created","customer.deleted","customer.updated","customer_request.state.updated","dispute.created","dispute.state.updated","grant.created","grant.status.updated","merchant.status.updated","payment.status.updated","refund.status.updated"],"title":"WebhookEventsGetParametersEventType"},"EventStatus":{"type":"string","enum":["PENDING","FAILED","SUCCESS"],"description":"The status of an event that was delivered to a webhook endpoint. The status can either be PENDING, SUCCESS, or FAILED.\n\nPENDING: The webhook event has been dispatched and is in the process of being delivered to the endpoint. If the event has failed and is being retried, it will continue to be in the PENDING status.\n\nSUCCESS: The webhook event has been delivered to the endpoint and we've received receipt of the delivery from the client's endpoint (e.g. 200OK).\n\nFAILED: The webhook event has failed all delivery attempts for 72 hours. No more deliveries will be attempted.","title":"EventStatus"},"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"},"EventDataDataObject0":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"}},"title":"EventDataDataObject0"},"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"},"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> Note: Nested keys are not supported.","title":"Metadata"},"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"},"EventDataDataObject1":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"}},"title":"EventDataDataObject1"},"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"},"EventDataDataObject2":{"type":"object","properties":{"dispute":{"$ref":"#/components/schemas/Dispute"}},"title":"EventDataDataObject2"},"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"],"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"},"EventDataDataObject3":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"title":"EventDataDataObject3"},"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"},"EventDataDataObject4":{"type":"object","properties":{"grant":{"$ref":"#/components/schemas/Grant"}},"title":"EventDataDataObject4"},"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"},"EventDataDataObject5":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"title":"EventDataDataObject5"},"RequestStatus":{"type":"string","enum":["APPROVED","DECLINED","PENDING","PROCESSING"],"default":"PENDING","description":"Indicates if the state is approved, declined, or pending. Approved requests have grants, while pending and declined grants do not.\n\nCurrent values:\n\n- `PENDING`: The request has been created, but not responded to.\n- `PROCESSING`: The Cash App customer is actively responding to the request on their mobile device, and will require time to fill out information before the request is approved / declined.\n- `APPROVED`: The request was approved by the customer and grants have been created for the provided actions.\n- `DECLINED`: The request was denied by the customer. No grants were created.","title":"RequestStatus"},"RequestAuthFlowTriggers":{"type":"object","properties":{"qr_code_image_url":{"type":"string","format":"uri","description":"Link to a QR code customers can scan with Cash App to authorize the given action, encoded as a PNG file.\n\nMin length: `8`\nMax length: `1024`"},"qr_code_svg_url":{"type":"string","format":"uri","description":"Link to a QR code customers can scan with Cash App to authorize the given action, encoded as an SVG file.\n\nMin length: `8`\nMax length: `1024`"},"mobile_url":{"type":"string","format":"uri","description":"If on an Android or iOS device, the URL to redirect customers to in order to authorize the given action.\n\nMin length: `8`\nMax length: `1024`"},"refreshes_at":{"type":"string","format":"date-time","description":"When the QR code image URL will be rotated. Generally, it will rotate every ~20 seconds and become invalid after 30 seconds."},"desktop_url":{"type":"string","format":"uri","description":"If on a desktop browser, the URL to redirect customers to in order to authorize the given action.\n\nMin length: `8`\nMax length: `1024`"}},"required":["qr_code_image_url","qr_code_svg_url","mobile_url","refreshes_at"],"description":"While the request is `PENDING`, contains different methods that can be used to start\nthe authorization flow in the Cash App mobile application. Its contents refresh each time\nthe `refreshes_at` timestamp passes. When the\ndata refreshes, you should update any buttons\nor QR codes referring to it immediately.\n\nAfter a request has been scanned (and is no\nlonger in the `PENDING` status), this\nfield will no longer be returned.","title":"RequestAuthFlowTriggers"},"RequestOriginType":{"type":"string","enum":["DIRECT","REQUEST_INITIATOR"],"description":"The method used to create the customer request.\n\n- `DIRECT` - the client or SDKs created this customer request by calling the \"CreateCustomerRequest\" endpoint\n- `REQUEST_INITIATOR` - a customer interacted with a request initiator and caused Cash App to create a customer request.","title":"RequestOriginType"},"RequestOrigin":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/RequestOriginType","description":"The method used to create the customer request.\n\n- `DIRECT` - the client or SDKs created this customer request by calling the \"CreateCustomerRequest\" endpoint\n- `REQUEST_INITIATOR` - a customer interacted with a request initiator and caused Cash App to create a customer request."},"id":{"type":"string","description":"If present, is the ID of the initiator used to create this request.\n\nMin length: `1`\nMax length: `128`"}},"required":["type"],"description":"Metadata describing how the customer request was created.","title":"RequestOrigin"},"RequestRequesterProfile":{"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`"},"logo_url":{"type":"string","format":"uri","description":"URL to the image of the entity (brand or client) that is requesting permission to perform the actions on the customer request.\n\nFormats:\n- `.jpg`\n- `.jpeg`\n- `.png`\n\nMin length: `8`\nMax length: `8000`"}},"required":["name","logo_url"],"description":"Details about the brand or client that are requesting permission to perform the actions on the customer request.","title":"RequestRequesterProfile"},"RequestCustomerProfile":{"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`"}},"required":["id","cashtag"],"description":"If the customer request was approved, contains the identity of the Cash App customer that approved it.","title":"RequestCustomerProfile"},"CustomerMetadata":{"type":"object","properties":{"reference_id":{"type":"string","description":"The `reference_id` of the customer approving this request. When a customer approves this request, that customer will be associated with this `reference_id`."}},"description":"Metadata to associate with the customer that approves this request.","title":"CustomerMetadata"},"Request":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the request issued by Cash App.\n\nMin length: `1`\nMax length: `128`"},"status":{"$ref":"#/components/schemas/RequestStatus","description":"Indicates if the state is approved, declined, or pending. Approved requests have grants, while pending and declined grants do not.\n\nCurrent values:\n\n- `PENDING`: The request has been created, but not responded to.\n- `PROCESSING`: The Cash App customer is actively responding to the request on their mobile device, and will require time to fill out information before the request is approved / declined.\n- `APPROVED`: The request was approved by the customer and grants have been created for the provided actions.\n- `DECLINED`: The request was denied by the customer. No grants were created."},"actions":{"type":"array","items":{"$ref":"#/components/schemas/Action"},"description":"Represents what the client intends to do to a customer if given authorization.\n\nNo duplicate action types allowed.\n\nMin number of items: `1`\nMax number of items: `5`"},"auth_flow_triggers":{"$ref":"#/components/schemas/RequestAuthFlowTriggers","description":"While the request is `PENDING`, contains different methods that can be used to start\nthe authorization flow in the Cash App mobile application. Its contents refresh each time\nthe `refreshes_at` timestamp passes. When the\ndata refreshes, you should update any buttons\nor QR codes referring to it immediately.\n\nAfter a request has been scanned (and is no\nlonger in the `PENDING` status), this\nfield will no longer be returned."},"redirect_url":{"type":"string","format":"uri","description":"If this request is responded to via mobile redirect, this field specifies the URL that Cash App will open for a customer in the mobile device's default browser after the request is approved or declined."},"created_at":{"type":"string","format":"date-time","description":"When this customer request was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"updated_at":{"type":"string","format":"date-time","description":"When the customer request was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"expires_at":{"type":"string","format":"date-time","description":"When this customer request will be automatically declined by Cash App, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."},"origin":{"$ref":"#/components/schemas/RequestOrigin","description":"Metadata describing how the customer request was created."},"channel":{"$ref":"#/components/schemas/Channel"},"grants":{"type":"array","items":{"$ref":"#/components/schemas/Grant"},"description":"If present, contains grants that can be used to perform actions specified in the request using the Network API.\n\nEach grant corresponds directly to an action on the request.\n\nMin number of items: `1`\nMax number of items: `5`"},"reference_id":{"type":"string","description":"A user-defined identifier for this request, typically used to associate the resource with a record in an external system.\n\nMin length: `1`\nMax length: `1024`"},"requester_profile":{"$ref":"#/components/schemas/RequestRequesterProfile","description":"Details about the brand or client that are requesting permission to perform the actions on the customer request."},"customer_profile":{"$ref":"#/components/schemas/RequestCustomerProfile","description":"If the customer request was approved, contains the identity of the Cash App customer that approved it."},"metadata":{"$ref":"#/components/schemas/Metadata"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"}},"required":["id","status","actions","redirect_url","created_at","updated_at","expires_at","origin","channel"],"description":"Describes a request from a client to perform a given action on a customer's account.","title":"Request"},"EventDataDataObject6":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/Request"}},"title":"EventDataDataObject6"},"EventDataDataObject":{"oneOf":[{"$ref":"#/components/schemas/EventDataDataObject0"},{"$ref":"#/components/schemas/EventDataDataObject1"},{"$ref":"#/components/schemas/EventDataDataObject2"},{"$ref":"#/components/schemas/EventDataDataObject3"},{"$ref":"#/components/schemas/EventDataDataObject4"},{"$ref":"#/components/schemas/EventDataDataObject5"},{"$ref":"#/components/schemas/EventDataDataObject6"}],"description":"The snapshot of the resource contained in the event.","title":"EventDataDataObject"},"EventDataType":{"type":"string","enum":["customer","merchant","dispute","grant","payment","refund","request"],"description":"The type of the resource contained in the event.","title":"EventDataType"},"EventDataData":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID provided by Cash App for the resource contained in the event."},"object":{"$ref":"#/components/schemas/EventDataDataObject","description":"The snapshot of the resource contained in the event."},"type":{"$ref":"#/components/schemas/EventDataType"}},"required":["id","object","type"],"description":"The underlying data encapsulated in the event.","title":"EventDataData"},"EventData":{"type":"object","properties":{"event_id":{"type":"string","description":"The unique ID of the webhook event."},"type":{"$ref":"#/components/schemas/EventType"},"created_at":{"type":"string","format":"date-time","description":"The timestamp of when the event was created."},"data":{"$ref":"#/components/schemas/EventDataData","description":"The underlying data encapsulated in the event."}},"required":["event_id","type","created_at","data"],"description":"This represents the data that is delivered to a webhook endpoint.","title":"EventData"},"WebhookEvent":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for a webhook event issued by Cash App."},"webhook_endpoint_id":{"type":"string","description":"This event is delivered to this webhook endpoint ID."},"event_type":{"$ref":"#/components/schemas/EventType"},"status":{"$ref":"#/components/schemas/EventStatus"},"created_at":{"type":"string","format":"date-time","description":"The timestamp of when the event was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp of when the event was last updated."},"expires_at":{"type":"string","format":"date-time","description":"The timestamp of when this event will expire and no longer be available in Cash App."},"event_data":{"$ref":"#/components/schemas/EventData"},"api_version":{"type":"string","description":"The API version used to serialize the event data."}},"required":["id","webhook_endpoint_id","event_type","status","created_at","updated_at","expires_at","event_data","api_version"],"description":"The event that is being sent to a particular webhook endpoint. The event is either in the process of being delivered (PENDING), has been successfully delivered (SUCCESS), or has failed all attempts to deliver (FAILED).","title":"WebhookEvent"},"webhooks_list-webhook-events_Response_200":{"type":"object","properties":{"webhook_events":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEvent"}},"cursor":{"type":"string","description":"The pagination cursor to be used in a subsequent request. If empty, this is the final response."}},"required":["webhook_events"],"title":"webhooks_list-webhook-events_Response_200"},"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsMethod":{"type":"string","enum":["GET","POST","PATCH","PUT","DELETE"],"description":"HTTP method of the request","title":"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsMethod"},"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsPathParams":{"type":"object","properties":{},"description":"A map of path parameters. The keys represent variables from the `path`. The value fields allow for **Accessing a previous response's value**.","title":"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsPathParams"},"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsQueryParams":{"type":"object","properties":{},"description":"A map of query parameters. The value fields allow for **Accessing a previous response's value**.","title":"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsQueryParams"},"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsBody":{"type":"object","properties":{},"description":"The body that is required for the requested endpoint. The value fields allow for **Accessing a previous response's value**.","title":"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsBody"},"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItems":{"type":"object","properties":{"uid":{"type":"string","description":"Unique identifier for the request"},"method":{"$ref":"#/components/schemas/RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsMethod","description":"HTTP method of the request"},"path":{"type":"string","description":"URL path to call. Use format `{path_params key name}` to add variable path parameters."},"path_params":{"$ref":"#/components/schemas/RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsPathParams","description":"A map of path parameters. The keys represent variables from the `path`. The value fields allow for **Accessing a previous response's value**."},"query_params":{"$ref":"#/components/schemas/RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsQueryParams","description":"A map of query parameters. The value fields allow for **Accessing a previous response's value**."},"body":{"$ref":"#/components/schemas/RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsBody","description":"The body that is required for the requested endpoint. The value fields allow for **Accessing a previous response's value**."}},"required":["uid","method","path"],"title":"RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItems"},"RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItemsRequestsItems":{"type":"object","properties":{"uid":{"type":"string","description":"Unique identifier for the request to execute"}},"required":["uid"],"title":"RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItemsRequestsItems"},"RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItemsExecutionMode":{"type":"string","enum":["SEQUENTIAL","PARALLEL"],"description":"Execution mode of the requests in a chain","title":"RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItemsExecutionMode"},"RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItems":{"type":"object","properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItemsRequestsItems"}},"execution_mode":{"$ref":"#/components/schemas/RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItemsExecutionMode","description":"Execution mode of the requests in a chain"}},"required":["requests","execution_mode"],"title":"RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItems"},"ResponseExecutionStatus":{"type":"string","enum":["EXECUTED","NOT_STARTED"],"description":"Execution status of the request","title":"ResponseExecutionStatus"},"ResponseMethod":{"type":"string","enum":["GET","POST","PATCH","PUT","DELETE"],"description":"HTTP method of the request","title":"ResponseMethod"},"ResponseBody":{"type":"object","properties":{},"description":"Response body of the requested endpoint","title":"ResponseBody"},"Response":{"type":"object","properties":{"request_uid":{"type":"string","description":"Unique identifier for the request"},"execution_status":{"$ref":"#/components/schemas/ResponseExecutionStatus","description":"Execution status of the request"},"path":{"type":"string","description":"URL path that was called"},"method":{"$ref":"#/components/schemas/ResponseMethod","description":"HTTP method of the request"},"status_code":{"type":"integer","description":"Status code of the request"},"body":{"$ref":"#/components/schemas/ResponseBody","description":"Response body of the requested endpoint"},"completed_at":{"type":"string","format":"date-time","description":"When the request was completed, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."}},"required":["request_uid","execution_status","path","method"],"title":"Response"},"requestChains_create-request-chain_Response_201":{"type":"object","properties":{"responses":{"type":"array","items":{"$ref":"#/components/schemas/Response"}}},"required":["responses"],"title":"requestChains_create-request-chain_Response_201"}}}}