Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Provision a Merchant

To gateway transactions, provision the Merchant using the previously created Identity.

warning

Ensure that a bank account has been created and associated to the previously created Identity before provisioning a Merchant account.

merchant resources can have three possible onboarding_states:

  1. PROVISIONING : The request is pending (the state may change after two minutes)
    • processing _ enabled: False
    • settlement _ enabled: False
  2. APPROVED : The Merchant has been approved and can begin processing payments
    • processing _ enabled: True
    • settlement _ enabled: True
  3. REJECTED : The Merchant was rejected by the processor because of
    invalid information or it failed a regulatory and/or compliance check (e.g. KYC, OFAC, or MATCH)
    • processing _ enabled: False
    • settlement _ enabled: False
attention

Provisioning a Merchant account is an asynchronous request. We recommend creating a Webhook to listen for the state change.

Copy
Copied
curl https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/merchants \
    -H "Content-Type: application/json" \
    -H 'Finix-Version: 2022-02-01' \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
    -d '
	{
	    "processor": "DUMMY_V1",
	    "tags": {
	        "key_2": "value_2"
	    }
	}'

Example Response:

Copy
Copied
{
    "id": "MUucec6fHeaWo3VHYoSkUySM",
    "created_at": "2022-01-27T07:36:58.19Z",
    "updated_at": "2022-10-06T20:25:24.06Z",
    "application": "APgPDQrLD52TYvqazjHJJchM",
    "card_cvv_required": false,
    "card_expiration_date_required": true,
    "convenience_charges_enabled": false,
    "creating_transfer_from_report_enabled": true,
    "default_partial_authorization_enabled": false,
    "fee_ready_to_settle_upon": "RECONCILIATION",
    "gross_settlement_enabled": false,
    "identity": "IDpYDM7J9n57q849o9E9yNrG",
    "level_two_level_three_data_enabled": false,
    "mcc": "4900",
    "merchant_name": "Finix Flowers",
    "merchant_profile": "MPzW2oRPtkLxK3fymcMACFi",
    "mid": "FNXh6htoPnfwmgGdvaG4L67Q1",
    "onboarding_state": "APPROVED",
    "processing_enabled": true,
    "processor": "DUMMY_V1",
    "processor_details": {
        "mid": "FNXh6htoPnfwmgGdvaG4L67Q1",
        "api_key": "secretValue"
    },
    "ready_to_settle_upon": "RECONCILIATION",
    "rent_surcharges_enabled": false,
    "settlement_enabled": true,
    "settlement_funding_identifier": "UNSET",
    "surcharges_enabled": false,
    "tags": {
        "key_2": "value_2"
    },
    "verification": "VIxfDrRKZZzkCDDbeCT15oDN",
    "_links": {
        "self": {
            "href": "https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM"
        },
        "identity": {
            "href": "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
        },
        "verifications": {
            "href": "https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM/verifications"
        },
        "merchant_profile": {
            "href": "https://finix.sandbox-payments-api.com/merchant_profiles/MPzW2oRPtkLxK3fymcMACFi"
        },
        "application": {
            "href": "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "verification": {
            "href": "https://finix.sandbox-payments-api.com/verifications/VIxfDrRKZZzkCDDbeCT15oDN"
        }
    }
}

HTTP Request

POST https://finix.sandbox-payments-api.com/identities/:IDENTITY_ID/merchants

URL Parameters

Parameter Description
:IDENTITY_ID ID of the Identity

Request Arguments

Field Type Description
processor string, required Name of the processor that you're onboarding the Merchant with (a user can pass either null or DUMMY_V1 for sandbox)
level_two_level_three_data_enabled boolean, optional Set to True to enable Merchant for Level 2 and Level 3 processing. Default value is false.