logo

Transfers

The transfers endpoint allows you to initiate and track money movement. You can access transfer details, including the transfer's unique ID, amount, currency, status, schedule, submission and resolution times, fees, and related links to the involved parties.

Functionality Retrieve transfer information, monitor transfer statuses, view transfer schedules, and access relevant links for the source, destination, and origin of the transfer.

Important - Account origin: a user initiated movement of money from one account to another - Paycheck origin: an automatic (system-generated) movement of money as part of payroll

Get a transfer object

Returns details about 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 available balance is updated based on current employment.

Securityoauth_user_token or oauth_client_credentials_token
Request
path Parameters
transfer_id
required
string <uuid>

Unique ID of the transfer

Example: aba332a2-24a2-46de-8257-5040e71ab210
query Parameters
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.

Examples:
include=estimated_funding_sources,final_funding_sources
header Parameters
DailyPay-API-Version
integer
Default: 3

The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.

Example: 3
Accept
required
string

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

Value: "application/vnd.api+json"
Responses
200

Returns the newly created transfer object.

Response Schema: application/vnd.api+json
required
object (TransferResource)
type
required
string
Value: "transfers"
id
required
string <uuid>
Example: "aba332a2-24a2-46de-8257-5040e71ab210"
required
object (TransferAttributes)

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.

preview
boolean
Default: false

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
amount
required
integer (Amount) >= 0

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, { amount: 7250, currency: 'USD' } resolves to $72.50.

currency
required
string (Currency)

A three-letter ISO 4217 currency code. For example, USD for US Dollars, EUR for Euros, or JPY for Japanese Yen.

status
required
string

Any transfer that originates from a Paycheck will have a pending status until the Paycheck or associated Paycheck enters the processing status. Once payroll processing begins, amounts of PENDING Transfers in excess of what has been withdrawn from the destination EARNINGS_BALANCE-type account may be zeroed out, and those Transfers will become SETTLED. One additional Transfer will be created automatically to reflect the movement of any remaining funds from the Paycheck to one of the default_paycheck_destinations set for the associated Job.

Enum: "PENDING" "SETTLED" "FAILED"
schedule
required
string

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"
Example: "WITHIN_THIRTY_MINUTES"
submitted_at
required
string <date-time>

An ISO 8601 timestamp denoting the receipt for the request.

Example: "2021-04-21T21:30:58.051Z"
resolved_at
required
string or null <date>

An ISO 8601 date denoting a successful or unsuccessful resolution for the request.

Example: "2021-04-21"
fee
required
integer >= 0

A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { amount: 7250, currency: 'USD' } resolves to $72.50. If a transfer incurs a fee, the fee will be deducted from the amount of the transfer.

Example: 0
required
object (TransferLinks)
self
required
string <uri> (TransferLink)
required
object (TransferRelationships)

The relationships between the transfer and other resources, including the destination account, the origination account, and the person who initiated the transfer.

required
AccountRelationship (object) or PaycheckRelationship (object)

Origin may be a reference to either a Paycheck or an Account.

User-created transfers always originate from an Account with account_type EARNINGS_BALANCE.

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

required
object (AccountRelationship)

The account to which funds are transferred.

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

required
object (PersonRelationship)
required
object (FundingSourcesRelationship)

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 final_funding_sources for the final allocations.

required
object (FundingSourcesRelationship)

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.

Array of objects (FundingSourceResource)
Array
id
required
string
Example: "b5393c00b7c113fc2e5ae3e80c785bb2"
type
required
string
Value: "funding_sources"
required
object (FundingSourceAttributes)
required
object (FundingSourceRelationships)
400

Bad Request

401

Invalid authentication credentials

403

Not authorized to perform this operation

404

Resource was not found

500

Unexpected error occured

get/rest/transfers/{transfer_id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    • "type": "transfers",
    • "id": "aba332a2-24a2-46de-8257-5040e71ab210",
    • "attributes": {
      • "preview": true,
      • "amount": 2500,
      • "currency": "USD",
      • "status": "PENDING",
      • "schedule": "WITHIN_THIRTY_MINUTES",
      • "submitted_at": "2021-04-21T21:30:58.051Z",
      • "resolved_at": "2021-04-21",
      • "fee": 0
      },
    • "links": {},
    • "relationships": {
      • "origin": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "destination": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
          }
        },
      • "estimated_funding_sources": {
        • "data": [
          • {
            }
          ]
        },
      • "final_funding_sources": {
        • "data": [
          • {
            }
          ]
        }
      }
    },
  • "included": [
    • {
      • "id": "b5393c00b7c113fc2e5ae3e80c785bb2",
      • "type": "funding_sources",
      • "attributes": {
        • "amount": 2500,
        • "currency": "USD"
        },
      • "relationships": {
        • "source": {
          • "data": {
            }
          },
        • "transfer": {
          • "data": {
            }
          }
        }
      }
    ]
}
Get a list of transfers
Returns a list of transfer objects.
See Filtering Transfers for a description of filterable fields.


Securityoauth_user_token or oauth_client_credentials_token 
Request 
query Parameters
filter
string
  Examples: 
filter=person_id:"aa860051-c411-4709-9685-c1b716df611b"
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.


  Examples: 
include=estimated_funding_sources,final_funding_sources
header Parameters
DailyPay-API-Version
integer
 Default:  3
The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.


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


 
 Value:  "application/vnd.api+json"
Responses 
200
A list of transfer objects.


Response Schema: application/vnd.api+json
required
Array of objects (TransferResource) 
 
 Array 
type
required
string
 
 Value:  "transfers"
id
required
string <uuid> 
 
 Example:  "aba332a2-24a2-46de-8257-5040e71ab210"
required
object (TransferAttributes) 
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.


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


 
Array of objects (FundingSourceResource) 
 
 Array 
id
required
string
 
 Example:  "b5393c00b7c113fc2e5ae3e80c785bb2"
type
required
string
 
 Value:  "funding_sources"
required
object (FundingSourceAttributes) 
 
required
object (FundingSourceRelationships) 
 
400
Bad Request


403
Invalid authentication credentials


500
Unexpected error occured


get/rest/transfers
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    • {
      • "type": "transfers",
      • "id": "aba332a2-24a2-46de-8257-5040e71ab210",
      • "attributes": {
        • "preview": true,
        • "amount": 2500,
        • "currency": "USD",
        • "status": "PENDING",
        • "schedule": "WITHIN_THIRTY_MINUTES",
        • "submitted_at": "2021-04-21T21:30:58.051Z",
        • "resolved_at": "2021-04-21",
        • "fee": 0
        },
      • "links": {},
      • "relationships": {
        • "origin": {
          • "data": {
            }
          },
        • "destination": {
          • "data": {
            }
          },
        • "person": {
          • "data": {
            }
          },
        • "estimated_funding_sources": {
          • "data": [
            ]
          },
        • "final_funding_sources": {
          • "data": [
            ]
          }
        }
      }
    ],
  • "included": [
    • {
      • "id": "b5393c00b7c113fc2e5ae3e80c785bb2",
      • "type": "funding_sources",
      • "attributes": {
        • "amount": 2500,
        • "currency": "USD"
        },
      • "relationships": {
        • "source": {
          • "data": {
            }
          },
        • "transfer": {
          • "data": {
            }
          }
        }
      }
    ]
}
Request a transfer
Request transfer of funds from an EARNINGS_BALANCE account to a
personal DEPOSITORY or CARD account.


Securityoauth_user_token 
Request 
query Parameters
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.


  Examples: 
include=estimated_funding_sources
header Parameters
DailyPay-API-Version
integer
 Default:  3
The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.


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


 
 Value:  "application/vnd.api+json"
Idempotency-Key
required
string <uuid> 
An idempotency key that, when included, guarantees a request will only be processed once.


When we detect a duplicate request, the response for the duplicate request will be identical 
to the response of the original request, including the previously returned http status code.


 
Request Body schema: application/vnd.api+json
required
required
object (TransferCreateResource) 
 
type
required
string
 
 Value:  "transfers"
id
required
string <uuid> 
The unique identifier of the transfer. Any UUID version is valid, lower-cased.


 
 Example:  "aba332a2-24a2-46de-8257-5040e71ab210"
required
object (TransferAttributes) 
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.


 
preview
boolean
 Default:  false
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
amount
required
integer (Amount)   >= 0 
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, { amount: 7250, currency: 'USD' } resolves to $72.50.


 
currency
required
string (Currency) 
A three-letter ISO 4217 currency code. For example, USD for US Dollars, EUR for Euros, or JPY for Japanese Yen.


 
schedule
required
string
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"  
 Example:  "WITHIN_THIRTY_MINUTES"
required
object (TransferCreateRelationships) 
The relationships between the transfer and other resources, including the destination account, the origination account, and the person who initiated the transfer.


 
required
object (AccountRelationship) 
User-created transfers must originate from an Account with account_type EARNINGS_BALANCE.


 
required
object (AccountRelationship) 
The account to which funds are transferred. 


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


 
required
object (PersonRelationship) 
 
Responses 
200
Returns the newly created transfer object.


Response Schema: application/vnd.api+json
required
object (TransferResource) 
 
type
required
string
 
 Value:  "transfers"
id
required
string <uuid> 
 
 Example:  "aba332a2-24a2-46de-8257-5040e71ab210"
required
object (TransferAttributes) 
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.


 
preview
boolean
 Default:  false
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
amount
required
integer (Amount)   >= 0 
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, { amount: 7250, currency: 'USD' } resolves to $72.50.


 
currency
required
string (Currency) 
A three-letter ISO 4217 currency code. For example, USD for US Dollars, EUR for Euros, or JPY for Japanese Yen.


 
status
required
string
Any transfer that originates from a Paycheck will have a pending status 
  until the Paycheck or associated Paycheck enters the processing status. Once payroll processing begins, 
  amounts of PENDING Transfers in excess of what has been withdrawn from the 
  destination EARNINGS_BALANCE-type account may be zeroed out, and those Transfers will become SETTLED.
One additional Transfer will be created automatically to reflect the movement of any remaining funds 
  from the Paycheck to one of the default_paycheck_destinations set for the associated Job.


 Enum: "PENDING" "SETTLED" "FAILED"  
schedule
required
string
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"  
 Example:  "WITHIN_THIRTY_MINUTES"
submitted_at
required
string <date-time> 
An ISO 8601 timestamp denoting the receipt for the request.


 
 Example:  "2021-04-21T21:30:58.051Z"
resolved_at
required
string or null <date> 
An ISO 8601 date denoting a successful or unsuccessful resolution for the request.


 
 Example:  "2021-04-21"
fee
required
integer  >= 0 
A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { amount: 7250, currency: 'USD' } resolves to $72.50.
If a transfer incurs a fee, the fee will be deducted from the amount of the transfer.


 
 Example:  0
required
object (TransferLinks) 
 
self
required
string <uri>  (TransferLink) 
 
required
object (TransferRelationships) 
The relationships between the transfer and other resources, including the destination account, the origination account, and the person who initiated the transfer.


 
required
AccountRelationship (object) or PaycheckRelationship (object)
Origin may be a reference to either a Paycheck or an Account.


User-created transfers always originate from an Account with account_type EARNINGS_BALANCE.


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


 
required
object (AccountRelationship) 
The account to which funds are transferred. 


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


 
required
object (PersonRelationship) 
 
required
object (FundingSourcesRelationship) 
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 final_funding_sources for the final allocations.


 
required
object (FundingSourcesRelationship) 
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.


 
Array of objects (FundingSourceResource) 
 
 Array 
id
required
string
 
 Example:  "b5393c00b7c113fc2e5ae3e80c785bb2"
type
required
string
 
 Value:  "funding_sources"
required
object (FundingSourceAttributes) 
 
required
object (FundingSourceRelationships) 
 
400
Bad Request


401
Invalid authentication credentials


403
Not authorized to perform this operation


422
Unprocessable entity


500
Unexpected error occured


post/rest/transfers
Request samples 
application/vnd.api+json
{
  • "data": {
    • "type": "transfers",
    • "id": "aba332a2-24a2-46de-8257-5040e71ab210",
    • "attributes": {
      • "preview": true,
      • "amount": 2500,
      • "currency": "USD",
      • "schedule": "WITHIN_THIRTY_MINUTES"
      },
    • "relationships": {
      • "origin": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "destination": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      }
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    • "type": "transfers",
    • "id": "aba332a2-24a2-46de-8257-5040e71ab210",
    • "attributes": {
      • "preview": true,
      • "amount": 2500,
      • "currency": "USD",
      • "status": "PENDING",
      • "schedule": "WITHIN_THIRTY_MINUTES",
      • "submitted_at": "2021-04-21T21:30:58.051Z",
      • "resolved_at": "2021-04-21",
      • "fee": 0
      },
    • "links": {},
    • "relationships": {
      • "origin": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "destination": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
          }
        },
      • "estimated_funding_sources": {
        • "data": [
          • {
            }
          ]
        },
      • "final_funding_sources": {
        • "data": [
          • {
            }
          ]
        }
      }
    },
  • "included": [
    • {
      • "id": "b5393c00b7c113fc2e5ae3e80c785bb2",
      • "type": "funding_sources",
      • "attributes": {
        • "amount": 2500,
        • "currency": "USD"
        },
      • "relationships": {
        • "source": {
          • "data": {
            }
          },
        • "transfer": {
          • "data": {
            }
          }
        }
      }
    ]
}
➔ Next to Organizations