Create a merchant connection

Changed on

Create a merchant connection.

post/merchantconnections

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/merchantconnections
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Headers

merchantstring required

Merchant ID

Request body

requesterIdstring required

Auto-generated unique identifier of the merchant that is requesting the connection.

requesterDetailsstring

Details of the requester merchant.

accepterIdstring required

Auto-generated unique identifier of the merchant that is accepting the connection.

accepterDetailsstring

Details of the requester merchant.

permissionsstring[] required

The type of connection allowed between the two merchants. You can specify multiple values. Supported values are: partner_invoice - The requester merchant can issue on-demand partner invoices to the accepter merchant. partner_invoice_inter_merchant - The requester merchant can issue on-demand partner invoices on behalf of the accepter merchant to another merchant. The requester merchant must have a connection with both merchants. partner_subscription - The accepter merchant can subscribe to partner subscriptions created by the requester merchant. partner_revenue_share - The requester merchant can collect a portion of funds from the accepter merchant using revenue share.

descriptionstring

Brief description of the merchant connection that can be merchant facing.

termsAndConditionsURLstring

Terms and Conditions URL.

Response

200

object required

Changes