Card View API
The Card View API is a highly efficient tool that allows you to effortlessly view Credit Card information and its associated details simply by accessing a URL. This API comprises several key components, including the partner ID, token ID (generated during Credit Card creation), and the client's IP address.
After passing the partner ID, token ID, and client IP into the API, it will generate a response containing a URL. This URL can be copied and pasted by the PMS into their system. By accessing this URL, the PMS will be able to conveniently view the card details directly within their own system, facilitating easy and seamless card management.
Endpoint
POST
Header Parameters
Content-Type
string (Required)
Indicates the format of the data that has to be sent or received.
Example:
application/json
x-api-name
string (Required)
This is for authentication purpose and can be obtained by logging into the Extranet itself.
Example:
XXXXFIRSTAPP
x-api-key
string (Required)
This is for authentication purpose and can be obtained by logging into the Extranet itself.
Example:
kfpwsfnknknfwknfkwnknef9823rujfsormDFS3ijoncvowoeorfnv
Attributes
partner_id
string (Required)
Indicates the unique property ID assigned upon the creation of the property.
token_id
string (Required)
Indicates the token ID generated upon creation of a credit card.
client_ip
string (Required)
Indicates the client's IP address.
Sample Request
Responses
200 Success Response
status
string
Indicates the status of the request.
ErrorMessages
string
Indicates the error messages, if any.
URL
string
Provides the URL to view the credit card in your system.
400 Bad Request
status
string
Indicates the status of the request.
ErrorMessages
string
Indicates the error messages, if any.
401 Unauthorized
status
string
Indicates the status of the request.
ErrorMessages
string
Indicates the error messages, if any.
Last updated
Was this helpful?