# Get a list of transfers

Returns a list of transfer objects.
See Filtering Transfers for a description of filterable fields.


Endpoint: GET /rest/transfers
Version: 3.0.0-beta01
Security: oauth_client_credentials_token, oauth_user_token

## Header parameters:

  - `DailyPay-API-Version` (integer)
    The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.

  - `Accept` (string)
    The media type of the requested payload. This should be set to  to signify your client can receive responses in the JSON:API format.  For more details, see https://jsonapi.org.
    Enum: "application/vnd.api+json", "*/*"

## Query parameters:

  - `filter[person.id]` (string)
    Limit the results to documents related to a specific person

  - `include` (string)
    Add related resources to the response. 

The value of the include parameter must be a comma-separated (U+002C COMMA, “,”) list of relationship paths.

  - `filter` (string)

## Response 200 fields (application/vnd.api+json):

  - `data` (array, required)

  - `data.type` (string, required)

  - `data.id` (string, required)
    Example: "aba332a2-24a2-46de-8257-5040e71ab210"

  - `data.attributes` (object, required)
    An object representing a transfer of money from one account to another. 
Created when a person takes an advance against a future paycheck, or on a daily basis 
when we update estimated earnings based on current employment.

  - `data.attributes.preview` (boolean)
    Include this field to preview a transfer without sending it, to see, for example, the fee that would be charged. This will return the same response as a typical transfer request.
When the preview field is true in the response to creating a transfer, that indicates no transfer was created.
    Example: true

  - `data.attributes.amount` (integer, required)
    The amount of funds requested to move from the origin account to the destination account. Any fees will be subtracted from this amount prior to landing in the destination account.

A monetary quantity expressed in units of the lowest denomination in the associated currency. For example,  resolves to $72.50.

  - `data.attributes.currency` (string, required)
    A three-letter ISO 4217 currency code. For example,  for US Dollars,  for Euros, or  for Japanese Yen.

  - `data.attributes.status` (string, required)
    The status of the transfer.
    Enum: "PENDING", "SETTLED", "FAILED"

  - `data.attributes.schedule` (string, required)
    Set the schedule for the transfer. If not set, the transfer will be processed immediately. 
A preview transfer will never send.
    Enum: "WITHIN_THIRTY_MINUTES", "NEXT_BUSINESS_DAY"

  - `data.attributes.submitted_at` (string, required)
    An ISO 8601 timestamp denoting the receipt for the request.
    Example: "2021-04-21T21:30:58.051Z"

  - `data.attributes.resolved_at` (string,null, required)
    An ISO 8601 date denoting a successful or unsuccessful resolution for the request.
    Example: "2021-04-21T21:30:58.051Z"

  - `data.attributes.fee` (integer, required)
    A monetary quantity expressed in units of the lowest denomination in the associated currency. For example,  resolves to $72.50.
If a transfer incurs a fee, the fee will be deducted from the amount of the transfer.

  - `data.links` (object, required)

  - `data.links.self` (string, required)

  - `data.relationships` (object, required)
    The relationships between the transfer and other resources, including the destination account, the origination account, and the person who initiated the transfer.

  - `data.relationships.origin` (any, required)
    Origin may be a reference to either a Paycheck or an Account.

User-created transfers always originate from an Account with  .

A transfer that originates from a Paycheck is a  
system-created record that describes a credit of earnings to an account with  .

  - `data.relationships.destination` (object, required)
    The account to which funds are transferred. 

User-created transfers should have a destination Account with   or .

  - `data.relationships.person` (object, required)

  - `data.relationships.estimated_funding_sources` (object, required)
    On user-created transfers, details the paychecks that are likely to be used to reimburse this transfer. 

The paychecks impacted, and final amount allocated from each paycheck is subject to change. 
See  for the final allocations.

  - `data.relationships.final_funding_sources` (object, required)
    On user-created transfers, details the paychecks that were used to reimburse this transfer and the amount allocated from each paycheck.

If this relationship has members, its members and their values are immutable.

  - `included` (array)

  - `included.attributes` (object, required)

  - `included.attributes.amount` (integer, required)
    The amount of money from the related paycheck allocated towards funding the related transfer.

A monetary quantity expressed in units of the lowest denomination in the
associated currency. For example,  resolves to $72.50.

  - `included.relationships` (object, required)

  - `included.relationships.source` (object, required)
    Identifies a resource, usually a paycheck, used as a source of funds for a transfer.

  - `included.relationships.transfer` (object, required)

## Response 400 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.code` (string, required)
    A code that indicates what went wrong. Please consider this an open enum, where new codes may be added over time.
    Example: "INVALID_PARAMETERS"

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

## Response 401 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

  - `errors.code` (string, required)
    A code that indicates what went wrong.
    Enum: "INVALID_TOKEN", "UNAUTHORIZED"

## Response 403 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

  - `errors.code` (string, required)
    A code that indicates what went wrong.
    Enum: "FORBIDDEN"

## Response 500 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

  - `errors.code` (string, required)
    A code that indicates what went wrong.
    Enum: "UNEXPECTED_ERROR"