Partner API

Use Partner API when merchant account management needs to be integrated into your own platform instead of performed manually in the Partner Portal.

The API lets you create merchant accounts when a customer signs up, retrieve the merchants associated with your partner profile, activate an account, and request merchant access tokens. The API reference contains the request and response schemas for each operation.

Merchant account management

API referencePOSTCreate merchant Account/public/api/v1/partner/accountsUse this endpoint to create a new merchant account associated with your partner profile. API referenceGETList merchant Accounts/public/api/v1/partner/accountsOpen the full API reference for request details, examples, and response schema. API referenceGETShow merchant Account/public/api/v1/partner/accounts/{accountId}Fetches merchant account details for the request id. API referencePATCHActivate merchant Live Account/public/api/v1/partner/accounts/{accountId}/activateTo enable a merchant to go live, and begin billing, use this endpoint. API referenceDELETEClose merchant Account/public/api/v1/partner/accounts/{accountId}Marks a merchant account for closing.

Closing an account marks it for closing. It is closed by ePay during the next billing period.

Access a merchant through the API

API referencePOSTRequest Merchant Access Token/public/api/v1/partner/accounts/{accountId}/access-tokenTo access the ePay API on behalf of a merchant under your partner profile, partners must create a access token for the merchant before sending requests.

Request an access token when your integration needs to access the ePay API on behalf of a merchant under your partner profile. The API reference documents the supported environment and token behaviour.

Prefer manual administration?

Use the Partner Portal to manage merchants and partner users through the UI.