{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/payments:paypal-disputes/disputes-list":{"get":{"operationId":"payments_paypal_disputes_disputes_list","summary":"List disputes","description":"GET /v1/customer/disputes","tags":["payments"],"parameters":[{"name":"start_time","in":"query","required":false,"description":"Filters the disputes in the response by a creation date and time. The start time must be within the last 180 days. Value is in [Internet…","schema":{"type":"string","default":"Current date and time","description":"Filters the disputes in the response by a creation date and time. The start time must be within the last 180 days. Value is in [Internet…"}},{"name":"disputed_transaction_id","in":"query","required":false,"description":"Filters the disputes in the response by a transaction, by ID. You can specify either but not both the `start_time` and…","schema":{"type":"string","description":"Filters the disputes in the response by a transaction, by ID. You can specify either but not both the `start_time` and…"}},{"name":"page_size","in":"query","required":false,"description":"Limits the number of disputes in the response to this value.","schema":{"type":"integer","default":10,"description":"Limits the number of disputes in the response to this value."}},{"name":"next_page_token","in":"query","required":false,"description":"The token that describes the next page of results to fetch. The list disputes call returns this token in the HATEOAS links in the response.","schema":{"type":"string","default":"The first page of data","description":"The token that describes the next page of results to fetch. The list disputes call returns this token in the HATEOAS links in the response."}},{"name":"dispute_state","in":"query","required":false,"description":"Filters the disputes in the response by a state. Separate multiple values with a comma (`,`). When you specify more than one…","schema":{"type":"string","description":"Filters the disputes in the response by a state. Separate multiple values with a comma (`,`). When you specify more than one…"}},{"name":"update_time_before","in":"query","required":false,"description":"The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).…","schema":{"type":"string","description":"The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).…"}},{"name":"update_time_after","in":"query","required":false,"description":"The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).…","schema":{"type":"string","description":"The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-get":{"get":{"operationId":"payments_paypal_disputes_disputes_get","summary":"Show dispute details","description":"GET /v1/customer/disputes/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the dispute for which to provide the supporting information.","schema":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-patch":{"post":{"operationId":"payments_paypal_disputes_disputes_patch","summary":"Partially update dispute","description":"PATCH /v1/customer/disputes/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-provide-evidence":{"post":{"operationId":"payments_paypal_disputes_disputes_provide_evidence","summary":"Provide evidence","description":"POST /v1/customer/disputes/{id}/provide-evidence","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-appeal":{"post":{"operationId":"payments_paypal_disputes_disputes_appeal","summary":"Appeal dispute","description":"POST /v1/customer/disputes/{id}/appeal","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-accept-claim":{"post":{"operationId":"payments_paypal_disputes_disputes_accept_claim","summary":"Accept claim","description":"POST /v1/customer/disputes/{id}/accept-claim","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-adjudicate":{"post":{"operationId":"payments_paypal_disputes_disputes_adjudicate","summary":"Settle dispute","description":"POST /v1/customer/disputes/{id}/adjudicate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-require-evidence":{"post":{"operationId":"payments_paypal_disputes_disputes_require_evidence","summary":"Update dispute status","description":"POST /v1/customer/disputes/{id}/require-evidence","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-escalate":{"post":{"operationId":"payments_paypal_disputes_disputes_escalate","summary":"Escalate dispute to claim","description":"POST /v1/customer/disputes/{id}/escalate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-send-message":{"post":{"operationId":"payments_paypal_disputes_disputes_send_message","summary":"Send message about dispute to other party","description":"POST /v1/customer/disputes/{id}/send-message","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-make-offer":{"post":{"operationId":"payments_paypal_disputes_disputes_make_offer","summary":"Make offer to resolve dispute","description":"POST /v1/customer/disputes/{id}/make-offer","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-accept-offer":{"post":{"operationId":"payments_paypal_disputes_disputes_accept_offer","summary":"Accept offer to resolve dispute","description":"POST /v1/customer/disputes/{id}/accept-offer","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-deny-offer":{"post":{"operationId":"payments_paypal_disputes_disputes_deny_offer","summary":"Deny offer to resolve dispute","description":"POST /v1/customer/disputes/{id}/deny-offer","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-acknowledge-return-item":{"post":{"operationId":"payments_paypal_disputes_disputes_acknowledge_return_item","summary":"Acknowledge returned item","description":"POST /v1/customer/disputes/{id}/acknowledge-return-item","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-disputes/disputes-provide-supporting-info":{"post":{"operationId":"payments_paypal_disputes_disputes_provide_supporting_info","summary":"Provide supporting information for dispute","description":"POST /v1/customer/disputes/{id}/provide-supporting-info","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the dispute for which to provide the supporting information."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}