{"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:volt-io/authenticating-with-the-api-using-oauth2-password":{"post":{"operationId":"payments_volt_io_authenticating_with_the_api_using_oauth2_password","summary":"oAuth2 password authentication","description":"POST /oauth","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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:volt-io/banks-and-financial-institutions-get-details":{"get":{"operationId":"payments_volt_io_banks_and_financial_institutions_get_details","summary":"Bank details","description":"GET /banks/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"UUID of the Bank","schema":{"type":"string","description":"UUID of the Bank"},"example":"662384a0-9734-4556-a8bd-3f1e774e2a3c"}],"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:volt-io/payments-submit-details":{"post":{"operationId":"payments_volt_io_payments_submit_details","summary":"New payment request","description":"POST /v2/payments","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:volt-io/payments-initiate-embedded-checkout":{"post":{"operationId":"payments_volt_io_payments_initiate_embedded_checkout","summary":"New Embedded checkout","description":"POST /dropin","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:volt-io/payments-get-list":{"get":{"operationId":"payments_volt_io_payments_get_list","summary":"List payments","description":"GET /payments","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"UUID of the Payment","schema":{"type":"string","description":"UUID of the Payment"},"example":"662384a0-9734-4556-a8bd-3f1e774e2a3c"},{"name":"bank","in":"query","required":false,"description":"UUID of the Bank","schema":{"type":"string","description":"UUID of the Bank"},"example":"662384a0-9734-4556-a8bd-3f1e774e2a3c"},{"name":"currency","in":"query","required":false,"description":"3-letter currency code - See [ISO 4217 - Currency codes](https://www.iso.org/iso-4217-currency-codes.html)","schema":{"type":"string","description":"3-letter currency code - See [ISO 4217 - Currency codes](https://www.iso.org/iso-4217-currency-codes.html)"},"example":"EUR"},{"name":"amount","in":"query","required":false,"description":"The amount of the transaction in 1/100 units (pence, cents etc)","schema":{"type":"integer","description":"The amount of the transaction in 1/100 units (pence, cents etc)"},"example":12345},{"name":"type","in":"query","required":false,"description":"The transaction type (these are predefined)","schema":{"type":"string","enum":["BILL","GOODS","PERSON_TO_PERSON","OTHER","SERVICES"],"description":"The transaction type (these are predefined)"},"example":"OTHER"},{"name":"uniqueReference","in":"query","required":false,"description":"Unique reference for the payment","schema":{"type":"string","description":"Unique reference for the payment"},"example":"sale123456"},{"name":"status","in":"query","required":false,"description":"The current status of the payment","schema":{"type":"string","description":"The current status of the payment"},"example":"REQUESTED"},{"name":"page","in":"query","required":false,"description":"You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in…","schema":{"type":"integer","default":1,"description":"You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in…"}},{"name":"limit","in":"query","required":false,"description":"If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first…","schema":{"type":"integer","default":50,"description":"If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first…"}}],"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:volt-io/payments-get-details":{"get":{"operationId":"payments_volt_io_payments_get_details","summary":"Payment details","description":"GET /payments/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of the payment","schema":{"type":"string","description":"ID of the payment"},"example":"93b85f3c-76eb-4316-b1ae-f3370ddc59bc"}],"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:volt-io/payouts-connect-eligible-beneficiaries-list":{"get":{"operationId":"payments_volt_io_payouts_connect_eligible_beneficiaries_list","summary":"Eligible beneficiaries list","description":"GET /payouts/beneficiaries","tags":["payments"],"parameters":[{"name":"name","in":"query","required":false,"description":"Name of the beneficiary you'd like to send a payout to","schema":{"type":"string","description":"Name of the beneficiary you'd like to send a payout to"}},{"name":"accountNumber","in":"query","required":false,"description":"Domestic account number for the beneficiary you'd like to send a payout to","schema":{"type":"string","description":"Domestic account number for the beneficiary you'd like to send a payout to"}},{"name":"iban","in":"query","required":false,"description":"iban for the beneficiary you'd like to send a payout to","schema":{"type":"string","description":"iban for the beneficiary you'd like to send a payout to"}},{"name":"page","in":"query","required":false,"description":"You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in…","schema":{"type":"integer","default":1,"description":"You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in…"}},{"name":"limit","in":"query","required":false,"description":"If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first…","schema":{"type":"integer","default":50,"description":"If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first…"}}],"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:volt-io/payouts-connect-get-list":{"get":{"operationId":"payments_volt_io_payouts_connect_get_list","summary":"Payout list","description":"GET /payouts","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in…","schema":{"type":"integer","default":1,"description":"You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in…"}},{"name":"limit","in":"query","required":false,"description":"If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first…","schema":{"type":"integer","default":50,"description":"If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first…"}}],"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:volt-io/payouts-connect-create-request":{"post":{"operationId":"payments_volt_io_payouts_connect_create_request","summary":"New payout request","description":"POST /payouts","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"idempotency-key":{"type":"string","description":"Recommended to avoid duplicate payout requests"},"X-JWS-Header":{"type":"string","description":"Optional - applicable if Volt is your Connect partner"},"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:volt-io/payouts-connect-get-details":{"get":{"operationId":"payments_volt_io_payouts_connect_get_details","summary":"Payout details","description":"GET /payouts/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of the payout","schema":{"type":"string","description":"ID of the payout"},"example":"efffed42-40f7-4bd2-840d-908aae9a33ad"}],"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:volt-io/refunds-connect-check-eligibility":{"get":{"operationId":"payments_volt_io_refunds_connect_check_eligibility","summary":"Check refund eligibility","description":"GET /payments/{id}/refund-details","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of the refund","schema":{"type":"string","description":"ID of the refund"},"example":"93b85f3c-76eb-4316-b1ae-f3370ddc59bc"}],"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:volt-io/refunds-connect-create-request":{"post":{"operationId":"payments_volt_io_refunds_connect_create_request","summary":"New refund request","description":"POST /payments/{id}/request-refund","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"idempotency-key":{"type":"string","description":"Optional - but recommended - to avoid duplicate refund requests"},"id":{"type":"string","description":"ID of the payment"},"X-JWS-Header":{"type":"string","description":"Optional - applicable if Volt is your Connect partner"},"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:volt-io/reporting-create-payment-report":{"post":{"operationId":"payments_volt_io_reporting_create_payment_report","summary":"Create payment report","description":"POST /reports/payments","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:volt-io/reporting-create-connect-report":{"post":{"operationId":"payments_volt_io_reporting_create_connect_report","summary":"Create Connect report","description":"POST /reports/connect/{bankAccountId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bankAccountId"],"properties":{"bankAccountId":{"type":"string","description":"Connect bank account ID that you're requesting report for"},"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:volt-io/reporting-create-refund-report":{"post":{"operationId":"payments_volt_io_reporting_create_refund_report","summary":"Create Refund report","description":"POST /reports/refund","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:volt-io/reporting-create-audit-log-report":{"post":{"operationId":"payments_volt_io_reporting_create_audit_log_report","summary":"Create Audit Log report","description":"POST /reports/auditlog","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:volt-io/reporting-get-available-reports":{"get":{"operationId":"payments_volt_io_reporting_get_available_reports","summary":"Get available reports","description":"GET /reports","tags":["payments"],"parameters":[{"name":"customerId","in":"query","required":false,"description":"The ID of a specific merchant within your customer hierarchy","schema":{"type":"string","description":"The ID of a specific merchant within your customer hierarchy"}}],"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:volt-io/reporting-get-report-details":{"get":{"operationId":"payments_volt_io_reporting_get_report_details","summary":"Get report by ID","description":"GET /reports/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of the report you wish to retrieve","schema":{"type":"string","description":"ID of the report you wish 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:volt-io/reporting-download-report-by-id":{"get":{"operationId":"payments_volt_io_reporting_download_report_by_id","summary":"Download a report","description":"GET /reports/{id}/download","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of report","schema":{"type":"string","description":"ID of report"}}],"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:volt-io/payments-check-match-score":{"get":{"operationId":"payments_volt_io_payments_check_match_score","summary":"Payment Match Score","description":"GET /payments/{paymentId}/name-match-score","tags":["payments"],"parameters":[{"name":"paymentId","in":"query","required":true,"schema":{"type":"string"}},{"name":"allow_initials","in":"query","required":false,"description":"default: true - if set to false, receiving an account holder name that contains an initial instead of a first name will significantly…","schema":{"type":"boolean","description":"default: true - if set to false, receiving an account holder name that contains an initial instead of a first name will significantly…"}}],"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"}}},"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"}}}}}}}