List all Batch Settlements

List the Transfers of type CREDIT that result from issuing funding instructions for the Settlement.

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

Example Response:

Copy
Copied
{
  "_embedded" : {
    "settlements" : [ {
      "id" : "STmCc8GbjjX33SdymwNhb9Et",
      "application" : "AP3AB2itAWrrrPVS6spvrGYp",
      "tags" : {
        "Internal Daily Settlement ID" : "21DFASJSAKAS"
      },
      "identity" : "IDqvpp6sfYBLxDsYNeFRdYeF",
      "currency" : "USD",
      "merchant_id" : "MUfBgBvvv355djUi4uXQKtit",
      "created_at" : "2021-05-25T00:25:04.98Z",
      "updated_at" : "2021-05-25T00:35:02.21Z",
      "processor" : "DUMMY_V1",
      "type" : "MERCHANT_REVENUE",
      "funds_flow" : null,
      "payment_type" : null,
      "total_amount" : -888888,
      "total_fees" : 0,
      "total_fee" : 0,
      "net_amount" : -888888,
      "destination" : null,
      "status" : "AWAITING_APPROVAL",
      "_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"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 1
  }
}

HTTP Request

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

URL Parameters

Parameter Description
:SETTLEMENT_ID ID of the Settlement