v1

latestOpenAPI 3.0.22026-08-061303782.1 MB

Payment Instrument Associations

Create a Payment Instrument Association

Create a Payment Instrument Association to associate a Payment Instrument with a Merchant for fee assignment purposes.

post/payment_instrument_associations

Headers

Finix-Versionstring

Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring

Example:application/json

The data type being sent in the request body must be application/json.

Request body

merchant_idstring required

The ID of the Merchant that fees will be applied to.

payment_instrument_idstring required

The ID of the Payment Instrument whose events will be charged to the specified merchant.

tagsTags nullable

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. (For example, order_number: 25, item_type: produce, department: sales)

Example request

{
  "merchant_id": "MUcgYZswyRfqSSbvMsxuaHxZ",
  "payment_instrument_id": "PIcgYZswyRfqSSbvMsxuaHxZ"
}

Response

A single Payment Instrument Association

idstring

The ID of the Payment Instrument Association.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

application_idstring

The ID of the Application the resource was created under.

enabledboolean

Indicates whether this current Payment Instrument Association is enabled.

instrument_idstring

The ID of the Payment Instrument whose events will be charged to the specified merchant.

merchant_idstring

The ID of the Merchant that fees will be applied to.

tagsTags nullable

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. (For example, order_number: 25, item_type: produce, department: sales)

Example response

{
  "id": "instrument_association_9xZ6pUo5fXb7aAB4o3TqkK",
  "application_id": "APxxx",
  "instrument_id": "PIcgYZswyRfqSSbvMsxuaHxZ",
  "merchant_id": "MUcgYZswyRfqSSbvMsxuaHxZ"
}