DAdailypay
Transfers

Request a transfer

Request transfer of funds from an EARNINGS_BALANCE account to a personal DEPOSITORY or CARD account.

post/rest/transfers

Request

Headers

Idempotency-Keystring uuid required
Example:e2736aa1-78c4-4cc6-b0a6-848e733f232a

An idempotency key is a unique string that you provide to ensure a request is only processed once. Any number of requests with the same idempotency key and payload will return an identical response.

Request body

Example request

{
  "data": {
    "id": "aba332a2-24a2-46de-8257-5040e71ab210",
    "attributes": {
      "preview": true,
      "amount": 2500,
      "currency": "USD",
      "schedule": "WITHIN_THIRTY_MINUTES"
    },
    "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"
        }
      }
    }
  }
}

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.