Deprecated API Reference

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

Fetch a Transfer

Retrieve the details of a specific transfer resource.

Copy

Copied

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

Example Response:

Copy

Copied

{
  "id" : "TRnH7FkSB7zePeHExNZwSb9H",
  "amount" : 7,
  "tags" : {
    "pagination" : "true!"
  },
  "state" : "SUCCEEDED",
  "trace_id" : "0e201222-d357-4038-9ed2-23a38482fd07",
  "currency" : "USD",
  "application" : "APgPDQrLD52TYvqazjHJJchM",
  "source" : null,
  "destination" : "PIe2YvpcjvoVJ6PzoRPBK137",
  "ready_to_settle_at" : "2022-07-05T21:20:06.89Z",
  "externally_funded" : "UNKNOWN",
  "fee" : 0,
  "statement_descriptor" : "FNX*FINIX FLOWERS",
  "type" : "REVERSAL",
  "messages" : [ ],
  "raw" : null,
  "created_at" : "2022-07-05T21:19:26.36Z",
  "updated_at" : "2022-07-05T21:20:06.88Z",
  "idempotency_id" : null,
  "merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
  "subtype" : "API",
  "failure_code" : null,
  "failure_message" : null,
  "additional_buyer_charges" : null,
  "_links" : {
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
    },
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRnH7FkSB7zePeHExNZwSb9H"
    },
    "merchant_identity" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
    },
    "payment_instruments" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRnH7FkSB7zePeHExNZwSb9H/payment_instruments"
    },
    "parent" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRacB6Q6GcW6yvFUKawSnMEP"
    },
    "destination" : {
      "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137"
    },
    "fee_profile" : {
      "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8"
    }
  }
}

HTTP Request

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

URL Parameters

`Parameter`	Description
:TRANSFER_ID	ID of the `transfer`

Response

Field	Type	Description
`id`	string	The ID of the `transfer` resource
`amount`	string	The total amount that will be debited in cents (e.g. 100 cents to debit $1.00)
`tags`	string	Key value pair for annotating custom meta data (e.g. order numbers)
`state`	string	The state of the `transfer`. Available values include: CANCELED PENDING FAILED SUCCEEDED UNKNOWN
`trace_id`	string	Trace ID of the `transfer`. The processor sends back the `trace_id` so you can track the transfer end-to-end
`currency`	string	ISO 4217 3 letter currency code
`application`	object	The ID of the `Application` resource the `transfer` was created under
`source`	string	ID of the `Payment Instrument` where funds get debited
`destination`	string	ID of the `Payment Instrument` where funds are getting sent
`ready_to_settle_at`	string	Timestamp of when the `transfer` is ready to be settled at
`externally_funded`	string	Details if the `transfer` will be settled externally by card processors
`fee`	string	The amount of the `transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to `amount`)
`statement_descriptor`	string	The description of the merchant that appears on the buyer's bank or card statement
`type`	string	Type of `transfer`.
`messages`	string	Message field that provides additional details. This field is typically null
`raw`	string	Raw response from the processor
`created_at`	string	Timestamp of when the object was created
`updated_at`	string	Timestamp of when the object was last updated
`idempotency_id`	string	A randomly generated value that'll be associated with the request
`merchant_identity`	string	The ID of the `Identity` resource associated with the `merchant` that submitted the `transfer`
`subtype`	string	Additional information describing the `type`
`failure_code`	string	A `failure_code` is provided when a transaction is declined. For more information on how to handle `failure_codes` see Failure Codes
`failure_message`	string	Additional information about the `failure_code` and why the transaction was declined. For more information on how to handle `failure_codes` see Failure Codes