A Merchant
resource represents the entity's merchant account on a processor.
You need to create and successfully validate a Merchant
before processing any payments for your merchant.
Related Guides: Getting Started, Onboarding
Create a Merchant
to start the underwriting (also called provisioning) process for your seller. Merchants
must be created under an Identity
.
A bank account must be associated with the previously created Identity
before a Merchant
can be successfully onboarded and verified.
Accept | string Default: application/hal+json |
Finix-Version | string Default: 2018-01-01 Specify the API version of your request. For more details, see Versioning. Example: 2022-02-01 |
gateway | string Name of the gateway that processes the |
default_partial_authorization_enabled | boolean Default: false
|
processor required | string or null Set the acquiring processor. Avalible values include:
|
object or null Include up to 50
(e.g., |
Single Merchant object
Error
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Error
{- "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": "Bobs Burgers",
- "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": {
- "verifications": {
}, - "merchant_profile": {
}, - "application": {
}, - "verification": {
}
}
}
Retrieve a list of Merchants
.
List of Merchants objects
Error
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl "https://finix.sandbox-payments-api.com/merchants" \ -H "Finix-Version: 2022-02-01" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "_embedded": {
- "merchants": [
- {
- "id": "MUk3936kZweevCrjyHLN1vsu",
- "created_at": "2022-10-10T05:20:18.12Z",
- "updated_at": "2022-10-10T05:21:01.42Z",
- "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": "IDx2ZETjYiWkbitkYdFt1yLF",
- "level_two_level_three_data_enabled": false,
- "mcc": "4900",
- "merchant_name": "Finix Flowers",
- "merchant_profile": "MPnXB4UBGtSUfxwA41z2Hqid",
- "mid": "FNXqeJt93ojP2cn1VUYtXANCF",
- "onboarding_state": "APPROVED",
- "processing_enabled": true,
- "processor": "DUMMY_V1",
- "processor_details": {
- "mid": "FNXqeJt93ojP2cn1VUYtXANCF",
- "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": "VItUgbe9V8vpgSaJAriLDxER",
- "_links": {
- "verifications": {
}, - "merchant_profile": {
}, - "application": {
}, - "verification": {
}
}
}, - {
- "id": "MU951dfkbH7nqVm4G91yb2au",
- "created_at": "2022-09-21T17:46:06.29Z",
- "updated_at": "2022-09-21T17:46:09.45Z",
- "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": "ID4YPdRriet29ZhaiVa6qhJ5",
- "level_two_level_three_data_enabled": false,
- "mcc": "4900",
- "merchant_name": "Petes Coffee",
- "merchant_profile": "MPo85BavSYVrkDn57BLh1JTs",
- "mid": "FNXkitpwdmgMJ8Vz9FxKBCSza",
- "onboarding_state": "APPROVED",
- "processing_enabled": true,
- "processor": "DUMMY_V1",
- "processor_details": {
- "mid": "FNXkitpwdmgMJ8Vz9FxKBCSza",
- "api_key": "secretValue"
}, - "ready_to_settle_upon": "RECONCILIATION",
- "rent_surcharges_enabled": false,
- "settlement_enabled": true,
- "settlement_funding_identifier": "UNSET",
- "surcharges_enabled": false,
- "tags": {
- "key": "value_2"
}, - "verification": "VIrjCZHf8v8arhbgPTikKmpp",
- "_links": {
- "verifications": {
}, - "merchant_profile": {
}, - "application": {
}, - "verification": {
}
}
}
]
}, - "_links": {
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 1669
}
}
Retrieve the details of a Merchant
.
Single Merchant object
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl "https://finix.sandbox-payments-api.com/merchants/MUmUL7aBsHkxVLQawJxEXw6N" \ -H "Content-Type: application/json" \ -H "Finix-Version: 2022-02-01" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "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": "Bobs Burgers",
- "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": {
- "verifications": {
}, - "merchant_profile": {
}, - "application": {
}, - "verification": {
}
}
}
Update a Merchant
to:
Identity
information saved with the underlying processorMerchant
so the seller can't create new Transfers
and Authorizations
Accept | string Default: application/hal+json |
Finix-Version | string Default: 2018-01-01 Specify the API version of your request. For more details, see Versioning. Example: 2022-02-01 |
Single Merchant object
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
{- "id": "MUeDVrf2ahuKc9Eg5TeZugvs",
- "created_at": "2022-01-27T07:37:04.03Z",
- "updated_at": "2022-01-27T07:37:06.12Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "card_cvv_required": false,
- "card_expiration_date_required": true,
- "convenience_charges_enabled": true,
- "creating_transfer_from_report_enabled": true,
- "default_partial_authorization_enabled": false,
- "fee_ready_to_settle_upon": "SUCCESSFUL_CAPTURE",
- "gateway": null,
- "gross_settlement_enabled": false,
- "identity": "IDuqZpDw28f2KK6YuDk4jNLg",
- "level_two_level_three_data_enabled": true,
- "mcc": "4900",
- "merchant_name": "Finix Flowers",
- "merchant_profile": "MP7tbAZ1RpjFycrfBVo6z4Ky",
- "mid": "FNXw5a7pBKHsCSgCAyQvU2soL",
- "onboarding_state": "APPROVED",
- "processing_enabled": false,
- "processor": "DUMMY_V1",
- "processor_details": {
- "mid": "FNXw5a7pBKHsCSgCAyQvU2soL",
- "api_key": "secretValue"
}, - "ready_to_settle_upon": "SUCCESSFUL_CAPTURE",
- "rent_surcharges_enabled": true,
- "settlement_enabled": true,
- "settlement_funding_identifier": "UNSET",
- "surcharges_enabled": false,
- "tags": {
- "key_2": "value_2"
}, - "verification": "VI5DBvVQ3ye5PcnUCSSvj84d",
- "_links": {
- "verifications": {
}, - "merchant_profile": {
}, - "application": {
}, - "verification": {
}
}
}
Verify a Merchant
if the onboarding_state
for a Merchant
returns FAILED, or if the correct the seller needs to update the saved in their information Identity
.
Related Guides: Onboarding Process
Accept | string Default: application/hal+json |
Finix-Version | string Default: 2018-01-01 Specify the API version of your request. For more details, see Versioning. Example: 2022-02-01 |
Single Verification object
Error
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
{- "id": "VIecViWTa71vFvgTgD3m8pyL",
- "created_at": "2023-10-17T23:50:21.71Z",
- "updated_at": "2023-10-17T23:50:21.76Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "identity": null,
- "merchant": "MUucec6fHeaWo3VHYoSkUySM",
- "merchant_identity": "IDpYDM7J9n57q849o9E9yNrG",
- "messages": [ ],
- "payment_instrument": null,
- "payment_instrument_verification_details": {
- "push_to_card_domestic": null,
- "push_to_card_cross_border": null,
- "card_type": null,
- "billing_currency": null,
- "issuer_country": null
}, - "processor": "DUMMY_V1",
- "raw": null,
- "state": "PENDING",
- "tags": { },
- "trace_id": "7ba9a29a-8988-48bb-9c0e-3b1889aa1f6c",
- "type": "MERCHANT",
- "_links": {
- "application": {
},
}
}