Retrieve Card By Link Request

const requestID = 'SULqe7pa22gghYDnX6O3J7QDMhyyUzNb';

const response = await fetch(
  `https://service.pcibooking.net/api/cardrequest/${requestID}`,
  {
    headers: {
      'Authorization': 'APIKEY your-api-key'
    }
  }
);

const data = await response.json();
console.log('Status:', data.Status);
console.log('Card URI:', data.CardUri);

import requests

request_id = 'SULqe7pa22gghYDnX6O3J7QDMhyyUzNb'

response = requests.get(
    f'https://service.pcibooking.net/api/cardrequest/{request_id}',
    headers={
        'Authorization': 'APIKEY your-api-key'
    }
)

data = response.json()
print('Status:', data['Status'])
print('Card URI:', data['CardUri'])

{
  "RequestID": "SULqe7pa22gghYDnX6O3J7QDMhyyUzNb",
  "RequestType": "Card",
  "Status": "MessageQueued",
  "StatusTime": "2018-03-21T13:28:38",
  "CardUri": null,
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": "nadya@recipientDomain.com",
  "DestinationType": "Email",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "CardTypes": "Visa,MasterCard,AMEX",
  "DefaultCardType": "AMEX",
  "AutoDetectCardType": true,
  "ShowOwnerID": false,
  "MinExpiration": "082018",
  "CVV": true,
  "ShortUrl": "SULqe7",
  "Css": "TEst CSS"
}

{
  "RequestID": "UPzpUmAj2NIRbciQCim3tHS0hZk7b2HE",
  "RequestType": "Card",
  "Status": "CardStored",
  "StatusTime": "2018-03-21T12:53:28",
  "CardUri": "https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": "nadya@recipientDomain.com",
  "DestinationType": "Email",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "CardTypes": "Visa,MasterCard,AMEX",
  "DefaultCardType": "AMEX",
  "AutoDetectCardType": true,
  "ShowOwnerID": false,
  "MinExpiration": "082018",
  "CVV": true,
  "ShortUrl": "7inQGn",
  "Css": "TEst CSS"
}

{
  "RequestID": "pMdsvukESyaUIFuSBmvIufYtKjI0vOrj",
  "RequestType": "CVV",
  "Status": "MessageSent",
  "StatusTime": "2018-03-21T12:56:00",
  "CardUri": null,
  "OriginCardUri": "https://service.pcibooking.net/api/payments/paycard/7175f98744434ca89615b1cc86c69a45",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": null,
  "DestinationType": "SMS",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "ShortUrl": "pMdsvu",
  "Css": "TEst CSS"
}

{
  "RequestID": "pMdsvukESyaUIFuSBmvIufYtKjI0vOrj",
  "RequestType": "CVV",
  "Status": "CardStored",
  "StatusTime": "2018-03-21T13:26:29",
  "CardUri": "https://service.pcibooking.net/api/payments/paycard/d4ffa09028a044d2ac0d8bada49b6502",
  "OriginCardUri": "https://service.pcibooking.net/api/payments/paycard/7175f98744434ca89615b1cc86c69a45",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": null,
  "DestinationType": "SMS",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "ShortUrl": "pMdsvu",
  "Css": "TEst CSS"
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected APIKEY",
    "errorList": null
}

{
    "code": -160,
    "message": "Uri not found",
    "moreInfo": "Card request not found",
    "errorList": null
}

GET

api

cardrequest

{requestID}

const requestID = 'SULqe7pa22gghYDnX6O3J7QDMhyyUzNb';

const response = await fetch(
  `https://service.pcibooking.net/api/cardrequest/${requestID}`,
  {
    headers: {
      'Authorization': 'APIKEY your-api-key'
    }
  }
);

const data = await response.json();
console.log('Status:', data.Status);
console.log('Card URI:', data.CardUri);

import requests

request_id = 'SULqe7pa22gghYDnX6O3J7QDMhyyUzNb'

response = requests.get(
    f'https://service.pcibooking.net/api/cardrequest/{request_id}',
    headers={
        'Authorization': 'APIKEY your-api-key'
    }
)

data = response.json()
print('Status:', data['Status'])
print('Card URI:', data['CardUri'])

{
  "RequestID": "SULqe7pa22gghYDnX6O3J7QDMhyyUzNb",
  "RequestType": "Card",
  "Status": "MessageQueued",
  "StatusTime": "2018-03-21T13:28:38",
  "CardUri": null,
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": "nadya@recipientDomain.com",
  "DestinationType": "Email",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "CardTypes": "Visa,MasterCard,AMEX",
  "DefaultCardType": "AMEX",
  "AutoDetectCardType": true,
  "ShowOwnerID": false,
  "MinExpiration": "082018",
  "CVV": true,
  "ShortUrl": "SULqe7",
  "Css": "TEst CSS"
}

{
  "RequestID": "UPzpUmAj2NIRbciQCim3tHS0hZk7b2HE",
  "RequestType": "Card",
  "Status": "CardStored",
  "StatusTime": "2018-03-21T12:53:28",
  "CardUri": "https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": "nadya@recipientDomain.com",
  "DestinationType": "Email",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "CardTypes": "Visa,MasterCard,AMEX",
  "DefaultCardType": "AMEX",
  "AutoDetectCardType": true,
  "ShowOwnerID": false,
  "MinExpiration": "082018",
  "CVV": true,
  "ShortUrl": "7inQGn",
  "Css": "TEst CSS"
}

{
  "RequestID": "pMdsvukESyaUIFuSBmvIufYtKjI0vOrj",
  "RequestType": "CVV",
  "Status": "MessageSent",
  "StatusTime": "2018-03-21T12:56:00",
  "CardUri": null,
  "OriginCardUri": "https://service.pcibooking.net/api/payments/paycard/7175f98744434ca89615b1cc86c69a45",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": null,
  "DestinationType": "SMS",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "ShortUrl": "pMdsvu",
  "Css": "TEst CSS"
}

{
  "RequestID": "pMdsvukESyaUIFuSBmvIufYtKjI0vOrj",
  "RequestType": "CVV",
  "Status": "CardStored",
  "StatusTime": "2018-03-21T13:26:29",
  "CardUri": "https://service.pcibooking.net/api/payments/paycard/d4ffa09028a044d2ac0d8bada49b6502",
  "OriginCardUri": "https://service.pcibooking.net/api/payments/paycard/7175f98744434ca89615b1cc86c69a45",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": null,
  "DestinationType": "SMS",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "ShortUrl": "pMdsvu",
  "Css": "TEst CSS"
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected APIKEY",
    "errorList": null
}

{
    "code": -160,
    "message": "Uri not found",
    "moreInfo": "Card request not found",
    "errorList": null
}

Card By Link Guide

Send secure card capture links via email or SMS

Use this endpoint to check the current status and configuration of a Card By Link request. The response includes the request parameters, delivery status, and the card token URI if the cardholder has already submitted their card details.

Error Responses

Code	HTTP Status	Condition
-1003	401	Missing or invalid API key in the `Authorization` header.
-160	404	Card request with the specified `requestID` was not found.

Parameters

Headers

Authorization

string

required

Your API key prefixed with APIKEY. Example: APIKEY your-api-key. See the Authentication guide.

Path Parameters

requestID

string

required

The request ID returned from sending a card capture link or CVV capture link.

const requestID = 'SULqe7pa22gghYDnX6O3J7QDMhyyUzNb';

const response = await fetch(
  `https://service.pcibooking.net/api/cardrequest/${requestID}`,
  {
    headers: {
      'Authorization': 'APIKEY your-api-key'
    }
  }
);

const data = await response.json();
console.log('Status:', data.Status);
console.log('Card URI:', data.CardUri);

import requests

request_id = 'SULqe7pa22gghYDnX6O3J7QDMhyyUzNb'

response = requests.get(
    f'https://service.pcibooking.net/api/cardrequest/{request_id}',
    headers={
        'Authorization': 'APIKEY your-api-key'
    }
)

data = response.json()
print('Status:', data['Status'])
print('Card URI:', data['CardUri'])

Response

200 Returns the full request configuration and its current status.

Status

string

The current status of the request. Possible values:

Channel	Value	Description
Email / SMS	`MessageQueued`	Message was added to the PCI Booking queue.
SMS only	`MessageSent`	The message was sent to the recipient.
SMS only	`MessageFailed`	Message delivery to the recipient failed.
SMS only	`MessageDelivered`	Message was successfully delivered to the recipient.
Email / SMS	`FormViewed`	Recipient viewed the capture form.
Email / SMS	`CardStored`	Card was captured and tokenized. The `CardUri` field contains the token URL.
Email / SMS	`LinkExpired`	The link to the capture form has expired.
Email / SMS	`StoreFailed`	Capture form submission failed.

RequestID

string

The unique identifier for this request.

RequestType

string

The type of request: Card for card capture, CVV for CVV-only capture.

CardUri

string

The PCI Booking token URL for the stored card. Only populated when Status is CardStored.

StatusTime

string

Timestamp of the last status change (ISO 8601 format).

OriginCardUri

string

The original token URL. Only present for CVV-only requests (RequestType: CVV).

For CVV-only requests, PCI Booking creates a new token that is a full copy of the original card details plus the captured CVV (returned in CardUri). The original token (OriginCardUri) is not modified and does not contain the CVV. You should delete the original token if it is no longer needed, otherwise it will continue to incur monthly storage fees.

Once Status is CardStored, remember to set the CVV Retention Policy on the token.

{
  "RequestID": "SULqe7pa22gghYDnX6O3J7QDMhyyUzNb",
  "RequestType": "Card",
  "Status": "MessageQueued",
  "StatusTime": "2018-03-21T13:28:38",
  "CardUri": null,
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": "nadya@recipientDomain.com",
  "DestinationType": "Email",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "CardTypes": "Visa,MasterCard,AMEX",
  "DefaultCardType": "AMEX",
  "AutoDetectCardType": true,
  "ShowOwnerID": false,
  "MinExpiration": "082018",
  "CVV": true,
  "ShortUrl": "SULqe7",
  "Css": "TEst CSS"
}

{
  "RequestID": "UPzpUmAj2NIRbciQCim3tHS0hZk7b2HE",
  "RequestType": "Card",
  "Status": "CardStored",
  "StatusTime": "2018-03-21T12:53:28",
  "CardUri": "https://service.pcibooking.net/api/payments/paycard/d919fe8ee51c4adbbbc22cef85e736a6",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": "nadya@recipientDomain.com",
  "DestinationType": "Email",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "CardTypes": "Visa,MasterCard,AMEX",
  "DefaultCardType": "AMEX",
  "AutoDetectCardType": true,
  "ShowOwnerID": false,
  "MinExpiration": "082018",
  "CVV": true,
  "ShortUrl": "7inQGn",
  "Css": "TEst CSS"
}

{
  "RequestID": "pMdsvukESyaUIFuSBmvIufYtKjI0vOrj",
  "RequestType": "CVV",
  "Status": "MessageSent",
  "StatusTime": "2018-03-21T12:56:00",
  "CardUri": null,
  "OriginCardUri": "https://service.pcibooking.net/api/payments/paycard/7175f98744434ca89615b1cc86c69a45",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": null,
  "DestinationType": "SMS",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "ShortUrl": "pMdsvu",
  "Css": "TEst CSS"
}

{
  "RequestID": "pMdsvukESyaUIFuSBmvIufYtKjI0vOrj",
  "RequestType": "CVV",
  "Status": "CardStored",
  "StatusTime": "2018-03-21T13:26:29",
  "CardUri": "https://service.pcibooking.net/api/payments/paycard/d4ffa09028a044d2ac0d8bada49b6502",
  "OriginCardUri": "https://service.pcibooking.net/api/payments/paycard/7175f98744434ca89615b1cc86c69a45",
  "SenderID": "Frodo",
  "SenderReference": "Refererfe",
  "CallBackURL": "https://httpbin.org/post",
  "RequestTTL": 22,
  "Destination": null,
  "DestinationType": "SMS",
  "RecipientName": "Mr. Roee Dayan",
  "Description": "Request for Roee's reservation in Bora Bora",
  "Amount": 999.65,
  "Currency": "USD",
  "Language": "en",
  "ShortUrl": "pMdsvu",
  "Css": "TEst CSS"
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected APIKEY",
    "errorList": null
}

{
    "code": -160,
    "message": "Uri not found",
    "moreInfo": "Card request not found",
    "errorList": null
}

Send CVV Capture Link Callback Notification

Start Here

Authentication & General

Capture Cards

Manage Tokens

Use Tokens

Additional Functions

Payments Library

Retrieve Card By Link Request

Card By Link Guide

Error Responses

Parameters

Headers

Path Parameters

Response

Card By Link Guide

​Error Responses

​Parameters

​Headers

​Path Parameters

​Response

Error Responses

Parameters

Headers

Path Parameters

Response