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
.
curl https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers \
-H "Content-Type: application/vnd.json+api" \
-u USpumes23XhzHwXqiy9bfX2B:c69d39e3-f9ff-4735-8c3e-abca86441906
Example Response:
{
"_embedded" : {
"transfers" : [ {
"id" : "TR7GnL3N1mNLhCzqgk7o49Fr",
"amount" : 888888,
"tags" : { },
"state" : "SUCCEEDED",
"trace_id" : "20c62114-ba15-4d8a-9227-3012417d3b83",
"currency" : "USD",
"application" : "APpLzXocRgscUduT8y9JTAMm",
"source" : null,
"destination" : "PIoQp9o3LX9ZiqzzFKJ6aAGx",
"ready_to_settle_at" : "2020-04-08T02:09:12.01Z",
"fee" : 0,
"statement_descriptor" : null,
"type" : "DISPUTE",
"messages" : [ ],
"raw" : null,
"created_at" : "2020-04-08T02:09:11.85Z",
"updated_at" : "2020-04-08T02:09:11.60Z",
"idempotency_id" : null,
"merchant_identity" : "ID5So7oZKfiwco2JTgMq93zR",
"subtype" : "MERCHANT_DEBIT",
"_links" : {
"application" : {
"href" : "https://finix.sandbox-payments-api.com/applications/APpLzXocRgscUduT8y9JTAMm"
},
"self" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TR7GnL3N1mNLhCzqgk7o49Fr"
},
"merchant_identity" : {
"href" : "https://finix.sandbox-payments-api.com/identities/ID5So7oZKfiwco2JTgMq93zR"
},
"payment_instruments" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TR7GnL3N1mNLhCzqgk7o49Fr/payment_instruments"
},
"disputed_transfer" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TR7GnL3N1mNLhCzqgk7o49Fr/disputed_transfer"
},
"destination" : {
"href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIoQp9o3LX9ZiqzzFKJ6aAGx"
},
"fee_profile" : {
"href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPd5aAm6YaZojrj78Cr3jTek"
}
}
}, {
"id" : "TRdfudN6n8RgcsoKB92Q5kSD",
"amount" : 888888,
"tags" : { },
"state" : "SUCCEEDED",
"trace_id" : "5834f0ff-e2c7-4d57-a419-084f0702da58",
"currency" : "USD",
"application" : "APpLzXocRgscUduT8y9JTAMm",
"source" : null,
"destination" : null,
"ready_to_settle_at" : "2020-04-08T02:09:12.28Z",
"fee" : 0,
"statement_descriptor" : null,
"type" : "DISPUTE",
"messages" : [ ],
"raw" : null,
"created_at" : "2020-04-08T02:09:12.17Z",
"updated_at" : "2020-04-08T02:09:11.60Z",
"idempotency_id" : null,
"merchant_identity" : "ID8bW3W9DmKEgFYF4GfDJ8or",
"subtype" : "PLATFORM_CREDIT",
"_links" : {
"application" : {
"href" : "https://finix.sandbox-payments-api.com/applications/APpLzXocRgscUduT8y9JTAMm"
},
"self" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRdfudN6n8RgcsoKB92Q5kSD"
},
"merchant_identity" : {
"href" : "https://finix.sandbox-payments-api.com/identities/ID8bW3W9DmKEgFYF4GfDJ8or"
},
"payment_instruments" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRdfudN6n8RgcsoKB92Q5kSD/payment_instruments"
},
"disputed_transfer" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRdfudN6n8RgcsoKB92Q5kSD/disputed_transfer"
},
"fee_profile" : {
"href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPbXEGtvQ5neByqSbjd8x84j"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://finix.sandbox-payments-api.com/settlements/STvJUxKddVtiZJVLqkqmwJn7/transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
}
},
"page" : {
"offset" : 0,
"limit" : 20,
"count" : 2
}
}
HTTP Request
GET https://finix.sandbox-payments-api.com/settlements/:SETTLEMENT_ID/transfers
URL Parameters
Parameter |
Description |
---|---|
:SETTLEMENT_ID | ID of the Settlement |