Charge API

The Charge API provides a means for you to initiate charges on a stored Credit Card within our system. To process a charge, the API requires either a token ID or an intent ID as it can not charge a Credit Card directly. Key components of the Charge API includes the partner ID, token ID, currency code, and the specific amount to be charged. By providing these necessary details, the PMS can securely and efficiently execute charges on the stored Credit Card.

Upon successfully charging the Credit Card, the API will provide the Payment Gateway Transaction ID as part of the response. This transaction ID serves as a unique identifier for the payment transaction conducted through the Payment Gateway. The PMS can use this transaction ID for further reference or record-keeping purposes related to the completed transaction.

---

Endpoint

POST

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

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.

---

token_id string (Required)

Indicates the token ID generated upon creation of an intent or token of a credit card.

---

currency_code string (Required)

Indicates the currency accepted by the partner.

---

amount string (Required)

Indicates the amount that has to be charged from the credit card.

---

customer_name string

When you use "Pay Advantage" payment gateway than this field is required.

---

Sample Request

{
  "partner_id": "H1",
  "token_id": "H4sIAAAAAAAAAzO3BADDOtuOAgAAAA==",
  "currency_code": "INR",
  "amount": "5000",
  "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": [],
  "PGTransactionID": "pi_3NOia7LkClv9jGLK1CV12znF"
}

---

400 Bad Request

status string

Indicates the status of the request.

---

ErrorMessages string

Indicates the error messages, if any.

{
  "Status": "Fail",
  "ErrorMessages": [
    "amount : Invalid or missing amount"
  ]
}

---

401 Unauthorized

status string

Indicates the status of the request.

---

ErrorMessages string

Indicates the error messages, if any.

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