Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Split Transfers

Fetch a Split Transfer

Fetch a Split Transfer that was created from a split transaction.

get/split_transfers/{split_transfer_id}

Headers

Finix-Versionstring
Example:2022-02-01

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

Response

A single Split Transfer

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

amountinteger

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

feeinteger

The minimum amount of the Transfer you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the amount).

  • If the fees applied by the 'Fee Profile' are higher than the value passed in 'fee', 'fee' will not be applied and have no effect.
  • If the fees applied by the 'Fee Profile' are lower than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the Fee Profile.
    • The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the Fee Profile.
currency'CAD' | 'USD'

ISO 4217 3-letter currency code.

parent_transfer_idstring

The ID of the original parent Transfer that was split.

ready_to_settle_atstring date-time nullable

The timestamp of when the Transfer is ready to be settled.

type'DEBIT' | 'DISPUTE_MERCHANT_DEBIT' | 'DISPUTE_MERCHANT_CREDIT'

The type of Split Transfer.

  • DEBIT: Standard Split Transfer from a split transaction where the parent Transfer debits the buyer's card.
  • DISPUTE_MERCHANT_DEBIT: A Split Transfer created when a Dispute pulls funds from merchants proportionally. Created when the parent adjustment transfer has type: DISPUTE and subtype: MERCHANT_DEBIT.
  • DISPUTE_MERCHANT_CREDIT: A Split Transfer created when a Dispute is ruled in favor of the Merchant and funds are returned proportionally. Created when the parent adjustment Transfer has type: DISPUTE and subtype: MERCHANT_CREDIT.
merchant_idstring

The ID of the Merchant resource the Split Transfer was created for and will settle under.

identity_idstring

The ID of Identity resource used by the Merchant the Split Transfer was created for.

fee_profile_idstring

The Fee Profile associated to this Split Transfer.

application_idstring

ID of the Application the resource was created under.

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

{
  "amount": 5000,
  "parent_transfer_id": "TR7h8NxhCDHunLFdJ1HCLp4r"
}