{"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/payments:echelon/incoming-payments-get-options":{"post":{"operationId":"payments_echelon_incoming_payments_get_options","summary":"Available payment options.","description":"POST /payins/!availablePaymentOptions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-API-Version","body"],"properties":{"X-API-Version":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"},"Id-Customer":{"type":"string","description":"TODO: Add description of Id-Customer header"},"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:echelon/outgoing-payments-get-available-payment-options":{"post":{"operationId":"payments_echelon_outgoing_payments_get_available_payment_options","summary":"Available payment options.","description":"POST /payouts/!availablePaymentOptions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-API-Version","body"],"properties":{"X-API-Version":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"},"Id-Customer":{"type":"string","description":"TODO: Add description of Id-Customer header"},"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:echelon/incoming-payments-get-details":{"get":{"operationId":"payments_echelon_incoming_payments_get_details","summary":"Incoming payment detail.","description":"GET /payins/{idPayin}","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}},{"name":"idPayin","in":"query","required":true,"description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids).","schema":{"type":"string","description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids)."}}],"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:echelon/incoming-payments-create-payment-request":{"post":{"operationId":"payments_echelon_incoming_payments_create_payment_request","summary":"Create payment.","description":"POST /payins/{idPayin}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-API-Version","idPayin","body"],"properties":{"X-API-Version":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"},"Id-Customer":{"type":"string","description":"TODO: Add description of Id-Customer header"},"idPayin":{"type":"string","description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids)."},"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:echelon/outgoing-payments-get-detail":{"get":{"operationId":"payments_echelon_outgoing_payments_get_detail","summary":"Outgoing payment detail.","description":"GET /payouts/{idPayout}","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}},{"name":"idPayout","in":"query","required":true,"description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids).","schema":{"type":"string","description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids)."}}],"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:echelon/outgoing-payments-create-request":{"post":{"operationId":"payments_echelon_outgoing_payments_create_request","summary":"Create outgoing payment.","description":"POST /payouts/{idPayout}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-API-Version","idPayout","body"],"properties":{"X-API-Version":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"},"Id-Customer":{"type":"string","description":"TODO: Add description of Id-Customer header"},"idPayout":{"type":"string","description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids)."},"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:echelon/payin-set-external-reference":{"post":{"operationId":"payments_echelon_payin_set_external_reference","summary":"Set external reference for the payment.","description":"POST /payins/{idPayin}/!setExternalReference","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-API-Version","idPayin","body"],"properties":{"X-API-Version":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"},"idPayin":{"type":"string","description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids)."},"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:echelon/accounts-get-balances":{"get":{"operationId":"payments_echelon_accounts_get_balances","summary":"Account balance.","description":"GET /balances","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}},{"name":"currencyCodes","in":"query","required":false,"description":"List of requested currencies. How to send multiple values please refer to [Query for multiple…","schema":{"type":"string","description":"List of requested currencies. How to send multiple values please refer to [Query for multiple…"}}],"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:echelon/payin-accounts":{"get":{"operationId":"payments_echelon_payin_accounts","summary":"Incoming payment accounts details.","description":"GET /payins/{idPayin}/accounts","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}},{"name":"idPayin","in":"query","required":true,"description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids).","schema":{"type":"string","description":"Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids)."}}],"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:echelon/merchant-info-get-info":{"get":{"operationId":"payments_echelon_merchant_info_get_info","summary":"Merchant information.","description":"GET /merchant-info","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}}],"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:echelon/payments-get-currencies":{"get":{"operationId":"payments_echelon_payments_get_currencies","summary":"Currencies.","description":"GET /currencies","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}}],"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:echelon/payments-list-segments":{"get":{"operationId":"payments_echelon_payments_list_segments","summary":"Segments.","description":"GET /segments","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}}],"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:echelon/payments-get-operators-list":{"get":{"operationId":"payments_echelon_payments_get_operators_list","summary":"Payment operators.","description":"GET /payment-operators","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}}],"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:echelon/payments-list-payment-methods":{"get":{"operationId":"payments_echelon_payments_list_payment_methods","summary":"Payment methods.","description":"GET /payment-methods","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}}],"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:echelon/payments-get-payment-options":{"get":{"operationId":"payments_echelon_payments_get_payment_options","summary":"Payment options.","description":"GET /payment-options","tags":["payments"],"parameters":[{"name":"X-API-Version","in":"query","required":true,"description":"Required API version. See [Versioning](general.html#versioning)","schema":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"}},{"name":"paymentTypeCode","in":"query","required":false,"description":"Payment direction from the merchant's point of view.","schema":{"type":"string","enum":["PAYIN","PAYOUT"],"description":"Payment direction from the merchant's point of view."}},{"name":"paymentMethodCodes","in":"query","required":false,"description":"Comma separated list of requested payment method codes. See request body for `paymentMethodCode` description and [Query for multiple…","schema":{"type":"string","description":"Comma separated list of requested payment method codes. See request body for `paymentMethodCode` description and [Query for multiple…"}},{"name":"currencyCodes","in":"query","required":false,"description":"List of requested currencies. How to send multiple values please refer to [Query for multiple…","schema":{"type":"string","description":"List of requested currencies. How to send multiple values please refer to [Query for multiple…"}},{"name":"segmentCodes","in":"query","required":false,"description":"Comma separated list of requested segment codes. See [`GET /segments`](https://developers.echelonpay.com) API and [Query for multiple…","schema":{"type":"string","description":"Comma separated list of requested segment codes. See [`GET /segments`](https://developers.echelonpay.com) API and [Query for multiple…"}},{"name":"paymentOperatorCodes","in":"query","required":false,"description":"Comma separated list of payment operator codes. See request body for `paymentOperators` description and [Query for multiple…","schema":{"type":"string","description":"Comma separated list of payment operator codes. See request body for `paymentOperators` description and [Query for multiple…"}}],"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:echelon/auth-issue-jwt":{"post":{"operationId":"payments_echelon_auth_issue_jwt","summary":"Authorization token.","description":"POST /auth-tokens","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-API-Version","body"],"properties":{"X-API-Version":{"type":"integer","description":"Required API version. See [Versioning](general.html#versioning)"},"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"}}},"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"}}}}}}}