Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Evervault 3D Secure API

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.

Evervault 3D Secure API is one of 12 APIs that Evervault publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include 3D Secure. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.evervault.com.

3 operations 3 paths 12 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.evervault.com
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Evervault 3D Secure API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (ApiKey). It accepts HTTP bearer tokens (RunToken) (TokenAuth). It accepts HTTP bearer tokens (Token) (ClientSideToken).

  • ApiKey — Authentication using an API key. The username is the App ID and the password is the Api Key.
  • TokenAuth — Authentication using a short lived run token that you can share with clients. The Authorization header must be formatted as follow: "RunToken "
  • ClientSideToken — Authentication using a short lived token that you can share with clients. The Authorization header must be formatted as follow: "Token "

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

3D Secure 3

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.

POST
/payments/3ds-sessions
Create a 3DS Session
createThreeDSSession body → 201400
GET
/payments/3ds-sessions/{3ds_session_id}
Retrieve a 3DS Session
retrieveThreeDSSession 1 param → 200
GET
/payments/3ds-sessions/{3ds_session_id}/messages
Retrieve 3DS Messages
retrieveThreeDSMessages 1 param → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ThreeDSSession (22 properties), Address (6 properties), PaymentInstallment (6 properties), Error (5 properties). Each schema is shown below with its type and property counts.

PaymentOneOff
object
A payment that is made in a single transaction.
3 properties 3 required
ThreeDSSession
object
The 3D Secure API can be used in combination with our [Client-Side SDK's](/sdks/javascriptuithreedsecure) to authenticate cardholders using 3D Secure. This API…
22 properties 7 required
PaymentInstallment
object
A repeating payment for paying a total amount in multiple installments.
6 properties 5 required
ThreeDSChallenge
object
Details about the 3DS challenge.
2 properties 1 required
ThreeDSAccessControlServer
object
Details about the Access Control Server involved in the 3DS transaction.
3 properties
Address
object
6 properties 4 required
Error
object
5 properties
Acquirer
object
The acquirer of the payment.
3 properties 3 required
PaymentRecurring
object
A repeating payment with a regular interval.
5 properties 5 required
ThreeDSDirectoryServer
object
Details about the Directory Server involved in the 3DS transaction.
3 properties
CardExpiry
object
2 properties 2 required
ThreeDSInitiator
object
Details about the transaction initiation process.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

evervault-3d-secure-api-openapi.yml Raw ↑

Other APIs Evervault publishes across the network.

Evervault Acquirers API
Evervault Card Account Updates API
Evervault Client Tokens API
Evervault Core API
Evervault Functions API
Evervault Insights API
Evervault Merchants API
Evervault Network Tokens API
Evervault Payments API
Evervault Relays API
Evervault Webhooks API