📃
📃
📃
📃
PayEngine API Reference
Search…
Introduction
Authentication
Onboarding
Create a merchant
Update Merchant Details (Deprecated)
Update Merchant Details V2
Document attachment
Validate onboarding application
Submit for Review
Application section criteria
Retrieve Merchant Details
Merchant Application Signing
List all merchants
Add Merchant's Bank Account
Get bank auto fill
Get address auto fill
Device Management
List all devices
Get device information
Fee Schedules
List all fee schedules
Retrieve a fee schedule
Transactions
Credit Card Authorization
Void Credit Authorization
Credit Card Capture
Credit Card Sale
Device Sale
Cancel Device Sale
ACH Sale
Refund
Credit
Offline
Subscription Payments
Payment Links
Search Transactions
Search Payouts
Batch Report
Batch Settlement Settings
Card Tokens
ACH Tokens
Gateway Orchestration
Testing
Error and Response Codes
Error codes
Transaction Response codes
Response codes from credit card networks
Address verification codes
Card holder verification codes
Card type codes
CVV verification codes
Commercial card codes
Authorization characteristics indicators
Universal cardholder authentication field
Mastercard purchase transaction type
ISO currency codes
ACH host response codes
ACH host transaction statuses
Webhooks
Create a webhook
Update webhook
Retrieve a webhook
List all webhooks
Delete a webhook
JS Client Library Properties & Styling
SecureFields JS
Onboarding Web-Component
Transactions Web-Component
Payouts Web-Component
Dashboard Web-Component
Powered By GitBook
Dashboard Web-Component
You can utilize our dashboard component by specifying the pay-engine web component with type dashboard and other necessary properties.
type="dashboard"
merchant-id="d8dfafb5-88d6-46c7-ba14-1ff972564085"
hash="0709c7f107ed6326aaeaa3810330834870591f3924943e7bce66a826ac532045"></pay-engine>
​

Properties and Styling

Properties
Following are properties that can be set on this web-component. You can set the property via a JavaScript object reference, or directly inline as an HTML tag attribute. See the example below:
<pay-engine id="pf-dashboard"
type="dashboard"
merchant-id="d8dfafb5-88d6-46c7-ba14-1ff972564085"
hash="0709c7f107ed6326aaeaa3810330834870591f3924943e7bce66a826ac532045"></pay-engine>
Following is a list of applicable properties.
Class
Description
merchant-id
Merchant ID (generated by using create merchant API call)
hash
HMAC generated from merchant-id (see securing embedded UIs section)
​
JS Client Library Properties & Styling - Previous
Payouts Web-Component
Last modified 9mo ago
Copy link