Generate with Billing and Contact Information

POST

/api/gateway/hosted-form

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "dba": {
        "id": 9
    },
    "terminal": {
        "id": 24
    },
    "threeds": "Disabled",
    "amount": 2,
    "feeType": "amount",
    "fee": 2,
    "externalId": "example",
    "origin": "WEB",
    "returnUrl": "https://example.com",
    "returnUrlNavigation": "top",
    "useLogo": "Yes",
    "visibleNote": "Yes"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/gateway/hosted-form' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dba": {
        "id": 9
    },
    "terminal": {
        "id": 24
    },
    "threeds": "Disabled",
    "amount": 2,
    "feeType": "amount",
    "fee": 2,
    "externalId": "example",
    "origin": "WEB",
    "returnUrl": "https://example.com",
    "returnUrlNavigation": "top",
    "useLogo": "Yes",
    "visibleNote": "Yes"
}'

Responses

🟢200Generate with Billing and Contact Information

application/json

Body

Example

{
    "code": "<div id=\"payment-form\"></div><script>(function() {const options = {\"data\":\"eyJkYmFJZCI6MTEyLCJ0ZXJtaW5hbElkIjoxMDksInRocmVlZHMiOiJEaXNhYmxlZCIsImV4dGVybmFsSWQiOiJleGFtcGxlIiwicmV0dXJuVXJsIjoiaHR0cHM6XC9cL2V4YW1wbGUuY29tIiwicmV0dXJuVXJsTmF2aWdhdGlvbiI6InRvcCIsImxvZ28iOiJZZXMiLCJ2aXNpYmxlTm90ZSI6IlllcyIsInJlcXVlc3RDb250YWN0SW5mbyI6IlllcyIsInJlcXVlc3RCaWxsaW5nSW5mbyI6IlllcyIsInNlbmRSZWNlaXB0IjoiIiwib3JpZ2luIjoiV0VCIiwiaGFzaCI6IjJhY2VjODNmNWRiMTdlNmQ2NTA1MjE5MTljYmY5ODQ1In0%3D\",\"amount\":2,\"fee\":2,\"feeType\":\"amount\",\"contactInfo\":{\"name\":\"John Doe\",\"email\":\"some@validemail.com\",\"phone\":\"\"},\"billingInfo\":{\"country\":\"United States\",\"address\":\"123 str.\",\"address2\":\"\",\"city\":\"Los Angeles\",\"state\":\"California\",\"zip\":\"61234\"}};const l = function() {new PaymentGateway({target: \"payment-form\",options: options});};if(typeof window.PaymentGateway === \"undefined\") {window.webroot = \"https://zendashboard.com";const e = document.createElement(\"script\"); e.async = true;e.src = window.webroot + \"/js/gateway/payment.js?v=\" + Date.now();document.getElementsByTagName(\"head\")[0].appendChild(e);e.onload = e.onreadystatechange = function() { l(); }} else { l(); }}());</script>",
    "url": "https://zendashboard.com/gateway/public/form?data=eyJkYmFJZCI6MTEyLCJ0ZXJtaW5hbElkIjoxMDksInRocmVlZHMiOiJEaXNhYmxlZCIsImV4dGVybmFsSWQiOiJleGFtcGxlIiwicmV0dXJuVXJsIjoiaHR0cHM6XC9cL2V4YW1wbGUuY29tIiwicmV0dXJuVXJsTmF2aWdhdGlvbiI6InRvcCIsImxvZ28iOiJZZXMiLCJ2aXNpYmxlTm90ZSI6IlllcyIsInJlcXVlc3RDb250YWN0SW5mbyI6IlllcyIsInJlcXVlc3RCaWxsaW5nSW5mbyI6IlllcyIsInNlbmRSZWNlaXB0IjoiIiwib3JpZ2luIjoiV0VCIiwiaGFzaCI6IjJhY2VjODNmNWRiMTdlNmQ2NTA1MjE5MTljYmY5ODQ1In0%3D&amount=2&fee=2&feeType=amount"
}

Modified at 2025-08-09 05:39:41

Generate

Hosted Fields