The Card API contains the API and API methods that we use to call you to send transactions on to the store of value for authorizations. Transactions originate from the merchant and are sent to Paymentology via the financial networks and then are forwarded to the store of value for authorization.

Note: You will need to implement the relevant method names corresponding to the different calls in order to perform the necessary actions on your system.

Available methods

• ActivateToken – Used to activate a token that has been approved and provisioned
• AddCardTag – Add a Tag Name and Tag Value to a card identified by tracking number
• AddPocket – Add a pocket for the type indicated by UUID to a card identified by tracking number
• BearerDetail – Get the details of the bearer that is identified by the given tracking number
• CalculateTAV – This API is used to create Token Authentication Value (TAV)
• CardDetail – Get the details of a card that is identified by the given tracking number
• ChangePin – Change the pin on the card associated with the customer reference and tracking number
• CreateVirtualCard – Create a virtual card in the campaign identified by its UUID and linked to the customer reference given
• CreateVirtualCardWithLoad – Create a virtual card in the campaign identified by its UUID and linked to the customer reference given and loads the card
• DeductFunds – Deducts the requested amount from a card, or a pocket if applicable
• DeductFundsReverse – Reverse a deduct that was previously requested but had potentially failed
• DeleteToken – Remove a payment token linked to a card
• Devalue – Deducts the requested amount from a card, or pocket if specified, with a redemption type of “Devalue”
• DevalueReverse – Reverse a devalue that was previously requested but had potentially failed
• GenerateTimeBasedSecret – Create a one-time based secret
• InsertTransactionFee – Charge a fee to a card (or pocket if applicable)
• LinkCard – Link an existing card to a given customer reference
• ListAllTokens – Returns all the tokens (active and inactive) linked to a card
• ListCards – Return a list of all cards that are linked to the customer reference
• ListTokens – Returns all the tokens linked to a card
• LoadFunds – Load a card (or pocket if applicable) with the requested amount
• LoadFundsReverse – Reverse a load that was previously requested but has potentially failed
• MostRecentTransactions – Provides the latest transactions on a card based on date range and transaction count.
• 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 with a pin block. A card can be printed with cardholder details by the card manufacturer.
• PocketTransfer – Transfer funds between two pockets linked to a card identified by tracking number
• PocketTransferReverse – Reverse an PocketTransfer transaction that was timed out using the details of the failed transaction
• RetireCard – Permanently disable a card so that it is no longer returned for the customer reference in the ListCards method
• Set3DSecureCode – Update the 3D Secure Code on the card associated with the customer reference and tracking number
• SetBearerDetail – Set the details of the bearer that is identified by the given tracking number
• Statement – Retrieve the statement of a card (or pocket if applicable). NB. Version 1.3 available
• StopCard – Stop a card with one of the allowed (integer) values for stopReasonID
• StopToken – Stops a token reference or all the ones linked to a card
• ThreeDSAuthenticationOutcome – Gives the result of the 3D Secure App Authentication.
• ToggleVoucherFeature – Toggles a voucher feature on or off
• TokenApproveDeviceBinding – Used to Bind the device with the token
• TokenRemoveDeviceBinding – Remove device with the token
• TransferFunds– Transfer funds from one card to another identified by tracking numbers, using pockets if applicable of the same type
• TransferFundsReverse – Reverse a TransferFunds transaction that was timed out using the details of the failed transaction
• TransferLink – Transfer a reference to a new card. The old card will be stopped and the bearer details transferred to the new card. The new card will be linked and activated
• TransferToken – Transfer a payment token from one card to another
• UnStopCard – Unstop a card
• UnstopToken – Unstops a token reference or all the ones linked to a card
• UpdateCardExpiryDate – Updates the expiry date of a virtual card
• UpdateCardLabel – Update the card label of a card identified by tracking number
• UpdateCVV – Generate a new CVV2 of the specified card
• UpdateTokenAccount – Updates the card PAN information associated with a token

Remote Messaging API for Non-Companion clients

The Remote Messaging API is hosted on your platform and allows us to call you to send administrative advice messages.

• 3DSecure.AppAuthentication
• 3DSecure.AppFinalisation
• 3DSecure.OTP
• 3DSecure Cardholder’s Contact Detail Collection
• digitization.activation
• digitization.activationmethods
• digitization.event
• Response Reference