SubMerchant Status Endpoint

Learn how to retrieve your SubMerchant's information.

SubMerchant information request

GET https://api-stg.directa24.com/v3/sub_merchants/{sub_merchant_id}

Path Parameters

Name	Type	Description
sub_merchant_id*	int	ID

200: OK

{
    "sub_merchant_id": 18703,
    "markup_fee": 2.00,
    "sub_merchant_name": "Dunder Mifflin",
    "email": "[email protected]",
    "status": "ACTIVE"
}

400: Bad Request SubMerchant not found on your account.

{
    "code": 423,
    "description": "Invalid subMerchant 18,400 for merchant 18,200",
    "type": "INVALID_SUBMERCHANT"
}

You can also access your SubMerchant's information in our Merchant Panel by going into the section Referred merchants, displayed on the navigation bar.

Request

You can trigger the check of the status of a SubMerchant at any moment you consider pertinent. However, every time a SubMerchant information changes, we will send you a notification containing the ID of the SubMerchant so that you can check its details and keep information up-to-date.

Example request

In the status endpoint, all the request have to be sent as GET, containing the usual headers.

Regarding the Authorization value, since the body of the requests will be empty, you should use an empty ("") string or nothing as the jsonPayload field.

cURL

curl --location --request GET 'https://api-stg.directa24.com/v3/sub_merchants/18703' \
--header 'X-Login: xxxxxxx' \
--header 'X-Date: 2020-06-24T17:13:21Z' \
--header 'Authorization: D24 e339247fb57b10c053159cf87d3a88415f9be567beb46a93f6839d9fc45d2c8a' \
--data-raw ''

Example response

{
    "sub_merchant_id": 18703,
    "markup_fee": 2.00,
    "sub_merchant_name": "Dunder Mifflin",
    "email": "[email protected]",
    "status": "ACTIVE",
    "external_submerchant_id":"Office2"
}

Response fields

Field	Format	Description
sub_merchant_id	integer	Identifier of the SubMerchant on our end.
markup_fee	decimal	Commission earned in each deposit. It is a percentual, expressed in decimal. E.g.: value 2.00 represents %2.00
sub_merchant_name	varchar	Represents the name of the SubMerchant.
email	varchar	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	enum ('ACTIVE' , 'INACTIVE')	Represents if the SubMerchant is either active or inactive. Only active merchants can process transactions.
external_submerchant_id	varchar	Represents the SubMerchant identifier on your end, if this information is included in the Referral Signup Form URL.