Provision a Merchant
attention
This API is available for Finix Flex and Finix Core customers.
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
:
-
PROVISIONING
: The request is pending (the state may change after two minutes)- processing _ enabled: False
- settlement _ enabled: False
-
APPROVED
: TheMerchant
has been approved and can begin processing payments- processing _ enabled: True
- settlement _ enabled: True
-
REJECTED
: TheMerchant
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.
curl https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/merchants \
-H "Content-Type: application/vnd.json+api" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-d '
{
"processor": "DUMMY_V1",
"tags": {
"key_2": "value_2"
}
}'
Example Response:
{
"id" : "MUucec6fHeaWo3VHYoSkUySM",
"application" : "APgPDQrLD52TYvqazjHJJchM",
"identity" : "IDpYDM7J9n57q849o9E9yNrG",
"verification" : "VIdikDHXv7x8nWyJg8JZemGx",
"merchant_profile" : "MPzW2oRPtkLxK3fymcMACFi",
"processor" : "DUMMY_V1",
"processing_enabled" : true,
"settlement_enabled" : true,
"gross_settlement_enabled" : false,
"creating_transfer_from_report_enabled" : true,
"card_expiration_date_required" : true,
"card_cvv_required" : false,
"tags" : {
"key_2" : "value_2"
},
"mcc" : "0742",
"mid" : "FNX7CwmebftudY7i5mA4qF6XT",
"merchant_name" : "Petes Coffee",
"settlement_funding_identifier" : "UNSET",
"ready_to_settle_upon" : "RECONCILIATION",
"fee_ready_to_settle_upon" : "RECONCILIATION",
"level_two_level_three_data_enabled" : false,
"created_at" : "2022-01-27T07:36:58.19Z",
"updated_at" : "2022-01-27T07:36:58.46Z",
"onboarding_state" : "APPROVED",
"processor_details" : {
"mid" : "FNX7CwmebftudY7i5mA4qF6XT",
"api_key" : "secretValue"
},
"_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/VIdikDHXv7x8nWyJg8JZemGx"
}
}
}
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. |