v1

latestOpenAPI 3.0.02026-07-26355499.1 KB

Get SubMerchant Information

Retrieve the information for a specific SubMerchant.

get/sub_merchants/{sub_merchant_id}

Path parameters

sub_merchant_idinteger required

The ID of the SubMerchant to retrieve.

Headers

Content-Typestring required

Media type of the body sent to the API.

X-Datestring date-time required

ISO8601 Datetime with Timezone (yyyy-MM-dd'T'HH:mm:ssZ)

X-Loginstring required

Merchant X-Login API Key.

Authorizationstring required

Authorization control hash.

X-Idempotency-Keystring

Unique idempotency key for ensuring that the same request is not processed more than once.

Response

Successful request. Returns the SubMerchant details.

sub_merchant_idinteger

Identifier of the SubMerchant on our end.

markup_feenumber double

Commission earned in each deposit. It is a percentual, expressed in decimal. E.g.: value 2.00 represents %2.00

sub_merchant_namestring

Represents the name of the SubMerchant.

emailstring

Email of the main user in the SubMerchant. In case you may want to match it with a user on your end, please request SubMerchant to signup with that address.

status'ACTIVE' | 'INACTIVE'

Represents if the SubMerchant is either active or inactive. Only active merchants can process transactions.

external_submerchant_idstring

Represents the SubMerchant identifier on your end, if this information is included in the Referral Signup Form URL.