API Reference

The Evervault API allows developers to interact programmatically with their Evervault apps using HTTP requests. The Evervault API is built around REST.

The API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

Authentication

The Evervault API uses API keys to authenticate requests. You can view and manage your API keys in the App Settings section of the Evervault dashboard.

Requests are authenticated via HTTP Basic Auth. Provide your app ID as the basic auth username and your API key as the password.

If you are handling the Authorization header yourself, you will need to base64 encode the app ID and API key before sending the request:

  1. If your App ID is app_1234, and your API key is ev:key:1:abcdefd, then combined they'd be app_1234:ev:key:1:abcdefd.
  2. Base64 encode the combined string to get YXBwXzEyMzQ6...
  3. Use the encoded string as the value for the Authorization header. Authorization: Basic YXBwXzUyMzQ6...

Errors

Evervault uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate the request has failed. Codes in the 5xx range indicate an error with Evervaults’ servers.

Errors returned from the API follow the Problem JSON spec and will be returned as JSON with a Content-Type of application/problem+json.

Encrypt

The encrypt endpoint can be used to encrypt the values of a JSON object, or file. When encrypting the values of a JSON object the Content-Type header should be set to application/json, when encrypting files it should be set to application/octet-stream.

Request Body

A JSON value or file to be encrypted. This can be any valid JSON value: Objects, Arrays, Numbers, Boolean or Strings (strings should be enclosed in double quotes).

Response

An encrypted JSON object or file. For JSON requests, The payload structure will be the same as the one in the request payload, with all of the values encrypted.

post/encrypt
200
Response

Decrypt

The decrypt endpoint can be used to decrypt the values of a JSON object, or file. When decrypting the values of a JSON object the Content-Type header should be set to application/json, when decrypting files it should be set to application/octet-stream.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Decrypt permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Client-Side Token
This endpoint can also be authenticated using a Client-Side Token with the action api:decrypt
Request Body

A JSON value or file to be decrypted. This can be any valid JSON value: Objects, Arrays, Numbers, Boolean or Strings (strings should be enclosed in double quotes).

Response

A decrypted JSON object or file. For JSON requests, The payload structure will be the same as the one in the request payload, with any encrypted values decrypted.

post/decrypt
200
Response

Inspect

Retrieve metadata for an encrypted value such as the time of encryption, the type of data, the data role and category-specific metadata (e.g. card metadata) without accessing the plaintext value.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Inspect permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Request Body

A JSON-formatted string representing the encrypted data to be inspected. Ensure that the string is wrapped in double quotes.

Response
The encrypted value's metadata.
typeinteger | float | boolean | string

The type of the encrypted value.

categorycard-number

The category or specific nature of the encrypted value.

encryptedAtinteger

The date and time when the value was encrypted. This is a Unix timestamp in milliseconds. This field is currently only populated for values encrypted with a Data Role.

rolestring

The data role of the encrypted value.

fingerprintstring

A unique identifier for the encrypted value.

metadata

Further metadata about the encrypted value. Returns different information based on the category of the data.

post/inspect
200
Response

The Card Object

Attributes
idstring

The unique identifier for the card.

numberRequiredstring

The Evervault encrypted card number. This can be decrypted using Relay decryption or using a function.

expiryobject
binRequiredstring

The first 6 or 8 digits of the card number.

lastFourRequiredstring

The last 4 digits of the card number.

brandvisa | mastercard | american-express | discover | diners-club | jcb | unionpay

The card brand associated with the payment card.

fundingdebit | credit | prepaid | deferred-debit | charge

The card funding type specifies the method by which transactions are financed. debit refers to cards that draw funds directly from a linked bank account, typically used for immediate payment. credit indicates cards that provide a line of credit from which users can borrow funds for transactions, to be repaid later under the terms of the credit agreement. prepaid are cards loaded with a set amount of funds in advance and can be used until the balance is depleted. deferred-debit cards combine aspects of debit and credit cards, allowing transactions to be debited from a linked account at a later date, usually monthly. charge cards require full payment of the balance at the end of each billing cycle, but do not have a pre-set spending limit.

segmentconsumer | commercial | business | government | payouts | all

The card segment indicates the primary market or usage category of the card. Each segment caters to specific needs and functionalities: consumer for personal use cards, offering rewards and benefits for everyday purchases; commercial for cards used by large organizations or corporations with features like higher credit limits and expense tracking; business for small to medium-sized business use, providing simpler accounting integration and business spending rewards; government for cards used by government entities, complying with governmental financial regulations and controls; payouts for cards designed to disburse payments like payroll or cashback; and all for general-purpose cards not confined to a specific segment.

countrystring

The country where the card was issued in lowercase ISO 3166-1 alpha-2 format.

currencystring

The currency of the card in lowercase ISO 4217 format.

issuerstring

The name of the card issuer.

statusactive | replaced | closed | invalid

The current status of the card:

  • active -- The card is active and can be used for transactions.
  • replaced -- The card has been replaced by another card (e.g. expired, lost or stolen).
  • closed -- The card account has been closed and can no longer be used for transactions.
  • invalid -- The card is invalid and cannot be used for transactions or updated.
replacementstringnull

The ID of the replacement card. This field is only present if the card has been replaced.

automaticUpdatesenabled | issuer-not-enrolled | cardholder-opted-out | disabled

The status of Card Account Updater on this card.

createdAtRequiredinteger

The Unix timestamp of when the card was created.

updatedAtintegernull

The Unix timestamp of when the card was last updated.

The Card Object

Create a Card

Authorization
API Key Permissions
This endpoint must be called using an API key with the Create Card permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Request Body
numberRequiredstring

The card number. This should be a valid Evervault encrypted card number or a valid plaintext card number.

expiryRequiredobject
Response
post/payments/cards
201
Response

Retrieve a Card

Retrieves a Card by its unique identifier.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Retrieve Card permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
card_id
The unique identifier of the Card.
Response
get/payments/cards/:card_id
200
Response

Delete a Card

Deletes a Card by its unique identifier.

Authorization
API Key Permissions
This endpoint must be called using an API key with the permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
card_id
The unique identifier of the Card.
delete/payments/cards/:card_id
204
Response

The Merchant Object

Attributes
idRequiredstring

A unique identifier assigned to each Merchant.

nameRequiredstring

The official name of the Merchant as recognized in transactions and communications. This name is used for display purposes and may be the company's trade name or a derived nickname.

websiteRequiredstring

The official website URL of the Merchant.

businessobject

The business details of the Merchant.

categoryCodestring

The 4-digit Merchant Category Code (MCC).

networkTokensobject

The Merchant's Network Token configuration.

createdAtRequiredinteger

The exact time, in epoch milliseconds, when this Merchant was created.

updatedAtinteger

The exact time, in epoch milliseconds, when this Merchant was last updated.

The Merchant Object

Create a Merchant

Creates a Merchant. Creating a merchant is a prerequisite for the issuance of Network Tokens, as these tokens are uniquely associated with and scoped to a specific Merchant.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Create Merchant permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Request Body
nameRequiredstring

The official name of the Merchant as recognized in transactions and communications. This name is used for display purposes and may be the company's trade name or a derived nickname.

websiteRequiredstring

The official website URL of the Merchant.

categoryCodeRequiredstring

The 4-digit Merchant Category Code (MCC).

businessRequiredobject

The business details of the Merchant.

networkTokensobject

The Merchant's Network Tokens configuration. This field should only be populated if the Merchant has already been enrolled in one of the Card Network programs and can use an existing Token Requestor ID (TRID).

Response
post/payments/merchants
201
Response

Retrieve a Merchant

Retrieves a Merchant by its unique identifier.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Retrieve Merchant permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
merchant_id
The unique identifier of the merchant.
Response
get/payments/merchants/:merchant_id
200
Response

The 3DS Session Object

Attributes
idRequiredstring

A unique identifier assigned to each 3DS Authentication.

cardobject
acquirerobject

The acquirer of the payment.

merchantobject

The merchant details.

paymentRequiredobject

The payment details of the 3D-Secure Authentication.

challengeobject

Details about the 3DS challenge.

initiatorobject

Details about the transaction initiation process.

accessControlServerobject

Details about the Access Control Server involved in the 3DS transaction.

directoryServerobject

Details about the Directory Server involved in the 3DS transaction.

versionRequired2.1.0 | 2.2.0 | 2.3.1

The 3D-Secure version used to authenticate the session.

statusaction-required | success | failure

The status of the 3DS Authentication.

authenticationobject

The details of the 3DS Authentication. This field is present when the status is success.

nextActionobject

The next action required to complete the 3DS Authentication.

cryptogramstring

The 3DS cryptogram (also called Authentication Value). This value must be retrieved and provided to the payment gateway when processing the payment. This value is only present when the status is success and is retained for one hour.

eciobject

The details of the Electronic Commerce Indicator. This value is only present when the status is success.

failureReasonstring

The reason for the 3DS Authentication failure. This field is present when the status is failure and can be used for troubleshooting.

createdAtRequiredinteger

The exact time, in epoch milliseconds, when this 3DS-Session was created.

updatedAtRequiredinteger

The exact time, in epoch milliseconds, when this 3DS-Session was last updated.

The 3DS Session Object

Create a 3DS Session

Creates a 3DS Session. This initiates the 3DS Authentication process.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Create 3DS Session permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Request Body
merchantRequiredobject

The merchant details.

cardRequiredobject

The card details.

acquirerRequiredobject

The acquirer of the payment.

customerobject

The details of the customer who initiated the transaction.

paymentobject

The payment details of the 3D-Secure Authentication. This field is mandatory for transactions involving payment authentications but not required for non-payment authentications.

preferredVersionsarray

A prioritized list of preferred 3DS versions. The first version in the list is the most preferred. If the first version is not supported, the next version in the list is attempted. If no preferred version is provided, the most optimal version will be automatically selected. If none of the specified versions are supported by the issuer, the session will fail.

Supported versions: 2.1.0, 2.2.0, 2.3.1.

challengeobject

Details about the 3DS challenge.

initiatorobject

Details about the transaction initiation process.

Response
post/payments/3ds-sessions
201
Response

Retrieve a 3DS Session

Retrieve a 3DS Session.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Retrieve 3DS Session permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
3ds_session_id
The id of the session
Response
get/payments/3ds-sessions/:3ds_session_id
200
Response

The Network Token Object

Attributes
idstring

A unique identifier representing a specific Network Token.

numberstring

The unique number of the Network Token.

expiryobject

The expiry details of the Network Token.

cardobject

The details of the underlying tokenized card.

tokenRequestorIdentifierstring

The identifier of the Token Requestor (TRID) that requested the Network Token.

tokenServiceProvidermdes | vts | aets

The Token Service Provider (TSP) that issued the Network Token.

paymentAccountReferencestring

The unique identifier of the Payment Account associated with this Network Token.

statusRequiredactive | inactive

The status of the Network Token. Active means the Network Token is valid and can be used for payments.

merchantstring

The unique identifier of the Merchant associated with this Network Token.

createdAtRequiredinteger

The exact time, in epoch milliseconds, when this Network Token was created.

updatedAtRequiredinteger

The exact time, in epoch milliseconds, when this Network Token was last updated.

The Network Token Object

Create a Network Token

Create a Network Token for a given card.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Create Network Token permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Request Body
cardRequiredobject
merchantRequiredstring

The unique identifier of the Merchant previously created using the Evervault API. It denotes the Merchant to which the Network Token should be associated with.

Response
post/payments/network-tokens
201
Response

Retrieve a Network Token

Retrieves a Network Token by its unique identifier.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Retrieve Network Token permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
network_token_id
The unique identifier of the Network Token.
Response
get/payments/network-tokens/:network_token_id
200
Response

Delete a Network Token

Deletes a Network Token by its unique identifier.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Delete Network Token permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
network_token_id
The unique identifier of the Network Token.
delete/payments/network-tokens/:network_token_id
204
Response

Create a Cryptogram

Creates a Network Token Cryptogram.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Create Network Token Cryptogram permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
network_token_id
The unique identifier of the Network Token.
Response
idRequiredstring

A unique identifier representing a specific Network Token Cryptogram.

cryptogramRequiredstring

The value of the Network Token Cryptogram. This is the value that is used embedded in the Authorization request.

createdAtRequiredinteger

The exact time, in epoch milliseconds, when this Network Token Cryptogram was created.

post/payments/network-tokens/:network_token_id/cryptograms
201
Response

Simulate a Network Token Update

Simulates an update to a Network Token so that you can test your integration. Sandbox only.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Create Network Token permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Request Body
updateTypedeactivate-token | new-card-expiry-and-last-four | new-token-expiry-and-number

The type of update to simulate.

Response
idstring

A unique identifier representing a specific Network Token.

numberstring

The unique number of the Network Token.

expiryobject

The expiry details of the Network Token.

cardobject

The details of the underlying tokenized card.

tokenRequestorIdentifierstring

The identifier of the Token Requestor (TRID) that requested the Network Token.

tokenServiceProvidermdes | vts | aets

The Token Service Provider (TSP) that issued the Network Token.

paymentAccountReferencestring

The unique identifier of the Payment Account associated with this Network Token.

statusRequiredactive | inactive

The status of the Network Token. Active means the Network Token is valid and can be used for payments.

merchantstring

The unique identifier of the Merchant associated with this Network Token.

createdAtRequiredinteger

The exact time, in epoch milliseconds, when this Network Token was created.

updatedAtRequiredinteger

The exact time, in epoch milliseconds, when this Network Token was last updated.

post/payments/network-tokens/:network_token_id/simulate
200
Response

Simulate a Card Update

Simulates an update to a Card so that you can test your Card Account Updater integration. Sandbox only.

Authorization
API Key Permissions
This endpoint must be called using an API key with the Create Card permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Request Body
The request body for simulating a card update differs depending on the type of event you want to simulate.

Response
idstring

The unique identifier for the card.

numberRequiredstring

The Evervault encrypted card number. This can be decrypted using Relay decryption or using a function.

expiryobject
binRequiredstring

The first 6 or 8 digits of the card number.

lastFourRequiredstring

The last 4 digits of the card number.

brandvisa | mastercard | american-express | discover | diners-club | jcb | unionpay

The card brand associated with the payment card.

fundingdebit | credit | prepaid | deferred-debit | charge

The card funding type specifies the method by which transactions are financed. debit refers to cards that draw funds directly from a linked bank account, typically used for immediate payment. credit indicates cards that provide a line of credit from which users can borrow funds for transactions, to be repaid later under the terms of the credit agreement. prepaid are cards loaded with a set amount of funds in advance and can be used until the balance is depleted. deferred-debit cards combine aspects of debit and credit cards, allowing transactions to be debited from a linked account at a later date, usually monthly. charge cards require full payment of the balance at the end of each billing cycle, but do not have a pre-set spending limit.

segmentconsumer | commercial | business | government | payouts | all

The card segment indicates the primary market or usage category of the card. Each segment caters to specific needs and functionalities: consumer for personal use cards, offering rewards and benefits for everyday purchases; commercial for cards used by large organizations or corporations with features like higher credit limits and expense tracking; business for small to medium-sized business use, providing simpler accounting integration and business spending rewards; government for cards used by government entities, complying with governmental financial regulations and controls; payouts for cards designed to disburse payments like payroll or cashback; and all for general-purpose cards not confined to a specific segment.

countrystring

The country where the card was issued in lowercase ISO 3166-1 alpha-2 format.

currencystring

The currency of the card in lowercase ISO 4217 format.

issuerstring

The name of the card issuer.

statusactive | replaced | closed | invalid

The current status of the card:

  • active -- The card is active and can be used for transactions.
  • replaced -- The card has been replaced by another card (e.g. expired, lost or stolen).
  • closed -- The card account has been closed and can no longer be used for transactions.
  • invalid -- The card is invalid and cannot be used for transactions or updated.
replacementstringnull

The ID of the replacement card. This field is only present if the card has been replaced.

automaticUpdatesenabled | issuer-not-enrolled | cardholder-opted-out | disabled

The status of Card Account Updater on this card.

createdAtRequiredinteger

The Unix timestamp of when the card was created.

updatedAtintegernull

The Unix timestamp of when the card was last updated.

post/payments/cards/:card_id/simulate
200
Response

Run a Function

The Function run endpoint lets you invoke an Evervault Function. The body of the request should contain a payload, the value of which will be decrypted and passed as an argument to the Function.

Parameters
function_name
The name of the Function to be executed.
Request Body
payloadRequiredobject

The data payload that the Function will use during its execution. Any encrypted values will be decrypted before being passed to the function.

asyncboolean

If you want your Function to run asynchronously and notify a callback URL, this can be set to true and the API will queue your Function run and return a 202 response code.

Response
idstring

A unique identifier representing this specific Function execution instance.

statussuccess | failure | scheduled

The outcome of the Function execution. A 'success' denotes successful execution, whereas a 'failure' indicates that the Function encountered an error.

resultobject

This field represents the output returned by the Function. This is provided only when the Function execution status is 'success'.

errorobject

This field details any error that occurred during Function execution. This is present only if the status is 'failure'.

createdAtinteger

The exact time, in epoch milliseconds, when this Function execution was triggered.

post/functions/:function_name/runs
200
Response

Using Client-Side Tokens

Client-Side Tokens are versatile and short-lived tokens that frontend applications can utilize to perform various actions, like running Functions or decrypting data.

After creating a Client-Side Token, you can use it to authenticate requests to the Evervault API by providing it in the Authorization header. The token is a JWT, and should be included in the header in the format:

Authorization: Token <client-side-token>

Create a client token

Client-Side Tokens are restricted to specific payloads. By default, a Client-Side Token will expire after 5 minutes. The maximum expiration time of a token is 10 minutes. When using the REST API, the expiry field must be in epoch milliseconds.

Request Body
actionRequiredapi:decrypt

The action that the token should permit

payloadobject

The payload that the token must be used with

expiryinteger

The expiry of the token in milliseconds format. Must be less than 10 minutes from now.

Response
idstring

The id of the token

tokenstring

The token

expiryinteger

The expiry of the token in unix millis format

createdAtinteger

The creation time of the token in unix millis format

post/client-side-tokens
201
Response

The Relay Object

Attributes
idstring

The unique identifier for the Relay.

destinationDomainstring

The domain in front of which the Relay should be configured.

evervaultDomainstring

The Evervault managed domain to which requests to be relayed to the destination domain should be sent.

routesarray

A collection of route configurations for the Relay.

authentication

The type of authentication required for the Relay. If this is null then the Relay is unauthenticated.

encryptEmptyStringsboolean

Whether or not empty strings should be encrypted.

appstring

The unique identifier for the app to which the Relay belongs.

createdAtinteger

The exact time, in epoch milliseconds, when this Relay was created.

updatedAtinteger

The exact time, in epoch milliseconds, when this Relay was updated.

The Relay Object

List all Relays

Response
get/relays
200
Response

Create a Relay

Request Body
destinationDomainRequiredstring

The domain in front of which you would like to configure a Relay

routesRequiredarray

A collection of route configurations for the Relay.

encryptEmptyStringsboolean

Whether or not empty strings should be encrypted. Defaults to true.

authentication

The type of authentication required for the Relay.

Response
post/relays
201
Response

Retrieve a Relay

Parameters
relay_id
The id of the Relay to be fetched.
Response
get/relays/:relay_id
200
Response

Updates a Relay

Parameters
relay_id
The id of the Relay to be updated.
Request Body
routesarray

A collection of route configurations for the Relay. Any existing route configurations will be replaced with the new configurations.

encryptEmptyStringsboolean

Whether or not empty strings should be encrypted.

authentication

The type of authentication required for the Relay.

Response
patch/relays/:relay_id
200
Response

Delete a Relay

Parameters
relay_id
The id of the Relay to be deleted.
delete/relays/:relay_id

The Custom Domain Object

Attributes
idstring

The unique identifier for the custom domain.

customDomainstring

The customer managed domain to which requests to be relayed to your domain should be sent.

relaystring

The ID of the Relay with which this custom domain is associated.

statusactive | inactive

The status of the domains DNS verification.

validationRecordstring

Validation TXT record to be added on the _ev-custom-relay subdomain of your custom domain

createdAtinteger

The exact time, in epoch milliseconds, when this custom domain was created.

updatedAtinteger

The exact time, in epoch milliseconds, when this custom domain was last updated.

The Custom Domain Object

List all Custom Domains

Parameters
relay_id
The id of the Relay whose custom domains should be fetched.
Response
get/relays/:relay_id/custom-domains
200
Response

Create a Custom Domain

Creates a custom domain for the Relay

Parameters
relay_id
The id of the Relay to which the custom domain should be added.
Request Body
customDomainRequiredstring

The customer managed domain to which requests to be relayed to your domain should be sent.

Response
post/relays/:relay_id/custom-domains
201
Response

Retrieve a Custom Domain

Parameters
relay_id
The id of the Relay to which the custom domain belongs.
custom_domain_id
The id of the custom domain to be fetched.
Response
get/relays/:relay_id/custom-domains/:custom_domain_id
200
Response

Delete a Custom Domain

Parameters
relay_id
The id of the Relay to which the custom domain belongs.
custom_domain_id
The id of the custom domain to be deleted.
delete/relays/:relay_id/custom-domains/:custom_domain_id

The Webhook Endpoint Object

Attributes
idstring

A unique identifier representing a specific Webhook Endpoint.

urlstring

The URL of the Webhook Endpoint.

eventsarray

A list of Events that the Webhook Endpoint is subscribed to. The Webhook will receive a POST request when any of these Events occur.

createdAtinteger

The exact time, in epoch milliseconds, when this Webhook Endpoint was created.

updatedAtintegernull

The exact time, in epoch milliseconds, when this Webhook Endpoint was last updated.

The Webhook Endpoint Object

List all Webhook Endpoints

Lists all Webhook Endpoints

Authorization
API Key Permissions
This endpoint must be called using an API key with the List Webhook Endpoints permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
limit
The maximum number of Webhook Endpoints to return (Default is 10).
startingAfter
The identifier of the last Webhook Endpoint in the previous page of results.
Response
get/webhook-endpoints
200
Response

Create a Webhook Endpoint

Create a Webhook Endpoint

Authorization
API Key Permissions
This endpoint must be called using an API key with the Create Webhook Endpoint permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Request Body
urlRequiredstring

The URL of the Webhook Endpoint.

eventsRequiredarray

A list of Events that the Webhook Endpoint is subscribed to. The following events are supported:

  • payments.merchant.updated: A Merchant was updated
  • payments.network-token.updated: A Network Token was updated
  • function.run.completed: An asynchronous Function Run was completed
Response
post/webhook-endpoints
201
Response

Retrieve a Webhook Endpoint

Retrieves a Webhook Endpoint

Authorization
API Key Permissions
This endpoint must be called using an API key with the Retrieve Webhook Endpoint permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
webhook_endpoint_id
The identifier of the Webhook Endpoint to retrieve.
Response
get/webhook-endpoints/:webhook_endpoint_id
200
Response

Update a Webhook Endpoint

Updates a Webhook Endpoint

Authorization
API Key Permissions
This endpoint must be called using an API key with the Update Webhook Endpoint permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
webhook_endpoint_id
The identifier of the Webhook Endpoint to update.
Request Body
eventsRequiredarray

A list of Events that the Webhook Endpoint is subscribed to. The following events are supported:

  • *: All Events
  • payments.merchant.updated: A Merchant was updated
  • payments.network-token.updated: A Network Token was updated
  • function.run.completed: An asynchronous Function Run was completed
Response
patch/webhook-endpoints/:webhook_endpoint_id
200
Response

Delete a Webhook Endpoint

Delete a Webhook Endpoint

Authorization
API Key Permissions
This endpoint must be called using an API key with the Delete Webhook Endpoint permission. API key permissions can be managed in the App Settings section of the Evervault dashboard.
Parameters
webhook_endpoint_id
The identifier of the Webhook Endpoint to delete.
delete/webhook-endpoints/:webhook_endpoint_id