Deprecated API Reference
This API Reference is being deprecated. Please use the New API Reference.
Update a Transfer
curl https://finix.sandbox-payments-api.com/transfers/TRvtThmhZtk56z6dtCt8hUDR \
-H "Content-Type: application/json" \
-H 'Finix-Version: 2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-X PUT \
-d '
{
"tags": {
"order_number": "12121212"
}
}'
Example Response:
{
"id" : "TRvtThmhZtk56z6dtCt8hUDR",
"created_at" : "2022-01-27T07:37:08.65Z",
"updated_at" : "2022-09-09T12:31:59.76Z",
"additional_buyer_charges" : null,
"additional_healthcare_data" : null,
"address_verification" : null,
"amount" : 6031,
"amount_requested" : 6031,
"application" : "APgPDQrLD52TYvqazjHJJchM",
"currency" : "USD",
"destination" : null,
"externally_funded" : "FALSE",
"failure_code" : null,
"failure_message" : null,
"fee" : 603,
"idempotency_id" : null,
"merchant_identity" : "IDpYDM7J9n57q849o9E9yNrG",
"messages" : [ ],
"raw" : null,
"ready_to_settle_at" : "2022-01-27T05:00:00.00Z",
"security_code_verification" : null,
"source" : "PIk3AG7aUSCyNgYpDwCKkwDC",
"state" : "SUCCEEDED",
"statement_descriptor" : "FNX*PETES COFFEE",
"subtype" : "API",
"tags" : {
"order_number" : "12121212"
},
"trace_id" : "fb3daad6-0f01-4133-a765-c1992c56df51",
"type" : "DEBIT",
"_links" : {
"application" : {
"href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
},
"self" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRvtThmhZtk56z6dtCt8hUDR"
},
"merchant_identity" : {
"href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
},
"payment_instruments" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRvtThmhZtk56z6dtCt8hUDR/payment_instruments"
},
"reversals" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRvtThmhZtk56z6dtCt8hUDR/reversals"
},
"fees" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRvtThmhZtk56z6dtCt8hUDR/fees"
},
"disputes" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRvtThmhZtk56z6dtCt8hUDR/disputes"
},
"source" : {
"href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIk3AG7aUSCyNgYpDwCKkwDC"
},
"fee_profile" : {
"href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPbDSnEPtaT8Nttxj9NJk7eC"
}
}
}
HTTP Request
PUT https://finix.sandbox-payments-api.com/transfers/:TRANSFER_ID
URL Parameters
Parameter |
Description |
---|---|
:TRANSFER_ID | ID of the Transfer |
Request Parameters
Field | Type | Description |
---|---|---|
tags |
object, required | Key value pair for annotating custom metadata (e.g. order numbers) |