{"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:peach-payments/checkout-generation-initiate-redirect-checkout":{"post":{"operationId":"payments_peach_payments_checkout_generation_initiate_redirect_checkout","summary":"Initiate redirect-based Checkout","description":"POST /checkout/initiate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Referer","body"],"properties":{"Referer":{"type":"string","description":"An allowlisted domain for the merchant."},"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:peach-payments/checkout-generation-initiate-payment":{"post":{"operationId":"payments_peach_payments_checkout_generation_initiate_payment","summary":"Initiate Checkout","description":"POST /checkout","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Referer","body"],"properties":{"Referer":{"type":"string","description":"An allowlisted domain for the merchant."},"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:peach-payments/checkout-generation-validate-request":{"post":{"operationId":"payments_peach_payments_checkout_generation_validate_request","summary":"Validate Checkout request","description":"POST /checkout/validate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Referer","body"],"properties":{"Referer":{"type":"string","description":"An allowlisted domain for the merchant."},"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:peach-payments/status-checkout-status-get":{"get":{"operationId":"payments_peach_payments_status_checkout_status_get","summary":"Query Checkout status","description":"GET /status","tags":["payments"],"parameters":[{"name":"authentication.entityId","in":"query","required":true,"description":"Merchant's entity ID.","schema":{"type":"string","description":"Merchant's entity ID."}},{"name":"checkoutId","in":"query","required":false,"description":"Checkout ID.","schema":{"type":"string","description":"Checkout ID."}},{"name":"merchantTransactionId","in":"query","required":false,"description":"Merchant transaction ID.","schema":{"type":"string","description":"Merchant transaction ID."}},{"name":"signature","in":"query","required":true,"description":"Signature of data signed with secret key of merchant.","schema":{"type":"string","description":"Signature of data signed with secret key of merchant."}}],"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:peach-payments/helpers-get-payment-methods":{"post":{"operationId":"payments_peach_payments_helpers_get_payment_methods","summary":"Retrieve a list of payment methods for a currency","description":"POST /merchant_specs","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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:peach-payments/checkout-v2-generation-initiate-checkout-instance":{"post":{"operationId":"payments_peach_payments_checkout_v2_generation_initiate_checkout_instance","summary":"Initiate Checkout","description":"POST /v2/checkout","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Referer","body"],"properties":{"Referer":{"type":"string","description":"An allowlisted domain for the merchant."},"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:peach-payments/payment-generate-link":{"post":{"operationId":"payments_peach_payments_payment_generate_link","summary":"Generate link","description":"POST /api/channels/{entityId}/payments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["entityId","body"],"properties":{"entityId":{"type":"string","description":"The entity for the request."},"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:peach-payments/payment-get-all-payment-links":{"get":{"operationId":"payments_peach_payments_payment_get_all_payment_links","summary":"Retrieve or export all payment links","description":"GET /api/payments","tags":["payments"],"parameters":[{"name":"merchant","in":"query","required":false,"description":"The unique merchant ID to scope the list to. Required if you're exporting payment links to CSV.","schema":{"type":"string","description":"The unique merchant ID to scope the list to. Required if you're exporting payment links to CSV."}},{"name":"offset","in":"query","required":false,"description":"The offset from which to read data.","schema":{"type":"integer","default":0,"description":"The offset from which to read data."}},{"name":"perPage","in":"query","required":false,"description":"The amount of items to retrieve.","schema":{"type":"integer","default":50,"description":"The amount of items to retrieve."}},{"name":"filters[startDate]","in":"query","required":false,"description":"Retrieve all payment links from the start date onwards.","schema":{"type":"string","description":"Retrieve all payment links from the start date onwards."}},{"name":"filters[endDate]","in":"query","required":false,"description":"Retrieve all payment links until the end date.","schema":{"type":"string","description":"Retrieve all payment links until the end date."}},{"name":"filters[status]","in":"query","required":false,"description":"The payment link status to filter on.","schema":{"type":"string","enum":["initiated","processing","expired","cancelled","completed"],"description":"The payment link status to filter on."}},{"name":"filters[amountValue]","in":"query","required":false,"description":"The amount to filter by.","schema":{"type":"number","description":"The amount to filter by."}},{"name":"filters[amountOperator]","in":"query","required":false,"description":"How to use the amountValue for filtering.","schema":{"type":"string","enum":["lt","lte","gt","gte","eq"],"description":"How to use the amountValue for filtering."}},{"name":"filters[sendingOptions]","in":"query","required":false,"description":"The sending option to filter on.","schema":{"type":"string","enum":["sendEmail","sendSms","sendWhatsapp","emailCc","emailBcc"],"description":"The sending option to filter on."}}],"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:peach-payments/status-query-payment-status":{"get":{"operationId":"payments_peach_payments_status_query_payment_status","summary":"Query payment status","description":"GET /api/payments/{paymentId}","tags":["payments"],"parameters":[{"name":"paymentId","in":"query","required":true,"description":"Payment ID. Returned when creating a new payment.","schema":{"type":"string","description":"Payment ID. Returned when creating a new payment."},"example":"b95d6888-591b-4538-b508-6102cf1259c9"}],"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:peach-payments/payment-cancel-link":{"post":{"operationId":"payments_peach_payments_payment_cancel_link","summary":"Cancel link","description":"DELETE /api/payments/{paymentId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId"],"properties":{"paymentId":{"type":"string","description":"The ID of the payment. Returned when creating a new payment."}}}}}},"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:peach-payments/files-download-file":{"get":{"operationId":"payments_peach_payments_files_download_file","summary":"Download a file","description":"GET /api/payments/{paymentId}/files/{fileId}","tags":["payments"],"parameters":[{"name":"paymentId","in":"query","required":true,"description":"Payment ID.","schema":{"type":"string","description":"Payment ID."},"example":"b95d6888-591b-4538-b508-6102cf1259c9"},{"name":"fileId","in":"query","required":true,"description":"File ID.","schema":{"type":"string","description":"File ID."},"example":"ca6cd55b-4be6-451d-bd72-fe5b7ec1f75z"}],"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:peach-payments/files-upload-file":{"post":{"operationId":"payments_peach_payments_files_upload_file","summary":"Upload a file","description":"POST /api/attachments","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"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:peach-payments/batch-get-batch-statuses":{"get":{"operationId":"payments_peach_payments_batch_get_batch_statuses","summary":"Get all batch statuses","description":"GET /api/channels/{entityId}/payments/batches","tags":["payments"],"parameters":[{"name":"entityId","in":"query","required":true,"description":"The entity for the request.","schema":{"type":"string","description":"The entity for the request."}},{"name":"offset","in":"query","required":false,"description":"The offset from which to read data.","schema":{"type":"number","default":0,"description":"The offset from which to read data."}},{"name":"perPage","in":"query","required":false,"description":"The amount of items to retrieve.","schema":{"type":"number","default":50,"description":"The amount of items to retrieve."}},{"name":"filters[startDate]","in":"query","required":false,"description":"Retrieve all batches from the start date onwards.","schema":{"type":"string","description":"Retrieve all batches from the start date onwards."}},{"name":"filters[endDate]","in":"query","required":false,"description":"Retrieve all batches until the end date.","schema":{"type":"string","description":"Retrieve all batches until the end date."}},{"name":"filters[status]","in":"query","required":false,"description":"The payment link status to filter on.","schema":{"type":"string","enum":["initiated","processing","expired","error","completed"],"description":"The payment link status to filter on."}}],"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:peach-payments/batch-generate-link":{"post":{"operationId":"payments_peach_payments_batch_generate_link","summary":"Generate batch link","description":"POST /api/channels/{entityId}/payments/batches","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["entityId","body"],"properties":{"entityId":{"type":"string","description":"The entity for the request."},"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:peach-payments/batch-link-status-get":{"get":{"operationId":"payments_peach_payments_batch_link_status_get","summary":"Batch link status","description":"GET /api/batches/{batchId}","tags":["payments"],"parameters":[{"name":"batchId","in":"query","required":true,"description":"The batch ID for the request.","schema":{"type":"string","description":"The batch ID for the request."}}],"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:peach-payments/batch-get-error-files":{"get":{"operationId":"payments_peach_payments_batch_get_error_files","summary":"Get batch error files","description":"GET /api/batches/{batchId}/files","tags":["payments"],"parameters":[{"name":"batchId","in":"query","required":true,"description":"The batch for the request.","schema":{"type":"string","description":"The batch for the request."}}],"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:peach-payments/merchant-webhook":{"post":{"operationId":"payments_peach_payments_merchant_webhook","summary":"Merchant webhook","description":"POST /","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Initialization-Vector":{"type":"string","description":"Initialization vector used to decrypt webhook payload."},"X-Authentication-Tag":{"type":"string","description":"Authentication tag."},"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:peach-payments/transaction-status":{"get":{"operationId":"payments_peach_payments_transaction_status","summary":"Query a transaction by merchantTransactionId","description":"GET /payments","tags":["payments"],"parameters":[{"name":"authentication.userId","in":"query","required":true,"description":"Authentication userId.","schema":{"type":"string","description":"Authentication userId."}},{"name":"authentication.password","in":"query","required":true,"description":"Authentication password.","schema":{"type":"string","description":"Authentication password."}},{"name":"authentication.entityId","in":"query","required":true,"description":"Authentication entityId","schema":{"type":"string","description":"Authentication entityId"}},{"name":"merchantTransactionId","in":"query","required":true,"description":"Merchant-provided reference number, often used for reconciliation.","schema":{"type":"string","description":"Merchant-provided reference number, often used for reconciliation."}}],"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:peach-payments/payments-api-inbound-initiate-debit-transaction":{"post":{"operationId":"payments_peach_payments_payments_api_inbound_initiate_debit_transaction","summary":"Payment","description":"POST /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:peach-payments/payments-api-inbound-query-transaction-by-id":{"get":{"operationId":"payments_peach_payments_payments_api_inbound_query_transaction_by_id","summary":"Query a transaction by transaction ID","description":"GET /payments/{uniqueId}","tags":["payments"],"parameters":[{"name":"uniqueId","in":"query","required":true,"description":"The Peach Payments unique ID for the transaction.","schema":{"type":"string","description":"The Peach Payments unique ID for the transaction."}},{"name":"authentication.entityId","in":"query","required":true,"description":"Authentication entityId.","schema":{"type":"string","description":"Authentication entityId."}},{"name":"authentication.userId","in":"query","required":true,"description":"Authentication userId.","schema":{"type":"string","description":"Authentication userId."}},{"name":"authentication.password","in":"query","required":true,"description":"Authentication password.","schema":{"type":"string","description":"Authentication password."}}],"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:peach-payments/payments-api-inbound-refund-transaction":{"post":{"operationId":"payments_peach_payments_payments_api_inbound_refund_transaction","summary":"Refund","description":"POST /payments/{uniqueId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uniqueId"],"properties":{"uniqueId":{"type":"string","description":"The Peach Payments unique ID of the original debit transaction."},"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:peach-payments/transactions-recon-list":{"get":{"operationId":"payments_peach_payments_transactions_recon_list","summary":"List transactions-recon","description":"GET /api/merchants/{merchantId}/transactions-recon","tags":["payments"],"parameters":[{"name":"merchantId","in":"query","required":true,"description":"The merchant's identifier.","schema":{"type":"string","description":"The merchant's identifier."}},{"name":"startDate","in":"query","required":true,"description":"Beginning of the query range (inclusive). Since this is in the query string, URL-encode the date when specifying a timezone. For example,…","schema":{"type":"string","description":"Beginning of the query range (inclusive). Since this is in the query string, URL-encode the date when specifying a timezone. For example,…"}},{"name":"endDate","in":"query","required":true,"description":"End of the query range (exclusive). Since this is in the query string, URL-encode the date when specifying a timezone. For example,…","schema":{"type":"string","description":"End of the query range (exclusive). Since this is in the query string, URL-encode the date when specifying a timezone. For example,…"}},{"name":"isSuccessful","in":"query","required":false,"description":"Whether the transaction was successful or not. If not provided, all transactions are returned.","schema":{"type":"boolean","description":"Whether the transaction was successful or not. If not provided, all transactions are returned."}},{"name":"paymentMethod","in":"query","required":false,"description":"The payment method used to facilitate the transaction, for example: - `bnpl` - `card` - `eft`","schema":{"type":"string","description":"The payment method used to facilitate the transaction, for example: - `bnpl` - `card` - `eft`"}}],"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"}}}}}}}