{"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:pay-com/session-create-payment":{"post":{"operationId":"payments_pay_com_session_create_payment","summary":"Create a Payment Session","description":"POST /v1/sessions/payment","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/session-get-payment-details":{"get":{"operationId":"payments_pay_com_session_get_payment_details","summary":"Retrieve a Payment Session","description":"GET /v1/sessions/payment/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Payment Session to retrieve.","schema":{"type":"string","description":"The id of the Payment Session to retrieve."}}],"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:pay-com/session-create-setup":{"post":{"operationId":"payments_pay_com_session_create_setup","summary":"Create a Setup Session","description":"POST /v1/sessions/setup","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/session-get-details":{"get":{"operationId":"payments_pay_com_session_get_details","summary":"Retrieve a Setup Session","description":"GET /v1/sessions/setup/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Setup Session to retrieve.","schema":{"type":"string","description":"The id of the Setup Session to retrieve."}}],"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:pay-com/session-get-attempts":{"get":{"operationId":"payments_pay_com_session_get_attempts","summary":"Retrieve Attempts of a Session","description":"GET /v1/sessions/payment/{id}/attempts","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Payment Session to retrieve attempts for.","schema":{"type":"string","description":"The id of the Payment Session to retrieve attempts for."}}],"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:pay-com/session-get-session-attempts":{"get":{"operationId":"payments_pay_com_session_get_session_attempts","summary":"Retrieve Attempts of a Session","description":"GET /v1/sessions/setup/{id}/attempts","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Setup Session to retrieve attempts for.","schema":{"type":"string","description":"The id of the Setup Session to retrieve attempts for."}}],"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:pay-com/session-create-linked":{"post":{"operationId":"payments_pay_com_session_create_linked","summary":"Create a Linked Session","description":"POST /v1/sessions/authentication/linked","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/session-create-independent":{"post":{"operationId":"payments_pay_com_session_create_independent","summary":"Create an Independent Session","description":"POST /v1/sessions/authentication/independent","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/session-get-payment-attempt":{"get":{"operationId":"payments_pay_com_session_get_payment_attempt","summary":"Retrieve a Payment Session","description":"GET /v1/attempts/payment/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Payment Session to retrieve.","schema":{"type":"string","description":"The id of the Payment Session to retrieve."}}],"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:pay-com/attempt-get-details":{"get":{"operationId":"payments_pay_com_attempt_get_details","summary":"Retrieve a Setup Attempt","description":"GET /v1/attempts/setup/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Setup Attempt to retrieve.","schema":{"type":"string","description":"The id of the Setup Attempt to retrieve."}}],"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:pay-com/charge-create-charge":{"post":{"operationId":"payments_pay_com_charge_create_charge","summary":"Create a Charge","description":"POST /v1/charges","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/charge-get-details":{"get":{"operationId":"payments_pay_com_charge_get_details","summary":"Retrieve a Charge","description":"GET /v1/charges/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Charge to retrieve.","schema":{"type":"string","description":"The id of the Charge to retrieve."}}],"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:pay-com/charge-confirm-charge":{"post":{"operationId":"payments_pay_com_charge_confirm_charge","summary":"Confirm a Charge","description":"POST /v1/charges/{id}/confirm","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the Charge to confirm."}}}}}},"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:pay-com/refund-payment-method":{"post":{"operationId":"payments_pay_com_refund_payment_method","summary":"Create a Refund","description":"POST /v1/refunds","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/refund-get-details":{"get":{"operationId":"payments_pay_com_refund_get_details","summary":"Retrieve a Refund","description":"GET /v1/refunds/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Refund to retrieve.","schema":{"type":"string","description":"The id of the Refund to retrieve."}}],"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:pay-com/hold-create-hold":{"post":{"operationId":"payments_pay_com_hold_create_hold","summary":"Create a Hold","description":"POST /v1/holds","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/hold-get-details":{"get":{"operationId":"payments_pay_com_hold_get_details","summary":"Retrieve a Hold","description":"GET /v1/holds/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Hold to retrieve.","schema":{"type":"string","description":"The id of the Hold to retrieve."}}],"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:pay-com/hold-capture-hold":{"post":{"operationId":"payments_pay_com_hold_capture_hold","summary":"Capture a Hold","description":"POST /v1/holds/{id}/capture","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the Hold to capture."},"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:pay-com/hold-cancel-hold":{"post":{"operationId":"payments_pay_com_hold_cancel_hold","summary":"Cancel a Hold","description":"POST /v1/holds/{id}/cancel","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the Hold to cancel."}}}}}},"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:pay-com/hold-confirm-hold-status":{"post":{"operationId":"payments_pay_com_hold_confirm_hold_status","summary":"Confirm a Hold","description":"POST /v1/holds/{id}/confirm","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the Charge to confirm."}}}}}},"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:pay-com/payout-create-payout":{"post":{"operationId":"payments_pay_com_payout_create_payout","summary":"Create a Payout","description":"POST /v1/payouts","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/payout-get-details":{"get":{"operationId":"payments_pay_com_payout_get_details","summary":"Retrieve a Payout","description":"GET /v1/payouts/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Payout to retrieve.","schema":{"type":"string","description":"The id of the Payout to retrieve."}}],"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:pay-com/payment-method-create-payment-method":{"post":{"operationId":"payments_pay_com_payment_method_create_payment_method","summary":"Create a Payment Method","description":"POST /v1/payment_methods","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/payment-method-get-details":{"get":{"operationId":"payments_pay_com_payment_method_get_details","summary":"Retrieve a Payment Method","description":"GET /v1/payment_methods/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the Payment Method.","schema":{"type":"string","description":"The id of the Payment Method."}}],"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:pay-com/payment-method-delete-method":{"post":{"operationId":"payments_pay_com_payment_method_delete_method","summary":"Delete a Payment Method","description":"DELETE /v1/payment_methods/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the Payment Method."}}}}}},"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:pay-com/customer-get-payment-methods":{"get":{"operationId":"payments_pay_com_customer_get_payment_methods","summary":"Retrieve Payment Methods","description":"GET /v1/customers/{reference_id}/payment_methods","tags":["payments"],"parameters":[{"name":"reference_id","in":"query","required":true,"description":"The reference id of the Customer to retrieve the payment methods for.","schema":{"type":"string","description":"The reference id of the Customer to retrieve the payment methods for."}}],"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:pay-com/customer-create-customer":{"post":{"operationId":"payments_pay_com_customer_create_customer","summary":"Create a Customer","description":"POST /v1/customers","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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:pay-com/customer-get-details":{"get":{"operationId":"payments_pay_com_customer_get_details","summary":"Retrieve a Customer","description":"GET /v1/customers/{reference_id}","tags":["payments"],"parameters":[{"name":"reference_id","in":"query","required":true,"description":"The reference id of the Customer.","schema":{"type":"string","description":"The reference id of the Customer."}}],"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:pay-com/customer-update-details":{"post":{"operationId":"payments_pay_com_customer_update_details","summary":"Update a Customer","description":"PUT /v1/customers/{reference_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reference_id"],"properties":{"reference_id":{"type":"string","description":"The reference id of the Customer."},"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:pay-com/customer-delete-customer":{"post":{"operationId":"payments_pay_com_customer_delete_customer","summary":"Delete a Customer","description":"DELETE /v1/customers/{reference_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reference_id"],"properties":{"reference_id":{"type":"string","description":"The reference id of the Customer."}}}}}},"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"}}}}}}}