v1

latestOpenAPI 3.0.02026-07-2352269214.0 KB
Transaction Management

Create Transaction

Provide all required data to the Merchant/PSP to build a transaction authorization request.

In case of network token, the token PAN, expiry date and cryptogram are provided.

In case of PCI token, the card PAN and expiry date are provided.

post/transactions

Headers

authorizationstring required

Technical identifier pre-defined at on-boarding that identifies the API consumer. Format shall be the string 'APIKEY' followed by a space and the api key value. </br> Example: APIKEY c03f88fe-01ba-11e8-ba89-0ed5f89f718b

x-correlation-idstring required

Technical identifier used for troubleshooting. </br>It helps on customer support when needed. </br>Each API request must be identified with a unique correlation Id. </br>It correlates the response and the request and eventually a notification if any.

Request body

tokenIdstring required

Identifier of the token

transactionType'PURCHASE' | 'REFUND' required

Transaction type

visaSignedPayloadstring

Required only for Visa CTF and Visa CTF with DAF. Set with the signature (JWT) generated by Thales ETP SDK.

Response

Created

transactionIdstring required

The unique transaction identifier.

encryptedDatastring required

The payment credentials data encrypted in a JWE structure (see security section in the documentation).

Once decrypted, the JWE plaintext contains the following JSON object:

JSON field parameter namedescriptionMOCLength
dpanThe token PAN value provided for network token.CUp to 19
expThe token expiry date in the format MMYY provided for network token.C4
cryptogramThe payment cryptogram to use with the token for a payment. Presence of the cryptogram depends on the transaction type and the scheme.CUp to 256
fpanThe funding card PAN value. Only provided for PCI token.CUp to 19
fpanExpThe funding card expiry date in the format MMYY. Only provided for PCI token.</li>C4

Example: {"dpan:"9580981500100002", "exp":"1222", "cryptogram": "45f8grzty7f4f5gs5s2c"}

ecistring

The Electronic Commerce Indicator. Payment System-specific value to indicate the results of the attempt to authenticate the cardholder. Provided only for Visa & Mastercard SCOF.

cryptogramExpiryDatestring

Cryptogram expiry date in ISO 8601. Provided for Visa only.

isDAFboolean

If present and set to 'true', VISA confirms it is a Digital Authentication Framework transaction. Can be present only if the transaction type is 'VISA_DAF'.