Deprecated API Reference

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

Fetch a Batch Settlement

Fetch a previously created Settlement.

Copy
Copied
curl https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  USpumes23XhzHwXqiy9bfX2B:c69d39e3-f9ff-4735-8c3e-abca86441906

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

GET https://finix.sandbox-payments-api.com/settlements/:SETTLEMENT_ID

URL Parameters

Parameter Description
:SETTLEMENT_ID ID of the Settlement