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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Evervault

Evervault Payments API

The Payments API from Evervault — 17 operation(s) for payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 25 operations across 17 paths, and defines 33 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.

25 operations 17 paths 33 schemas 4 DELETE9 GET2 PATCH10 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
Contact
Evervault Support Team
Resource Areas
1

Authentication & Security 3

Evervault Payments 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 25

Across 17 paths, the API surfaces 25 operations — 4 DELETE, 9 GET, 2 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 25
POST
/insights/cards
Card Insights
createCardInsight body → 201
POST
/payments/bin-lookups
BIN Lookup
createBinLookup body → 201
POST
/payments/merchants
Create a Merchant
createMerchant body → 201
GET
/payments/merchants
List Merchants
listMerchants 3 params → 200
GET
/payments/merchants/{merchant_id}
Retrieve a Merchant
getMerchant 1 param → 200
PATCH
/payments/merchants/{merchant_id}
Update a Merchant
updateMerchant 1 param body → 200
DELETE
/payments/merchants/{merchant_id}
Delete a Merchant
deleteMerchant 1 param → 204
POST
/payments/acquirers
Create an Acquirer
createAcquirer body → 201
GET
/payments/acquirers
List Acquirers
listAcquirers 2 params → 200
GET
/payments/acquirers/{acquirer_id}
Retrieve an Acquirer
getAcquirer 1 param → 200
PATCH
/payments/acquirers/{acquirer_id}
Update an Acquirer
updateAcquirer 1 param body → 200
DELETE
/payments/acquirers/{acquirer_id}
Delete an Acquirer
deleteAcquirer 1 param → 204
POST
/payments/network-tokens
Create a Network Token
createNetworkToken body → 201400422500
GET
/payments/network-tokens/{network_token_id}
Retrieve a Network Token
getNetworkToken 1 param → 200
DELETE
/payments/network-tokens/{network_token_id}
Delete a Network Token
deleteNetworkToken 1 param → 204
POST
/payments/network-tokens/{network_token_id}/cryptograms
Create a Cryptogram
createNetworkTokenCryptogram 1 param → 201
POST
/payments/network-tokens/{network_token_id}/simulate
Simulate a Network Token Update
simulateNetworkTokenUpdate 1 param body → 200
GET
/payments/network-tokens/{network_token_id}/card-art
Retrieve Card Art
getCardArt 1 param → 200
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
POST
/payments/cards
Register a Card
registerCard body → 200201
GET
/payments/cards/{card_id}
Retrieve a Card
getCard 1 param → 200
DELETE
/payments/cards/{card_id}
Delete a Card
deleteCard 1 param → 204
POST
/payments/cards/{card_id}/simulate
Simulate a Card Update
simulateCardUpdate 1 param body → 200

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ThreeDSSession (22 properties), Card (16 properties), BinLookup (12 properties), NetworkToken (11 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
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
CardFastFunds
object
Specifies the availability of instant payment capabilities for card transactions, indicating whether funds can be transferred immediately both within the same…
2 properties
Address
object
6 properties 4 required
Error
object
5 properties
CardInsightCapabilities
object
7 properties
CardInsight
object
10 properties 4 required
ThreeDSDirectoryServer
object
Details about the Directory Server involved in the 3DS transaction.
3 properties
CardExpiry
object
2 properties 2 required
PaymentInstallment
object
A repeating payment for paying a total amount in multiple installments.
6 properties 5 required
CauAclUpdate
object
Account closure
1 property 1 required
NetworkToken
object
11 properties 9 required
CauNedUpdate
object
New expiry date
2 properties 1 required
CardArt
object
4 properties 4 required
MerchantNetworkTokenStatus
object
1 property
CardThreeDSMetadata
object
Metadata about 3DS capabilities, including supported versions and ACS (Access Control Server) indicators.
2 properties
Acquirer
object
The acquirer of the payment.
3 properties 3 required
CardInsightAddress
object
4 properties
BinLookup
object
12 properties
PaymentRecurring
object
A repeating payment with a regular interval.
5 properties 5 required
MerchantApplePay
object
1 property
CardFunding
string
The card funding type specifies the method by which transactions are financed.
Merchant
object
10 properties 4 required
ThreeDSInitiator
object
Details about the transaction initiation process.
CardInsightCardholder
object
4 properties
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
NetworkTokenCryptogram
object
3 properties 3 required
CardSegment
string
The card segment indicates the primary market or usage category of the card.
AcquirerConfiguration
object
5 properties 4 required
CauNanUpdate
object
New account number
3 properties 1 required
Card
object
16 properties 4 required
CardBrand
string
The card brand associated with the payment card.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

evervault-payments-api-openapi.yml Raw ↑

Other APIs Evervault publishes across the network.

Evervault 3D Secure API
AE Profile APIs.io
Evervault Acquirers API
AE Profile APIs.io
Evervault Card Account Updates API
AE Profile APIs.io
Evervault Client Tokens API
AE Profile APIs.io
Evervault Core API
AE Profile APIs.io
Evervault Functions API
AE Profile APIs.io
Evervault Insights API
AE Profile APIs.io
Evervault Merchants API
AE Profile APIs.io
Evervault Network Tokens API
AE Profile APIs.io
Evervault Relays API
AE Profile APIs.io
Evervault Webhooks API
AE Profile APIs.io
#Payments
← Back to E APIs
API Details
ID
evervault:evervault-payments-api
Base URL
https://api.evervault.com
Docs
https://docs.evervault.com/api
Provider
Evervault
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network