Use Case: Validating and Authorizing a Transaction
The Validation service can be combined with the Authorization service so that when a
customer's authentication is validated, the transaction is automatically submitted for
authorization.
Fields Specific to the Visa Secure Use Case
These API fields are required specifically for this use case.
- Set this field tovbvfor a successful authentication (EMV 3-D Secure value of05),vbv_attemptedif authentication was attempted but did not succeed (EMV 3-D Secure value of06), orvbv_failureif authentication failed (EMV 3-D Secure value of07).
- Required when payer authentication is successful.
Card-Specific Requirements
Some payment cards require information to be collected during a transaction.
- Recommended for Discover ProtectBuy.
- Required when the card type is Cartes Bancaires.
- Required for American Express SafeKey (US) when the product code isAIRfor an airlinepurchase).
- Required for Visa Secure travel.
- Required only for American Express SafeKey (US).
- Required only for American Express SafeKey (US)
Country-Specific Requirements
These fields are required for transactions in specific countries.
- Required for transactions processed in France.
- Required for transactions in US., Canada, and Mainland China.
- Required when theorderInformation.billTo.countryfield value isUSorCA.
- Required for transactions in US, Canada, and Mainland China.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/paymentsTest:
POST
https://apitest.cybersource.com
/pts/v2/payments
Required Fields for Processing an Authorization Using Visa Secure
Use these required fields to process an authorization using Visa Secure.
IMPORTANT
When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.
-
Required when payer authentication is successful. Otherwise, this field is optional.
-
Set this field to one of these values:
-
vbv: Successful authentication (EMV 3-D Secure value of05).
-
vbv_attempted: Authentication was attempted (EMV 3-D Secure value of06).
-
vbv_failure: orinternet: Authentication failed or was not attempted (EMV 3-D Secure value of07).
-
Related Information
Optional Fields for Validating Step-Up
These fields are optional when validating a Payer Authentication transaction. In certain circumstances, the information provided by an optional field might be required before a transaction can proceed. Those optional fields that are sometimes required are listed in the required fields with the circumstance described.
REST Example: Validating and Authorizing a Transaction
Request
{ "clientReferenceInformation": { "code": "TC50171_3" }, "processingInformation": { "commerceIndicator": "vbv" }, "paymentInformation": { "card": { "number": "41111111XXXXXXX1", "expirationMonth": "01", "expirationYear": "2026" } }, "orderInformation": { "amountDetails": { "totalAmount": "100", "currency": "USD" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "201 S. Division St._1", "locality": "Foster City", "administrativeArea": "CA", "postalCode": "94404", "country": "US", "email": "accept@who.com", "phoneNumber": "6504327113" } }, "consumerAuthenticationInformation": { "cavv": "1234567890987654321ABCDEFabcdefABCDEF123", "xid": "1234567890987654321ABCDEFabcdefABCDEF123" } }
Response
{ "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6758954108726900304951/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6758954108726900304951" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6758954108726900304951/captures" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6758954108726900304951", "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "USD" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "711764833DU1FCQD", "status": "AUTHORIZED", "submitTimeUtc": "2023-02-08T22:30:11Z" }