{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:helcim/general-test-connectivity-to-helcim-api":{"get":{"operationId":"open_data_helcim_general_test_connectivity_to_helcim_api","summary":"Tests connectivity to the Helcim API","description":"GET /connection-test","tags":["open-data"],"parameters":[],"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/open-data:helcim/payment-process-purchase-transaction":{"post":{"operationId":"open_data_helcim_payment_process_purchase_transaction","summary":"Process Purchase Transaction","description":"POST /payment/purchase","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idempotency-key"],"properties":{"idempotency-key":{"type":"string","description":"Idempotency Key. Alphanumeric 25-characters"},"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/open-data:helcim/payment-process-preauth-transaction":{"post":{"operationId":"open_data_helcim_payment_process_preauth_transaction","summary":"Process Preauth Transaction","description":"POST /payment/preauth","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idempotency-key"],"properties":{"idempotency-key":{"type":"string","description":"Idempotency Key. Alphanumeric 25-characters"},"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/open-data:helcim/payment-process-capture-transaction":{"post":{"operationId":"open_data_helcim_payment_process_capture_transaction","summary":"Process Capture Transaction","description":"POST /payment/capture","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idempotency-key"],"properties":{"idempotency-key":{"type":"string","description":"Idempotency Key. Alphanumeric 25-characters"},"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/open-data:helcim/payment-verify-transaction":{"post":{"operationId":"open_data_helcim_payment_verify_transaction","summary":"Process Verify Transaction","description":"POST /payment/verify","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idempotency-key"],"properties":{"idempotency-key":{"type":"string","description":"Idempotency Key. Alphanumeric 25-characters"},"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/open-data:helcim/payment-process-refund-transaction":{"post":{"operationId":"open_data_helcim_payment_process_refund_transaction","summary":"Process Refund Transaction","description":"POST /payment/refund","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idempotency-key"],"properties":{"idempotency-key":{"type":"string","description":"Idempotency Key. Alphanumeric 25-characters"},"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/open-data:helcim/payment-reverse-transaction":{"post":{"operationId":"open_data_helcim_payment_reverse_transaction","summary":"Process Reverse Transaction","description":"POST /payment/reverse","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idempotency-key"],"properties":{"idempotency-key":{"type":"string","description":"Idempotency Key. Alphanumeric 25-characters"},"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/open-data:helcim/payment-process-withdrawal-transaction":{"post":{"operationId":"open_data_helcim_payment_process_withdrawal_transaction","summary":"Process Withdraw Transaction","description":"POST /payment/withdraw","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idempotency-key"],"properties":{"idempotency-key":{"type":"string","description":"Idempotency Key. Alphanumeric 25-characters"},"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/open-data:helcim/card-batch-get-details":{"get":{"operationId":"open_data_helcim_card_batch_get_details","summary":"Get Card Batch","description":"GET /card-batches/{cardBatchId}","tags":["open-data"],"parameters":[{"name":"cardBatchId","in":"query","required":true,"description":"The Card Batch Id of the Card Batch you want to get","schema":{"type":"integer","description":"The Card Batch Id of the Card Batch you want to get"}},{"name":"collect-stats","in":"query","required":false,"description":"Includes transaction statistics for the batch","schema":{"type":"string","enum":["true","false"],"description":"Includes transaction statistics for the batch"},"example":true}],"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/open-data:helcim/card-batch-settle-batch":{"post":{"operationId":"open_data_helcim_card_batch_settle_batch","summary":"Settles an Open Card Batch","description":"POST /card-batches/{cardBatchId}/settle","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cardBatchId"],"properties":{"cardBatchId":{"type":"integer","description":"The Card Batch Id of the Card Batch you want to settle"}}}}}},"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/open-data:helcim/card-transaction-get-by-id":{"get":{"operationId":"open_data_helcim_card_transaction_get_by_id","summary":"Get Card Transaction by id","description":"GET /card-transactions/{cardTransactionId}","tags":["open-data"],"parameters":[{"name":"cardTransactionId","in":"query","required":true,"description":"The Card Transaction Id of the Card Transaction you want to get","schema":{"type":"integer","description":"The Card Transaction Id of the Card Transaction you want to get"}}],"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/open-data:helcim/customer-get-customer":{"get":{"operationId":"open_data_helcim_customer_get_customer","summary":"Get customer","description":"GET /customers/{customerId}","tags":["open-data"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"The Id of the customer","schema":{"type":"integer","description":"The 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/open-data:helcim/customer-update-details":{"post":{"operationId":"open_data_helcim_customer_update_details","summary":"Update customer","description":"PUT /customers/{customerId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"The 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/open-data:helcim/customer-get-cards":{"get":{"operationId":"open_data_helcim_customer_get_cards","summary":"Get customer cards","description":"GET /customers/{customerId}/cards","tags":["open-data"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"The Id of the customer","schema":{"type":"integer","description":"The Id of the customer"}},{"name":"cardToken","in":"query","required":false,"description":"The card token.","schema":{"type":"string","description":"The card token."},"example":"907af81acc0224e0134949"}],"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/open-data:helcim/customer-get-card-details":{"get":{"operationId":"open_data_helcim_customer_get_card_details","summary":"Get customer card","description":"GET /customers/{customerId}/cards/{cardId}","tags":["open-data"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"The Id of the customer","schema":{"type":"integer","description":"The Id of the customer"}},{"name":"cardId","in":"query","required":true,"description":"The Id of the card","schema":{"type":"integer","description":"The Id of the card"}}],"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/open-data:helcim/customer-get-bank-accounts":{"get":{"operationId":"open_data_helcim_customer_get_bank_accounts","summary":"Get customer bank accounts","description":"GET /customers/{customerId}/bank-accounts","tags":["open-data"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"The Id of the customer","schema":{"type":"integer","description":"The Id of the customer"}},{"name":"bankToken","in":"query","required":false,"description":"The bank account token.","schema":{"type":"string","description":"The bank account token."}},{"name":"verified","in":"query","required":false,"description":"Check if bank account is verified or not. use 1 or 0.","schema":{"type":"number","description":"Check if bank account is verified or not. use 1 or 0."}},{"name":"ready","in":"query","required":false,"description":"Check if bank account is ready or not. use 1 or 0.","schema":{"type":"number","description":"Check if bank account is ready or not. use 1 or 0."}}],"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/open-data:helcim/customer-get-bank-account":{"get":{"operationId":"open_data_helcim_customer_get_bank_account","summary":"Get customer bank account","description":"GET /customers/{customerId}/bank-accounts/{bankAccountId}","tags":["open-data"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"The Id of the customer","schema":{"type":"integer","description":"The Id of the customer"}},{"name":"bankAccountId","in":"query","required":true,"description":"The Id of the bank account","schema":{"type":"integer","description":"The Id of the bank account"}}],"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/open-data:helcim/customer-set-bank-account-default":{"post":{"operationId":"open_data_helcim_customer_set_bank_account_default","summary":"Set customer bank account as default","description":"PATCH /customers/{customerId}/bank-accounts/{bankAccountId}/default","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","bankAccountId"],"properties":{"customerId":{"type":"integer","description":"The Id of the customer"},"bankAccountId":{"type":"integer","description":"The Id of the bank account"}}}}}},"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/open-data:helcim/invoice-get-by-id":{"get":{"operationId":"open_data_helcim_invoice_get_by_id","summary":"Get invoice","description":"GET /invoices/{invoiceId}","tags":["open-data"],"parameters":[{"name":"invoiceId","in":"query","required":true,"description":"The unique invoice Id","schema":{"type":"string","description":"The unique invoice Id"}}],"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/open-data:helcim/invoice-update-details":{"post":{"operationId":"open_data_helcim_invoice_update_details","summary":"Update invoice","description":"PUT /invoices/{invoiceId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceId"],"properties":{"invoiceId":{"type":"string","description":"The unique invoice Id"},"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/open-data:helcim/helcim-pay-create-checkout-session":{"post":{"operationId":"open_data_helcim_helcim_pay_create_checkout_session","summary":"Creates a HelcimPay.js Checkout Session","description":"POST /helcim-pay/initialize","tags":["open-data"],"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/open-data:helcim/card-batch-get-all":{"get":{"operationId":"open_data_helcim_card_batch_get_all","summary":"Get Card Batches","description":"GET /card-batches","tags":["open-data"],"parameters":[{"name":"batchNumber","in":"query","required":false,"description":"The number of the batch to retrieve. Note that this is the batch number, not batch ID.","schema":{"type":"number","description":"The number of the batch to retrieve. Note that this is the batch number, not batch ID."},"example":18900},{"name":"terminalId","in":"query","required":false,"description":"The terminalId of the requested batch","schema":{"type":"number","description":"The terminalId of the requested batch"},"example":180000},{"name":"collect-stats","in":"query","required":false,"description":"Includes transaction statistics for the batch","schema":{"type":"string","enum":["true","false"],"description":"Includes transaction statistics for the batch"},"example":true}],"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/open-data:helcim/card-transaction-collect-transactions":{"get":{"operationId":"open_data_helcim_card_transaction_collect_transactions","summary":"Collects up to 1000 Card Transactions","description":"GET /card-transactions","tags":["open-data"],"parameters":[{"name":"dateFrom","in":"query","required":false,"description":"Filters transactions created from 2020-01-01 (Mountain Time)","schema":{"type":"string","description":"Filters transactions created from 2020-01-01 (Mountain Time)"},"example":"2020-01-01"},{"name":"dateTo","in":"query","required":false,"description":"Filters transactions created until 2021-01-01 (Mountain Time)","schema":{"type":"string","description":"Filters transactions created until 2021-01-01 (Mountain Time)"},"example":"2021-01-01"},{"name":"search","in":"query","required":false,"description":"Searches amount, card number(F4L4 only), cardholder name, & approval codes","schema":{"type":"string","description":"Searches amount, card number(F4L4 only), cardholder name, & approval codes"},"example":500},{"name":"customerCode","in":"query","required":false,"description":"The code of the customer associated with the transaction","schema":{"type":"string","description":"The code of the customer associated with the transaction"},"example":"CST1000"},{"name":"invoiceNumber","in":"query","required":false,"description":"The number of the invoice associated with the transaction","schema":{"type":"string","description":"The number of the invoice associated with the transaction"},"example":"INV1000"},{"name":"cardToken","in":"query","required":false,"description":"The token of the card associated with the transaction","schema":{"type":"string","description":"The token of the card associated with the transaction"},"example":"5454JK97UU1F5454"},{"name":"cardBatchId","in":"query","required":false,"description":"The id of the batch associated with the transaction","schema":{"type":"integer","description":"The id of the batch associated with the transaction"},"example":3}],"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/open-data:helcim/customer-list":{"get":{"operationId":"open_data_helcim_customer_list","summary":"Get customers","description":"GET /customers","tags":["open-data"],"parameters":[{"name":"search","in":"query","required":false,"description":"The search term to be used for partial matching on contactName, businessName, customerCode, city, phone and email (Only use one query…","schema":{"type":"string","description":"The search term to be used for partial matching on contactName, businessName, customerCode, city, phone and email (Only use one query…"},"example":"john"},{"name":"customerCode","in":"query","required":false,"description":"Existing customer code (Only use one query field per request).","schema":{"type":"string","description":"Existing customer code (Only use one query field per request)."},"example":"CST1000"}],"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/open-data:helcim/customer-create-new-customer":{"post":{"operationId":"open_data_helcim_customer_create_new_customer","summary":"Create customer","description":"POST /customers","tags":["open-data"],"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/open-data:helcim/invoice-list":{"get":{"operationId":"open_data_helcim_invoice_list","summary":"Get invoices","description":"GET /invoices","tags":["open-data"],"parameters":[{"name":"invoiceNumber","in":"query","required":false,"description":"The number of the invoice associated with the transaction","schema":{"type":"string","description":"The number of the invoice associated with the transaction"},"example":"INV1000"},{"name":"dateStart","in":"query","required":false,"description":"Filters transactions created from 2020-01-01 (Mountain Time)","schema":{"type":"string","description":"Filters transactions created from 2020-01-01 (Mountain Time)"},"example":"2020-01-01"},{"name":"dateEnd","in":"query","required":false,"description":"Filters transactions created until 2021-01-01 (Mountain Time)","schema":{"type":"string","description":"Filters transactions created until 2021-01-01 (Mountain Time)"},"example":"2021-01-01"},{"name":"withConvenienceFee","in":"query","required":false,"description":"Include convenience fee of each invoice 0 | 1","schema":{"type":"integer","description":"Include convenience fee of each invoice 0 | 1"},"example":1}],"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/open-data:helcim/invoice-create-new":{"post":{"operationId":"open_data_helcim_invoice_create_new","summary":"Create invoice","description":"POST /invoices","tags":["open-data"],"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/open-data:helcim/card-terminal-get-all":{"get":{"operationId":"open_data_helcim_card_terminal_get_all","summary":"Get card terminals","description":"GET /card-terminals","tags":["open-data"],"parameters":[],"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"}}}}}}}