Deprecated API Reference

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

List Transfers in a Batch Settlement

List the batch of Transfers of type DEBIT and REFUND that comprise the net settled amount of a Settlement.

Copy
Copied
curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Example Response:

Copy
Copied
{
  "_embedded" : {
    "transfers" : [ {
      "id" : "TR8yiKY6ju988aUZhfqJFjag",
      "created_at" : "2022-08-12T16:56:01.90Z",
      "updated_at" : "2022-08-12T16:56:01.90Z",
      "additional_buyer_charges" : null,
      "additional_healthcare_data" : null,
      "address_verification" : null,
      "amount" : 100,
      "amount_requested" : 100,
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "currency" : "USD",
      "destination" : null,
      "externally_funded" : "FALSE",
      "failure_code" : null,
      "failure_message" : null,
      "fee" : 0,
      "fee_type" : "CARD_FIXED",
      "idempotency_id" : null,
      "merchant_identity" : "IDddHpRqwf2VsH2XB1fmLfhM",
      "messages" : [ ],
      "raw" : null,
      "ready_to_settle_at" : "2022-08-12T22:15:02.69Z",
      "security_code_verification" : null,
      "source" : null,
      "state" : "SUCCEEDED",
      "statement_descriptor" : null,
      "subtype" : "PLATFORM_FEE",
      "tags" : { },
      "trace_id" : "272fe816-2dd1-46ed-a7e7-9041d7a8f0ff",
      "type" : "FEE",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TR8yiKY6ju988aUZhfqJFjag"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TR8yiKY6ju988aUZhfqJFjag/payment_instruments"
        },
        "parent" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb"
        },
        "fee_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8"
        }
      }
    }, {
      "id" : "TRwgubpxAJWbaDZE1kKP6SSi",
      "created_at" : "2022-08-12T16:56:01.90Z",
      "updated_at" : "2022-08-12T16:56:01.90Z",
      "additional_buyer_charges" : null,
      "additional_healthcare_data" : null,
      "address_verification" : null,
      "amount" : 2,
      "amount_requested" : 2,
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "currency" : "USD",
      "destination" : null,
      "externally_funded" : "FALSE",
      "failure_code" : null,
      "failure_message" : null,
      "fee" : 0,
      "fee_type" : "CARD_BASIS_POINTS",
      "idempotency_id" : null,
      "merchant_identity" : "IDddHpRqwf2VsH2XB1fmLfhM",
      "messages" : [ ],
      "raw" : null,
      "ready_to_settle_at" : "2022-08-12T22:15:02.69Z",
      "security_code_verification" : null,
      "source" : null,
      "state" : "SUCCEEDED",
      "statement_descriptor" : null,
      "subtype" : "PLATFORM_FEE",
      "tags" : { },
      "trace_id" : "5e2dbd9c-1ad1-4e36-8d16-cfedd3bce385",
      "type" : "FEE",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRwgubpxAJWbaDZE1kKP6SSi"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRwgubpxAJWbaDZE1kKP6SSi/payment_instruments"
        },
        "parent" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb"
        },
        "fee_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8"
        }
      }
    }, {
      "id" : "TRm9ppvqX43CbwmNzhckf2gb",
      "created_at" : "2022-08-12T16:55:47.66Z",
      "updated_at" : "2022-08-12T16:56:02.19Z",
      "additional_buyer_charges" : null,
      "additional_healthcare_data" : null,
      "address_verification" : null,
      "amount" : 100,
      "amount_requested" : 100,
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "currency" : "USD",
      "destination" : null,
      "externally_funded" : "FALSE",
      "failure_code" : null,
      "failure_message" : null,
      "fee" : 0,
      "idempotency_id" : null,
      "merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
      "messages" : [ ],
      "raw" : null,
      "ready_to_settle_at" : "2022-08-12T04:00:00.00Z",
      "security_code_verification" : null,
      "source" : "PIe2YvpcjvoVJ6PzoRPBK137",
      "state" : "SUCCEEDED",
      "statement_descriptor" : "FNX*DUNDER MIFFLIN",
      "subtype" : "API",
      "tags" : { },
      "trace_id" : "381f1f6f-492b-4101-9a57-40001a59813a",
      "type" : "DEBIT",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/payment_instruments"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/reversals"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/fees"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRm9ppvqX43CbwmNzhckf2gb/disputes"
        },
        "source" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137"
        },
        "fee_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers?after_cursor=TRm9ppvqX43CbwmNzhckf2gb"
    }
  },
  "page" : {
    "limit" : 100,
    "next_cursor" : "TRm9ppvqX43CbwmNzhckf2gb"
  }
}

HTTP Request

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

URL Parameters

Parameter Description
:SETTLEMENT_ID ID of the Settlement