The Transfer object 

Attributes

• idstring

  Unique identifier for the object.

• amountinteger

  Amount in cents to be transferred.

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• descriptionnullable string

  An arbitrary string attached to the object. Often useful for displaying to users.

• destinationnullable stringExpandable

  ID of the Stripe account the transfer was sent to.

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• amount_reversedinteger

  Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

• balance_transactionnullable stringExpandable

  Balance transaction that describes the impact of this transfer on your account balance.

• createdtimestamp

  Time that this record of the transfer was first created.

• destination_paymentnullable stringExpandable

  If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• reversalsobject

  A list of reversals that have been applied to the transfer.

  Hide child attributes

  • reversals.objectstring

    String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • reversals.dataarray of objects

    Details about each object.

    Hide child attributes

    • reversals.data.idstring

      Unique identifier for the object.

    • reversals.data.objectstring

      String representing the object’s type. Objects of the same type share the same value.

    • reversals.data.amountinteger

      Amount, in cents.

    • reversals.data.balance_transactionnullable stringExpandable

      Balance transaction that describes the impact on your account balance.

    • reversals.data.createdtimestamp

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • reversals.data.currencyenum

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • reversals.data.destination_payment_refundnullable stringExpandable

      Linked payment refund for the transfer reversal.

    • reversals.data.metadatanullable object

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • reversals.data.source_refundnullable stringExpandable

      ID of the refund responsible for the transfer reversal.

    • reversals.data.transferstringExpandable

      ID of the transfer that was reversed.

  • reversals.has_moreboolean

    True if this list has another page of items after this one that can be fetched.

  • reversals.urlstring

    The URL where this list can be accessed.

• reversedboolean

  Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

• source_transactionnullable stringExpandable

  ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.

• source_typenullable string

  The source balance this transfer came from. One of card, fpx, or bank_account.

• transfer_groupnullable string

  A string that identifies this transaction as part of a group. See the Connect documentation for details.