Transfer Schedule

Create, retrieve, and delete Transfer Schedules, a type of schedule. To create a new Transfer Schedule, create a new schedule and populate the transfer field with this object.

Attributes

Name	Type	Description
object	string	The string `scheduled_transfer`.
id	string	The scheduled transfer identifier matching `/rtrf(_test)?_[0-9a-z]+/`.
livemode	boolean	Whether this is a live (`true`) or test (`false`) scheduled transfer.
amount	integer	Scheduled transfer amount in smallest unit of transfer currency.
created_at	string	UTC datetime of scheduled transfer creation in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
currency	string	Currency for scheduled transfer as three-letter ISO 4217 code.
percentage_of_balance	float	Percentage of balance to transfer.
recipient	object_id_expandable	Identifier for recipient of scheduled transfer.

Example

JSON Response

{
  "object": "scheduled_transfer",
  "id": "rtrf_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "amount": 12345,
  "currency": "THB",
  "percentage_of_balance": null,
  "recipient": "recp_test_no1t4tnemucod0e51mo",
  "created_at": "2019-12-31T12:59:59Z"
}