HomeGuideMethod ReferenceAssess YourselfRequest Sandbox Account
Method Reference
Ask For AssistanceLogin

Request to Send Card Security Code Capture Form to Recipient

post
https://service.pcibooking.net/api/cardrequest/duplicate

The request will trigger a message to be sent to the recipient (via email or text message) with a link to the card security code capture form.
We recommend that you first review the guide for this method.

[Manage merchant information for 3D Secure authentication

📘

Encoding URLs

Since the URLs provided in this request are provided in the body of the message instead of in the request URL's query string, the URLs mentioned above should not be urlEncoded.

📘

Requests specific parameters vs account parameters

The following parameters - CustomerSupportLink, CustomerSupportLinkText, CustomerSupportEmail and CustomerSupportPhone - can be provided either as specific values for each individual request, or their value can be retrieved from your account settings (as set in our portal).

If specific values are provided in the request, they will override the values from the account and the specific values will be displayed in the card capture form.

When submitted successfully, the response body will be blank and there will be a header added:

  • Location: The URI for the card request which can be referenced later to retrieve status or cancel.

📘

Duplicate card warning

Once the card owner enters the CVV code, the card details of the original token will be duplicated to a new token and the CVV data captured in this form will be added to the new token.
It is your responsibility to clear the original token that was stored in PCI Booking. If this token is not cleared, it will be charged the monthly storage fee.

Body Params
string
required

The user ID of the booker

string
required

The card URI is the resource identifier for the card location within PCI Booking .

string
Defaults to EN

The form's language in ISO 639-1 (2-letter) format - see here. If an unsupported language is received, English will be displayed. Adding languages is simple to do through our user's control panel.

string

The CSS resource name. Please follow our guide on managing stylesheets. If no CSS is provided, PCI Booking will implement the default CSS.

string

A URL where the status of the request will be pushed to by PCI Booking.

int32
required

The number of hours that the request will be valid for. Minimum 1 hour, maximum 24 hours.

string
required

Indicates how to send the link to the card capture form - by Email or by text message. Optional values are email and sms.

string
required

The destination of the message. Email address or a phone number. If providing a phone number, the number should be formatted as an international dial number: Country code + area code + phone number.

string

A reference value which then can be used to query for this card token.

string

Free text field to provide a description of this request. The Description parameter can contain up to 50 characters.

string
required

Free text field to provide the recipient's name. The RecipientName parameter can contain up to 70 characters.

double

An optional parameter to indicate the amount of the transaction. The Amount parameter is required if the Currency parameter is provided.

string

An optional parameter to indicate the currency of the amount of the transaction. Currency should be provided in ISO 4217 (3-letter) format. The Currency parameter is required if the Amount parameter is provided. If the Currency parameter has an incorrect value, error code 401 BAD DATA will be returned.

string

Free text to be displayed in the header of the message to the recipient. The CustomHeaderText parameter can contain up to 1000 characters.

If the RecipientName, Amount and Currency placeholders are not listed in the CustomHeaderText or in the portal customizations - however, they are provided in the other parameters of this request, the recipient name will be displayed under the header text area, and the amount and currency will be displayed under the recipient name.

string

Free text to be displayed in the footer of the message to the recipient. The CustomFooterText parameter can contain up to 1000 characters.

If the CustomerSupportEmail and CustomerSupportPhone placeholders are not listed in the CustomFooterText or in the portal customizations - however, they are provided in the other parameters of this request, the contact details will be displayed under the header text area.

string

Free text to be displayed as the phone number displayed in the email message to the recipient and in the landing page. The CustomerSupportPhone parameter can contain up to 20 characters.

string

Free text to be displayed in the email address displayed in the email message to the recipient and in the landing page. The CustomerSupportEmail parameter can contain up to 50 characters.

string

Free text to be displayed in the URL for customer support displayed in the email message to the recipient and in the landing page. The CustomerSupportLink parameter can contain up to 255 characters. The CustomerSupportLink parameter is required if the CustomerSupportLinkText parameter is provided.

string

Free text to be displayed in the display name of the URL for customer support displayed in the email message to the recipient and in the landing page. The CustomerSupportLinkText parameter can contain up to 100 characters. The CustomerSupportLinkText parameter is required if the CustomerSupportLink parameter is provided.

string

The URL where a successful response will be redirected to. Read more on how to set up success / failure redirection pages.

string

The URL where a failed response will be redirected to. Read more on how to set up success / failure redirection pages.

string

The URL to the logo that will be displayed in the COTP email and landing page.

  • If you prefer not to have a logo at all, please submit this parameter with a null value.
  • If the parameter is not supplied in the request, the logo displayed will be taken from the Booker information in our portal.
  • Images must be publically accessible, in HTTPS url with file type in one of the following: png, gif, bmp, jpeg or jpg.

    • string

    The title of the logo.

  • If not provided, the name of the booker (as set in our portal) will be used.
  • If you prefer that there will be no title to the logo image, please provide this parameter with a null value.
  • The LogoTitle can be up to 100 characters.

    • string

    The URL to the favicon that will be displayed in the COTP landing page.

  • If the parameter is not supplied in the request, the favicon displayed will be the browser default.
  • Images must be publically accessible, in HTTPS url in either ico or png format, size 1616 or 3232.

    • string

    The page title to be displayed. The SiteTitle can be up to 40 characters.

    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 over 4 years ago

    Language
    Response 
    Click Try It! to start a request and see the response here! Or choose an example:
    application/json
    Updated over 4 years ago