API PpgServices

Powered by Intercash

Service performs the loading of funds to a users card from the calling companies ABL (Available Balance for Load). NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, needs still be submitted with a default value. (Example: String = Empty String, Integer = 0, Decimal = 0.00) NOTE: The currency in which the card is requested to be loaded must match the currency in which the card is denominated and issued NOTE: Funds must be available in the companies ABL (Available Balance for Load) in order to obtain a successful load response
Service is used to process an Invoice payment by a QR Code. NOTE: a previously consumed QR Code will not return anything. NOTE: No special characters are permitted (Latin Characters only) NOTE: Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00) NOTE: Secured Card information will be returned in the response in an encrypted format. The encryption keys must first be obtained in order to utilize this function to decrypt card data.
Service is used to obtain secured Card data (CVV and expiry date). NOTE: Secured Card information will be returned in the response in an encrypted format. The encryption keys must first be obtained in order to utilize this function to decrypt card data. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to perform the issuing of a new gift card. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs registration of the cardholders' 3D Secure credentials. NOTE : When the user is already previously enrolled it will update the credentials NOTE: No special Characters are permitted. (Latin Characters only)
Service is used to retrieve the Merchant Account Balance (ABL-Available Balance for Load). NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to retrieve the current status information of the Card NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs the registeration of a users details to an existing card that has already been created but is not yet assigned. The function will ultimately assign an Existing SAN to a NEW user. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to perform a status change associated to the card. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to create both virtual and physical cards. This service will enable the issuing of a new card. The card will adopt all the properties configured within the settings of the account and program. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00) NOTE: Secured Card information will be returned in the response in an encrypted format. The encryption keys must first be obtained in order to utilize this function and decrypt card data.
Service is used to retrieve the virtual card image specific to the partner
Service is used to retrieve an invoice by a QR Code. NOTE: a consumed QR will not return anything. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to retrieve the PIN (Personal Identification Number) associated to the card and programmed to the EMV Chip. NOTE: The PIN number must not be stored. NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs the reissuing of a card for an Existing Cardholder. This service will close the existing card and reissue a NEW one with the option to choose the Delivery Method and Card Type. The following events will occur: -A new PAN, SAN, CVV, and Expiry Date will be assigned to the card-All the limits of the old card will carry over to the new one -The balance of the old card is transferred to the new one-Original Remote ID on the old card will be assigned to the new one.
Service will perform the issuing of a new gift card and load file. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service used to perform email delivery using a template determined from partner configurations
Service used to perform change to the Personal Identification Number (PIN) associated to the card and programmed to the EMV Chip. NOTE: The PIN number must not be stored. NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs updates to configurations for transactional processing, including velocity/limit rules as well as fee configurations NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service will retrieve the current exchange rate for the currencies provided. NOTE: rate returned is NOT a quote
Service call that will for reset access code. (Secured Access Code) NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs the conversion of a virtual card to a plastic card. NOTE: If the Virtual card is not yet been activated this function will automatically Activate the virtual card. The physical card will remain inactive until the cardholder receives and activates. NOTE: Address and shipping details are inherited from the initial card request. NOTE: No special Characters are permitted. (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs the loading of funds to a users secondary account. NOTE: The currency in which the card is requested to be loaded must match the currency in which the card is denominated and issued. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service will retrieve CardHolder's Sanctions if it has registered sanctions (Based on firstName and lastName) NOTE: No special characters are permitted (Latin Characters only)
Service call will check access to the service
Service performs change of the status of the card from Suspend to Normal, and will additionally perform a load to the card. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to retrieve information registered to an individual cardholder including the individual profile details and card status. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to send an Invoice and generate a QR to claim. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs a Gift Card assignment NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs a Debit (unload) a wallet. The Access Code must be collected from the Cardholder and passed in this function. NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
This function to provide the KYC document of the cardholder to Intercash for review. This function is used to provide Proof of Address (POA) and Proof of Identification (POI) in separate calls. Additionally, once both documents are provided the card will immediately be validated and card limits will be increased to fully verified limits. NOTE: Documents MUST be in “.PDF” format and MUST be named as follows: NOTE: Naming of file for Proof of Identity(PoI) – “SAN#_I_KYC.pdf” (Replace SAN# with the actual SAN # of the actual card) NOTE: Naming of file for Proof of Address(PoA) – “SAN#_A_KYC.pdf” (Replace SAN# with the actual SAN # of the actual card) NOTE: The documents must be stored on the merchants side in an accessible location(URL) and remain available for a minimum of 5 business days. NOTE: No special characters are permitted (Latin Characters only) NOTE: Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to retrieve the transaction's status. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to obtain the current remaining limits available on the card. This service also obtains the daily velocity limits associated to the card. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service will perform a Debit (unload) from a card. The Access Code must be collected from the Cardholder and passed in this function to indicate Cardholder acceptance of the movement. NOTE: Funds will be settled in real-time back to the company’s ABL(Available Balance For Load). NOTE: No special Characters are permitted. (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service performs a card renewal for an existing card. NOTE : This call can only be used for expired cards. The following events will occur: A new PAN, SAN, CVV, and Expiry Date will be assigned. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used as STEP ONE for completing a secure debit (unload) request. This service will generate a Secure Authorization Code that will be sent to the Cardholders registered email associated to their account. NOTE: The authorization code is 6 digits long and only valid for 10 minutes. NOTE: No special Characters are permitted. (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to perform activation for both virtual and physical cards. NOTE: This function can only be used for Inactive cards (“Inactive” status). NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
This function upload the KYC document with the max limit of 1MB. DocumentType=0 for POI and DocumentType=1 for POA. Acceptable file formats are: gif, png, jpg, jpeg, pdf NOTE: There are 2 distinct ways to provide proof of identification: 1. USE documentLocation, 2. USE File NOTE (when providing documentLocation): Documents MUST be in “.PDF” format and MUST be named as follows: Proof of Identity(PoI) – “SAN#_I_KYC.pdf” (Replace SAN# with the actual SAN # of the actual card) Proof of Address(PoA) – “SAN#_A_KYC.pdf” (Replace SAN# with the actual SAN # of the actual card) The documents must be stored on the merchants side in an accessible location(URL) and remain available for a minimum of 5 business days. NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service is used to perform retrieval of a Card Balance. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service will perform an update on the Cardholder details. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)
Service will perform an update on the Cardholder address. NOTE: No special characters are permitted (Latin Characters only) NOTE : Non-mandatory fields which are not being used, the field must be present and a default value must be passed. (For example: String = Empty String, Integer = 0, Decimal = 0.00)