Deprecated API Reference

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

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" \
    -H 'Finix-Version:2022-02-01' \
    -u  USpumes23XhzHwXqiy9bfX2B:c69d39e3-f9ff-4735-8c3e-abca86441906

Example Response:

Copy
Copied
{
  "_embedded" : {
    "settlements" : [ {
      "id" : "STdhfJPXLKbC2AQqsxMHZmJr",
      "created_at" : "2022-10-01T23:04:23.02Z",
      "updated_at" : "2022-10-01T23:15:25.96Z",
      "application" : "AP3AB2itAWrrrPVS6spvrGYp",
      "currency" : "USD",
      "destination" : null,
      "funds_flow" : null,
      "identity" : "IDhKZw6H3bbFigSoic3rCnZF",
      "merchant_id" : "MU6yVa8Aw1xJCv6x1y5HB7wF",
      "net_amount" : -10,
      "payment_type" : null,
      "processor" : "DUMMY_V1",
      "status" : "AWAITING_APPROVAL",
      "tags" : { },
      "total_amount" : 0,
      "total_fee" : 10,
      "total_fees" : 10,
      "type" : "MERCHANT_REVENUE",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STdhfJPXLKbC2AQqsxMHZmJr"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDhKZw6H3bbFigSoic3rCnZF"
        },
        "funding_transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STdhfJPXLKbC2AQqsxMHZmJr/funding_transfers"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STdhfJPXLKbC2AQqsxMHZmJr/transfers"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STdhfJPXLKbC2AQqsxMHZmJr/transfers?type=fee"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STdhfJPXLKbC2AQqsxMHZmJr/transfers?type=reverse"
        },
        "credits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STdhfJPXLKbC2AQqsxMHZmJr/transfers?type=credit"
        },
        "debits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STdhfJPXLKbC2AQqsxMHZmJr/transfers?type=debit"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/STdhfJPXLKbC2AQqsxMHZmJr/transfers?type=dispute"
        }
      }
    }, {
      "id" : "ST89JtNBa9iRnzwVoFCSTYC1",
      "created_at" : "2022-06-01T21:24:31.64Z",
      "updated_at" : "2022-06-01T21:45:26.32Z",
      "application" : "AP3AB2itAWrrrPVS6spvrGYp",
      "currency" : "USD",
      "destination" : null,
      "funds_flow" : null,
      "identity" : "IDhq2EiQko6bHjZs27CR9B3Y",
      "merchant_id" : "MUeZcPncpB9STVRRVRzfkrTf",
      "net_amount" : -10,
      "payment_type" : null,
      "processor" : "DUMMY_V1",
      "status" : "AWAITING_APPROVAL",
      "tags" : { },
      "total_amount" : 0,
      "total_fee" : 10,
      "total_fees" : 10,
      "type" : "MERCHANT_REVENUE",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST89JtNBa9iRnzwVoFCSTYC1"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDhq2EiQko6bHjZs27CR9B3Y"
        },
        "funding_transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST89JtNBa9iRnzwVoFCSTYC1/funding_transfers"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST89JtNBa9iRnzwVoFCSTYC1/transfers"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST89JtNBa9iRnzwVoFCSTYC1/transfers?type=fee"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST89JtNBa9iRnzwVoFCSTYC1/transfers?type=reverse"
        },
        "credits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST89JtNBa9iRnzwVoFCSTYC1/transfers?type=credit"
        },
        "debits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST89JtNBa9iRnzwVoFCSTYC1/transfers?type=debit"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST89JtNBa9iRnzwVoFCSTYC1/transfers?type=dispute"
        }
      }
    }, {
      "id" : "ST2H2MdEnwHGu7WJMp9PTEVq",
      "created_at" : "2022-06-01T21:23:17.68Z",
      "updated_at" : "2022-06-01T21:45:26.43Z",
      "application" : "AP3AB2itAWrrrPVS6spvrGYp",
      "currency" : "USD",
      "destination" : null,
      "funds_flow" : null,
      "identity" : "IDtjKWpLzVDQxY69oe1UatmM",
      "merchant_id" : "MUv7sAMnixoGKBVxAxAf6veV",
      "net_amount" : -10,
      "payment_type" : null,
      "processor" : "DUMMY_V1",
      "status" : "AWAITING_APPROVAL",
      "tags" : { },
      "total_amount" : 0,
      "total_fee" : 10,
      "total_fees" : 10,
      "type" : "MERCHANT_REVENUE",
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST2H2MdEnwHGu7WJMp9PTEVq"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/AP3AB2itAWrrrPVS6spvrGYp"
        },
        "identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDtjKWpLzVDQxY69oe1UatmM"
        },
        "funding_transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST2H2MdEnwHGu7WJMp9PTEVq/funding_transfers"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST2H2MdEnwHGu7WJMp9PTEVq/transfers"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST2H2MdEnwHGu7WJMp9PTEVq/transfers?type=fee"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST2H2MdEnwHGu7WJMp9PTEVq/transfers?type=reverse"
        },
        "credits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST2H2MdEnwHGu7WJMp9PTEVq/transfers?type=credit"
        },
        "debits" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST2H2MdEnwHGu7WJMp9PTEVq/transfers?type=debit"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/settlements/ST2H2MdEnwHGu7WJMp9PTEVq/transfers?type=dispute"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/?after_cursor=ST2H2MdEnwHGu7WJMp9PTEVq"
    }
  },
  "page" : {
    "limit" : 100,
    "next_cursor" : "ST2H2MdEnwHGu7WJMp9PTEVq"
  }
}

HTTP Request

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

URL Parameters

Parameter Description
:SETTLEMENT_ID ID of the Settlement