Deprecated API Reference

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

Update a Transfer

Copy
Copied
curl https://finix.sandbox-payments-api.com/transfers/TRvtThmhZtk56z6dtCt8hUDR \
-H "Content-Type: application/vnd.json+api" \
-H 'Finix-Version:2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-X PUT \
-d '
  {
  	  "tags": {
  	      "order_number": "12121212"
  	  }
  }'

Example Response:

Copy
Copied
{
  "id" : "TRvtThmhZtk56z6dtCt8hUDR",
  "amount" : 6031,
  "tags" : {
    "order_number" : "12121212"
  },
  "state" : "SUCCEEDED",
  "trace_id" : "fb3daad6-0f01-4133-a765-c1992c56df51",
  "currency" : "USD",
  "application" : "APgPDQrLD52TYvqazjHJJchM",
  "source" : "PIk3AG7aUSCyNgYpDwCKkwDC",
  "destination" : null,
  "ready_to_settle_at" : null,
  "externally_funded" : "UNKNOWN",
  "fee" : 603,
  "statement_descriptor" : "FNX*FINIX FLOWERS",
  "type" : "DEBIT",
  "messages" : [ ],
  "raw" : null,
  "created_at" : "2022-01-27T07:37:08.65Z",
  "updated_at" : "2022-01-27T07:42:47.18Z",
  "idempotency_id" : null,
  "merchant_identity" : "IDpYDM7J9n57q849o9E9yNrG",
  "subtype" : "API",
  "_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)