HomeGuideMethod ReferenceAssess YourselfRequest Sandbox Account
Method Reference
Ask For AssistanceLogin

Create Payments Library Session

post
https://service.pcibooking.net/api/eWalletOperation
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

operation TOKENIZEcan only be used on select payment methods

Please be aware that tokenization is only available when selecting the payment methods card pay, ApplePay and GooglePay. Other payment methods can be used for charge only.

📘

3D Secure Authentication / Two Factor Authentication

3D Secure authentication - or two factor authentication is available as part of ApplePay, GooglePay and card pay.

  • For ApplePay, two factor authentication is always enabled and performed by Apple when the card owner interacts with their Apple device. When our system receives the card from ApplePay, it will always include the 3DS authentication results.results.
  • For GooglePay, it is available only partially, depending on how the card owner has interacted with GooglePay and the device used. If GooglePay performed two factor authentication, the card our system receives will include the 3DS authentication result.result.
  • For card pay, our customers can choose if they would like to have 3DS authentication performed once the card owner has entered their card details. If enabled, our system will perform the 3DS authentication and only if successful, will the chosen operation continue.
    • Body Params
    string

    The type of the operation that you would like to perform. This can be:

  • TOKENIZE - in this operation, PCI Booking will retrieve the card details from the eWallet and store it as a token in our vault. This token can then be used for further operations inside PCI Booking as any other token.
  • CHARGE - in this operation, PCI Booking will retrieve the card details from the eWallet and send a charge operation on that card to the payment gateway specified to process the payment transaction.
  • CHARGE_AND_TOKENIZE - in this operation, PCI Booking will retrieve the card details from the eWallet and send a charge operation on that card to the payment gateway specified to process the payment transaction. Once the charge completes successfully, the card will be tokenized.
  • PREAUTH_AND_TOKENIZE - in this operation, PCI Booking will retrieve the card details from the eWallet and send a pre-authorization operation on that card to the payment gateway specified to process the payment transaction. Once the pre-authorization completes successfully, the card will be tokenized.

    • string
    required

    The credentialsId that you set for your merchant account details at your payment processor which you stored using the Store Payment Gateway Credentials method.

    string
    required

    A CSV list of name values that you set for the digital wallet credentials that were stored using the store credentials method.

    string
    required

    Indicates which type of environment is being used. Possible values are:
    TEST
    LIVE

    string
    required

    The currency of the transaction. Based on ISO 4217.

    float
    required

    The amount of the transaction.

    string
    required

    The 2 letter country code of the payer.

    string
    required

    Will be used to limit the list of card types supported for operations
    If the card type the payer has stored in their digital wallet does not match the brand(s) specified here, the payer will be asked to enter a different card.

    FallbackUpgs
    array of objects

    An array of objects specifying fallback payment gateway accounts to be used if the primary payment gateway fails. Each object within the array should contain the following:

    FallbackUpgs
    string

    The CustomerEmail parameter should be used to provide the Cardholder's e-mail address for 3D Secure authentication. The Cardholder's email address must be in a valid email address format, e.g. [email protected].
    Please note, if you chose to perform 3DS authentication, then you must provide one of the following parameters: either the CustomerEmail or CustomerPhone parameters. For additional details, please read our blog.

    string

    The CustomerPhone parameter should be used to provide the Cardholder's telephone number for 3D Secure authentication. The Cardholder's telephone number may only contain digits [0-9], e.g.: 00353112223344.
    Please note, if you chose to perform 3DS authentication, then you must provide one of the following parameters: either the CustomerEmail or CustomerPhone parameters. For additional details, please read our blog.

    string

    The custom reference that you would like to use for this transaction. This value will be sent and recorded with the payment processor

    Headers
    string
    required

    The authorization mechanism for this method is with the API key in the format of APIKEY {value}.
    For example, APIKEY bd3ce883352e42539a2b7644f72e6311.

    Responses

    Updated about 1 year ago

    Language
    LoadingLoading…
    Response
    Click Try It! to start a request and see the response here! Or choose an example:
    application/json

    Updated about 1 year ago