Processors

A Processor represents the acquiring platform where Merchant accounts get provisioned and ultimately where Transfers are processed. Your Finix point of contact will let you know which processor you should use.

The Finix Payment Platform is processor agnostic which allows transactions to get processed across multiple processors. Once a Processor is enabled, the Application can begin provisioning Merchant accounts.

Related Guides: Related Guides: Onboarding Process

List Application Processors

List all Processors enabled for an Application.

Request
path Parameters
application_id
required
string

ID of Application to use.

Responses
200

List of Processor objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/applications/{application_id}/processors
Request samples
curl https://finix.sandbox-payments-api.com/applications/APmuwPBaW8pVcwb4vCTHQH32/processors \
  -H "Content-Type: application/vnd.api+json" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/hal+json
{
  • "_embedded": {
    • "processors": [
      ]
    },
  • "page": {
    • "offset": 0,
    • "limit": 20,
    • "count": 3
    }
}

Create Application Processor

Enable a Processor for an Application. If created successfully, a 201 status is returned with a location header added to the response which refers to the newly enabled processor.

Request
path Parameters
application_id
required
string

ID of Application to use.

Request Body schema: application/hal+json
tags
object or null

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500.

(e.g., order number: 25, item_type: produce, department: sales, etc.)

type
required
string non-empty

The type of processor. Use DUMMY_V1 for sandbox.

Responses
201

Single Processor object

400

Error

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

post/applications/{application_id}/processors
Request samples
curl https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/processors \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X POST \
  -d '
  {
    "config": {
      "canDebitBankAccount": true
    },
    "type": "DUMMY_V1"
  }'
Response samples
application/hal+json
{
  • "id": "PR9DvbgX5uuhqyKuBBD6VmFi",
  • "created_at": "2022-04-29T18:29:23.07Z",
  • "updated_at": "2022-04-29T18:29:22.97Z",
  • "application": "APdHjTsAPx81go7ekSMJqQdz",
  • "application_config": {
    • "key1": "value-1",
    • "key2": "value-2",
    • "can_debit_bank_account": true,
    • "allow_split_payouts": false,
    • "ach_immediate_destination_name": null,
    • "default_currencies": [
      ],
    • "ach_settlement_delay_days": null,
    • "default_level_two_level_three_data_enabled": false,
    • "template_countries_available": [ ],
    • "alert_on_unknown_merchants": false
    },
  • "config": {
    • "key1": "value-1",
    • "key2": "value-2",
    • "canDebitBankAccount": true
    },
  • "default_merchant_profile": "MPpWCidKDfKZARSJKCAW3kex",
  • "enabled": true,
  • "processor": "DUMMY_V1",
  • "system_config": null,
}

Fetch Application Processors

Get the Processors for an Application by type.

Request
path Parameters
application_id
required
string

ID of Application to use.

type
required
string

Type of Processor.

Responses
200

Single Processor object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/applications/{application_id}/processors/{type}
Request samples
curl https://finix.sandbox-payments-api.com/applications/APdHjTsAPx81go7ekSMJqQdz/processors/DUMMY_V1 \
  -H "Content-Type: application/vnd.api+json" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/hal+json
{
  • "id": "PR9DvbgX5uuhqyKuBBD6VmFi",
  • "created_at": "2022-04-29T18:29:23.07Z",
  • "updated_at": "2022-04-29T18:29:22.97Z",
  • "application": "APdHjTsAPx81go7ekSMJqQdz",
  • "application_config": {
    • "key1": "value-1",
    • "key2": "value-2",
    • "can_debit_bank_account": true,
    • "allow_split_payouts": false,
    • "ach_immediate_destination_name": null,
    • "default_currencies": [
      ],
    • "ach_settlement_delay_days": null,
    • "default_level_two_level_three_data_enabled": false,
    • "template_countries_available": [ ],
    • "alert_on_unknown_merchants": false
    },
  • "config": {
    • "key1": "value-1",
    • "key2": "value-2",
    • "canDebitBankAccount": true
    },
  • "default_merchant_profile": "MPpWCidKDfKZARSJKCAW3kex",
  • "enabled": true,
  • "processor": "DUMMY_V1",
  • "system_config": null,
}