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.
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.
API keys are sensitive and should always be kept secret. You should not store API keys in publically accessible code such as public GitHub repositories or client-side code.
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:
- Combine the app ID and API key into a single string separated by a colon. e.g
app_123:api_key_123 - Base64 encode the combined string.
- Use the base64 encoded string as the value of the Authorization header.
Authorization: Basic YXBwXzUyMzQ6...
All requests to the Evervault API must authenticated and made over https.
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 Evervault's 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
The JSON value to be encrypted. This can be any valid JSON value: Dictionaries, Arrays, Numbers, Boolean or Strings (strings should be enclosed in double quotes).
Response Body
The encrypted JSON value.
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.
Request Body
The JSON value to be decrypted. This can be any valid JSON value: Dictionaries, Arrays or Strings (strings should be enclosed in double quotes). Non-encrypted values are returned unaltered.
Response Body
The decrypted JSON value.
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.
Response Body
The type of the encrypted value.
Supported values
"integer""float""boolean""string"
The category or specific nature of the encrypted value.
Supported values
"card-number"
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.
The data role of the encrypted value.
A unique identifier for the encrypted value.
Further metadata about the encrypted value. Returns different information based on the category of the data.
Only present if category is
card-number
Functions
Evervault Functions are secure serverless functions which allow you to process data encrypted by Evervault products. When you pass encrypted data to a Function, it is automatically decrypted. You can then process this data by running custom logic written in Node.js or Python as you usually would, but without ever handling it in plaintext on your infrastructure.
Endpoints
post/functions/:function_name/runs
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.
Request Body
The data payload that the Function will use during its execution. Any encrypted values will be decrypted before being passed to the function.
If you want your Function to run asynchronously and notify a callback URL, this can be set to
trueand the API will queue your Function run and return a202response code.
Response Body
A unique identifier representing this specific Function execution instance.
The outcome of the Function execution.
Supported values
"success"The Function executed successfully
"failure"The Function encountered an error
"scheduled"The Function execution has been queued
This field represents the output returned by the Function. This is provided only when the Function execution status is 'success'.
This field details any error that occurred during Function execution. This is present only if the status is 'failure'.
The exact time, in epoch milliseconds, when this Function execution was triggered.
Client Tokens
Client-Side Tokens are short-lived tokens that can be used to perform actions from your frontend applications.
Endpoints
post/client-side-tokens
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
The action that the token should permit
Supported values
"api:decrypt"
The payload that the token must be used with
The expiry of the token in milliseconds format. Must be less than 10 minutes from now.
Relays
Relay is a network proxy that can be configured to encrypt or decrypt sensitive data as it passes between a client and a destination server. Relay can be used with your own API or with third-party APIs. It is designed to be easy to use and requires minimal changes to your existing code.
Endpoints
post/relays
get/relays
get/relays/:id
patch/relays/:id
delete/relays/:id
post/relays/:relay_id/custom-domains
get/relays/:relay_id/custom-domains
get/relays/:relay_id/custom-domains/:id
delete/relays/:relay_id/custom-domains/:id
Create a Relay
Creates a new Relay.
Request Body
The domain in front of which you would like to configure a Relay
A collection of route configurations for the Relay.
The HTTP method that must be matched for the operation to be performed. For any method, use null.
Supported values
"GET""HEAD""POST""PUT""DELETE""PATCH"
The path that must be matched for the operation to be performed. For wildcards, use '*'. For a catchall of all subsequent paths, use '**'.
The actions to be performed on the data on request.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The actions to be performed on the data on response.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
Whether or not empty strings should be encrypted. Defaults to true.
The type of authentication required for the Relay
Supported values
"api-key"Requires API key
nullAllows unauthenticated requests
Response Body
The unique identifier for the Relay.
The domain in front of which the Relay should be configured.
The Evervault managed domain to which requests to be relayed to the destination domain should be sent.
A collection of route configurations for the Relay.
The HTTP method that must be matched for the operation to be performed. For any method, use null.
Supported values
"GET""HEAD""POST""PUT""DELETE""PATCH"
The path that must be matched for the operation to be performed. For wildcards, use '*'. For a catchall of all subsequent paths, use '**'.
The actions to be performed on the data on request.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The actions to be performed on the data on response.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The type of authentication required for the Relay
Supported values
"api-key"Requires API key
nullAllows unauthenticated requests
Whether or not empty strings should be encrypted.
The unique identifier for the app to which the Relay belongs.
The exact time, in epoch milliseconds, when this Relay was created.
The exact time, in epoch milliseconds, when this Relay was updated.
List all Relays
Lists all Relays for the App.
Response Body
An array of Relays belonging to the App.
The unique identifier for the Relay.
The domain in front of which the Relay should be configured.
The Evervault managed domain to which requests to be relayed to the destination domain should be sent.
A collection of route configurations for the Relay.
The HTTP method that must be matched for the operation to be performed. For any method, use null.
Supported values
"GET""HEAD""POST""PUT""DELETE""PATCH"
The path that must be matched for the operation to be performed. For wildcards, use '*'. For a catchall of all subsequent paths, use '**'.
The actions to be performed on the data on request.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The actions to be performed on the data on response.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The type of authentication required for the Relay
Supported values
"api-key"Requires API key
nullAllows unauthenticated requests
Whether or not empty strings should be encrypted.
The unique identifier for the app to which the Relay belongs.
The exact time, in epoch milliseconds, when this Relay was created.
The exact time, in epoch milliseconds, when this Relay was updated.
Retrieve a Relay
Retrieves a Relay by its ID.
Response Body
The unique identifier for the Relay.
The domain in front of which the Relay should be configured.
The Evervault managed domain to which requests to be relayed to the destination domain should be sent.
A collection of route configurations for the Relay.
The HTTP method that must be matched for the operation to be performed. For any method, use null.
Supported values
"GET""HEAD""POST""PUT""DELETE""PATCH"
The path that must be matched for the operation to be performed. For wildcards, use '*'. For a catchall of all subsequent paths, use '**'.
The actions to be performed on the data on request.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The actions to be performed on the data on response.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The type of authentication required for the Relay
Supported values
"api-key"Requires API key
nullAllows unauthenticated requests
Whether or not empty strings should be encrypted.
The unique identifier for the app to which the Relay belongs.
The exact time, in epoch milliseconds, when this Relay was created.
The exact time, in epoch milliseconds, when this Relay was updated.
Updates a Relay
Updates a Relay. Any properties not provided are left unchanged.
Request Body
A collection of route configurations for the Relay. Any existing route configurations will be replaced with the new configurations.
The HTTP method that must be matched for the operation to be performed. For any method, use null.
Supported values
"GET""HEAD""POST""PUT""DELETE""PATCH"
The path that must be matched for the operation to be performed. For wildcards, use '*'. For a catchall of all subsequent paths, use '**'.
The actions to be performed on the data on request.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The actions to be performed on the data on response.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
Whether or not empty strings should be encrypted.
The type of authentication required for the Relay.
Supported values
"api-key"null
Response Body
The unique identifier for the Relay.
The domain in front of which the Relay should be configured.
The Evervault managed domain to which requests to be relayed to the destination domain should be sent.
A collection of route configurations for the Relay.
The HTTP method that must be matched for the operation to be performed. For any method, use null.
Supported values
"GET""HEAD""POST""PUT""DELETE""PATCH"
The path that must be matched for the operation to be performed. For wildcards, use '*'. For a catchall of all subsequent paths, use '**'.
The actions to be performed on the data on request.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The actions to be performed on the data on response.
The operation to perform on the selected data.
Supported values
"encrypt""decrypt"
The selections of data on which the operation will be performed.
The type of the selector used to identify the data on which the action should be performed.
Supported values
"header"selectorshould be a case-insensitive header name"json"selectorshould be a valid JSONPath string to select fields in the JSON payload"form"selectorshould be an exact form field name
The role of the encrypted field that must be matched for the operation to be performed.
The selector that identifies the data on which the action should be performed
The type of authentication required for the Relay
Supported values
"api-key"Requires API key
nullAllows unauthenticated requests
Whether or not empty strings should be encrypted.
The unique identifier for the app to which the Relay belongs.
The exact time, in epoch milliseconds, when this Relay was created.
The exact time, in epoch milliseconds, when this Relay was updated.
Delete a Relay
Deletes a Relay. This action cannot be undone and the Relay domain will no longer forward requests to its destination domain.
Create a Custom Domain
Creates a custom domain for the Relay
Request Body
The customer managed domain to which requests to be relayed to your domain should be sent.
Response Body
The unique identifier for the custom domain.
The customer managed domain to which requests to be relayed to your domain should be sent.
The ID of the Relay with which this custom domain is associated.
The status of the domains DNS verification.
Supported values
"active"The domain is active and can be used for requests
"inactive"The domain is inactive and cannot be used for requests
Validation TXT record to be added on the
_ev-custom-relaysubdomain of your custom domainThe exact time, in epoch milliseconds, when this custom domain was created.
The exact time, in epoch milliseconds, when this custom domain was last updated.
List all Custom Domains
Lists all custom domains for a Relay.
Response Body
The unique identifier for the custom domain.
The customer managed domain to which requests to be relayed to your domain should be sent.
The ID of the Relay with which this custom domain is associated.
The status of the domains DNS verification.
Supported values
"active"The domain is active and can be used for requests
"inactive"The domain is inactive and cannot be used for requests
Validation TXT record to be added on the
_ev-custom-relaysubdomain of your custom domainThe exact time, in epoch milliseconds, when this custom domain was created.
The exact time, in epoch milliseconds, when this custom domain was last updated.
Retrieve a Custom Domain
Retrieves a custom domain for a Relay.
Parameters
The id of the Relay to which the custom domain belongs.
The id of the custom domain to be fetched.
Response Body
The unique identifier for the custom domain.
The customer managed domain to which requests to be relayed to your domain should be sent.
The ID of the Relay with which this custom domain is associated.
The status of the domains DNS verification.
Supported values
"active"The domain is active and can be used for requests
"inactive"The domain is inactive and cannot be used for requests
Validation TXT record to be added on the
_ev-custom-relaysubdomain of your custom domainThe exact time, in epoch milliseconds, when this custom domain was created.
The exact time, in epoch milliseconds, when this custom domain was last updated.
Delete a Custom Domain
Deletes a custom domain for a Relay. This action cannot be undone.
Insights
The Evervault API provides several endpoints which can be used to retrieve additional information for cards and bin ranges. This can be used for tasks such as fraud detection and payment routing.
Endpoints
post/insights/cards
post/payments/bin-lookups
Card Insights
The Card Insights API allows you to perform address verification (AVS), name verification (ANI), and CVV verification checks. You can also check the card's push and pull transaction capabilities.
Request Body
The card details.
The card number. This should be a valid Evervault encrypted card number or a valid plaintext card number.
The card security code. This should be a valid Evervault encrypted CVV or a valid plaintext CVV. Required if the
cvvextension is requested.
The extensions to the card insight request.
Supported item values
"capabilities"Check the card's push and pull transaction capabilities
"cvv"Check the card's CVV verification
"cardholder"Check the cardholder's name verification
"address"Check the cardholder's address verification
Details about the cardholder's address that the address verification (AVS) is for. Required if the
addressextension is requested.The ZIP or postal code.
Street address line 1
Street address line 2
The city name
The state or province code. Required when
countryisus,ca, orau.- Format
One- to three-letter subdivision code, usually for a state or province (ISO 3166-2 subdivision, lowercase)
- Example
"ny"
The country code.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
Response Body
The unique identifier for the Card Insight
A unique, cryptographically secure identifier for the card number. Useful for deduplication.
The BIN details for the supplied card. This includes details such as the card brand, funding type, issuer, 3D Secure support and more.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The card funding type specifies the method by which transactions are financed.
Supported values
"debit"Draw funds directly from a linked bank account
"credit"Provide a line of credit from which users can borrow funds for transactions
"prepaid"Loaded with a set amount of funds in advance and can be used until the balance is depleted
"deferred-debit"Combine aspects of debit and credit cards, allowing transactions to be debited from a linked account at a later date, usually monthly
"charge"Require full payment of the balance at the end of each billing cycle, but do not have a pre-set spending limit
The card segment indicates the primary market or usage category of the card.
Supported values
"consumer"Personal use cards
"commercial"Cards used by large organizations or corporations
"business"Small to medium-sized business use
"government"Cards used by government entities
"payouts"Cards designed to disburse payments like payroll or cashback
"all"General-purpose cards not confined to a specific segment
The country associated with the card.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
The currency associated with the card (ISO 4217)
The name of the issuer bank
Type of card or network token identified during the lookup.
Supported values
"card""network-token"null
The name of the product associated with the card
Specifies the availability of instant payment capabilities for card transactions, indicating whether funds can be transferred immediately both within the same country and across international borders.
When true, indicates that instant payments are supported for transactions within the same country/domestic market. This allows for immediate funds availability for local transfers.
When true, indicates that instant payments are supported for international transactions between different countries. This enables immediate funds availability for cross-border transfers.
Metadata about 3DS capabilities, including supported versions and ACS (Access Control Server) indicators.
Array of ACS information indicators
The indicator code, the following values are supported:
authentication-availableattempts-supporteddecoupled-authentication-supportedtrustlist-supporteddevice-binding-supportedwebauthn-authentication-supportedspc-authentication-supportedtra-exemption-supportedtrustlist-exemption-supportedlow-value-exemption-supportedsecure-corporate-payments-exemption-supportedemvco-reservedds-reserved
American Express only:
issuer-tra-exemption-supportedissuer-trustlist-exemption-supportedissuer-low-value-exemption-supportedissuer-secure-corporate-payments-exemption-supportedbridging-message-extension-supported
Mastercard only:
smart-auth-direct-stand-in-onlysmart-auth-directpayment-transactions-supportednon-payment-transactions-supportedapp-channel-supportedbrowser-channel-supportedapp-acs-challenge-supportedbrowser-acs-challenge-supported
Visa only:
issuer-tra-exemption-supporteddata-only-supporteddelegated-authentication-supporteddigital-auth-framework-supported
The raw numeric indicator value, ranges from 01 to 99
Human-readable description of the indicator
The push and pull capabilities of the card
Indicates if push or pull transactions are enabled for the supplied card
The card network for the supplied card
The funding type of the card
Indicates the typical time for payouts
Supported values
"immediate""next-day""next-few"
Indicates if the issuer is a regulated institution
Indicates if push or pull transactions are enabled for the supplied card
The card network for the supplied card
The funding type of the card
Indicates the typical time for payouts
Supported values
"immediate""next-day""next-few"
Indicates if the issuer is a regulated institution
Deprecated. Always returns
null. Previously the estimated network and interchange fees for push and pull transactions.A unique identifier generated for this AVS verification
A network generated transaction identifier that is unique to every authorization and financial request.
The result of the address verification check (AVS)
The raw result code
The match code for the address portion of the AVS (excludes zip code)
Supported values
"match""no-match""unknown""unavailable"
The match code for the zip code portion of the address (excludes line1, line2, etc.)
Supported values
"match""no-match""unknown""unavailable"
The unique identifier of the Payment Account associated with this card.
Unix timestamp of when the card insight was created
BIN Lookup
Performs a BIN lookup for the provided card number and retrieves associated information such as the card brand, country, issuer, and more.
Request Body
The card number for which the BIN lookup is being requested. It can be a plaintext Card number (FPAN) / Network Token number (DPAN), an encrypted Card number / Network Token number or simply just a BIN (6-10 first digits of a Card Number) for range lookup.
Response Body
The unique identifier for the BIN lookup
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The card funding type specifies the method by which transactions are financed.
Supported values
"debit"Draw funds directly from a linked bank account
"credit"Provide a line of credit from which users can borrow funds for transactions
"prepaid"Loaded with a set amount of funds in advance and can be used until the balance is depleted
"deferred-debit"Combine aspects of debit and credit cards, allowing transactions to be debited from a linked account at a later date, usually monthly
"charge"Require full payment of the balance at the end of each billing cycle, but do not have a pre-set spending limit
The card segment indicates the primary market or usage category of the card.
Supported values
"consumer"Personal use cards
"commercial"Cards used by large organizations or corporations
"business"Small to medium-sized business use
"government"Cards used by government entities
"payouts"Cards designed to disburse payments like payroll or cashback
"all"General-purpose cards not confined to a specific segment
The country associated with the card.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"gb"
The currency associated with the card (ISO 4217)
The name of the issuer bank
Type of card range identified during the lookup
Supported values
"card"A card range was identified
"network-token"A network token range was identified
nullNone identified
The name of the product associated with the card
Specifies the availability of instant payment capabilities for card transactions, indicating whether funds can be transferred immediately both within the same country and across international borders.
When true, indicates that instant payments are supported for transactions within the same country/domestic market. This allows for immediate funds availability for local transfers.
When true, indicates that instant payments are supported for international transactions between different countries. This enables immediate funds availability for cross-border transfers.
Metadata about 3DS capabilities, including supported versions and ACS (Access Control Server) indicators.
Array of ACS information indicators
The indicator code, the following values are supported:
authentication-availableattempts-supporteddecoupled-authentication-supportedtrustlist-supporteddevice-binding-supportedwebauthn-authentication-supportedspc-authentication-supportedtra-exemption-supportedtrustlist-exemption-supportedlow-value-exemption-supportedsecure-corporate-payments-exemption-supportedemvco-reservedds-reserved
American Express only:
issuer-tra-exemption-supportedissuer-trustlist-exemption-supportedissuer-low-value-exemption-supportedissuer-secure-corporate-payments-exemption-supportedbridging-message-extension-supported
Mastercard only:
smart-auth-direct-stand-in-onlysmart-auth-directpayment-transactions-supportednon-payment-transactions-supportedapp-channel-supportedbrowser-channel-supportedapp-acs-challenge-supportedbrowser-acs-challenge-supported
Visa only:
issuer-tra-exemption-supporteddata-only-supporteddelegated-authentication-supporteddigital-auth-framework-supported
The raw numeric indicator value, ranges from 01 to 99
Human-readable description of the indicator
Unix timestamp of when the BIN lookup was created
Merchants
Endpoints
post/payments/merchants
get/payments/merchants
get/payments/merchants/:merchant_id
patch/payments/merchants/:merchant_id
delete/payments/merchants/:merchant_id
Create a Merchant
Enrolls a Merchant with Card Networks.
In rare cases it can take up to 48 hours to enroll a merchant with each of the card networks. If you are still unable to provision network tokens after this period, please contact support@evervault.com
Request Body
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.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme"
A shorter version of the Merchant's name. Optional. When creating a 3D Secure session that references this Merchant by ID,
shortNameis used in place ofnameifnameexceeds the 40-character limit imposed by the 3D Secure specification.- Regex
/^[a-zA-Z0-9 ]{1,40}$/- Example
"Acme"
The official website URL of the Merchant. The domain must use a valid IANA top-level domain. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt
The 4-digit Merchant Category Code (MCC).
The business details of the Merchant.
The legal name under which the Merchant's business is registered.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme Corp"
The physical address of the Merchant's principal place of business.
The first line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"123 Main St"
The second line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"Floor 4"
The city where the address is located.
- Regex
/^[0-9a-zA-Z _\-¡-]+$/- Example
"Springfield"
The state or province code. Required when
countryisus,ca, orau.- Format
One- to three-letter subdivision code, usually for a state or province (ISO 3166-2 subdivision, lowercase)
- Example
"ny"
The postal code of the address.
- Regex
/^[0-9a-zA-Z ]*$/- Example
"13468"
The country where the address is located.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
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 Body
A unique identifier assigned to each Merchant.
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.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme"
A shorter version of the Merchant's name. When creating a 3D Secure session that references this Merchant by ID,
shortNameis used in place ofnameifnameexceeds the 40-character limit imposed by the 3D Secure specification.- Regex
/^[a-zA-Z0-9 ]{1,40}$/- Example
"Acme"
The official website URL of the Merchant. The domain must use a valid IANA top-level domain. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt
The business details of the Merchant.
The legal name under which the Merchant's business is registered.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme Corp"
The physical address of the Merchant's principal place of business.
The first line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"123 Main St"
The second line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"Floor 4"
The city where the address is located.
- Regex
/^[0-9a-zA-Z _\-¡-]+$/- Example
"Springfield"
The state or province code. Required when
countryisus,ca, orau.- Format
One- to three-letter subdivision code, usually for a state or province (ISO 3166-2 subdivision, lowercase)
- Example
"ny"
The postal code of the address.
- Regex
/^[0-9a-zA-Z ]*$/- Example
"13468"
The country where the address is located.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
The 4-digit Merchant Category Code (MCC).
The Merchant's Network Token configuration.
An array detailing the Merchant's enrollment status for network token issuance across different card brands.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The unique Token Requestor Identifier (TRID) associated with the Merchant for the specific card brand. This identifier is used when creating Network Tokens for the Merchant.
The current stage of the Merchant's enrolment process for network token issuance with the specified card brand.
Supported values
"active"The Merchant is fully enrolled and can create Network Tokens for the card brand.
"provisioning"The Merchant is in the process of being enrolled for the card brand.
"inactive"The Merchant is not enrolled for the card brand.
The Merchant's Apple Pay configuration.
The domains the Merchant has enrolled with Apple Pay and the status of the enrollment.
The exact time, in epoch milliseconds, when this Merchant was created.
The exact time, in epoch milliseconds, when this Merchant was last updated.
List Merchants
Lists all Merchants that have been created.
Parameters
The page number to retrieve.
The number of Merchants to retrieve per page (default is 50).
Filter the Merchants by name.
Response Body
A unique identifier assigned to each Merchant.
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.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme"
A shorter version of the Merchant's name. When creating a 3D Secure session that references this Merchant by ID,
shortNameis used in place ofnameifnameexceeds the 40-character limit imposed by the 3D Secure specification.- Regex
/^[a-zA-Z0-9 ]{1,40}$/- Example
"Acme"
The official website URL of the Merchant. The domain must use a valid IANA top-level domain. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt
The business details of the Merchant.
The legal name under which the Merchant's business is registered.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme Corp"
The physical address of the Merchant's principal place of business.
The first line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"123 Main St"
The second line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"Floor 4"
The city where the address is located.
- Regex
/^[0-9a-zA-Z _\-¡-]+$/- Example
"Springfield"
The state or province code. Required when
countryisus,ca, orau.- Format
One- to three-letter subdivision code, usually for a state or province (ISO 3166-2 subdivision, lowercase)
- Example
"ny"
The postal code of the address.
- Regex
/^[0-9a-zA-Z ]*$/- Example
"13468"
The country where the address is located.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
The 4-digit Merchant Category Code (MCC).
The Merchant's Network Token configuration.
An array detailing the Merchant's enrollment status for network token issuance across different card brands.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The unique Token Requestor Identifier (TRID) associated with the Merchant for the specific card brand. This identifier is used when creating Network Tokens for the Merchant.
The current stage of the Merchant's enrolment process for network token issuance with the specified card brand.
Supported values
"active"The Merchant is fully enrolled and can create Network Tokens for the card brand.
"provisioning"The Merchant is in the process of being enrolled for the card brand.
"inactive"The Merchant is not enrolled for the card brand.
The Merchant's Apple Pay configuration.
The domains the Merchant has enrolled with Apple Pay and the status of the enrollment.
The exact time, in epoch milliseconds, when this Merchant was created.
The exact time, in epoch milliseconds, when this Merchant was last updated.
The number of Merchants retrieved per page.
The next page number to retrieve. If there are no additional Merchants, this will be
null.The total count of all Merchants, after any filters.
Retrieve a Merchant
Retrieves a Merchant by its unique identifier.
Response Body
A unique identifier assigned to each Merchant.
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.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme"
A shorter version of the Merchant's name. When creating a 3D Secure session that references this Merchant by ID,
shortNameis used in place ofnameifnameexceeds the 40-character limit imposed by the 3D Secure specification.- Regex
/^[a-zA-Z0-9 ]{1,40}$/- Example
"Acme"
The official website URL of the Merchant. The domain must use a valid IANA top-level domain. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt
The business details of the Merchant.
The legal name under which the Merchant's business is registered.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme Corp"
The physical address of the Merchant's principal place of business.
The first line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"123 Main St"
The second line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"Floor 4"
The city where the address is located.
- Regex
/^[0-9a-zA-Z _\-¡-]+$/- Example
"Springfield"
The state or province code. Required when
countryisus,ca, orau.- Format
One- to three-letter subdivision code, usually for a state or province (ISO 3166-2 subdivision, lowercase)
- Example
"ny"
The postal code of the address.
- Regex
/^[0-9a-zA-Z ]*$/- Example
"13468"
The country where the address is located.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
The 4-digit Merchant Category Code (MCC).
The Merchant's Network Token configuration.
An array detailing the Merchant's enrollment status for network token issuance across different card brands.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The unique Token Requestor Identifier (TRID) associated with the Merchant for the specific card brand. This identifier is used when creating Network Tokens for the Merchant.
The current stage of the Merchant's enrolment process for network token issuance with the specified card brand.
Supported values
"active"The Merchant is fully enrolled and can create Network Tokens for the card brand.
"provisioning"The Merchant is in the process of being enrolled for the card brand.
"inactive"The Merchant is not enrolled for the card brand.
The Merchant's Apple Pay configuration.
The domains the Merchant has enrolled with Apple Pay and the status of the enrollment.
The exact time, in epoch milliseconds, when this Merchant was created.
The exact time, in epoch milliseconds, when this Merchant was last updated.
Update a Merchant
Updates a Merchant by its unique identifier.
Request Body
A shorter version of the Merchant's name. When creating a 3D Secure session that references this Merchant by ID,
shortNameis used in place ofnameifnameexceeds the 40-character limit imposed by the 3D Secure specification.- Regex
/^[a-zA-Z0-9 ]{1,40}$/- Example
"Acme"
The Merchant's Apple Pay configuration.
Response Body
A unique identifier assigned to each Merchant.
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.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme"
A shorter version of the Merchant's name. When creating a 3D Secure session that references this Merchant by ID,
shortNameis used in place ofnameifnameexceeds the 40-character limit imposed by the 3D Secure specification.- Regex
/^[a-zA-Z0-9 ]{1,40}$/- Example
"Acme"
The official website URL of the Merchant. The domain must use a valid IANA top-level domain. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt
The business details of the Merchant.
The legal name under which the Merchant's business is registered.
- Regex
/^[a-zA-Z0-9 ]{1,60}$/- Example
"Acme Corp"
The physical address of the Merchant's principal place of business.
The first line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"123 Main St"
The second line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"Floor 4"
The city where the address is located.
- Regex
/^[0-9a-zA-Z _\-¡-]+$/- Example
"Springfield"
The state or province code. Required when
countryisus,ca, orau.- Format
One- to three-letter subdivision code, usually for a state or province (ISO 3166-2 subdivision, lowercase)
- Example
"ny"
The postal code of the address.
- Regex
/^[0-9a-zA-Z ]*$/- Example
"13468"
The country where the address is located.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
The 4-digit Merchant Category Code (MCC).
The Merchant's Network Token configuration.
An array detailing the Merchant's enrollment status for network token issuance across different card brands.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The unique Token Requestor Identifier (TRID) associated with the Merchant for the specific card brand. This identifier is used when creating Network Tokens for the Merchant.
The current stage of the Merchant's enrolment process for network token issuance with the specified card brand.
Supported values
"active"The Merchant is fully enrolled and can create Network Tokens for the card brand.
"provisioning"The Merchant is in the process of being enrolled for the card brand.
"inactive"The Merchant is not enrolled for the card brand.
The Merchant's Apple Pay configuration.
The domains the Merchant has enrolled with Apple Pay and the status of the enrollment.
The exact time, in epoch milliseconds, when this Merchant was created.
The exact time, in epoch milliseconds, when this Merchant was last updated.
Delete a Merchant
Acquirers
The Acquirer API allows you to enroll Acquirer details with Card Networks to enable use of other payment APIs such as 3D Secure.
Endpoints
post/payments/acquirers
get/payments/acquirers
get/payments/acquirers/:acquirer_id
patch/payments/acquirers/:acquirer_id
delete/payments/acquirers/:acquirer_id
Create an Acquirer
Creates an Acquirer to be used with 3DS sessions.
Request Body
The name of the Acquirer.
The description of the Acquirer.
Specifies whether this Acquirer is the default. Only one default Acquirer configuration can exist at a time; setting a new one clears the previous default. If none is defined, the first Acquirer created becomes the default. See the Acquirers API for details.
The Acquirer configurations. Configurations are set according to each card network the Acquirer is associated with, and each
networkcan only appear once. To use a differentbin,acquirerMerchantIdentifier, orcountryfor the same network, create a separate Acquirer.The card network of the Acquirer.
discovercovers Discover, Diners Club, and JCB (US only).Supported values
"visa""mastercard""american-express""discover"
The Bank Identification Number (BIN) of the Acquirer. Must be 6 to 11 digits.
- Regex
/^[0-9]{6,11}$/- Example
"424242"
The merchant identifier associated with the configuration.
The country of the Acquirer configuration, used when creating 3DS sessions.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
Response Body
The unique identifier of the acquirer configuration.
The name of the acquirer configuration.
The description of the acquirer configuration.
The acquirer configuration settings.
The card network of the Acquirer.
discovercovers Discover, Diners Club, and JCB (US only).Supported values
"visa""mastercard""american-express""discover"
The Bank Identification Number (BIN) of the Acquirer. Must be 6 to 11 digits.
- Regex
/^[0-9]{6,11}$/- Example
"424242"
The merchant identifier the configuration is associated with.
The country of the acquirer configuration, used when creating 3DS sessions.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
List Acquirers
Lists all Acquirers that have been created.
Parameters
The page number to retrieve.
The number of Acquirers to retrieve per page. The default is 50, which is also the maximum.
Response Body
The unique identifier of the acquirer configuration.
The name of the acquirer configuration.
The description of the acquirer configuration.
The acquirer configuration settings.
The card network of the Acquirer.
discovercovers Discover, Diners Club, and JCB (US only).Supported values
"visa""mastercard""american-express""discover"
The Bank Identification Number (BIN) of the Acquirer. Must be 6 to 11 digits.
- Regex
/^[0-9]{6,11}$/- Example
"424242"
The merchant identifier the configuration is associated with.
The country of the acquirer configuration, used when creating 3DS sessions.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
The number of Acquirers retrieved per page.
The next page number to retrieve. If there are no additional Acquirers, this will be
null.The total count of all Acquirers.
Retrieve an Acquirer
Retrieves an Acquirer by its unique identifier.
Response Body
The unique identifier of the acquirer configuration.
The name of the acquirer configuration.
The description of the acquirer configuration.
The acquirer configuration settings.
The card network of the Acquirer.
discovercovers Discover, Diners Club, and JCB (US only).Supported values
"visa""mastercard""american-express""discover"
The Bank Identification Number (BIN) of the Acquirer. Must be 6 to 11 digits.
- Regex
/^[0-9]{6,11}$/- Example
"424242"
The merchant identifier the configuration is associated with.
The country of the acquirer configuration, used when creating 3DS sessions.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
Update an Acquirer
Updates an Acquirer by its unique identifier.
Request Body
The name of the Acquirer.
The description of the Acquirer.
Specifies whether this Acquirer is the default. Only one default Acquirer configuration can exist at a time; setting a new one clears the previous default. See the Acquirers API for details.
The Acquirer configurations. Configurations are set according to each card network the Acquirer is associated with, and each
networkcan only appear once. To use a differentbin,acquirerMerchantIdentifier, orcountryfor the same network, create a separate Acquirer.The card network to use the configuration for.
discovercovers Discover, Diners Club, and JCB (US only).Supported values
"visa""mastercard""american-express""discover"
The Bank Identification Number (BIN) of the acquirer. Must be 6 to 11 digits.
- Regex
/^[0-9]{6,11}$/
The merchant identifier the configuration is associated with.
The country of the acquirer configuration, used when creating 3DS sessions.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
Response Body
The unique identifier of the acquirer configuration.
The name of the acquirer configuration.
The description of the acquirer configuration.
The acquirer configuration settings.
The card network of the Acquirer.
discovercovers Discover, Diners Club, and JCB (US only).Supported values
"visa""mastercard""american-express""discover"
The Bank Identification Number (BIN) of the Acquirer. Must be 6 to 11 digits.
- Regex
/^[0-9]{6,11}$/- Example
"424242"
The merchant identifier the configuration is associated with.
The country of the acquirer configuration, used when creating 3DS sessions.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
Delete an Acquirer
Network Tokens
Endpoints
post/payments/network-tokens
get/payments/network-tokens/:network_token_id
delete/payments/network-tokens/:network_token_id
post/payments/network-tokens/:network_token_id/cryptograms
post/payments/network-tokens/:network_token_id/simulate
get/payments/network-tokens/:network_token_id/card-art
Create a Network Token
Create a Network Token for a given card.
Request Body
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 Body
A unique identifier representing a specific Network Token.
The unique number of the Network Token.
The details of the underlying encrypted card.
The last four digits of the card number.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express"
The identifier of the Token Requestor (TRID) that requested the Network Token.
The Token Service Provider (TSP) that issued the Network Token.
Supported values
"mdes""vts""aets"
The unique identifier of the Payment Account associated with this Network Token.
The status of the Network Token. Active means the token is valid and can be used for payments. Inactive means the token exists but is not currently active. Blocked and provisioning are reserved for future use. Suspended means the token is temporarily unusable but may be reactivated by the issuer or transition to deleted. Deleted is a terminal state where the token is permanently removed and a new credential must be obtained. Expired means the token has passed its expiration date and should not be used for transactions.
Supported values
"active""inactive""blocked""provisioning""suspended""deleted""expired"
The unique identifier of the Merchant associated with this Network Token.
The exact time, in epoch milliseconds, when this Network Token was created.
The exact time, in epoch milliseconds, when this Network Token was last updated.
Retrieve a Network Token
Retrieves a Network Token by its unique identifier.
Response Body
A unique identifier representing a specific Network Token.
The unique number of the Network Token.
The details of the underlying encrypted card.
The last four digits of the card number.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express"
The identifier of the Token Requestor (TRID) that requested the Network Token.
The Token Service Provider (TSP) that issued the Network Token.
Supported values
"mdes""vts""aets"
The unique identifier of the Payment Account associated with this Network Token.
The status of the Network Token. Active means the token is valid and can be used for payments. Inactive means the token exists but is not currently active. Blocked and provisioning are reserved for future use. Suspended means the token is temporarily unusable but may be reactivated by the issuer or transition to deleted. Deleted is a terminal state where the token is permanently removed and a new credential must be obtained. Expired means the token has passed its expiration date and should not be used for transactions.
Supported values
"active""inactive""blocked""provisioning""suspended""deleted""expired"
The unique identifier of the Merchant associated with this Network Token.
The exact time, in epoch milliseconds, when this Network Token was created.
The exact time, in epoch milliseconds, when this Network Token was last updated.
Delete a Network Token
Create a Cryptogram
Creates a Network Token Cryptogram.
Response Body
A unique identifier representing a specific Network Token Cryptogram.
The value of the Network Token Cryptogram. This is the value that is used embedded in the Authorization request.
The exact time, in epoch milliseconds, when this Network Token Cryptogram was created.
Simulate a Network Token Update
Simulates an update to a Network Token so that you can test your integration. Sandbox only.
Request Body
The type of update to simulate.
Supported values
"new-token-status""new-card-expiry-and-last-four""new-token-expiry-and-number"
Response Body
A unique identifier representing a specific Network Token.
The unique number of the Network Token.
The details of the underlying encrypted card.
The last four digits of the card number.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express"
The identifier of the Token Requestor (TRID) that requested the Network Token.
The Token Service Provider (TSP) that issued the Network Token.
Supported values
"mdes""vts""aets"
The unique identifier of the Payment Account associated with this Network Token.
The status of the Network Token. Active means the token is valid and can be used for payments. Inactive means the token exists but is not currently active. Blocked and provisioning are reserved for future use. Suspended means the token is temporarily unusable but may be reactivated by the issuer or transition to deleted. Deleted is a terminal state where the token is permanently removed and a new credential must be obtained. Expired means the token has passed its expiration date and should not be used for transactions.
Supported values
"active""inactive""blocked""provisioning""suspended""deleted""expired"
The unique identifier of the Merchant associated with this Network Token.
The exact time, in epoch milliseconds, when this Network Token was created.
The exact time, in epoch milliseconds, when this Network Token was last updated.
Retrieve Card Art
Retrieves the card art for a Network Token by its unique identifier.
3D Secure
3D Secure is a security protocol designed to prevent fraud in online card transactions. It adds an additional layer of authentication during the payment process.
Endpoints
post/payments/3ds-sessions
get/payments/3ds-sessions/:3ds_session_id
Create a 3DS Session
Creates a 3DS Session to initiate the 3DS Authentication process. The session ID must then be passed to our client-side SDK to complete the authentication process. Learn more
Request Body
The merchant details. Either an inline merchant object or the unique identifier of a Merchant created with the Merchants API.
An inline merchant object.
The unique identifier of a Merchant created with the Merchants API.
The acquirer details to use for the 3DS session. Either an inline acquirer object or the unique identifier of an acquirer created with the Acquirers API. If omitted, Evervault resolves the default acquirer configuration for the card's network.
The acquirer of the payment.
The unique identifier of an acquirer created with the Acquirers API.
The details of the customer who initiated the transaction.
The name of the customer.
- Regex
/^[a-zA-Z0-9 !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]{2,45}$/- Example
"Seamus Finnigan"
The email address of the customer.
The shipping details of the customer.
The shipping address.
The first line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"123 Main St"
The second line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"Floor 4"
The city where the address is located.
- Regex
/^[0-9a-zA-Z _\-¡-]+$/- Example
"Springfield"
The state or province code. Required when
countryisus,ca, orau.- Format
One- to three-letter subdivision code, usually for a state or province (ISO 3166-2 subdivision, lowercase)
- Example
"ny"
The postal code of the address.
- Regex
/^[0-9a-zA-Z ]*$/- Example
"13468"
The country where the address is located.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
The billing details of the customer.
The first line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"123 Main St"
The second line of the address.
- Regex
/^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$!% ]+$/- Example
"Floor 4"
The city where the address is located.
- Regex
/^[0-9a-zA-Z _\-¡-]+$/- Example
"Springfield"
The state or province code. Required when
countryisus,ca, orau.- Format
One- to three-letter subdivision code, usually for a state or province (ISO 3166-2 subdivision, lowercase)
- Example
"ny"
The postal code of the address.
- Regex
/^[0-9a-zA-Z ]*$/- Example
"13468"
The country where the address is located.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"us"
The tax identifier of the cardholder.
The payment details of the 3D Secure Authentication. This field is mandatory for transactions involving payment authentications but not required for non-payment authentications.
A payment that is made in a single transaction.
A repeating payment for paying a total amount in multiple installments.
A repeating payment with a regular interval.
A prioritized list of preferred 3D Secure versions. 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 is selected. If none of the specified versions are supported by the issuer, the session fails.
Supported item values
"2.2.0"
Details about the 3DS challenge.
The 3DS challenge preference.
Supported values
"no-preference""challenge-requested""challenge-mandated""no-challenge-requested"
The reason for not requesting a challenge. This value should only be present when the preference is
no-challenge-requested.Supported values
"data-sharing""low-value""low-risk""secure-corporate-payment""authentication-already-performed"null
Details about the transaction initiation process.
Response Body
A unique identifier assigned to each 3DS Authentication.
The last four digits of the card number.
The card brand.
The card funding type.
The card segment.
The name of the card issuer.
The country code of the card.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"gb"
The currency code of the card. (ISO 4217 three-letter code)
The acquirer of the payment.
The Bank Identification Number (BIN) of the acquirer. Must be 6 to 11 digits.
- Regex
/^[0-9]{6,11}$/- Example
"42424242"
The merchant identifier assigned by the acquirer.
The country code of the acquirer
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
The merchant details.
The name of the merchant.
The website of the merchant.
The category code of the merchant.
The country code of the merchant.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
The payment details of the 3D Secure Authentication.
A repeating payment for paying a total amount in multiple installments.
A payment that is made in a single transaction.
A repeating payment with a regular interval.
Details about the 3DS challenge.
The 3DS challenge preference.
Supported values
"no-preference""challenge-requested""challenge-mandated""no-challenge-requested"
The reason for not requesting a challenge. This value should only be present when the preference is
no-challenge-requested.Supported values
"data-sharing""low-value""low-risk""secure-corporate-payment""authentication-already-performed"null
Details about the transaction initiation process.
Details about the Directory Server involved in the 3DS transaction.
The 3D Secure version used to authenticate the session.
Supported values
"2.2.0"
The status of the 3DS Authentication.
Supported values
"action-required""success""failure"
The details of the 3DS Authentication. This field is present when the status is
success.The authentication flow.
Supported values
"frictionless""challenge""attempt"
The authentication method(s). This field is only present when the flow is
challenge.Supported item values
"static-passcode""sms-otp""emv-card-reader-otp""app-otp""other-otp""knowledge-based""push-confirmation""oob-biometrics""oob-login""oob-other""webauthn""secure-payment-confirmation""behavioral-biometrics""electronic""decoupled"
The next action required to complete the 3DS Authentication.
The next action required to progress the 3DS Authentication. If the type is
use-sdkyou must use our Client-Side SDK to complete the 3DS Authentication.Supported values
"use-sdk"
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
successand is retained for one hour.The details of the Electronic Commerce Indicator. This value is only present when the status is
success.The value of the ECI. Below are descriptions of each of the possible values:
Mastercard:
00: Not authenticated. No liability shift.01: Attempted (Stand-in) authentication. Liability shift applies.02: Successful authentication. Liability shift applies.04: Data only authentication. No liability shift.06: Transaction is exempt from SCA. No liability shift.07: Recurring transaction authenticated. Liability shift applies for initial transaction only.
Visa, American Express, Discover, Diners Club, JCB:
05: Successful authentication. Liability shift applies.06: Attempted (Stand-in) authentication. Liability shift applies.07: Not authenticated. No liability shift.
Supported values
"00""01""02""04""05""06""07"
The descriptor of the ECI. This value must be retrieved and provided to the payment gateway when processing the payment.
Supported values
"fully-authenticated""attempted""not-authenticated"
A boolean value indicating whether the liability shift has occurred.
The reason for the 3DS Authentication failure. This field is present when the status is
failureand can be used for troubleshooting.Supported values
"failed-authentication"The authentication failed. Typically this is due to the cardholder failing to provide the correct 3DS authentication details. This transaction should be considered as potentially fraudulent.
"card-not-enrolled"The card is not enrolled in 3DS and therefore cannot be authenticated.
"no-card-record"The issuer has no record of the card. Verify the card details with the cardholder before retrying.
"suspected-fraud"The transaction is suspected to be fraudulent. You should not process this transaction.
"invalid-acquirer-details"The acquirer details are invalid. Please check the
acquirerobject for the correct details."transaction-cancelled-by-cardholder"The cardholder explicitly cancelled the transaction.
"unsupported-3ds-version"The 3DS version is not supported.
"challenge-required"This failure mode indicates that the cardholder is required to complete a challenge but the SDK has been mounted with the
failOnChallengeoption set totrue."timed-out"The authentication timed out. This is likely because the cardholder abandoned the transaction.
"acs-unavailable"The Access Control Server associated with the card issuer was unavailable. Please try again later.
"directory-server-unavailable"The Directory Server associated with the card network was unavailable. Please try again later.
"transient-system-failure"A transient system failure occurred. This is likely due to a technical issue with the 3DS authentication process. Please try again later.
"invalid-card-details"The card details are invalid. Please check the
cardobject for the correct details and ensure the card is not expired."transaction-not-permitted"The current session configuration is not permitted for this card. For example, defining a merchant intiated transaction reason of
secure-corporate-paymentfor non-commercial cards."required-data-element-missing"A required data element is missing. Please check the
cardobject for the correct details and ensure all required data elements are present."protocol-error"A protocol error occurred. This is likely due to a technical issue with the 3DS authentication process. Please try again later.
The details of the 3DS Authentication Response (ARes).
The details of the 3DS Challenge Response (CRes).
The result of the 3DS authentication when a challenge has occurred.
The exact time, in epoch milliseconds, when this 3DS-Session was created.
The exact time, in epoch milliseconds, when this 3DS-Session was last updated.
The 3D Secure API can be used in combination with our Client-Side SDK's to authenticate cardholders using 3D Secure. This API allows you to create, retrieve and update 3D Secure sessions.
Retrieve a 3DS Session
Retrieve a 3DS Session.
Response Body
A unique identifier assigned to each 3DS Authentication.
The last four digits of the card number.
The card brand.
The card funding type.
The card segment.
The name of the card issuer.
The country code of the card.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"gb"
The currency code of the card. (ISO 4217 three-letter code)
The acquirer of the payment.
The Bank Identification Number (BIN) of the acquirer. Must be 6 to 11 digits.
- Regex
/^[0-9]{6,11}$/- Example
"42424242"
The merchant identifier assigned by the acquirer.
The country code of the acquirer
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
The merchant details.
The name of the merchant.
The website of the merchant.
The category code of the merchant.
The country code of the merchant.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"ie"
The payment details of the 3D Secure Authentication.
A repeating payment for paying a total amount in multiple installments.
A payment that is made in a single transaction.
A repeating payment with a regular interval.
Details about the 3DS challenge.
The 3DS challenge preference.
Supported values
"no-preference""challenge-requested""challenge-mandated""no-challenge-requested"
The reason for not requesting a challenge. This value should only be present when the preference is
no-challenge-requested.Supported values
"data-sharing""low-value""low-risk""secure-corporate-payment""authentication-already-performed"null
Details about the transaction initiation process.
Details about the Directory Server involved in the 3DS transaction.
The 3D Secure version used to authenticate the session.
Supported values
"2.2.0"
The status of the 3DS Authentication.
Supported values
"action-required""success""failure"
The details of the 3DS Authentication. This field is present when the status is
success.The authentication flow.
Supported values
"frictionless""challenge""attempt"
The authentication method(s). This field is only present when the flow is
challenge.Supported item values
"static-passcode""sms-otp""emv-card-reader-otp""app-otp""other-otp""knowledge-based""push-confirmation""oob-biometrics""oob-login""oob-other""webauthn""secure-payment-confirmation""behavioral-biometrics""electronic""decoupled"
The next action required to complete the 3DS Authentication.
The next action required to progress the 3DS Authentication. If the type is
use-sdkyou must use our Client-Side SDK to complete the 3DS Authentication.Supported values
"use-sdk"
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
successand is retained for one hour.The details of the Electronic Commerce Indicator. This value is only present when the status is
success.The value of the ECI. Below are descriptions of each of the possible values:
Mastercard:
00: Not authenticated. No liability shift.01: Attempted (Stand-in) authentication. Liability shift applies.02: Successful authentication. Liability shift applies.04: Data only authentication. No liability shift.06: Transaction is exempt from SCA. No liability shift.07: Recurring transaction authenticated. Liability shift applies for initial transaction only.
Visa, American Express, Discover, Diners Club, JCB:
05: Successful authentication. Liability shift applies.06: Attempted (Stand-in) authentication. Liability shift applies.07: Not authenticated. No liability shift.
Supported values
"00""01""02""04""05""06""07"
The descriptor of the ECI. This value must be retrieved and provided to the payment gateway when processing the payment.
Supported values
"fully-authenticated""attempted""not-authenticated"
A boolean value indicating whether the liability shift has occurred.
The reason for the 3DS Authentication failure. This field is present when the status is
failureand can be used for troubleshooting.Supported values
"failed-authentication"The authentication failed. Typically this is due to the cardholder failing to provide the correct 3DS authentication details. This transaction should be considered as potentially fraudulent.
"card-not-enrolled"The card is not enrolled in 3DS and therefore cannot be authenticated.
"no-card-record"The issuer has no record of the card. Verify the card details with the cardholder before retrying.
"suspected-fraud"The transaction is suspected to be fraudulent. You should not process this transaction.
"invalid-acquirer-details"The acquirer details are invalid. Please check the
acquirerobject for the correct details."transaction-cancelled-by-cardholder"The cardholder explicitly cancelled the transaction.
"unsupported-3ds-version"The 3DS version is not supported.
"challenge-required"This failure mode indicates that the cardholder is required to complete a challenge but the SDK has been mounted with the
failOnChallengeoption set totrue."timed-out"The authentication timed out. This is likely because the cardholder abandoned the transaction.
"acs-unavailable"The Access Control Server associated with the card issuer was unavailable. Please try again later.
"directory-server-unavailable"The Directory Server associated with the card network was unavailable. Please try again later.
"transient-system-failure"A transient system failure occurred. This is likely due to a technical issue with the 3DS authentication process. Please try again later.
"invalid-card-details"The card details are invalid. Please check the
cardobject for the correct details and ensure the card is not expired."transaction-not-permitted"The current session configuration is not permitted for this card. For example, defining a merchant intiated transaction reason of
secure-corporate-paymentfor non-commercial cards."required-data-element-missing"A required data element is missing. Please check the
cardobject for the correct details and ensure all required data elements are present."protocol-error"A protocol error occurred. This is likely due to a technical issue with the 3DS authentication process. Please try again later.
The details of the 3DS Authentication Response (ARes).
The details of the 3DS Challenge Response (CRes).
The result of the 3DS authentication when a challenge has occurred.
The exact time, in epoch milliseconds, when this 3DS-Session was created.
The exact time, in epoch milliseconds, when this 3DS-Session was last updated.
The 3D Secure API can be used in combination with our Client-Side SDK's to authenticate cardholders using 3D Secure. This API allows you to create, retrieve and update 3D Secure sessions.
Card Account Updates
If your account has access to Card Account Updater you can use the Card Account Updater API to register cards for automatic updates. If an update is available for a card, the replacement field will be populated with the identifier of the new card.
Endpoints
post/payments/cards
get/payments/cards/:card_id
delete/payments/cards/:card_id
post/payments/cards/:card_id/simulate
Register a Card
When registering a card, you can provide either an Evervault encrypted card number or a plaintext card number. If you provide a plaintext card number it will be encrypted and the encrypted value will be returned in the response.
Card registration is idempotent on card number. Registering the same card number a second time returns the existing Card object, rather than creating a new one. This means you can use the Card object id as a unique identifier. If you register an existing card number but with a different expiry date, the existing Card object is updated with the new date, and Evervault returns a 200 OK response. A 201 Created response indicates that a new Card object was created.
Request Body
The card number. This should be a valid Evervault encrypted card number or a valid plaintext card number.
Response Body
The unique identifier for the card.
The Evervault encrypted card number. This can be decrypted using Relay decryption or using a function.
The first 6 or 8 digits of the card number.
The last 4 digits of the card number.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The card funding type specifies the method by which transactions are financed.
Supported values
"debit"Draw funds directly from a linked bank account
"credit"Provide a line of credit from which users can borrow funds for transactions
"prepaid"Loaded with a set amount of funds in advance and can be used until the balance is depleted
"deferred-debit"Combine aspects of debit and credit cards, allowing transactions to be debited from a linked account at a later date, usually monthly
"charge"Require full payment of the balance at the end of each billing cycle, but do not have a pre-set spending limit
The card segment indicates the primary market or usage category of the card.
Supported values
"consumer"Personal use cards
"commercial"Cards used by large organizations or corporations
"business"Small to medium-sized business use
"government"Cards used by government entities
"payouts"Cards designed to disburse payments like payroll or cashback
"all"General-purpose cards not confined to a specific segment
The country where the card was issued.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"gb"
The currency of the card.
- Format
Three-letter alphabetic code for the currency (ISO 4217, lowercase)
- Example
"gbp"
The name of the card issuer.
The current status of the card.
Supported values
"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.
The ID of the replacement card. This field is only present if the card has been replaced.
The status of Card Account Updater on this card. Evervault currently supports Card Account Updates for Visa, Mastercard and American Express cards.
Supported values
"enabled""issuer-not-enrolled""disabled"
The Unix timestamp of when the card was created.
The Unix timestamp of when the card was last updated.
Retrieve a Card
Retrieves a Card by its unique identifier.
Response Body
The unique identifier for the card.
The Evervault encrypted card number. This can be decrypted using Relay decryption or using a function.
The first 6 or 8 digits of the card number.
The last 4 digits of the card number.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The card funding type specifies the method by which transactions are financed.
Supported values
"debit"Draw funds directly from a linked bank account
"credit"Provide a line of credit from which users can borrow funds for transactions
"prepaid"Loaded with a set amount of funds in advance and can be used until the balance is depleted
"deferred-debit"Combine aspects of debit and credit cards, allowing transactions to be debited from a linked account at a later date, usually monthly
"charge"Require full payment of the balance at the end of each billing cycle, but do not have a pre-set spending limit
The card segment indicates the primary market or usage category of the card.
Supported values
"consumer"Personal use cards
"commercial"Cards used by large organizations or corporations
"business"Small to medium-sized business use
"government"Cards used by government entities
"payouts"Cards designed to disburse payments like payroll or cashback
"all"General-purpose cards not confined to a specific segment
The country where the card was issued.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"gb"
The currency of the card.
- Format
Three-letter alphabetic code for the currency (ISO 4217, lowercase)
- Example
"gbp"
The name of the card issuer.
The current status of the card.
Supported values
"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.
The ID of the replacement card. This field is only present if the card has been replaced.
The status of Card Account Updater on this card. Evervault currently supports Card Account Updates for Visa, Mastercard and American Express cards.
Supported values
"enabled""issuer-not-enrolled""disabled"
The Unix timestamp of when the card was created.
The Unix timestamp of when the card was last updated.
Delete a Card
Simulate a Card Update
Simulates an update to a Card so that you can test your Card Account Updater integration. This endpoint is only available for Sandbox Apps.
Request Body
The request body for simulating a card update differs depending on the type of event you want to simulate.
Response Body
The unique identifier for the card.
The Evervault encrypted card number. This can be decrypted using Relay decryption or using a function.
The first 6 or 8 digits of the card number.
The last 4 digits of the card number.
The card brand associated with the payment card.
Supported values
"visa""mastercard""american-express""discover""diners-club""jcb""unionpay"
The card funding type specifies the method by which transactions are financed.
Supported values
"debit"Draw funds directly from a linked bank account
"credit"Provide a line of credit from which users can borrow funds for transactions
"prepaid"Loaded with a set amount of funds in advance and can be used until the balance is depleted
"deferred-debit"Combine aspects of debit and credit cards, allowing transactions to be debited from a linked account at a later date, usually monthly
"charge"Require full payment of the balance at the end of each billing cycle, but do not have a pre-set spending limit
The card segment indicates the primary market or usage category of the card.
Supported values
"consumer"Personal use cards
"commercial"Cards used by large organizations or corporations
"business"Small to medium-sized business use
"government"Cards used by government entities
"payouts"Cards designed to disburse payments like payroll or cashback
"all"General-purpose cards not confined to a specific segment
The country where the card was issued.
- Format
Two-letter country code (ISO 3166-1 Alpha-2, lowercase)
- Example
"gb"
The currency of the card.
- Format
Three-letter alphabetic code for the currency (ISO 4217, lowercase)
- Example
"gbp"
The name of the card issuer.
The current status of the card.
Supported values
"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.
The ID of the replacement card. This field is only present if the card has been replaced.
The status of Card Account Updater on this card. Evervault currently supports Card Account Updates for Visa, Mastercard and American Express cards.
Supported values
"enabled""issuer-not-enrolled""disabled"
The Unix timestamp of when the card was created.
The Unix timestamp of when the card was last updated.
Webhook Events
Webhook Events are notifications triggered by specific operations to which you can subscribe, allowing you to be alerted when those operations occur. These events might include scenarios such as a Network Token being updated, a successful 3DS session, or the completion of a function deployment. Each event is categorized by a type that defines the nature of the event, along with associated data relevant to that event.
Create a Webhook Endpoint
Create a Webhook Endpoint
Request Body
The URL of the Webhook Endpoint.
A list of Events that the Webhook Endpoint should subscribe to.
Supported item values
"*"All events
"function.run.completed"An asynchronous Function Run was completed
"function.deployment.started"A Function Deployment was started
"function.deployment.updated"A Function Deployment was updated
"function.deployment.finished"A Function Deployment was finished
"enclave.deployment.started"An Enclave Deployment was started
"enclave.deployment.updated"An Enclave Deployment was updated
"enclave.deployment.finished"An Enclave Deployment was finished
"audit-log.event"An Audit Log Event was triggered
"payments.network-token.updated"A Network Token was updated
"payments.merchant.updated"A Merchant was updated
"payments.card.updated"A Card was updated
"payments.3ds-session.success"A 3DS Session was successful
"payments.3ds-session.failure"A 3DS Session failed
Response Body
A unique identifier representing a specific Webhook Endpoint.
The URL of the Webhook Endpoint.
A list of Events that the Webhook Endpoint is subscribed to. The Webhook will receive a POST request when any of these Events occur.
Supported item values
"*"All events
"function.run.completed"An asynchronous Function Run was completed
"function.deployment.started"A Function Deployment was started
"function.deployment.updated"A Function Deployment was updated
"function.deployment.finished"A Function Deployment was finished
"enclave.deployment.started"An Enclave Deployment was started
"enclave.deployment.updated"An Enclave Deployment was updated
"enclave.deployment.finished"An Enclave Deployment was finished
"audit-log.event"An Audit Log Event was triggered
"payments.network-token.updated"A Network Token was updated
"payments.merchant.updated"A Merchant was updated
"payments.card.updated"A Card was updated
"payments.3ds-session.success"A 3DS Session was successful
"payments.3ds-session.failure"A 3DS Session failed
The exact time, in epoch milliseconds, when this Webhook Endpoint was created.
The exact time, in epoch milliseconds, when this Webhook Endpoint was last updated.
List all Webhook Endpoints
Lists all Webhook Endpoints
Parameters
The maximum number of Webhook Endpoints to return (Default is 10).
The identifier of the last Webhook Endpoint in the previous page of results.
Response Body
A unique identifier representing a specific Webhook Endpoint.
The URL of the Webhook Endpoint.
A list of Events that the Webhook Endpoint is subscribed to. The Webhook will receive a POST request when any of these Events occur.
Supported item values
"*"All events
"function.run.completed"An asynchronous Function Run was completed
"function.deployment.started"A Function Deployment was started
"function.deployment.updated"A Function Deployment was updated
"function.deployment.finished"A Function Deployment was finished
"enclave.deployment.started"An Enclave Deployment was started
"enclave.deployment.updated"An Enclave Deployment was updated
"enclave.deployment.finished"An Enclave Deployment was finished
"audit-log.event"An Audit Log Event was triggered
"payments.network-token.updated"A Network Token was updated
"payments.merchant.updated"A Merchant was updated
"payments.card.updated"A Card was updated
"payments.3ds-session.success"A 3DS Session was successful
"payments.3ds-session.failure"A 3DS Session failed
The exact time, in epoch milliseconds, when this Webhook Endpoint was created.
The exact time, in epoch milliseconds, when this Webhook Endpoint was last updated.
Indicates whether there are more Webhook Endpoints to retrieve.
Retrieve a Webhook Endpoint
Retrieves a Webhook Endpoint
Response Body
A unique identifier representing a specific Webhook Endpoint.
The URL of the Webhook Endpoint.
A list of Events that the Webhook Endpoint is subscribed to. The Webhook will receive a POST request when any of these Events occur.
Supported item values
"*"All events
"function.run.completed"An asynchronous Function Run was completed
"function.deployment.started"A Function Deployment was started
"function.deployment.updated"A Function Deployment was updated
"function.deployment.finished"A Function Deployment was finished
"enclave.deployment.started"An Enclave Deployment was started
"enclave.deployment.updated"An Enclave Deployment was updated
"enclave.deployment.finished"An Enclave Deployment was finished
"audit-log.event"An Audit Log Event was triggered
"payments.network-token.updated"A Network Token was updated
"payments.merchant.updated"A Merchant was updated
"payments.card.updated"A Card was updated
"payments.3ds-session.success"A 3DS Session was successful
"payments.3ds-session.failure"A 3DS Session failed
The exact time, in epoch milliseconds, when this Webhook Endpoint was created.
The exact time, in epoch milliseconds, when this Webhook Endpoint was last updated.
Update a Webhook Endpoint
Updates a Webhook Endpoint
Request Body
A list of Events that the Webhook Endpoint should subscribe to.
Supported item values
"*"All events
"function.run.completed"An asynchronous Function Run was completed
"function.deployment.started"A Function Deployment was started
"function.deployment.updated"A Function Deployment was updated
"function.deployment.finished"A Function Deployment was finished
"enclave.deployment.started"An Enclave Deployment was started
"enclave.deployment.updated"An Enclave Deployment was updated
"enclave.deployment.finished"An Enclave Deployment was finished
"audit-log.event"An Audit Log Event was triggered
"payments.network-token.updated"A Network Token was updated
"payments.merchant.updated"A Merchant was updated
"payments.card.updated"A Card was updated
"payments.3ds-session.success"A 3DS Session was successful
"payments.3ds-session.failure"A 3DS Session failed
Response Body
A unique identifier representing a specific Webhook Endpoint.
The URL of the Webhook Endpoint.
A list of Events that the Webhook Endpoint is subscribed to. The Webhook will receive a POST request when any of these Events occur.
Supported item values
"*"All events
"function.run.completed"An asynchronous Function Run was completed
"function.deployment.started"A Function Deployment was started
"function.deployment.updated"A Function Deployment was updated
"function.deployment.finished"A Function Deployment was finished
"enclave.deployment.started"An Enclave Deployment was started
"enclave.deployment.updated"An Enclave Deployment was updated
"enclave.deployment.finished"An Enclave Deployment was finished
"audit-log.event"An Audit Log Event was triggered
"payments.network-token.updated"A Network Token was updated
"payments.merchant.updated"A Merchant was updated
"payments.card.updated"A Card was updated
"payments.3ds-session.success"A 3DS Session was successful
"payments.3ds-session.failure"A 3DS Session failed
The exact time, in epoch milliseconds, when this Webhook Endpoint was created.
The exact time, in epoch milliseconds, when this Webhook Endpoint was last updated.