# Ebury API API

> Ebury API API on Apizie: 57 endpoints (Get the list of account details of the referred client, Update the alias of an account details, Mark the account as primary (default) for its holder and currency, Retrieve a list of accounts, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:ebury/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:ebury`
- Category: Payments
- Status: byok
- Source: https://ebury.com
- Page: https://apizie.tech/api/payments/ebury
- OpenAPI: https://apizie.tech/api/payments/ebury/openapi.json

Ebury API allows customers: to retrieve accounts, balances, beneficiaries, and transactions; to get buy/sell estimates and quotes, book trades and retrieve trade history; to allocate payments to a trade and…

## Endpoints

### Get the list of account details of the referred client
`GET https://apizie.tech/v1/payments:ebury/account-details-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | ID of the client that owns the account details |
| account_details_type | string | no | Filter by the type of the account details |
| account_id | string | no | Filter by the unique ID of the account |
| country | string | no | Filter by the country of the account details (ISO Code 2) |
| currency | string | no | Filter by the currency of the account details |
| alias | string | no | Filter by the user-friendly alias of the account details. Only dedicated accounts can be filtered by alias. |
| page | integer | no | Page number to retrieve |
| page_size | integer | no | Maximum number of items to include in each page |

### Update the alias of an account details
`POST https://apizie.tech/v1/payments:ebury/account-details-update-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| account_details_id | string | yes | Unique ID of account details |
| client_id | string | yes | ID of the client that owns the account |
| body | object | yes | JSON request body |

### Mark the account as primary (default) for its holder and currency
`POST https://apizie.tech/v1/payments:ebury/account-details-mark-as-primary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| account_details_id | string | yes | Unique ID of account details |
| client_id | string | yes | ID of the client that owns the account |

### Retrieve a list of accounts
`GET https://apizie.tech/v1/payments:ebury/accounts-list-retrieve` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| currencies | string | yes | A comma-separated list of currencies |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Get an account
`GET https://apizie.tech/v1/payments:ebury/accounts-get-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| account_id | string | yes | Account UUID |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Get a balance for a single account
`GET https://apizie.tech/v1/payments:ebury/balances-get-single-account-balance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| account_id | string | yes | The UUID of the account |
| client_id | string | yes | The ID of the client |
| balance_types | string | no | The balance types to be retrieved |
| X-Contact-ID | string | no | The ID of the contact |

### Create statement file for an account
`POST https://apizie.tech/v1/payments:ebury/statements-create-statement-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| account_id | string | yes | Account UUID |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |
| format | string | no | The format of the statement to generate |
| body | object | yes | JSON request body |

### Get an account
`GET https://apizie.tech/v1/payments:ebury/statement-fetch-by-uuid-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| account_id | string | yes | Account UUID |
| statement_id | string | yes | Statement UUID |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Get transactions for a single account
`GET https://apizie.tech/v1/payments:ebury/transactions-get-by-account-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| account_id | string | yes | The UUID of the account |
| client_id | string | yes | The ID of the client |
| credit_debit_indicator | string | no | Filter transactions by debit/credit type |
| X-Contact-ID | string | no | The ID of the contact |
| from_value_datetime | string | no | Only return transactions with value date and time after this UTC date and time. YYYY-MM-DDThh:mm format |
| to_value_datetime | string | no | Only return transactions with value date and time before this UTC date and time. YYYY-MM-DDThh:mm format |
| page | integer | no | The desired page number for pagination |
| page_size | integer | no | The number of items per page for pagination |
| transaction_type | string | no | Only return transactions of the specified transaction type. |

### Get a single transactions for an account
`GET https://apizie.tech/v1/payments:ebury/transactions-get-single-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| account_id | string | yes | The UUID of the account |
| transaction_id | string | yes | The UUID of the transaction |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | yes | The ID of the contact |

### Authenticate
`GET https://apizie.tech/v1/payments:ebury/oauth20-get-login-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| scope | string | yes | The OAuth 2.0 scope parameter. Must include the value openid. No other values required. |
| response_type | string | yes | The response type required from the Authorization Server. This must be set to code |
| client_id | string | yes | Your Authorization Client ID, identifies your application to the Authorisation Server |
| redirect_uri | string | yes | The redirect URL that is registered for your application. This must match the value we hold. |
| state | string | yes | The OAuth 2.0 state parameter. |

### Authenticate
`POST https://apizie.tech/v1/payments:ebury/oauth20-get-login-template-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |

### Retrieve a list of the client's balances
`GET https://apizie.tech/v1/payments:ebury/balances-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| currencies | string | yes | A comma-separated list of currency codes compliant to ISO 4217 |
| client_id | string | yes | The ID of the client |
| balance_types | string | no | The balance types to be retrieved |
| X-Contact-ID | string | no | The ID of the contact |

### Retrieve a list of the client's currencies
`GET https://apizie.tech/v1/payments:ebury/currencies-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| trade_type | string | no | The trade types to be retrieved |

### Get beneficiaries
`GET https://apizie.tech/v1/payments:ebury/beneficiaries-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |
| account_number | string | no | Filter. The account number of the beneficiary you want to search. |
| iban | string | no | Filter. The iban of the account of the beneficiary you want to search. |
| bank_identifier | string | no | Filter. The bank identifier of the account of the beneficiary you want to search. |
| page | integer | no | The desired page number for pagination. By default is 1. |
| page_size | integer | no | The number of items per page for pagination. By default is 50. |

### Create a new beneficiary
`POST https://apizie.tech/v1/payments:ebury/beneficiaries-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The identifier of a client. |
| X-Contact-ID | string | no | The identifier of a contact. |
| body | object | yes | JSON request body |

### Get a beneficiary
`GET https://apizie.tech/v1/payments:ebury/beneficiary-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| beneficiary_id | string | yes | The identifier of a beneficiary. |
| client_id | string | yes | The identifier of a client. |
| X-Contact-ID | string | no | The identifier of a contact. |

### Update a beneficiary
`POST https://apizie.tech/v1/payments:ebury/beneficiary-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| beneficiary_id | string | yes | The identifier of a beneficiary. |
| client_id | string | yes | The identifier of a client. |
| X-Contact-ID | string | no | The identifier of a contact. |
| body | object | yes | JSON request body |

### Delete a beneficiary
`POST https://apizie.tech/v1/payments:ebury/beneficiary-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| beneficiary_id | string | yes | The identifier of a beneficiary. |
| client_id | string | yes | The identifier of a client. |
| X-Contact-ID | string | no | The identifier of a contact. |

### Get clients
`GET https://apizie.tech/v1/payments:ebury/clients-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| X-Contact-ID | string | no | The identifier of a contact. |

### Get contacts
`GET https://apizie.tech/v1/payments:ebury/contacts-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The identifier of a client. |
| X-Contact-ID | string | no | The identifier of a contact. |

### Get a contact
`GET https://apizie.tech/v1/payments:ebury/contact-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| contact_id | string | yes | The identifier of a contact. |
| client_id | string | yes | The identifier of a client. |
| X-Contact-ID | string | no | The identifier of a contact. |

### Update a contact
`POST https://apizie.tech/v1/payments:ebury/contact-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| contact_id | string | yes | The identifier of a contact. |
| client_id | string | yes | The identifier of a client. |
| X-Contact-ID | string | no | The identifier of a contact. |
| body | object | yes | JSON request body |

### Get a document
`GET https://apizie.tech/v1/payments:ebury/document-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| type | string | yes | The document type: pi (payment instruction), pr (payment receipt), tr (trade receipt). |
| id | string | yes | The ID of the entity that generated this document e.g. payment, trade, etc. |
| client_id | string | yes | The identifier of a client. |
| X-Contact-ID | string | no | The identifier of a contact. |

### Available contacts
`GET https://apizie.tech/v1/payments:ebury/oauth20-get-available-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |

### Login
`POST https://apizie.tech/v1/payments:ebury/oauth20-login-template-retrieve` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| password | string | yes | Your password |

### Get beneficiary metadata
`GET https://apizie.tech/v1/payments:ebury/metadata-describe-new-beneficiary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |

### Get currency metadata
`GET https://apizie.tech/v1/payments:ebury/metadata-get-currency-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| data_only | boolean | no | Used to generate a flat array. |

### Create a multi payment instruction
`POST https://apizie.tech/v1/payments:ebury/multi-payments-create-instruction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| trade_id | string | no | Trade ID to book payments against. Omit if trade should be executed to fund payments |
| sell_currency | string | no | If trade_id omitted, a sell currency must be supplied |
| accept_partial | boolean | no | Accept a partially successful instruction. If true, send successful instructions for payment. If false, reject the entire instruction |
| accept_immediately | boolean | yes | Set to true. Accept quote immediately, do not require confirmation |
| X-Contact-ID | string | no | The ID of the contact |
| body | object | yes | JSON request body |

### Accept a multi payment
`POST https://apizie.tech/v1/payments:ebury/multi-payments-accept-multi-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| multipayment_id | string | yes | The multi payment ID |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Rejects a multi payment
`POST https://apizie.tech/v1/payments:ebury/multi-payments-reject-multi-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| multipayment_id | string | yes | The multi payment ID |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Fetch payment instructions of a mass payment
`GET https://apizie.tech/v1/payments:ebury/multi-payments-get-payment-instructions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| mass_payment_id | string | no | The ID of the multipayment |
| external_reference_id | string | no | The external reference of the multipayment |
| sell_currency | string | no | The sell currency of the multipayment |
| page | integer | no | The desired page number for pagination. By default is 1. |
| page_size | integer | no | The number of items per page for pagination. By default is 50. |

### Create a mass payment instruction
`POST https://apizie.tech/v1/payments:ebury/multi-payments-create-instruction-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |
| body | object | yes | JSON request body |

### Confirm multi payment instructions
`POST https://apizie.tech/v1/payments:ebury/multi-payments-confirm-instruction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Fetch the payment instructions submitted for a mass payment
`GET https://apizie.tech/v1/payments:ebury/multi-payments-get-payment-instructions-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| mass_payment_id | string | yes | The mass payment ID |
| client_id | string | yes | The ID of the client |
| page | integer | no | The desired page number for pagination. By default is 1. |
| page_size | integer | no | The number of items per page for pagination. By default is 50. |

### Fetch the payment instructions with errors for a mass payment
`GET https://apizie.tech/v1/payments:ebury/multi-payments-get-payment-instructions-with-errors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| mass_payment_id | string | yes | The mass payment ID |
| client_id | string | yes | The ID of the client |
| page | integer | no | The desired page number for pagination. By default is 1. |
| page_size | integer | no | The number of items per page for pagination. By default is 50. |
| payment_currency | string | no | Filter by payment currency |

### Search or retrieve payments
`GET https://apizie.tech/v1/payments:ebury/payments-get-all-for-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| mass_payment_id | string | no | Filter by related mass payment's uuid. |
| mass_payment_external_reference_id | string | no | Filter by related mass payment's external reference. |
| payment_currency | string | no | Filter by payment currency |
| page | integer | no | The desired page number for pagination. By default is 1. |
| page_size | integer | no | The number of items per page for pagination. By default is 50. |
| reference | string | no | Filter payments by reference. |
| trade_id | string | no | Filter payments by trade_id. |
| from_payment_date | string | no | Filter payments by from_payment_date. |
| to_payment_date | string | no | Filter payments by to_payment_date. |
| from_created_date | string | no | Filter payments by from_created_date. |
| to_created_date | string | no | Filter payments by to_created_date. |
| X-Contact-ID | string | no | The ID of the contact |

### Create one or more payments
`POST https://apizie.tech/v1/payments:ebury/payments-create-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |
| body | object | yes | JSON request body |

### Retrieve a payment
`GET https://apizie.tech/v1/payments:ebury/payments-get-payment-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| payment_id | string | yes | Unique idenifier for payment |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Authorise or reject a payment
`POST https://apizie.tech/v1/payments:ebury/payments-authorise-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| payment_id | string | yes | Unique idenifier for payment |
| client_id | string | yes | The ID of the client |
| action | string | yes | The action to take (authorise or reject) |
| X-Contact-ID | string | no | The ID of the contact |

### Delete a payment
`POST https://apizie.tech/v1/payments:ebury/payments-delete-payment-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| payment_id | string | yes | Unique idenifier for payment |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Get the fee of payments
`GET https://apizie.tech/v1/payments:ebury/payments-get-fee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| beneficiary_id | string | yes | The ID of the beneficiary |
| payment_amount | number | yes | The amount of the payment |

### Get the estimate fee of payments
`GET https://apizie.tech/v1/payments:ebury/payments-estimate-fee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | yes | The ID of the contact |
| payment_amount | number | yes | The amount of the payment |
| payment_currency | string | yes | The currency of the payment |
| payment_country | string | no | The destination country of the payment |
| payment_intra_Ebury | boolean | no | boolean flag to filter by Ebury intra payments or not |

### Test connectivity
`GET https://apizie.tech/v1/payments:ebury/ping-connectivity-test` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |

### Test connectivity
`POST https://apizie.tech/v1/payments:ebury/ping-connectivity-test-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |

### Get an estimate or firm quote
`POST https://apizie.tech/v1/payments:ebury/quotes-create-firm-quote` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| quote_type | string | yes | The quote type. A quote_type of quote returns a quote ID which a trade can be booked against |
| client_id | string | yes | The ID of the client this quote is for |
| X-Contact-ID | string | no | The ID of the contact |
| body | object | yes | JSON request body |

### Get the availability for FX markets
`GET https://apizie.tech/v1/payments:ebury/quotes-get-fx-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Token
`POST https://apizie.tech/v1/payments:ebury/oauth20-token-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |

### Token for a Contact
`POST https://apizie.tech/v1/payments:ebury/trusted-authentication-token-for-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| contact_id | string | yes | The id of the contact |

### Get all trades
`GET https://apizie.tech/v1/payments:ebury/trades-get-all-for-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| trade_type | array | no | The trade type. The list will be filtered to include only trades with a matching trade type. |
| parent_trade_id | string | no | Parent identifier for drawdown trades |
| page | integer | no | The desired page number for pagination. By default is 1. |
| page_size | integer | no | The number of items per page for pagination. By default is 50. |
| external_reference_id | string | no | Filter by the API external reference id |
| mass_payment_id | string | no | Filter by related mass payment's uuid. |
| mass_payment_external_reference_id | string | no | Filter by related mass payment's external reference. |
| buy_currency | string | no | Filter by the buy currency |
| status | array | no | Filter trades by comma separated statuses |
| X-Contact-ID | string | no | The ID of the contact |

### Create a Trade
`POST https://apizie.tech/v1/payments:ebury/trades-create-trade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| quote_id | string | yes | The identifier of the quote |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |
| body | object | yes | JSON request body |

### Get a trade
`GET https://apizie.tech/v1/payments:ebury/trades-get-trade-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| trade_id | string | yes | Trade identifier |
| client_id | string | yes | The ID of the client |
| X-Contact-ID | string | no | The ID of the contact |

### Get transactions for all client accounts
`GET https://apizie.tech/v1/payments:ebury/transactions-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| currencies | string | yes | A comma-separated list of currency codes compliant to ISO 4217 |
| client_id | string | yes | The ID of the client |
| credit_debit_indicator | string | no | Filter transactions by debit/credit type |
| X-Contact-ID | string | no | The ID of the contact |
| from_value_datetime | string | no | Only return transactions with value date and time after this UTC date and time. YYYY-MM-DDThh:mm format |
| to_value_datetime | string | no | Only return transactions with value date and time before this UTC date and time. YYYY-MM-DDThh:mm format |
| page | integer | no | The desired page number for pagination |
| page_size | integer | no | The number of items per page for pagination |
| transaction_type | string | no | Only return transactions of the specified transaction type. |

### Verify
`POST https://apizie.tech/v1/payments:ebury/oauth20-verify2fa-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | Your Authorization Client ID, identifies your application to the Authorisation Server |
| code | string | yes | Your Authorization Client ID, identifies your application to the Authorisation Server |
| redirect_uri | string | yes | The redirect URL that is registered for your application. This must match the value we hold. |

### Send verification code
`POST https://apizie.tech/v1/payments:ebury/oauth20-send-verification-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | Your Authorization Client ID, identifies your application to the Authorisation Server |
| code | string | yes | Your Authorization Client ID, identifies your application to the Authorisation Server |

### Execute a GraphQL query over the webhooks API
`POST https://apizie.tech/v1/payments:ebury/webhooks-execute-graphql-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| client_id | string | yes | The ID of the client |
| body | object | yes | JSON request body |

### Ping a subscription
`POST https://apizie.tech/v1/payments:ebury/webhooks-ping-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | no | Part of the server address: https://{environment}.ebury.io |
| subscription_id | string | yes | The UUID of the subscription |

## Example
```
curl "https://apizie.tech/v1/payments:ebury/account-details-get-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Ebury API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:ebury/account-details-get-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Ebury API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Ebury API itself also needs your own key from {environment}.ebury.io.

### Can AI agents use the Ebury API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:ebury.

### What is the status of the Ebury API API?
Needs your own provider key (bring your own key)