This is the Encrypted Data Exchange API endpoint for information on how to encrypt see our Data Exchange API integration guide. Included on this page are all the required fields and objects to run a registration check for either an enrollment or authentication flow using VPPS.
Connection URL’s
Environment | URL |
---|---|
Staging | |
Production |
Request
Signature Number REQUIRED
A mathematical scheme for verifying the authenticity of digital messages or documents
TimeStamp String or Number REQUIRED
This value can be an ISO 8601 format or, Unix Epoch Time milliseconds in numeric format.
Example: 2024-07-21T17:32:28Z
or, 1709659521000
Identifier String REQUIRED
API Key Identifier or Name value
OrgUnitId String REQUIRED
Processor/Merchant level OrgUnitId
Algorithm String REQUIRED
The hashing algorithm used to generate the Signature value. Valid options include:
SHA-256
SHA-512
Payload Object REQUIRED
The Payload containing fields and a payment object.
{ "Signature": "KmL2SLBeTRRU9TlxA6XfnAYg5yWn1QwEO0GL1RtP8mg=", "Timestamp": "2024-02-21T20:10:20.872Z", "Identifier": "59c282d02f3e7357b4aa6f13", "OrgUnitId": "59c2745f2f3e7357b4aa516a", "Algorithm": "SHA-256", "Payload": { "AccountNumber": "400009******0800", "CardBrand":"Visa", "ReferenceId": "12345-1234-123145-1423", "AcquirerCountryCode": "840", "LanguagePreference": ["en", "es"], "Email": "someone@somewhere.com", "Payment": { "Amount": "12.34", "CurrencyCode": "USD", "MerchantName": "Amazon", } } }
Response
ErrorNumber String REQUIRED
An identifier of who is issuing the JWT. Used to contain the Api Key identifier or name.
Error Description String REQUIRED
Processor/Merchant level OrgUnitId
RequestId String REQUIRED
The session identifier for the merchant to pass on all subsequent requests.
Payload Object REQUIRED
The Payload containing fields and a payment object
{ "ErrorNumber": 0, "ErrorDescription": "Success", "RequestId": "b3933183-48df-409f-94ff-12952364009b", "Payload": { "Account": { "CardBrand": "Visa", "LastFour": "0094", "FIDO": { "FlowType": "ENROLLMENT", "ReasonCode": "1001", "ReasonDescription": "Error" } }, "Issuer": { "SupportedVersions": [ { "Version": "2.1.0", "Capabilities": [ "AuthenticationAvailableAtACS", "DAF" ], "MethodURLPresent": true }, { "Version": "2.2.0", "Capabilities": [ "AuthenticationAvailableAtACS", "DecoupledAuthentication", "DataOnly", "DelegatedAuthentication", "IssuerTRA", "DAF" ], "MethodURLPresent": true } ] }, "ReferenceId": "51ca6679-12ed-47c4-8982-1a29e10d4587" } }