Get CC Collection (Generate Link)

This endpoint is designed to facilitate the generation of a secure payment link for a customer to complete a credit card transaction.

Endpoint

POST

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

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.

amount string (Required)

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

currency_code string (Required)

Indicates the currency accepted by the partner.

order_id string (Required)

A unique order identifier, typically generated by your system to link this payment request to a specific order.

customer_email string

The email address of the customer. This must be a valid email format and should not exceed 50 characters.

Example - john@abc.com

contact_number string

The customer’s contact number in international format.

Example - +919876XXXXXX

return_url string

The URL to which the user will be redirected after payment is completed. This is typically used to handle post-payment processing.

Sample Request

{
   "partner_id": "TOH",
   "amount": "30",
   "currency_code": "NZD",
   "order_id": "TEST1AABDFGDFG46a54dsdcRs46g5d4fsz6g54a1s",
   "customer_email": "testuser@domain.co.nz",
   "contact_number": "+64211234567",
   "return_url": "https://testdomain.net/returnURL_Endpoint.php?flag=tokenRequest"
}

Responses

Success Response

status string

Indicates the status of the request.

ErrorMessages string

Indicates the error messages, if any.

URL string

A link to the payment page where the customer can complete the payment process. This URL will be generated upon success and should be used to redirect the user to the payment interface.

{
   "Status": "Success",
   "ErrorMessages": [],
   "URL": "https://token.suissu.com/service/pgcard/f4ab7ceb2663afcf50a598a0d8e9173c"
}

Error Response

status string

Indicates the status of the request.

ErrorMessages string

An array containing specific error messages that describe why the request failed. In this example, the error relates to the invalid or missing customer_email.

{
   "Status": "Fail",
   "ErrorMessages": [
       "customer_email : Invalid or missing email or length greater than 50 characters"
   ]
}
PreviousCard CollectionNextCheck Status of CC Collection

Last updated

Was this helpful?