{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:nuapay/bank-service-view-bank-families":{"get":{"operationId":"finance_nuapay_bank_service_view_bank_families","summary":"View Bank Families","description":"GET /bankfamilies","tags":["finance"],"parameters":[{"name":"pagenumber","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"pagesize","in":"query","required":false,"description":"Page size","schema":{"type":"integer","default":20,"description":"Page size"}},{"name":"supportedcurrencies","in":"query","required":false,"schema":{"type":"array"}}],"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/finance:nuapay/bank-service-get-bank-family":{"get":{"operationId":"finance_nuapay_bank_service_get_bank_family","summary":"View Bank Family","description":"GET /bankfamilies/{bankfamilyId}","tags":["finance"],"parameters":[{"name":"bankfamilyId","in":"query","required":true,"description":"Bank Family id returned by Get Bank Families endpoint.","schema":{"type":"string","description":"Bank Family id returned by Get Bank Families endpoint."}}],"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/finance:nuapay/bank-service-get-supported-banks":{"get":{"operationId":"finance_nuapay_bank_service_get_supported_banks","summary":"Retrieve Banks","description":"GET /banks","tags":["finance"],"parameters":[{"name":"country","in":"query","required":false,"description":"CountryCode - ISO country code - indicates where bank is domiciled (ISO 3166 Alpha-2)","schema":{"type":"array","description":"CountryCode - ISO country code - indicates where bank is domiciled (ISO 3166 Alpha-2)"}},{"name":"debtoraccountrequired","in":"query","required":false,"description":"Allows to filter the banks that requires debtor account to be provided when initiating payment.","schema":{"type":"boolean","description":"Allows to filter the banks that requires debtor account to be provided when initiating payment."}},{"name":"pagenumber","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"pagesize","in":"query","required":false,"description":"Page size","schema":{"type":"integer","default":20,"description":"Page size"}},{"name":"supportedcurrencies","in":"query","required":false,"schema":{"type":"array"}},{"name":"bankfamilyid","in":"query","required":false,"description":"Allows filtering by Bank Family via the Bank Family Id.","schema":{"type":"string","description":"Allows filtering by Bank Family via the Bank Family Id."}},{"name":"excludebankfamily","in":"query","required":false,"description":"Allows filtering by Banks without an associated Bank Family.","schema":{"type":"boolean","description":"Allows filtering by Banks without an associated Bank Family."}},{"name":"services","in":"query","required":false,"description":"Filter the bank list by service provided returns both AISPs and PISPs, 'AISP' returns only AISPs and 'PISP' returns only PISPs. When not…","schema":{"type":"array","description":"Filter the bank list by service provided returns both AISPs and PISPs, 'AISP' returns only AISPs and 'PISP' returns only PISPs. When not…"}},{"name":"sepainstantreachability","in":"query","required":false,"description":"Filter the bank list by payment method. When not provided or false, returns the full list of banks. When true, the only banks that…","schema":{"type":"boolean","description":"Filter the bank list by payment method. When not provided or false, returns the full list of banks. When true, the only banks that…"}}],"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/finance:nuapay/pisp-service-list-payments":{"get":{"operationId":"finance_nuapay_pisp_service_list_payments","summary":"List payments","description":"GET /payments","tags":["finance"],"parameters":[{"name":"fromdatetime","in":"query","required":false,"description":"Submission from date time in the format, 'yyyy-MM-dd'T'HH:mm:ss', maximum date from/to date range is 30 days. If neither from/to date is…","schema":{"type":"string","description":"Submission from date time in the format, 'yyyy-MM-dd'T'HH:mm:ss', maximum date from/to date range is 30 days. If neither from/to date is…"}},{"name":"todatetime","in":"query","required":false,"description":"Submission to date time in the format, 'yyyy-MM-dd'T'HH:mm:ss', maximum date from/to date range is 30 days. If neither from/to date is…","schema":{"type":"string","description":"Submission to date time in the format, 'yyyy-MM-dd'T'HH:mm:ss', maximum date from/to date range is 30 days. If neither from/to date is…"}},{"name":"fromamount","in":"query","required":false,"description":"When provided only payments with amount equal or higher than provided amount will be returned","schema":{"type":"number","description":"When provided only payments with amount equal or higher than provided amount will be returned"}},{"name":"toamount","in":"query","required":false,"description":"When provided only payments with amount equal or smaller than provided amount will be returned","schema":{"type":"number","description":"When provided only payments with amount equal or smaller than provided amount will be returned"}},{"name":"userinterfacepaymentid","in":"query","required":false,"description":"This is used in UI flows to get payment details. Applicable for payments created with REDIRECT, CHECKOUT integration type.","schema":{"type":"string","description":"This is used in UI flows to get payment details. Applicable for payments created with REDIRECT, CHECKOUT integration type."}},{"name":"paymentstatus","in":"query","required":false,"description":"A number of statuses can be queried within a single request by providing multiple occurences of the parameter. If not provided all…","schema":{"type":"array","description":"A number of statuses can be queried within a single request by providing multiple occurences of the parameter. If not provided all…"}},{"name":"payername","in":"query","required":false,"description":"Payer name. This parameter supports searching with wildcards","schema":{"type":"string","description":"Payer name. This parameter supports searching with wildcards"}},{"name":"payeremail","in":"query","required":false,"description":"Payer e-mail. This parameter supports searching with wildcards","schema":{"type":"string","description":"Payer e-mail. This parameter supports searching with wildcards"}},{"name":"reference","in":"query","required":false,"description":"Payment reference will attempt to match endToEndIdentification, remittanceInformation.reference and remittanceInformation.unstructured.…","schema":{"type":"string","description":"Payment reference will attempt to match endToEndIdentification, remittanceInformation.reference and remittanceInformation.unstructured.…"}},{"name":"currency","in":"query","required":false,"description":"Currency","schema":{"type":"string","enum":["EUR","GBP","PLN","BGN","HRK","CZK","DKK","HUF","RON","SEK"],"description":"Currency"}},{"name":"pagenumber","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"pagesize","in":"query","required":false,"description":"Page size","schema":{"type":"integer","default":20,"description":"Page size"}}],"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/finance:nuapay/pisp-service-make-payment":{"post":{"operationId":"finance_nuapay_pisp_service_make_payment","summary":"Create Payment","description":"POST /payments","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Idempotency-Key":{"type":"string","description":"Every request will be processed only once per Idempotency-Key. The Idempotency Key will be valid for 24 hours."},"PSU-ID":{"type":"string","description":"Client ID of the PSU in the ASPSP client interface."},"Customer-IP-Address":{"type":"string","description":"The PSU's IP address if the PSU is currently logged in with the TPP."},"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/finance:nuapay/pisp-service-forward-payment-callback":{"post":{"operationId":"finance_nuapay_pisp_service_forward_payment_callback","summary":"Forward Payment Callback","description":"POST /payments/callback","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Idempotency-Key":{"type":"string","description":"Every request will be processed only once per Idempotency-Key. The Idempotency Key will be valid for 24 hours."},"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/finance:nuapay/pisp-service-get-payment":{"get":{"operationId":"finance_nuapay_pisp_service_get_payment","summary":"Retrieve Payment","description":"GET /payments/{paymentId}","tags":["finance"],"parameters":[{"name":"paymentId","in":"query","required":true,"description":"The ID of the payment for which you want to retrieve details","schema":{"type":"string","description":"The ID of the payment for which you want to retrieve details"}}],"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/finance:nuapay/pisp-service-retry-payment-patch":{"post":{"operationId":"finance_nuapay_pisp_service_retry_payment_patch","summary":"Retry Payment","description":"PATCH /payments/{paymentId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId","body"],"properties":{"paymentId":{"type":"string","description":"The ID of the payment that you want to retry"},"Customer-IP-Address":{"type":"string","description":"The PSU's IP address if the PSU is currently logged in with the TPP."},"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/finance:nuapay/pisp-service-get-payment-history":{"get":{"operationId":"finance_nuapay_pisp_service_get_payment_history","summary":"Retrieve Payment History","description":"GET /payments/{paymentId}/history","tags":["finance"],"parameters":[{"name":"paymentId","in":"query","required":true,"description":"The ID of the payment for which you want to retrieve audit trail history","schema":{"type":"string","description":"The ID of the payment for which you want to retrieve audit trail history"}},{"name":"pagenumber","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"pagesize","in":"query","required":false,"description":"Page size","schema":{"type":"integer","default":20,"description":"Page size"}}],"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/finance:nuapay/pisp-service-get-payment-refunds":{"get":{"operationId":"finance_nuapay_pisp_service_get_payment_refunds","summary":"List Payment Refunds","description":"GET /payments/{paymentId}/refunds","tags":["finance"],"parameters":[{"name":"paymentId","in":"query","required":true,"description":"The ID of the payment for which you want to list refunds","schema":{"type":"string","description":"The ID of the payment for which you want to list refunds"}},{"name":"fromcreationdatetime","in":"query","required":false,"description":"Submission from date time in the format, 'yyyy-MM-dd'T'HH:mm:ss', maximum create date from/to create date range is 30 days. If neither…","schema":{"type":"string","description":"Submission from date time in the format, 'yyyy-MM-dd'T'HH:mm:ss', maximum create date from/to create date range is 30 days. If neither…"}},{"name":"tocreationdatetime","in":"query","required":false,"description":"Submission to date time in the format, 'yyyy-MM-dd'T'HH:mm:ss', maximum create date from/to create date range is 30 days. If neither…","schema":{"type":"string","description":"Submission to date time in the format, 'yyyy-MM-dd'T'HH:mm:ss', maximum create date from/to create date range is 30 days. If neither…"}},{"name":"fromrefundamount","in":"query","required":false,"description":"When provided only payments with amount equal or higher than provided amount will be returned","schema":{"type":"number","description":"When provided only payments with amount equal or higher than provided amount will be returned"}},{"name":"torefundamount","in":"query","required":false,"description":"When provided only payments with amount equal or smaller than provided amount will be returned","schema":{"type":"number","description":"When provided only payments with amount equal or smaller than provided amount will be returned"}},{"name":"refundstatus","in":"query","required":false,"description":"A number of statuses can be queried within a single request by providing multiple occurences of the parameter. If not provided all…","schema":{"type":"array","description":"A number of statuses can be queried within a single request by providing multiple occurences of the parameter. If not provided all…"}},{"name":"pagenumber","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"pagesize","in":"query","required":false,"description":"Page size","schema":{"type":"integer","default":20,"description":"Page size"}}],"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/finance:nuapay/pisp-service-refund-payment":{"post":{"operationId":"finance_nuapay_pisp_service_refund_payment","summary":"Refund Payment","description":"POST /payments/{paymentId}/refunds","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId","body"],"properties":{"paymentId":{"type":"string","description":"The ID of the payment which you want to refund"},"Idempotency-Key":{"type":"string","description":"Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours."},"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/finance:nuapay/pisp-service-get-refund":{"get":{"operationId":"finance_nuapay_pisp_service_get_refund","summary":"Retrieve Refund","description":"GET /payments/{paymentId}/refunds/{refundId}","tags":["finance"],"parameters":[{"name":"paymentId","in":"query","required":true,"description":"The ID of the payment for which you want to retrieve details","schema":{"type":"string","description":"The ID of the payment for which you want to retrieve details"}},{"name":"refundId","in":"query","required":true,"description":"The ID of the refund for which you want to retrieve details","schema":{"type":"string","description":"The ID of the refund for which you want to retrieve details"}}],"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"}}}}}}}