Close Current Active Settlement

Close the currently accruing settlement.

Finix, by default, creates accruing settlements then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement.

The closed Settlement will not accrue any further transactions and gets immediately submitted for approval.

  • This endpoint is only available to Finix Core customers. If you have any questions, please contact the Finix Support Team.
  • Any refunded Transfers get included in Settlements as a deduction.
  • PENDING Transfers don't get included in Settlements.
  • The total_amount minus the total_fee equals the net_amount. The net_amount is the amount in cents that gets deposited into the seller's bank account.

Related Guides: Accruing Settlements

Request
path Parameters
identity_id
required
string

ID of the Identity for the merchant you want to settle.

Request Body schema: application/hal+json
currency
string

ISO 4217 3 letter currency code.

Enum: "AED" "AFN" "ALL" "AMD" "ANG" … 174 more
merchant_id
string

If the Application has more than one associated processor, this field is required.

processor
string

If the Application has more than one associated processor, it's required when creating settlements to include the processor (e.g. DUMMY_V1).

tags
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.

(e.g., order number: 25, item_type: produce, department: sales, etc.)

Responses
201

Settlement object.

400

Error

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Merchant identity disabled error

post/identities/{identity_id}/settlements
Request samples
curl https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj/settlements \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X POST \
  -d '
  {
    "currency": "USD",
    "processor": "DUMMY_V1",
    "tags": {
      "Internal Daily Settlement ID": "21DFASJSAKAS"
    }
  }'
Response samples
application/hal+json
{}

List All Settlements

Retrieve a list of Settlements.

Request
query Parameters
created_at.gte
string

Filter where created_at is after the given date.

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

Filter where created_at is before the given date.

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

Filter where updated_at is after the given date.

updated_at.lte
string

Filter where updated_at is before the given date.

id
string

Filter by id.

limit
integer

The numbers of items to return.

Example: limit=10
transfer_id
string

Filter by a transfer_id a Settlement has accrued.

funding_transfer_id
string

Filter by a funding_transfer a Settlement has created.

Responses
200

List of Settlement objects

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

get/settlements
Request samples
curl https://finix.sandbox-payments-api.com/settlements/ \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Fetch a Settlement

Retreive the details of a Settlement.

Request
path Parameters
settlement_id
required
string

ID of Settlement object.

Responses
200

Settlement object.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/settlements/{settlement_id}
Request samples
curl https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

List Settlement Funding Transfers

List the funding Transfers that were created when a Settlement was approved that have type CREDIT or DEBIT.

Request
path Parameters
settlement_id
required
string

ID of Settlement object.

query Parameters
limit
integer

The numbers of items to return.

Example: limit=10
Responses
200

List of Transfer objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/settlements/{settlement_id}/funding_transfers
Request samples
curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Delete Settlement Transfers

Remove a Transfer that makes up a Settlement.

As long as the Settlement hasn't been funded, you can remove the Transfer or an array of Transfers, along with its corresponding fee from the encompassing Settlement.

  • Funding transfers can't be deleted.

Per the JSON API for deleting a resource, our API doesn't have a response body when removing a Transfer from a Settlement.

Request
path Parameters
settlement_id
required
string

ID of Settlement object.

Request Body schema: application/hal+json
transfers
Array of strings

ID of Transfer resource.

Responses
204

No content

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

delete/settlements/{settlement_id}/transfers
Request samples
curl https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X DELETE \
  -d '
  {
    "transfers": [
      "TRr61njQxaa7AJf6E1C3QwCc"
    ]
  }'
Response samples
application/hal+json
{
  • "total": 0,
  • "_embedded": {
    • "errors": [
      ]
    }
}

List all Transfers in a Settlement

Retrieve a list of every Transfer in a Settlement that has type DEBIT or REFUND.

Request
path Parameters
settlement_id
required
string

ID of Settlement object.

query Parameters
limit
integer

The numbers of items to return.

Example: limit=10
Responses
200

List of Transfer objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/settlements/{settlement_id}/transfers
Request samples
curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}