Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Create a Batch Settlement

Each settlement is comprised of all the Transfers that have a SUCCEEDED state and that have not been previously settled out. In other words, if a merchant has a transfer in the PENDING state it will not be included in the batch settlement. In addition, Settlements will include any refunded Transfers as a deduction. The total_amount minus the total_fee equals the net_amount (the amount in cents that will be deposited into your merchant's bank account).

attention

To view all the Transfers that were included in a Settlement you can make a request to the transfers link (i.e. POST https://finix.sandbox-payments-api.com/settlements/:SETTLEMENT\_ID/transfers

Copy
Copied
curl https://finix.sandbox-payments-api.com/identities/IDqvpp6sfYBLxDsYNeFRdYeF/settlements \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  USpumes23XhzHwXqiy9bfX2B:c69d39e3-f9ff-4735-8c3e-abca86441906 \
    -d '
	{
	    "currency": "USD",
	    "processor": "DUMMY_V1",
	    "tags": {
	        "Internal Daily Settlement ID": "21DFASJSAKAS"
	    }
	}'

Example Response:

Copy
Copied
{
    "id": "STmCc8GbjjX33SdymwNhb9Et",
    "created_at": "2021-05-25T00:25:04.98Z",
    "updated_at": "2022-06-23T22:50:07.60Z",
    "application": "AP3AB2itAWrrrPVS6spvrGYp",
    "currency": "USD",
    "destination": null,
    "funds_flow": null,
    "identity": "IDqvpp6sfYBLxDsYNeFRdYeF",
    "merchant_id": "MUfBgBvvv355djUi4uXQKtit",
    "net_amount": 0,
    "payment_type": null,
    "processor": "DUMMY_V1",
    "status": "AWAITING_APPROVAL",
    "tags": {
        "Internal Daily Settlement ID": "21DFASJSAKAS"
    },
    "total_amount": 0,
    "total_fee": 0,
    "total_fees": 0,
    "type": "MERCHANT_REVENUE",
    "_links": {
        "self": {
            "href": "https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et"
        },
        "application": {
            "href": "https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp"
        },
        "identity": {
            "href": "https://finix.sandbox-payments-api.com/identities/IDqvpp6sfYBLxDsYNeFRdYeF"
        },
        "funding_transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/funding_transfers"
        },
        "transfers": {
            "href": "https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers"
        },
        "fees": {
            "href": "https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=fee"
        },
        "reversals": {
            "href": "https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=reverse"
        },
        "credits": {
            "href": "https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=credit"
        },
        "debits": {
            "href": "https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=debit"
        },
        "disputes": {
            "href": "https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers?type=dispute"
        }
    }
}

HTTP Request

POST https://finix.sandbox-payments-api.com/identities/:IDENTITY_ID/settlements

URL Parameters

Parameter Description
:IDENTITY_ID ID of the Identity for the merchant you wish to settle out

Request Arguments

Field Type Description
currency integer, required 3-letter currency code that the funds should be deposited (e.g. USD)
merchant_id string, required If the Application has more than one processor association, this field is required
processor string, optional If the Application has more than one processor association, it's required to pass the processor (e.g. DUMMY_V1)
tags object, optional Key value pair for annotating custom metadata (e.g. order numbers)