Hosted Checkout API

API Endpoint

Live APIProduction environment

POSThttps://api.thepayment.company/api/v1/live/hosted/card

Test APISandbox environment

POSThttps://api.thepayment.company/api/v1/test/hosted/card

Request Fields

Parameter	Type	Description	Required
`first_name`	String	Given name of the cardholder	Yes
`last_name`	String	Family name of the cardholder	Yes
`email`	String	Customer email address	Yes
`address`	String	Billing street address	Yes
`country`	String	Country code in ISO 3166-1 alpha-3 format	Yes
`city`	String	Cardholder city	Yes
`state`	String	Cardholder state or region	Yes
`zip`	String	ZIP or postal code	Yes
`ip_address`	String	Customer IP address	Yes
`phone_number`	String	Cardholder phone number	Yes
`amount`	Number	Payment amount in the smallest currency unit	Yes
`currency`	String	Currency code in ISO 4217 format	Yes
`redirect_url`	String	URL where the customer is sent after payment	Yes
`webhook_url`	String	URL used for server-to-server webhook updates	NO
`order_id`	String	Merchant-side unique order reference	NO
`terminal_id`	String	Unique connector terminal ID, useful when choosing a primary or fallback connector	NO

Payload

Send the request payload as JSON. The sample structure is shown below:

{
"first_name": "James",
"last_name": "Dean",
"email": "james@gmail.com",
"address": "64 Hertingfordbury Rd",
"country": "GB",
"city": "Newport",
"state": "GB",
"zip": "TF10 8DF",
"ip_address": "127.0.0.1",
"phone_number": "7654233212",
"amount": 100,
"currency": "GBP",
"redirect_url": "https://thepayment.company",
"webhook_url": "https://thepayment.company/webhook",
"order_id": "12524AGSDF34DS"
}

Sample Responses

{
"status": "REDIRECT",
"message": "Please redirect user to complete the payment.",
"redirect_url": "https://api.thepayment.company/api/v1/test/card/hosted/TPC0186280974141637",
"data": {
  "amount": 100,
  "currency": "GBP",
  "order_id": null,
  "transaction_id": "TPC0186280974141637",
  "customer": {
    "first_name": "James",
    "last_name": "Dean",
    "email": "james@gmail.com"
  },
  "refund": {
    "status": false,
    "refund_date": null
  },
  "chargeback": {
    "status": false,
    "chargeback_date": null
  }
}
}

Encrypted payment APIs must use AES-256-CBC before transmitting sensitive fields. Authentication, headers, encryption steps, and sample implementations for Node.js, PHP, Python, and Java are documented in Integration Examples.

Hosted Checkout API

API Endpoint

Request Fields

Payload

Sample Responses

Integration Notes

On this page