Integrating your Broker Escrow account with your Omnyfy Marketplace (as a Marketplace Owner)
Configuring your API Key
Obtaining the Key from your Escrow Account
Before starting, ensure that you are using the correct environment to configure your API keys.
- https://www.escrow.com/ - Escrow Live Accounts
- https://www.escrow-sandbox.com/ - Escrow Sandbox/Staging Accounts
To integrate your Escrow account to the marketplace, you will first need an API Key. This can be obtained from your Escrow account, under My Integrations > API > API Keys.
Once you reach the API Dashboard, you will be able to see your available API Keys. On the second box, you will need to generate the API Key. Add in the new Key Name (call this something clear such as {your marketplace name} API Key). Then select Generate API Key.
IMPORTANT: Once you select Generate API Key, it is important to note that a pop up will appear. This is crucial as you will only see your API Key on this pop up. Save this API Key somewhere, as you cannot access this from Escrow again once you leave this screen. You can also choose Copy to automatically copy it, however you must paste it somewhere before you leave this screen to ensure it copied correctly. If you do not copy this and you leave this page, you will need to create a new API key again.
Once you have copied your API Key, you will be able to see it created in your API Dashboard.
That's all that's required from Escrow API.
Configuring your marketplace
Once you have the API Key, you can then go to your marketplace admin and begin configuring the Escrow Payment Method.
Log in to the admin as a Marketplace Owner, and go to Stores > Settings > Configuration > Sales > Payment Methods > Other Payment Methods > Escrow Payment.
Here you want to set Enabled to Yes. Ensure that you untick Use system value to change the field.
Most of the other fields can remain as default with the exception of a few business logic requirements.
Field | Notes |
Inspection Period | 14 is the default |
Environment | |
| API Username | Obtained from Escrow |
API Key | Obtained from Escrow |
Return URL | The default should be your main domain URL, followed by /escrow/response/success |
Once this has been configured, you will just need to add webhooks to complete the integration.
Webhooks
You only need to create a webhook within Escrow. The integration will call upon this specific URL by default, so you will not need to set anything within the marketplace.
In the Escrow website, through your account dashboard, go to My Integrations > API > Webhooks. Here you can create a webhook. Add the
The webhook URL will just need to be your domain, followed by /escrow/webhook.
EG: {domain}/escrow/webhook.
Once you generate the webhook, your integration will be complete. You will now be able to set Escrow as your payment method.
Related Articles
Creating and Verifying your Escrow Account from the Escrow Website
Creating an Escrow Account Signing up from the Escrow Website An Escrow account is needed in order to be able to manage, or transact with Escrow. This applies to customers, marketplace owners and vendors on the platform. There are 3 types of roles ...Transaction flow in Escrow
Overview You can see the high level overview of the transactions here: Escrow Overview. This is the process from customer buying to receiving the funds, all the way to Vendors getting paid with the Marketplace Owner receiving commissions based on the ...Escrow Overview
Escrow is a payment method that acts as a guarantor for the customer (to only release the funds to the vendor/marketplace owner once the customer is satisfied with the order) and the vendor (to ensure that the funds are there before the products are ...Reviewing Escrow Transactions in Omnyfy
In the backend of Omnyfy, Marketplace Owners and Vendors can view Escrow transactions. Vendors will only be able to see their own, however Marketplace Owners can see all transactions made in the marketplace. To access this, in the admin, go to Sales ...Creating and Verifying your Escrow account via checkout (For Customers Only)
Account Creation As a customer, you can create your own Escrow account during the checkout process on the marketplace. When selecting Escrow as the payment method (and you aren't signed in to Escrow already), you will be taken to the Escrow website ...