Local API Overview

The Local API contains all the methods available for you to call Paymentology in order to perform the necessary actions on your cards. It includes methods that allow the SVA to create a virtual card, stop a card, or link a physical card. Local API calls are initiated by you.

The Local API is used for administration purposes.

Available Methods

• ActivateCard – Activate the specified card if the card was initially created as inactive
• ActivateToken – Used to activate a token for a digitization that has been approved and provisioned, but requires additional cardholder authentication prior to activation
• CalculateTAV – Return the TAV (Token Authentication Value) of the specified card. The Token Authentication Value will be returned in Base64 format.
• ChangePin – Change the specified card’s PIN
• CreateLinkedCard – Create a new, active virtual card and link it to a reference with the given bearer details
• DeleteToken – Remove a payment token linked to a card
• GenerateTimeBasedSecret – Create a one-time based secret
• GetActiveLinkedCards – Get an array of card details of activated cards linked to the reference
• GetCardDetails – Get card details of a specific card
• GetLinkedCards – Get an array of card details of all cards (active, stopped and retired) linked to the reference
• LinkCard – Link a card to a reference with the given bearer details. Linking a card will not activate it
• ListAllTokens – Returns all the tokens (active and inactive) linked to a card
• ListTokens – Returns all the active tokens linked to a card
• OrderCard – Order a card for a specific cardholder. A card can be printed with cardholder details by the card manufacturer
• OrderCardWithPinBlock – Order a card for a specific cardholder. A card can be printed with cardholder details by the card manufacturer
• PrintLinkedCard – Print the specified card if the card was initially created as virtual
• PrintLinkedCardWithPINBlock – Print the specified card if the card was initially created as virtual with PIN block
• ResetPin – Reset the specified card’s PIN. The random pin will be sent to the card bearer’s cell via text message
• RetireCard – Retires the specified card
• Status – Return the status of the specified card
• Set3dSecureCode – Set 3D Secure Code of the specified card
• StopCard – Stop the specified card
• StopToken – Stops a token reference or all the ones linked to a card. The token or tokens can be unstopped using UnStopToken
• ThreeDSAuthenticationOutcome – Gives the result of the 3D Secure App Authentication
• ToggleVoucherFeature – Toggles a voucher feature on or off
• TokenApproveDeviceBinding – Bind the device with token
• TokenRemoveDeviceBinding – Remove device with the token
• TransferLink – Transfer a reference to a new card
• TransferToken – Transfer a payment token from one card to another
• UnstopCard – Unstop the specified card
• UnStopToken – Unstops a token reference or all the ones linked to a card
• UpdateBearer – Update the specified card’s bearer details
• UpdateCVV – Generate a new CVV2 of the specified card
• UpdateTokenAccount – Updates the card PAN information associated with a token

Response Codes

To access the Response Codes for the Local API, please click here.