{ "opencollection": "1.0.0", "info": { "name": "Evervault Payments API", "version": "0.0.1" }, "items": [ { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "Card Insights", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/insights/cards", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "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.\n" }, { "info": { "name": "BIN Lookup", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/bin-lookups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Performs a BIN lookup for the provided card number and retrieves associated information such as the card brand, country, issuer, and more.\n" }, { "info": { "name": "List Merchants", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/merchants", "params": [ { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of Merchants to retrieve per page (default is 50)." }, { "name": "q", "value": "", "type": "query", "description": "Filter the Merchants by name." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Lists all Merchants that have been created.\n" }, { "info": { "name": "Create a Merchant", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/merchants", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Enrolls a Merchant with Card Networks.\n\nIn 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\n" }, { "info": { "name": "Retrieve a Merchant", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/merchants/:merchant_id", "params": [ { "name": "merchant_id", "value": "", "type": "path", "description": "The unique identifier of the merchant." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves a Merchant by its unique identifier.\n" }, { "info": { "name": "Update a Merchant", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.evervault.com/payments/merchants/:merchant_id", "params": [ { "name": "merchant_id", "value": "", "type": "path", "description": "The id of the Merchant to be updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates a Merchant by its unique identifier.\n" }, { "info": { "name": "Delete a Merchant", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.evervault.com/payments/merchants/:merchant_id", "params": [ { "name": "merchant_id", "value": "", "type": "path", "description": "The id of the Merchant to be deleted." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes a Merchant by its unique identifier.\n" }, { "info": { "name": "List Acquirers", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/acquirers", "params": [ { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of Acquirers to retrieve per page. The default is 50, which is also the maximum." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Lists all Acquirers that have been created.\n" }, { "info": { "name": "Create an Acquirer", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/acquirers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates an Acquirer to be used with 3DS sessions.\n" }, { "info": { "name": "Retrieve an Acquirer", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/acquirers/:acquirer_id", "params": [ { "name": "acquirer_id", "value": "", "type": "path", "description": "The unique identifier of the Acquirer." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves an Acquirer by its unique identifier.\n" }, { "info": { "name": "Update an Acquirer", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.evervault.com/payments/acquirers/:acquirer_id", "params": [ { "name": "acquirer_id", "value": "", "type": "path", "description": "The id of the Acquirer to be updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates an Acquirer by its unique identifier.\n" }, { "info": { "name": "Delete an Acquirer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.evervault.com/payments/acquirers/:acquirer_id", "params": [ { "name": "acquirer_id", "value": "", "type": "path", "description": "The id of the Acquirer to be deleted." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes an Acquirer by its unique identifier.\n" }, { "info": { "name": "Create a Network Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/network-tokens", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a Network Token for a given card.\n" }, { "info": { "name": "Retrieve a Network Token", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/network-tokens/:network_token_id", "params": [ { "name": "network_token_id", "value": "", "type": "path", "description": "The unique identifier of the Network Token." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves a Network Token by its unique identifier.\n" }, { "info": { "name": "Delete a Network Token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.evervault.com/payments/network-tokens/:network_token_id", "params": [ { "name": "network_token_id", "value": "", "type": "path", "description": "The unique identifier of the Network Token." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes a Network Token by its unique identifier.\n" }, { "info": { "name": "Create a Cryptogram", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/network-tokens/:network_token_id/cryptograms", "params": [ { "name": "network_token_id", "value": "", "type": "path", "description": "The unique identifier of the Network Token." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a Network Token Cryptogram.\n" }, { "info": { "name": "Simulate a Network Token Update", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/network-tokens/:network_token_id/simulate", "params": [ { "name": "network_token_id", "value": "", "type": "path", "description": "The id of the Network Token" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Simulates an update to a Network Token so that you can test your integration. Sandbox only.\n" }, { "info": { "name": "Retrieve Card Art", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/network-tokens/:network_token_id/card-art", "params": [ { "name": "network_token_id", "value": "", "type": "path", "description": "The unique identifier of the Network Token." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the card art for a Network Token by its unique identifier.\n" }, { "info": { "name": "Create a 3DS Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/3ds-sessions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "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](/sdks/javascript#ui.threedsecure())\n" }, { "info": { "name": "Retrieve a 3DS Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/3ds-sessions/:3ds_session_id", "params": [ { "name": "3ds_session_id", "value": "", "type": "path", "description": "The id of the session" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a 3DS Session.\n" }, { "info": { "name": "Retrieve 3DS Messages", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/3ds-sessions/:3ds_session_id/messages", "params": [ { "name": "3ds_session_id", "value": "", "type": "path", "description": "The id of the 3DS session" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve messages for a 3DS Session. This endpoint can be helpful for debugging 3DS sessions, providing insight into the raw 3DS messages that were exchanged between the 3DS Server and the Directory Server.\n" }, { "info": { "name": "Register a Card", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/cards", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "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.\n\nCard 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 b" }, { "info": { "name": "Retrieve a Card", "type": "http" }, "http": { "method": "GET", "url": "https://api.evervault.com/payments/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the Card." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves a Card by its unique identifier.\n" }, { "info": { "name": "Delete a Card", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.evervault.com/payments/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the Card." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes a Card by its unique identifier.\n" }, { "info": { "name": "Simulate a Card Update", "type": "http" }, "http": { "method": "POST", "url": "https://api.evervault.com/payments/cards/:card_id/simulate", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The id of the Card" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Simulates an update to a Card so that you can test your Card Account Updater integration. This endpoint is only available for [Sandbox Apps](/developers/sandbox).\n" } ] } ], "bundled": true }