Transfers
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.
get/rest/transfers/{transfer_id}
Request
- Base URLhttps://api.dailypay.com
- AuthOAuth 2Authorization codehttps://auth.dailypay.com/oauth2/authToken URLhttps://auth.dailypay.com/oauth2/tokenScopesuser:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
transfer_idstring uuid required
Example:aba332a2-24a2-46de-8257-5040e71ab210
Unique ID of the transfer
Response
Returns the newly created transfer object.
Example response
{
"data": {
"id": "aba332a2-24a2-46de-8257-5040e71ab210",
"attributes": {
"preview": true,
"amount": 2500,
"currency": "USD",
"schedule": "WITHIN_THIRTY_MINUTES",
"submitted_at": "2021-04-21T21:30:58.051Z",
"resolved_at": "2021-04-21T21:30:58.051Z"
},
"links": {
"self": "https://api.dailypay.com/rest/transfers/aba332a2-24a2-46de-8257-5040e71ab210"
},
"relationships": {
"origin": {
"data": {
"id": "2bc7d781-3247-46f6-b60f-4090d214936a"
}
},
"destination": {
"data": {
"id": "2bc7d781-3247-46f6-b60f-4090d214936a"
}
},
"person": {
"data": {
"type": "people",
"id": "3fa8f641-5717-4562-b3fc-2c963f66afa6"
}
},
"estimated_funding_sources": {
"data": [
{
"id": "b5393c00b7c113fc2e5ae3e80c785bb2"
}
]
},
"final_funding_sources": {
"data": [
{
"id": "b5393c00b7c113fc2e5ae3e80c785bb2"
}
]
}
}
},
"included": [
{
"id": "b5393c00b7c113fc2e5ae3e80c785bb2",
"attributes": {
"amount": 2500,
"currency": "USD"
},
"relationships": {
"source": {
"data": {
"id": "3fa8f641-5717-4562-b3fc-2c963f66afa6"
}
},
"transfer": {
"data": {
"id": "aba332a2-24a2-46de-8257-5040e71ab210"
}
}
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.