Profile API Reference

Available Methods

  • ActivateToken – Used to activate a token for a digitization that has been approved and provisioned, but requires additional cardholder authentication prior to activation.
  • 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
  • CancelStopCard – Un-stop a card
  • CalculateTAV – This API is used to create Token Authentication Value (TAV)
  • CardDetail – Returns details regarding the created virtual card
  • ChangePin – Change the pin on the card associated with the customer reference and tracking number
  • 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
  • DeleteToken – Remove a payment token linked to a card
  • GenerateTimeBasedSecret – Generates a “secret token” to enable communication with our tokenisation APIs
  • InsertTransactionFee – Deduct requested amount from card as a fee using any one of the (integer) fee type IDs
  • ListAllTokens – Returns all the tokens (active and inactive) linked to a card
  • ListTokens – Returns all the tokens linked to a card
  • 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
  • ReverseTransactionFee – Reverse a fee that was charged via the API using InsertTransactionFee
  • StatementByDateRange – Returns the statement between two dates
  • 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
  • TransferFunds – Transfer funds from one card to another
  • TransferFundsBetweenProfiles – Transfer funds from one profile to another
  • 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

Was this page helpful?

Are you ready to use our APIs

If you are not yet registered with us.

Still have questions? Contact us.