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

Response Schema: application/hal+json
object

Details the page that's returned.

object

List of Processors objects.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

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.json+api" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/hal+json
{
  • "_embedded": {
    • "processors": [
      ]
    },
  • "page": {
    • "offset": 0,
    • "limit": 20,
    • "count": 2
    }
}

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
object

Key value pair for annotating custom meta data (e.g. order numbers).

type
required
string non-empty

The type of processor. Use DUMMY_V1 for sandbox.

Responses
201

Single Processor object

Response Schema: application/hal+json
id
string

ID of the Processor resource.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

application
string

The ID of the Application resource.

object or null

Details that configure how the Processor handles transactions.

default_merchant_profile
string

The ID of the Merchant Profile resource used to create the Processor.

enabled
boolean

Details if the Processor resource is enabled. Set to false to disable the Processor.

processor
string

The name of the processor.

object or null

Details that configure how the Processor handles transactions with the processor.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

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
Response samples
application/hal+json
{}

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

Response Schema: application/hal+json
id
string

ID of the Processor resource.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

application
string

The ID of the Application resource.

object or null

Details that configure how the Processor handles transactions.

default_merchant_profile
string

The ID of the Merchant Profile resource used to create the Processor.

enabled
boolean

Details if the Processor resource is enabled. Set to false to disable the Processor.

processor
string

The name of the processor.

object or null

Details that configure how the Processor handles transactions with the processor.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

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.json+api" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/hal+json
{}