π 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:
- Authenticate with Deets API β Securely obtain an authentication token.
- Generate Your Checkout Page β Use Deets API to dynamically create a payment page.
- 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:
- Sandbox API: https://test.digitzsapi.com/test
- Sandbox Payment API: https://utilities.staging.digitzs.com
- Production API: https://beta.digitzsapi.com/v3
- Production Payment API: https://utilities.digitzs.com
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β
Parameter | Type | Required | Description |
---|---|---|---|
amount | Integer | β Yes | Amount in cents (e.g., 1000 for $10.00) |
email | String | β No | Customer's email address |
zip | String | β No | Customer's ZIP code |
invoice | String | β No | Unique invoice number for the transaction |
splitConfig | JSON | β No | Split 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β
Parameter | Type | Required | Description |
---|---|---|---|
cardHolderName | String | β No | Cardholder's name |
email | String | β No | Customer's email address |
isEmailEnabled | Boolean | β No | Show or hide email field |
mobileNumber | String | β No | Customer's phone number |
zipCode | String | β No | Customer's ZIP code |
isZipCodeEnabled | Boolean | β No | Show 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! π