Profile API Reference

Card Issuance and Management API's

• Activate - Activate a card

• AllocateCard - Allocate a card to a bearer

• AllocateCreateVirtualCard - Create a virtual card with specified amount loaded, linked to the specified profile and allocated to a cardholder with specified details

• Balance - Retrieve the balance of a card

• CancelScheduledStop - Cancels an existing scheduled stop

• CancelStopCard - Un-stop a card

• CardDetail - Returns details regarding the created virtual card

• ChangePin - Change the pin on the card associated with the customer reference and tracking number

• CheckAuthorisation - Provides a method to check if the specified amount was deducted from a card.

• CheckLoad - Provides a method to check if the specified amount was loaded on a card.

• CreateScheduledStop - Schedules the stop of the card on the date of the parameter

• CreateVirtualCard - Create a virtual card with specified amount loaded, linked to the specified profile and allocated to the profile owner

• DeductCardLoadProfile - Deduct requested amount from card and load the amount back to the profile

• DeLinkCard - Provides a method to unlink a card from a specified profile

• DevalueProfile - Deducts the requested amount from the Profile specified

• GetScheduleStopDetail - Returns the existing scheduled stops for a card

• InsertTransactionFee - Deduct requested amount from card as a fee using any one of the (integer) fee type IDs

• LoadCardDeductProfile - Load a card with the requested amount and deduct the amount off the profile

• LinkCard - Link a card to a profile

• LinkCardsBySequenceRange - Link multiple cards to a profile using a range of sequence numbers

• OrderCard - Order a card for a specific cardholder

• Register - Creates and registers a new profile

• ResetPin - Provides a method to reset the PIN of a card

• ReverseDeductCardLoadProfile - Reverse a previous DeductCardLoadProfile request

• ReverseDevalueProfile - Reverse a previous DevalueProfile request

• ReverseTransactionFee - Reverse a fee that was charged via the API using InsertTransactionFee

• Statement - Retrieve the statement of a card

• StatementByDateRange - Returns the statement between two dates

• Status - Retrieve the current status of a card

• StopCard - Stop a card with one of the allowed (integer) values for stopReasonID

• ToggleVoucherFeature - Toggles a voucher feature on or off

• TransferFunds - Transfer funds from one card to another

• TransferFundsBetweenProfiles - Transfer funds from one profile to another

• UpdateAllocatedCard - Updates the cellphone or ID number linked to an allocated card

• UpdateBearer - Updates the firstName, lastName, cellphone and ID number linked to an allocated card

• UpdateProfile - Updates a profile owner's details

• UpdateScheduledStop - Updates an existing scheduled stop

Additional Card Management API's

NOTE: The Additional Card Management API's listed below are available to specific clients. Please confirm with your Account Manager.

• TransferLink - Transfer a reference to a new card (Visa).

• AllocateIBAN - Allocate an IBAN [Account Number] for a card linked to the specified profile.

• ReverseVasTransferFunds - Reverse a VAS transfer on the card.

• UpdateBearerExtended - Update the cardholder details. This is an extended API to update additional details like address and employment details.

• UploadFicaDocument - Uploads identification to be FICA compliant.

• VasTransferFunds - Transfer funds from a card for a VAS transaction.

Tokenisation Life Cycle Management API's

NOTE: The Tokenisation Life Cycle Management API's listed below are available to Tokenisation enabled clients. Please contact your Account Manager if you require further information.

• ActivateToken - Used to activate a token for a digitization that has been approved and provisioned, but requires additional cardholder authentication prior to activation.

• CalculateTAV - This API is used to create Token Authentication Value (TAV)

• DeleteToken - Remove a payment token linked to a card

• GenerateTimeBasedSecret - Generates a “secret token” to enable communication with our tokenisation APIs

• ListAllTokens - Returns all the tokens (active and inactive) linked to a card

• ListTokens - Returns all the tokens linked to a card

• StopToken - Stops a token reference or all the ones linked to a card

• TransferToken - Transfer a payment token from one card to another

• UpdateTokenAccount - Updates the card PAN information associated with a token

• UnStopToken - Unstops a token reference or all the ones linked to a card