Settlement Queue Entries

A Settlement Queue Entry resource represents an entry in the settlement queue used to track when and how a transfer is queued to be processed.

If a merchant's settlement_queue_mode is set to MANUAL, all transfers will have a Settlement Queue Entry created and will not be placed into settlement until the Settlement Queue Entry is explicitly released using a PUT Update Settlement Queue Entries request.

List Settlement Queue Entries

Retrieve a list of Settlement Queue Entry resources.

For details on how to query endpoints using the available parameters, see Query Parameters.

Request
query Parameters
after_cursor
string

Return every resource created after the cursor value.

Example: after_cursor=TRnasXQ5AmjsLnPMwnme7TL4
application_id
string

Filter by Application ID.

Example: application_id=APgPDQrLD52TYvqazjHJJchM
before_cursor
string

Return every resource created before the cursor value.

Example: before_cursor=TRnasXQ5AmjsLnPMwnme7TL4
created_at.gte
string <date-time>

Filter where created_at is after the given date.

Example: created_at.gte=2022-09-27T11:21:23
created_at.lte
string <date-time>

Filter where created_at is before the given date.

Example: created_at.lte=2022-09-27T11:21:23
entity_id
string

Filter by entity_id.

Example: entity_id=STiuhZx9SQ6B2D72AacxJY3n
entity_type
string

Filter by entity_type.

Example: entity_type=TRANSFER
limit
integer

The numbers of items to return.

Example: limit=10
merchant_id
string

Filter by Merchant ID.

Example: merchant_id=MUeDVrf2ahuKc9Eg5TeZugvs
ready_to_settle_after.gte
string <date-time>

Filter where ready_to_settle_after is after the given date.

Example: ready_to_settle_after.gte=2023-06-28T00:00:00
ready_to_settle_after.lte
string <date-time>

Filter where ready_to_settle_after is before the given date.

Example: ready_to_settle_after.lte=2023-06-28T00:00:00
state
string

Filter by state.

Example: state=PENDING
updated_at.gte
string <date-time>

Filter where updated_at is after the given date.

Example: updated_at.gte=2022-09-27T11:21:23
updated_at.lte
string <date-time>

Filter where updated_at is before the given date.

Example: updated_at.lte=2023-01-21T10:17:22
header Parameters
Finix-Version
string
Default: 2018-01-01

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

Example: 2022-02-01
Responses
200

List of Settlement Queue Entry objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

422

Invalid field

get/settlement_queue_entries
Request samples 
curl "https://finix.sandbox-payments-api.com/settlement_queue_entries" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/json
{}

Update Settlement Queue Entries

This action is used to release a number of Settlement Queue Entry resources, allowing them to be included in a Settlement as Settlement Entry resources.

Request
header Parameters
Finix-Version
string
Default: 2018-01-01

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

Example: 2022-02-01
Request Body schema: application/json
ids
Array of strings

Array of IDs representing the Settlement Queue Entry resources on which to apply the specified action.

action
string

Specify the action to be performed on the Settlement Queue Entry resources. Use the RELEASE action to release a list of Transfer, Fee, or Reversal resources, placing them into a Settlement as corresponding Settlement Entry resources.

Value: "RELEASE"
Responses
204

No content

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

422

Invalid field

put/settlement_queue_entries
Request samples 
Response samples 
application/json
{
  • "total": 0,
  • "_embedded": {
    • "errors": [
      ]
    }
}
Fetch a Settlement Queue Entry
Retrieve the details of a Settlement Queue Entry created from a Transfer, Fee, or Reversal.


Request 
path Parameters
settlement_queue_entry_id
required
string
The ID of the Settlement Queue Entry.


 
header Parameters
Finix-Version
string
 Default:  2018-01-01
Specify the API version of your request. For more details, see Versioning.


 
 Example:  2022-02-01
Responses 
200
A single Settlement Queue Entry object


401
Authentication information is missing or invalid


403
Forbidden


404
Object does not exist


422
Invalid field


get/settlement_queue_entries/{settlement_queue_entry_id}
Request samples 
curl "https://finix.sandbox-payments-api.com/settlement_queue_entries/settlement_queue_entry_cdhqdXjTQfg62wHzJ41g5" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples 
application/json
{}