Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Settlement Queue Entries

Fetch a Settlement Queue Entry

Retrieve the details of a Settlement Queue Entry created from a Transfer, Fee, or Reversal.

get/settlement_queue_entries/{settlement_queue_entry_id}

Headers

Finix-Versionstring
Example:2022-02-01

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

Response

A single Settlement Queue Entry

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.

application_idstring

ID of the Application the resource was created under.

entity_idstring

The ID of the related resource.

entity_type'ADJUSTMENT' | 'DISPUTE_TRANSFER' | 'FEE' | 'TRANSFER' | 'REVERSE' | 'SPLIT_TRANSFER'

The entity the Settlement Queue Entry is linked to.

merchant_idstring

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

platform_idstring

The unique identifier for the Platform where the entity associated with the Settlement Queue Entry was created.

ready_to_settle_afterstring date-time nullable

A timestamp indicating when the Settlement Queue Entry can be processed for settlement.

state'AWAITING_SETTLEMENT_TIME' | 'PENDING' | 'RELEASED'

The current state of the Settlement Queue Entry.