Sign in

v2

latestOpenAPI 3.0.22026-08-081303782.1 MB
Settlements

Fetch a Settlement

Retrieve the details of an existing Settlement.

get/settlements/{settlement_id}

Headers

Finix-Versionstring
Example:2022-02-01

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

Response

A single Settlement

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.

applicationstring

ID of the Application the resource was created under.

currency'CAD' | 'USD'

ISO 4217 3-letter currency code.

destinationstring nullable

ID of the Payment Instrument where funds will be sent.

funds_flowstring nullable

Details how funds will be dispersed in the Funding Transfer (usually null).

identitystring

The ID of the Identity used to create the Settlement resource.

is_exceptionboolean

Returns true if the Settlement contains items that were removed from a previous Settlement.

merchant_idstring

The ID of the Merchant used to create the Settlement resource.

net_amountinteger

The amount in cents that will be deposited into the merchant's bank account.

payment_typestring nullable

The type of Payment Instrument used in the Funding Transfer (or the original payment).

payout_profile_idstring

The ID of the Payout Profile that was used to generate the Settlement.

processorstring

The name of the processor.

status'APPROVED' | 'AWAITING_APPROVAL'

The status of the Settlement. Merchants only receive payouts when Settlements are APPROVED. For more information, see Payouts.

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)
total_amountinteger

The total amount of the Settlement in cents.

total_feeinteger

The sum of the fees in the Settlement.

total_feesinteger

The sum of the fees in the Settlement, including subscription billing fees.

type'MERCHANT_REVENUE' | 'PLATFORM_FEE' | 'PARTNER_FEE' | 'NOOP' | 'MERCHANT' | 'APPLICATION' | 'PLATFORM'

The type of Settlement.

Example response

{
  "destination": "PIxxxxxxxxxxxxxxxxxx"
}