Card API

The Card API simplifies the process for you to seamlessly create or add a Credit Card to a Property without the need to store the card information within their own system. This alleviates the concerns and responsibilities associated with storing sensitive card data, providing a convenient and secure solution for managing Credit Cards within the PMS Partner's operations.

Additionally, the Card API encompasses a wealth of information pertaining to a Credit Card. This includes essential components such as the partner ID, card number, cardholder name, CVV code, card type, expiry month, expiry year, and various actions that can be performed on the card. This comprehensive set of information ensures efficient management and utilization of Credit Card data within the system.

The Card API also includes several actionable functionalities that can be applied to Credit Cards:

1. Store : This action enables you to securely store Credit Card information, including the cardholder's name, card number, CVV code, expiry month, and expiry year.

2. Intent : This action allows you to create a customer or intent associated with a particular Credit Card. This process generates a token ID specifically for the PMS, which can be utilized for future charges on the same card.

3. Token : This action enables you to generate a unique token ID, which can be used only once to charge a Credit Card.

4. Charge : This action empowers you to initiate the charging process for a Credit Card, facilitating seamless payment transactions without the need to store the card information for future use.

---

Endpoint

POST

https://token.suissu.com/service/api/card

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

XXXX can be replaced with the client name.

---

x-api-key string (Required)

This is for authentication purpose and can be obtained by logging into the Extranet itself.

Example: kfpwsfnknknfwknfkwnknef9823rujfsormDFS3ijoncvowoeorfnv

This key will be unique for every client.

---

Attributes

partner_id string (Required)

Indicates the unique property ID assigned upon the creation of the Property.

---

card_number string (Required)

Indicates the credit card number.

---

card_holder_name string (Required)

Indicates the name of the card holder.

---

cvv_number string (Required)

The CVV number of the credit card.

---

expiry_month string (Required)

Indicates the expiry month of the card.

---

expiry_year string (Required)

Indicates the expiry year of the card.

---

action string (Required)

Indicates the desired action on the credit card.

Enum:

store

intent

token

charge

---

customer_name string

When you use "Pay Advantage" payment gateway than this field is required while generate the token and direct charge.

---

currency_code string

Indicates the currency accepted by the partner. It is only required if the credit card is directly charged.

---

amount string

Indicates the amount that has to be charged from the credit card. It is only required if the card is directly charged.

Sample Request

Action : Store

{
  "partner_id": "H4",
  "card_number": "5105105105105100",
  "card_holder_name": "John Smith",
  "cvv_code": "987",
  "expiry_month": "06",
  "expiry_year": "2023",
  "action": "store"
} 

Action : Intent

{
  "partner_id": "H4",
  "card_number": "5105105105105100",
  "card_holder_name": "John Smith",
  "cvv_code": "987",
  "expiry_month": "06",
  "expiry_year": "2023",
  "action": "intent"
}

Action : Token

{
  "partner_id": "H4",
  "card_number": "5105105105105100",
  "card_holder_name": "John Smith",
  "cvv_code": "987",
  "expiry_month": "06",
  "expiry_year": "2023",
  "currency_code": "INR",
  "action": "token",
  "customer_name": "John Doe",
  "amount": 16
}

Action : Charge

{
  "partner_id": "H4",
  "card_number": "5105105105105100",
  "card_holder_name": "John Smith",
  "cvv_code": "787",
  "expiry_month": "06",
  "expiry_year": "2024",
  "amount": "5000",
  "currency_code": "INR",
  "action": "charge",
  "customer_name": "John Doe"
}

---

Responses

---

200 Success Response

status string

Indicates the status of the request.

---

ErrorMessages string

Indicates the error messages, if any.

{
  "Status": "Success",
  "ErrorMessages": [],
  "TokenID": "H4sIAAAAAAAAAzM0NQAAr6QAXgMAAAA="
}

---

400 Bad Request

status string

Indicates the status of the request.

---

ErrorMessages string

Indicates the error messages, if any.

{
  "Status": "Fail",
  "ErrorMessages": [
    "Invalid expiry_year or expiry_month (Date is passed)"
  ]
}

---

401 Unauthorized

status string

Indicates the status of the request.

---

ErrorMessages string

Indicates the error messages, if any.

{
  "Status": "Fail",
  "ErrorMessages": [
    "Unauthorised"
  ]
}