Deprecated API Reference

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

List Funding Transfers in a Batch Settlement

List the Transfers of type CREDIT or DEBIT that result from issuing a Settlement.

Copy
Copied
curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_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" : "TRkwxPhCf3qChKFEVGhDjr76",
      "created_at" : "2022-08-12T21:46:12.97Z",
      "updated_at" : "2022-08-12T21:47:06.65Z",
      "additional_buyer_charges" : null,
      "additional_healthcare_data" : null,
      "address_verification" : null,
      "amount" : 102,
      "amount_requested" : 102,
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "currency" : "USD",
      "destination" : "PIrFpayBAQcqK35HMQgRfaqD",
      "externally_funded" : "UNKNOWN",
      "failure_code" : null,
      "failure_message" : null,
      "fee" : 0,
      "idempotency_id" : null,
      "merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
      "messages" : [ ],
      "raw" : null,
      "ready_to_settle_at" : null,
      "security_code_verification" : null,
      "source" : null,
      "state" : "SUCCEEDED",
      "statement_descriptor" : null,
      "subtype" : "SETTLEMENT_PLATFORM",
      "tags" : { },
      "trace_id" : "d4a6df17-f581-42d0-ac70-ad6770acd5c4",
      "type" : "CREDIT",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/payment_instruments"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/reversals"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/fees"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRkwxPhCf3qChKFEVGhDjr76/disputes"
        },
        "destination" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIrFpayBAQcqK35HMQgRfaqD"
        }
      }
    }, {
      "id" : "TRxb61dJ6PvGcvyS2L2B9SZE",
      "created_at" : "2022-08-12T21:46:12.98Z",
      "updated_at" : "2022-08-12T21:47:05.26Z",
      "additional_buyer_charges" : null,
      "additional_healthcare_data" : null,
      "address_verification" : null,
      "amount" : 2,
      "amount_requested" : 2,
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "currency" : "USD",
      "destination" : null,
      "externally_funded" : "UNKNOWN",
      "failure_code" : null,
      "failure_message" : null,
      "fee" : 0,
      "idempotency_id" : null,
      "merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
      "messages" : [ ],
      "raw" : null,
      "ready_to_settle_at" : null,
      "security_code_verification" : null,
      "source" : "PIm8mdyYcEnYAZLLyw8g59Pw",
      "state" : "SUCCEEDED",
      "statement_descriptor" : null,
      "subtype" : "SETTLEMENT_MERCHANT",
      "tags" : { },
      "trace_id" : "e192bc39-0909-4da9-b4c2-022a84ae3984",
      "type" : "DEBIT",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/payment_instruments"
        },
        "reversals" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/reversals"
        },
        "fees" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/fees"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRxb61dJ6PvGcvyS2L2B9SZE/disputes"
        },
        "source" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIm8mdyYcEnYAZLLyw8g59Pw"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers?after_cursor=TRxb61dJ6PvGcvyS2L2B9SZE"
    }
  },
  "page" : {
    "limit" : 100,
    "next_cursor" : "TRxb61dJ6PvGcvyS2L2B9SZE"
  }
}

HTTP Request

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

URL Parameters

Parameter Description
:SETTLEMENT_ID ID of the Settlement