{"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:ebury/account-details-get-list":{"get":{"operationId":"payments_ebury_account_details_get_list","summary":"Get the list of account details of the referred client","description":"GET /account-details","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"ID of the client that owns the account details","schema":{"type":"string","description":"ID of the client that owns the account details"}},{"name":"account_details_type","in":"query","required":false,"description":"Filter by the type of the account details","schema":{"type":"string","enum":["dedicated","pooled"],"description":"Filter by the type of the account details"}},{"name":"account_id","in":"query","required":false,"description":"Filter by the unique ID of the account","schema":{"type":"string","description":"Filter by the unique ID of the account"}},{"name":"country","in":"query","required":false,"description":"Filter by the country of the account details (ISO Code 2)","schema":{"type":"string","description":"Filter by the country of the account details (ISO Code 2)"}},{"name":"currency","in":"query","required":false,"description":"Filter by the currency of the account details","schema":{"type":"string","description":"Filter by the currency of the account details"}},{"name":"alias","in":"query","required":false,"description":"Filter by the user-friendly alias of the account details. Only dedicated accounts can be filtered by alias.","schema":{"type":"string","description":"Filter by the user-friendly alias of the account details. Only dedicated accounts can be filtered by alias."}},{"name":"page","in":"query","required":false,"description":"Page number to retrieve","schema":{"type":"integer","description":"Page number to retrieve"}},{"name":"page_size","in":"query","required":false,"description":"Maximum number of items to include in each page","schema":{"type":"integer","description":"Maximum number of items to include in each page"}}],"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:ebury/account-details-update-alias":{"post":{"operationId":"payments_ebury_account_details_update_alias","summary":"Update the alias of an account details","description":"PATCH /account-details/{account_details_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_details_id","client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"account_details_id":{"type":"string","description":"Unique ID of account details"},"client_id":{"type":"string","description":"ID of the client that owns the account"},"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:ebury/account-details-mark-as-primary":{"post":{"operationId":"payments_ebury_account_details_mark_as_primary","summary":"Mark the account as primary (default) for its holder and currency","description":"POST /account-details/{account_details_id}/make-default","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_details_id","client_id"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"account_details_id":{"type":"string","description":"Unique ID of account details"},"client_id":{"type":"string","description":"ID of the client that owns the 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/payments:ebury/accounts-list-retrieve":{"get":{"operationId":"payments_ebury_accounts_list_retrieve","summary":"Retrieve a list of accounts","description":"GET /accounts","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"currencies","in":"query","required":true,"description":"A comma-separated list of currencies","schema":{"type":"string","description":"A comma-separated list of currencies"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/accounts-get-account":{"get":{"operationId":"payments_ebury_accounts_get_account","summary":"Get an account","description":"GET /accounts/{account_id}","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"account_id","in":"query","required":true,"description":"Account UUID","schema":{"type":"string","description":"Account UUID"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/balances-get-single-account-balance":{"get":{"operationId":"payments_ebury_balances_get_single_account_balance","summary":"Get a balance for a single account","description":"GET /accounts/{account_id}/balances","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"account_id","in":"query","required":true,"description":"The UUID of the account","schema":{"type":"string","description":"The UUID of the account"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"balance_types","in":"query","required":false,"description":"The balance types to be retrieved","schema":{"type":"string","enum":["RequiredFunds","InterimAvailable"],"default":"InterimAvailable","description":"The balance types to be retrieved"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/statements-create-statement-file":{"post":{"operationId":"payments_ebury_statements_create_statement_file","summary":"Create statement file for an account","description":"POST /accounts/{account_id}/statements/file","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id","client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"account_id":{"type":"string","description":"Account UUID"},"client_id":{"type":"string","description":"The ID of the client"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"},"format":{"type":"string","default":"pdf","description":"The format of the statement to generate"},"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:ebury/statement-fetch-by-uuid-file":{"get":{"operationId":"payments_ebury_statement_fetch_by_uuid_file","summary":"Get an account","description":"GET /accounts/{account_id}/statements/{statement_id}/file","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"account_id","in":"query","required":true,"description":"Account UUID","schema":{"type":"string","description":"Account UUID"}},{"name":"statement_id","in":"query","required":true,"description":"Statement UUID","schema":{"type":"string","description":"Statement UUID"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/transactions-get-by-account-id":{"get":{"operationId":"payments_ebury_transactions_get_by_account_id","summary":"Get transactions for a single account","description":"GET /accounts/{account_id}/transactions","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"account_id","in":"query","required":true,"description":"The UUID of the account","schema":{"type":"string","description":"The UUID of the account"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"credit_debit_indicator","in":"query","required":false,"description":"Filter transactions by debit/credit type","schema":{"type":"string","enum":["credit","debit"],"description":"Filter transactions by debit/credit type"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}},{"name":"from_value_datetime","in":"query","required":false,"description":"Only return transactions with value date and time after this UTC date and time. YYYY-MM-DDThh:mm format","schema":{"type":"string","description":"Only return transactions with value date and time after this UTC date and time. YYYY-MM-DDThh:mm format"}},{"name":"to_value_datetime","in":"query","required":false,"description":"Only return transactions with value date and time before this UTC date and time. YYYY-MM-DDThh:mm format","schema":{"type":"string","description":"Only return transactions with value date and time before this UTC date and time. YYYY-MM-DDThh:mm format"}},{"name":"page","in":"query","required":false,"description":"The desired page number for pagination","schema":{"type":"integer","default":1,"description":"The desired page number for pagination"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page for pagination","schema":{"type":"integer","default":50,"description":"The number of items per page for pagination"}},{"name":"transaction_type","in":"query","required":false,"description":"Only return transactions of the specified transaction type.","schema":{"type":"string","enum":["credit","debit","incoming","margin","payment_returned"],"description":"Only return transactions of the specified transaction type."}}],"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:ebury/transactions-get-single-transaction":{"get":{"operationId":"payments_ebury_transactions_get_single_transaction","summary":"Get a single transactions for an account","description":"GET /accounts/{account_id}/transactions/{transaction_id}","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"account_id","in":"query","required":true,"description":"The UUID of the account","schema":{"type":"string","description":"The UUID of the account"}},{"name":"transaction_id","in":"query","required":true,"description":"The UUID of the transaction","schema":{"type":"string","description":"The UUID of the transaction"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":true,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/oauth20-get-login-template":{"get":{"operationId":"payments_ebury_oauth20_get_login_template","summary":"Authenticate","description":"GET /authenticate","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"scope","in":"query","required":true,"description":"The OAuth 2.0 scope parameter. Must include the value openid. No other values required.","schema":{"type":"string","description":"The OAuth 2.0 scope parameter. Must include the value openid. No other values required."}},{"name":"response_type","in":"query","required":true,"description":"The response type required from the Authorization Server. This must be set to code","schema":{"type":"string","enum":["code"],"description":"The response type required from the Authorization Server. This must be set to code"}},{"name":"client_id","in":"query","required":true,"description":"Your Authorization Client ID, identifies your application to the Authorisation Server","schema":{"type":"string","description":"Your Authorization Client ID, identifies your application to the Authorisation Server"}},{"name":"redirect_uri","in":"query","required":true,"description":"The redirect URL that is registered for your application. This must match the value we hold.","schema":{"type":"string","description":"The redirect URL that is registered for your application. This must match the value we hold."}},{"name":"state","in":"query","required":true,"description":"The OAuth 2.0 state parameter.","schema":{"type":"string","description":"The OAuth 2.0 state parameter."}}],"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:ebury/oauth20-get-login-template-2":{"post":{"operationId":"payments_ebury_oauth20_get_login_template_2","summary":"Authenticate","description":"POST /authenticate","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}}}}}},"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:ebury/balances-get-list":{"get":{"operationId":"payments_ebury_balances_get_list","summary":"Retrieve a list of the client's balances","description":"GET /balances","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"currencies","in":"query","required":true,"description":"A comma-separated list of currency codes compliant to ISO 4217","schema":{"type":"string","description":"A comma-separated list of currency codes compliant to ISO 4217"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"balance_types","in":"query","required":false,"description":"The balance types to be retrieved","schema":{"type":"string","enum":["RequiredFunds","InterimAvailable"],"default":"InterimAvailable","description":"The balance types to be retrieved"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/currencies-get-list":{"get":{"operationId":"payments_ebury_currencies_get_list","summary":"Retrieve a list of the client's currencies","description":"GET /currencies","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"trade_type","in":"query","required":false,"description":"The trade types to be retrieved","schema":{"type":"string","enum":["spot","forward"],"default":"spot","description":"The trade types to be retrieved"}}],"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:ebury/beneficiaries-get":{"get":{"operationId":"payments_ebury_beneficiaries_get","summary":"Get beneficiaries","description":"GET /beneficiaries","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}},{"name":"account_number","in":"query","required":false,"description":"Filter. The account number of the beneficiary you want to search.","schema":{"type":"string","description":"Filter. The account number of the beneficiary you want to search."}},{"name":"iban","in":"query","required":false,"description":"Filter. The iban of the account of the beneficiary you want to search.","schema":{"type":"string","description":"Filter. The iban of the account of the beneficiary you want to search."}},{"name":"bank_identifier","in":"query","required":false,"description":"Filter. The bank identifier of the account of the beneficiary you want to search.","schema":{"type":"string","description":"Filter. The bank identifier of the account of the beneficiary you want to search."}},{"name":"page","in":"query","required":false,"description":"The desired page number for pagination. By default is 1.","schema":{"type":"integer","description":"The desired page number for pagination. By default is 1."}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page for pagination. By default is 50.","schema":{"type":"integer","description":"The number of items per page for pagination. By default is 50."}}],"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:ebury/beneficiaries-post":{"post":{"operationId":"payments_ebury_beneficiaries_post","summary":"Create a new beneficiary","description":"POST /beneficiaries","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"client_id":{"type":"string","description":"The identifier of a client."},"X-Contact-ID":{"type":"string","description":"The identifier of a contact."},"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:ebury/beneficiary-get":{"get":{"operationId":"payments_ebury_beneficiary_get","summary":"Get a beneficiary","description":"GET /beneficiaries/{beneficiary_id}","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"beneficiary_id","in":"query","required":true,"description":"The identifier of a beneficiary.","schema":{"type":"string","description":"The identifier of a beneficiary."}},{"name":"client_id","in":"query","required":true,"description":"The identifier of a client.","schema":{"type":"string","description":"The identifier of a client."}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The identifier of a contact.","schema":{"type":"string","description":"The identifier of a contact."}}],"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:ebury/beneficiary-patch":{"post":{"operationId":"payments_ebury_beneficiary_patch","summary":"Update a beneficiary","description":"PATCH /beneficiaries/{beneficiary_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beneficiary_id","client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"beneficiary_id":{"type":"string","description":"The identifier of a beneficiary."},"client_id":{"type":"string","description":"The identifier of a client."},"X-Contact-ID":{"type":"string","description":"The identifier of a contact."},"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:ebury/beneficiary-delete":{"post":{"operationId":"payments_ebury_beneficiary_delete","summary":"Delete a beneficiary","description":"DELETE /beneficiaries/{beneficiary_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["beneficiary_id","client_id"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"beneficiary_id":{"type":"string","description":"The identifier of a beneficiary."},"client_id":{"type":"string","description":"The identifier of a client."},"X-Contact-ID":{"type":"string","description":"The identifier of a contact."}}}}}},"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:ebury/clients-get":{"get":{"operationId":"payments_ebury_clients_get","summary":"Get clients","description":"GET /clients","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The identifier of a contact.","schema":{"type":"string","description":"The identifier of a contact."}}],"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:ebury/contacts-get":{"get":{"operationId":"payments_ebury_contacts_get","summary":"Get contacts","description":"GET /contacts","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The identifier of a client.","schema":{"type":"string","description":"The identifier of a client."}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The identifier of a contact.","schema":{"type":"string","description":"The identifier of a contact."}}],"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:ebury/contact-get":{"get":{"operationId":"payments_ebury_contact_get","summary":"Get a contact","description":"GET /contacts/{contact_id}","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"contact_id","in":"query","required":true,"description":"The identifier of a contact.","schema":{"type":"string","description":"The identifier of a contact."}},{"name":"client_id","in":"query","required":true,"description":"The identifier of a client.","schema":{"type":"string","description":"The identifier of a client."}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The identifier of a contact.","schema":{"type":"string","description":"The identifier of a contact."}}],"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:ebury/contact-patch":{"post":{"operationId":"payments_ebury_contact_patch","summary":"Update a contact","description":"PATCH /contacts/{contact_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contact_id","client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"contact_id":{"type":"string","description":"The identifier of a contact."},"client_id":{"type":"string","description":"The identifier of a client."},"X-Contact-ID":{"type":"string","description":"The identifier of a contact."},"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:ebury/document-get":{"get":{"operationId":"payments_ebury_document_get","summary":"Get a document","description":"GET /documents","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"type","in":"query","required":true,"description":"The document type: pi (payment instruction), pr (payment receipt), tr (trade receipt).","schema":{"type":"string","enum":["pi","pr","tr"],"description":"The document type: pi (payment instruction), pr (payment receipt), tr (trade receipt)."}},{"name":"id","in":"query","required":true,"description":"The ID of the entity that generated this document e.g. payment, trade, etc.","schema":{"type":"string","description":"The ID of the entity that generated this document e.g. payment, trade, etc."}},{"name":"client_id","in":"query","required":true,"description":"The identifier of a client.","schema":{"type":"string","description":"The identifier of a client."}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The identifier of a contact.","schema":{"type":"string","description":"The identifier of a contact."}}],"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:ebury/oauth20-get-available-contacts":{"get":{"operationId":"payments_ebury_oauth20_get_available_contacts","summary":"Available contacts","description":"GET /info/available-contacts","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}}],"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:ebury/oauth20-login-template-retrieve":{"post":{"operationId":"payments_ebury_oauth20_login_template_retrieve","summary":"Login","description":"POST /login","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"password":{"type":"string","enum":["code"],"description":"Your 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:ebury/metadata-describe-new-beneficiary":{"get":{"operationId":"payments_ebury_metadata_describe_new_beneficiary","summary":"Get beneficiary metadata","description":"GET /metadata/beneficiary","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}}],"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:ebury/metadata-get-currency-metadata":{"get":{"operationId":"payments_ebury_metadata_get_currency_metadata","summary":"Get currency metadata","description":"GET /metadata/currency","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"data_only","in":"query","required":false,"description":"Used to generate a flat array.","schema":{"type":"boolean","description":"Used to generate a flat 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/payments:ebury/multi-payments-create-instruction":{"post":{"operationId":"payments_ebury_multi_payments_create_instruction","summary":"Create a multi payment instruction","description":"POST /multipayments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_id","accept_immediately","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"client_id":{"type":"string","description":"The ID of the client"},"trade_id":{"type":"string","description":"Trade ID to book payments against. Omit if trade should be executed to fund payments"},"sell_currency":{"type":"string","description":"If trade_id omitted, a sell currency must be supplied"},"accept_partial":{"type":"boolean","default":true,"description":"Accept a partially successful instruction. If true, send successful instructions for payment. If false, reject the entire instruction"},"accept_immediately":{"type":"boolean","description":"Set to true. Accept quote immediately, do not require confirmation"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"},"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:ebury/multi-payments-accept-multi-payment":{"post":{"operationId":"payments_ebury_multi_payments_accept_multi_payment","summary":"Accept a multi payment","description":"PATCH /multipayments/{multipayment_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["multipayment_id","client_id"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"multipayment_id":{"type":"string","description":"The multi payment ID"},"client_id":{"type":"string","description":"The ID of the client"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"}}}}}},"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:ebury/multi-payments-reject-multi-payment":{"post":{"operationId":"payments_ebury_multi_payments_reject_multi_payment","summary":"Rejects a multi payment","description":"DELETE /multipayments/{multipayment_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["multipayment_id","client_id"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"multipayment_id":{"type":"string","description":"The multi payment ID"},"client_id":{"type":"string","description":"The ID of the client"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"}}}}}},"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:ebury/multi-payments-get-payment-instructions":{"get":{"operationId":"payments_ebury_multi_payments_get_payment_instructions","summary":"Fetch payment instructions of a mass payment","description":"GET /mass-payments","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"mass_payment_id","in":"query","required":false,"description":"The ID of the multipayment","schema":{"type":"string","description":"The ID of the multipayment"}},{"name":"external_reference_id","in":"query","required":false,"description":"The external reference of the multipayment","schema":{"type":"string","description":"The external reference of the multipayment"}},{"name":"sell_currency","in":"query","required":false,"description":"The sell currency of the multipayment","schema":{"type":"string","description":"The sell currency of the multipayment"}},{"name":"page","in":"query","required":false,"description":"The desired page number for pagination. By default is 1.","schema":{"type":"integer","description":"The desired page number for pagination. By default is 1."}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page for pagination. By default is 50.","schema":{"type":"integer","description":"The number of items per page for pagination. By default is 50."}}],"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:ebury/multi-payments-create-instruction-2":{"post":{"operationId":"payments_ebury_multi_payments_create_instruction_2","summary":"Create a mass payment instruction","description":"POST /mass-payments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"client_id":{"type":"string","description":"The ID of the client"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"},"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:ebury/multi-payments-confirm-instruction":{"post":{"operationId":"payments_ebury_multi_payments_confirm_instruction","summary":"Confirm multi payment instructions","description":"POST /mass-payments/$mass_payment_id/confirm","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_id"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"client_id":{"type":"string","description":"The ID of the client"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"}}}}}},"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:ebury/multi-payments-get-payment-instructions-2":{"get":{"operationId":"payments_ebury_multi_payments_get_payment_instructions_2","summary":"Fetch the payment instructions submitted for a mass payment","description":"GET /mass-payments/{mass_payment_id}/payments-received","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"mass_payment_id","in":"query","required":true,"description":"The mass payment ID","schema":{"type":"string","description":"The mass payment ID"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"page","in":"query","required":false,"description":"The desired page number for pagination. By default is 1.","schema":{"type":"integer","description":"The desired page number for pagination. By default is 1."}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page for pagination. By default is 50.","schema":{"type":"integer","description":"The number of items per page for pagination. By default is 50."}}],"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:ebury/multi-payments-get-payment-instructions-with-errors":{"get":{"operationId":"payments_ebury_multi_payments_get_payment_instructions_with_errors","summary":"Fetch the payment instructions with errors for a mass payment","description":"GET /mass-payments/{mass_payment_id}/errors","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"mass_payment_id","in":"query","required":true,"description":"The mass payment ID","schema":{"type":"string","description":"The mass payment ID"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"page","in":"query","required":false,"description":"The desired page number for pagination. By default is 1.","schema":{"type":"integer","description":"The desired page number for pagination. By default is 1."}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page for pagination. By default is 50.","schema":{"type":"integer","description":"The number of items per page for pagination. By default is 50."}},{"name":"payment_currency","in":"query","required":false,"description":"Filter by payment currency","schema":{"type":"string","description":"Filter by payment currency"}}],"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:ebury/payments-get-all-for-client":{"get":{"operationId":"payments_ebury_payments_get_all_for_client","summary":"Search or retrieve payments","description":"GET /payments","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"mass_payment_id","in":"query","required":false,"description":"Filter by related mass payment's uuid.","schema":{"type":"string","description":"Filter by related mass payment's uuid."}},{"name":"mass_payment_external_reference_id","in":"query","required":false,"description":"Filter by related mass payment's external reference.","schema":{"type":"string","description":"Filter by related mass payment's external reference."}},{"name":"payment_currency","in":"query","required":false,"description":"Filter by payment currency","schema":{"type":"string","description":"Filter by payment currency"}},{"name":"page","in":"query","required":false,"description":"The desired page number for pagination. By default is 1.","schema":{"type":"integer","description":"The desired page number for pagination. By default is 1."}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page for pagination. By default is 50.","schema":{"type":"integer","description":"The number of items per page for pagination. By default is 50."}},{"name":"reference","in":"query","required":false,"description":"Filter payments by reference.","schema":{"type":"string","description":"Filter payments by reference."}},{"name":"trade_id","in":"query","required":false,"description":"Filter payments by trade_id.","schema":{"type":"string","description":"Filter payments by trade_id."}},{"name":"from_payment_date","in":"query","required":false,"description":"Filter payments by from_payment_date.","schema":{"type":"string","description":"Filter payments by from_payment_date."}},{"name":"to_payment_date","in":"query","required":false,"description":"Filter payments by to_payment_date.","schema":{"type":"string","description":"Filter payments by to_payment_date."}},{"name":"from_created_date","in":"query","required":false,"description":"Filter payments by from_created_date.","schema":{"type":"string","description":"Filter payments by from_created_date."}},{"name":"to_created_date","in":"query","required":false,"description":"Filter payments by to_created_date.","schema":{"type":"string","description":"Filter payments by to_created_date."}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/payments-create-payments":{"post":{"operationId":"payments_ebury_payments_create_payments","summary":"Create one or more payments","description":"POST /payments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"client_id":{"type":"string","description":"The ID of the client"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"},"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:ebury/payments-get-payment-by-id":{"get":{"operationId":"payments_ebury_payments_get_payment_by_id","summary":"Retrieve a payment","description":"GET /payments/{payment_id}","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"payment_id","in":"query","required":true,"description":"Unique idenifier for payment","schema":{"type":"string","description":"Unique idenifier for payment"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/payments-authorise-payment":{"post":{"operationId":"payments_ebury_payments_authorise_payment","summary":"Authorise or reject a payment","description":"PATCH /payments/{payment_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_id","client_id","action"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"payment_id":{"type":"string","description":"Unique idenifier for payment"},"client_id":{"type":"string","description":"The ID of the client"},"action":{"type":"string","enum":["authorise","reject"],"description":"The action to take (authorise or reject)"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"}}}}}},"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:ebury/payments-delete-payment-by-id":{"post":{"operationId":"payments_ebury_payments_delete_payment_by_id","summary":"Delete a payment","description":"DELETE /payments/{payment_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_id","client_id"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"payment_id":{"type":"string","description":"Unique idenifier for payment"},"client_id":{"type":"string","description":"The ID of the client"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"}}}}}},"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:ebury/payments-get-fee":{"get":{"operationId":"payments_ebury_payments_get_fee","summary":"Get the fee of payments","description":"GET /payments/fees","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"beneficiary_id","in":"query","required":true,"description":"The ID of the beneficiary","schema":{"type":"string","description":"The ID of the beneficiary"}},{"name":"payment_amount","in":"query","required":true,"description":"The amount of the payment","schema":{"type":"number","description":"The amount of the 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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:ebury/payments-estimate-fee":{"get":{"operationId":"payments_ebury_payments_estimate_fee","summary":"Get the estimate fee of payments","description":"GET /payments/fees_estimate","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":true,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}},{"name":"payment_amount","in":"query","required":true,"description":"The amount of the payment","schema":{"type":"number","description":"The amount of the payment"}},{"name":"payment_currency","in":"query","required":true,"description":"The currency of the payment","schema":{"type":"string","description":"The currency of the payment"}},{"name":"payment_country","in":"query","required":false,"description":"The destination country of the payment","schema":{"type":"string","description":"The destination country of the payment"}},{"name":"payment_intra_Ebury","in":"query","required":false,"description":"boolean flag to filter by Ebury intra payments or not","schema":{"type":"boolean","description":"boolean flag to filter by Ebury intra payments or not"}}],"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:ebury/ping-connectivity-test":{"get":{"operationId":"payments_ebury_ping_connectivity_test","summary":"Test connectivity","description":"GET /ping","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}}],"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:ebury/ping-connectivity-test-2":{"post":{"operationId":"payments_ebury_ping_connectivity_test_2","summary":"Test connectivity","description":"POST /ping","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}}}}}},"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:ebury/quotes-create-firm-quote":{"post":{"operationId":"payments_ebury_quotes_create_firm_quote","summary":"Get an estimate or firm quote","description":"POST /quotes","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["quote_type","client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"quote_type":{"type":"string","enum":["estimate","quote"],"description":"The quote type. A quote_type of quote returns a quote ID which a trade can be booked against"},"client_id":{"type":"string","description":"The ID of the client this quote is for"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"},"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:ebury/quotes-get-fx-availability":{"get":{"operationId":"payments_ebury_quotes_get_fx_availability","summary":"Get the availability for FX markets","description":"GET /quotes/fx-availability","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/oauth20-token-access":{"post":{"operationId":"payments_ebury_oauth20_token_access","summary":"Token","description":"POST /token","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}}}}}},"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:ebury/trusted-authentication-token-for-contact":{"post":{"operationId":"payments_ebury_trusted_authentication_token_for_contact","summary":"Token for a Contact","description":"POST /token/{contact_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contact_id"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"contact_id":{"type":"string","description":"The id of the contact"}}}}}},"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:ebury/trades-get-all-for-client":{"get":{"operationId":"payments_ebury_trades_get_all_for_client","summary":"Get all trades","description":"GET /trades","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"trade_type","in":"query","required":false,"description":"The trade type. The list will be filtered to include only trades with a matching trade type.","schema":{"type":"array","description":"The trade type. The list will be filtered to include only trades with a matching trade type."}},{"name":"parent_trade_id","in":"query","required":false,"description":"Parent identifier for drawdown trades","schema":{"type":"string","description":"Parent identifier for drawdown trades"}},{"name":"page","in":"query","required":false,"description":"The desired page number for pagination. By default is 1.","schema":{"type":"integer","description":"The desired page number for pagination. By default is 1."}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page for pagination. By default is 50.","schema":{"type":"integer","description":"The number of items per page for pagination. By default is 50."}},{"name":"external_reference_id","in":"query","required":false,"description":"Filter by the API external reference id","schema":{"type":"string","description":"Filter by the API external reference id"}},{"name":"mass_payment_id","in":"query","required":false,"description":"Filter by related mass payment's uuid.","schema":{"type":"string","description":"Filter by related mass payment's uuid."}},{"name":"mass_payment_external_reference_id","in":"query","required":false,"description":"Filter by related mass payment's external reference.","schema":{"type":"string","description":"Filter by related mass payment's external reference."}},{"name":"buy_currency","in":"query","required":false,"description":"Filter by the buy currency","schema":{"type":"string","description":"Filter by the buy currency"}},{"name":"status","in":"query","required":false,"description":"Filter trades by comma separated statuses","schema":{"type":"array","description":"Filter trades by comma separated statuses"},"example":"Funds In Full,Closed"},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/trades-create-trade":{"post":{"operationId":"payments_ebury_trades_create_trade","summary":"Create a Trade","description":"POST /trades","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["quote_id","client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"quote_id":{"type":"string","description":"The identifier of the quote"},"client_id":{"type":"string","description":"The ID of the client"},"X-Contact-ID":{"type":"string","description":"The ID of the contact"},"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:ebury/trades-get-trade-by-id":{"get":{"operationId":"payments_ebury_trades_get_trade_by_id","summary":"Get a trade","description":"GET /trades/{trade_id}","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"trade_id","in":"query","required":true,"description":"Trade identifier","schema":{"type":"string","description":"Trade identifier"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}}],"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:ebury/transactions-get-all":{"get":{"operationId":"payments_ebury_transactions_get_all","summary":"Get transactions for all client accounts","description":"GET /transactions","tags":["payments"],"parameters":[{"name":"environment","in":"query","required":false,"description":"Part of the server address: https://{environment}.ebury.io","schema":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"}},{"name":"currencies","in":"query","required":true,"description":"A comma-separated list of currency codes compliant to ISO 4217","schema":{"type":"string","description":"A comma-separated list of currency codes compliant to ISO 4217"}},{"name":"client_id","in":"query","required":true,"description":"The ID of the client","schema":{"type":"string","description":"The ID of the client"}},{"name":"credit_debit_indicator","in":"query","required":false,"description":"Filter transactions by debit/credit type","schema":{"type":"string","enum":["credit","debit"],"description":"Filter transactions by debit/credit type"}},{"name":"X-Contact-ID","in":"query","required":false,"description":"The ID of the contact","schema":{"type":"string","description":"The ID of the contact"}},{"name":"from_value_datetime","in":"query","required":false,"description":"Only return transactions with value date and time after this UTC date and time. YYYY-MM-DDThh:mm format","schema":{"type":"string","description":"Only return transactions with value date and time after this UTC date and time. YYYY-MM-DDThh:mm format"}},{"name":"to_value_datetime","in":"query","required":false,"description":"Only return transactions with value date and time before this UTC date and time. YYYY-MM-DDThh:mm format","schema":{"type":"string","description":"Only return transactions with value date and time before this UTC date and time. YYYY-MM-DDThh:mm format"}},{"name":"page","in":"query","required":false,"description":"The desired page number for pagination","schema":{"type":"integer","default":1,"description":"The desired page number for pagination"}},{"name":"page_size","in":"query","required":false,"description":"The number of items per page for pagination","schema":{"type":"integer","default":50,"description":"The number of items per page for pagination"}},{"name":"transaction_type","in":"query","required":false,"description":"Only return transactions of the specified transaction type.","schema":{"type":"string","enum":["credit","debit","incoming","margin","payment_returned"],"description":"Only return transactions of the specified transaction type."}}],"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:ebury/oauth20-verify2fa-code":{"post":{"operationId":"payments_ebury_oauth20_verify2fa_code","summary":"Verify","description":"POST /verify","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_id","code","redirect_uri"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"client_id":{"type":"string","description":"Your Authorization Client ID, identifies your application to the Authorisation Server"},"code":{"type":"string","description":"Your Authorization Client ID, identifies your application to the Authorisation Server"},"redirect_uri":{"type":"string","description":"The redirect URL that is registered for your application. This must match the value we hold."}}}}}},"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:ebury/oauth20-send-verification-code":{"post":{"operationId":"payments_ebury_oauth20_send_verification_code","summary":"Send verification code","description":"POST /send-verification-code","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_id","code"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"client_id":{"type":"string","description":"Your Authorization Client ID, identifies your application to the Authorisation Server"},"code":{"type":"string","description":"Your Authorization Client ID, identifies your application to the Authorisation Server"}}}}}},"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:ebury/webhooks-execute-graphql-query":{"post":{"operationId":"payments_ebury_webhooks_execute_graphql_query","summary":"Execute a GraphQL query over the webhooks API","description":"POST /webhooks/graphql","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_id","body"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"client_id":{"type":"string","description":"The ID of the client"},"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:ebury/webhooks-ping-subscription":{"post":{"operationId":"payments_ebury_webhooks_ping_subscription","summary":"Ping a subscription","description":"POST /webhooks/ping/{subscription_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id"],"properties":{"environment":{"type":"string","enum":["api","sandbox"],"default":"api","description":"Part of the server address: https://{environment}.ebury.io"},"subscription_id":{"type":"string","description":"The UUID of the subscription"}}}}}},"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"}}}}}}}