Review Queue Items

Funds are released to sub-merchants when a Settlement's corresponding Review Queue Item is marked as ACCEPTED by a user with the appropriate role permissions.

List Review Queue Items

Retrieve a list of Review Queue Item 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=SETTLEMENT_V2
id
string

Filter by id.

limit
integer

The numbers of items to return.

Example: limit=10
outcome
string

Filter by outcome.

Example: outcome=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 Review Queue Item objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

422

Invalid field

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

Fetch a Review Queue Item

Retrieve the details of a Review Queue Item corresponding to a Settlement.

Request
path Parameters
review_queue_item_id
required
string

The ID of the Review Queue Item.

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 Review Queue Item object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

422

Invalid field

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

Update a Review Queue Item

Update an existing Review Queue Item resource.

Request
path Parameters
review_queue_item_id
required
string

The ID of the Review Queue Item.

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
outcome
string

The current status of the Review Queue Item.

Enum: "ACCEPTED" "MANUAL_REVIEW" "PENDING" "REJECTED"
object or null

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)
Responses
200

A single Review Queue Item object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

422

Invalid field

put/review_queue/{review_queue_item_id}
Request samples 
Response samples 
application/json
{}