Skip to main content

🌟 Generate & Configure Your Checkout Page with Deets iFrame

Deets provides a secure, flexible, and fully customizable checkout solution that keeps sensitive payment data out of your infrastructureβ€”eliminating PCI compliance headaches while giving you full control over the payment experience.

πŸš€ Getting Started​

To integrate Deets iFrame into your checkout, follow these three key steps:

  1. Authenticate with Deets API – Securely obtain an authentication token.
  2. Generate Your Checkout Page – Use Deets API to dynamically create a payment page.
  3. Customize & Configure the Checkout Page – Use query parameters to tailor the checkout experience.

Please use the correct base URL for the environment you intend to use:

Please use the following credentials for the sandbox environment:

  • Merchant ID: corsourc-godominicga-718651163-3246805-1739619379
  • Api Key: EmBfRrvTez2CWkEvP4kxn5merinmzc1y3g3VGNmk
  • App Key: t7U3xyLLoTSiCHXyqmyPlYaEsGXythryc2uzZ3NddnX7S5UkHqLZMGKY000anJtl

Your account manager will provide you production credentials after sandbox integration.


πŸ”‘ Step 1: Authenticate with Deets API​

Before you can generate a checkout page, you need to authenticate your API requests using the credentials provided by your Deets account manager after signing up to MyValet.

Generating an Authentication Token​

Use the following request to authenticate and retrieve a temporary authentication token.

Request​

curl --location '{{base_url}}/auth/token' \
--header 'x-api-key: {{your-api-key}}' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"type": "auth",
"attributes": {
"appKey": "{{your-app-key}}"
}
}
}'

Response:​

Upon successful authentication, you will receive a token. Take note of this token, as it will be required for subsequent requests.

{
"links": {
"self": "{{base_url}}/auth/token"
},
"data": {
"type": "auth",
"id": "{{API KEY USED}}",
"attributes": {
"appToken": "{JWT TOKEN}"
}
}
}

βœ… Store this token securelyβ€”it will be used for subsequent API requests.


πŸ“„ Step 2: Generate Your Checkout Page​

Once authenticated, you can generate a checkout page dynamically.

Request​

curl --location '{{base_url}}/generator/genPayment' \
--header 'x-api-key: {{your-api-key}}' \
--header 'Authorization: Bearer {{authentication-token}}' \
--header 'Content-Type: application/json' \
--data '{
"merchant_id": "{{your-merchant-id}}",
"is_capture_email": true,
"is_capture_zip": true,
"enable_token": true,
"payment_version": "v4",
"style": ""
}'

Response​

If successful, the response will include the generated checkout page URL:

{
"message": "OK",
"object_url": "{{ YOUR IFRAME URL }}",
"shared_key": "{{ SHARED KEY }}"
}

βœ… Use this object_url to embed the checkout page into your application.


🎨 Step 3: Customize & Configure Your Checkout Page​

Deets iFrame allows you to personalize the checkout experience by adding URL query parameters. These parameters can pre-fill customer details, adjust styling, and enable additional security features.

Query Parameters for Customization​

ParameterTypeRequiredDescription
amountIntegerβœ… YesAmount in cents (e.g., 1000 for $10.00)
emailString❌ NoCustomer's email address
zipString❌ NoCustomer's ZIP code
invoiceString❌ NoUnique invoice number for the transaction
splitConfigJSON❌ NoSplit payment configuration for multi-recipient transactions

Example Checkout Page URL with Parameters: Click this link to preview a configured checkout page

Advanced Customization (Embedded Checkout Form Configuration)​

If embedding the checkout page into an iFrame, you can pre-populate fields with URL parameters:

Core Customer Information​

ParameterTypeRequiredDescription
cardHolderNameString❌ NoCardholder's name
emailString❌ NoCustomer's email address
isEmailEnabledBoolean❌ NoShow or hide email field
mobileNumberString❌ NoCustomer's phone number
zipCodeString❌ NoCustomer's ZIP code
isZipCodeEnabledBoolean❌ NoShow or hide ZIP code field

Example Embedded Checkout Form URL Parameters:

?cardHolderName=John%20Doe
&email=[email protected]
&isEmailEnabled=true
&zipCode=12345
&isZipCodeEnabled=true

βœ… Final Summary​

By following these steps, you can successfully authenticate, generate, and configure your Deets iFrame checkout:

1️⃣ Obtain an Authentication Token – Secure API access with your credentials.
2️⃣ Generate a Checkout Page – Create a secure and dynamic payment session.
3️⃣ Customize the Checkout Experience – Use parameters to tailor the UI and functionality.
4️⃣ Embed Securely & Process Transactions – Ensure full compliance while keeping payments seamless.

Ready to go live? Start integrating Deets today and unlock fast, secure, and PCI-compliant payments for your business! πŸš€