DailyPay Transfers API

openapi: 3.2.0
info:
  version: 3.0.0-beta.117
  termsOfService: https://www.dailypay.com/en-us/legal/direct/dailypay-client-api-terms-of-use/
  title: DailyPay Rest Transfers API
  x-logo:
    url: https://developer.dailypay.com/static/svgs/dp_text.svg
  contact:
    name: DailyPay Developer Support
    url: https://developer.dailypay.com
  description: Embed DailyPay and On Demand Pay features into your application.
servers:
- url: https://api.{environment}.com
  description: DailyPay REST API server
  variables:
    environment:
      default: dailypay
      enum:
      - dailypay
      - dailypayuat
security:
- oauth_client_credentials_token:
  - client:admin
- oauth_user_token:
  - user:read
tags:
- name: Transfers
  description: '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

    '
paths:
  /rest/transfers/{transfer_id}:
    parameters:
    - $ref: '#/components/parameters/apiversion'
    - $ref: '#/components/parameters/transferIncludes'
    get:
      tags:
      - Transfers
      summary: Get a transfer object
      description: "Returns details about a transfer of money from one account to another. \n\nCreated when a person takes an advance against a future paycheck, or on a daily basis when available balance is updated based on current employment.\n"
      operationId: readTransfer
      security:
      - oauth_user_token:
        - user:read
      parameters:
      - $ref: '#/components/parameters/transfer_id'
      responses:
        '200':
          $ref: '#/components/responses/Transfer200'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/Unexpected'
      x-codeSamples:
      - lang: C#
        source: "using DailyPay.SDK.DotNet8;\nusing DailyPay.SDK.DotNet8.Models.Components;\nusing DailyPay.SDK.DotNet8.Models.Requests;\n\nvar sdk = new SDK(\n    version: 3,\n    security: new Security() {\n        OauthUserToken = \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n    }\n);\n\nReadTransferRequest req = new ReadTransferRequest() {\n    Include = \"estimated_funding_sources,final_funding_sources\",\n    TransferId = \"aba332a2-24a2-46de-8257-5040e71ab210\",\n};\n\nvar res = await sdk.Transfers.ReadAsync(req);\n\n// handle response"
      - lang: Java
        source: "package hello.world;\n\nimport com.dailypay.sdk.DailyPay;\nimport com.dailypay.sdk.models.components.Security;\nimport com.dailypay.sdk.models.errors.*;\nimport com.dailypay.sdk.models.operations.ReadTransferRequest;\nimport com.dailypay.sdk.models.operations.ReadTransferResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorBadRequest, ErrorUnauthorized, ErrorForbidden, ErrorNotFound, ErrorUnexpected, Exception {\n\n        DailyPay sdk = DailyPay.builder()\n                .version(3L)\n                .security(Security.builder()\n                    .oauthUserToken(System.getenv().getOrDefault(\"OAUTH_USER_TOKEN\", \"\"))\n                    .build())\n            .build();\n\n        ReadTransferRequest req = ReadTransferRequest.builder()\n                .transferId(\"aba332a2-24a2-46de-8257-5040e71ab210\")\n                .include(\"estimated_funding_sources,final_funding_sources\")\n                .build();\n\n        ReadTransferResponse res = sdk.transfers().read()\n                .request(req)\n                .call();\n\n        if (res.transferData().isPresent()) {\n            System.out.println(res.transferData().get());\n        }\n    }\n}"
      - lang: Go
        source: "package main\n\nimport(\n\t\"context\"\n\t\"github.com/dailypay/dailypay-go-sdk/models/components\"\n\tdailypay \"github.com/dailypay/dailypay-go-sdk\"\n\t\"github.com/dailypay/dailypay-go-sdk/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := dailypay.New(\n        dailypay.WithVersion(3),\n        dailypay.WithSecurity(components.Security{\n            OauthUserToken: dailypay.Pointer(\"<YOUR_OAUTH_USER_TOKEN_HERE>\"),\n        }),\n    )\n\n    res, err := s.Transfers.Read(ctx, operations.ReadTransferRequest{\n        Include: dailypay.Pointer(\"estimated_funding_sources,final_funding_sources\"),\n        TransferID: \"aba332a2-24a2-46de-8257-5040e71ab210\",\n    })\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.TransferData != nil {\n        // handle response\n    }\n}"
      - lang: JavaScript
        source: "import { SDK } from \"@dailypay/dailypay\";\n\nconst sdk = new SDK({\n  version: 3,\n  security: {\n    oauthUserToken: \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n  },\n});\n\nasync function run() {\n  const result = await sdk.transfers.read({\n    include: \"estimated_funding_sources,final_funding_sources\",\n    transferId: \"aba332a2-24a2-46de-8257-5040e71ab210\",\n  });\n\n  console.log(result);\n}\n\nrun();"
      - lang: csharp
        label: readTransfer
        source: "using DailyPay.SDK.DotNet9;\nusing DailyPay.SDK.DotNet9.Models.Components;\nusing DailyPay.SDK.DotNet9.Models.Requests;\n\nvar sdk = new SDK(\n    version: 3,\n    security: new Security() {\n        OauthUserToken = \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n    }\n);\n\nReadTransferRequest req = new ReadTransferRequest() {\n    Include = \"estimated_funding_sources,final_funding_sources\",\n    TransferId = \"aba332a2-24a2-46de-8257-5040e71ab210\",\n};\n\nvar res = await sdk.Transfers.ReadAsync(req);\n\n// handle response"
      - lang: java
        label: readTransfer
        source: "package hello.world;\n\nimport com.dailypay.sdk.DailyPay;\nimport com.dailypay.sdk.models.components.SchemeOauthClientCredentialsToken;\nimport com.dailypay.sdk.models.components.Security;\nimport com.dailypay.sdk.models.errors.*;\nimport com.dailypay.sdk.models.operations.ReadTransferRequest;\nimport com.dailypay.sdk.models.operations.ReadTransferResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorBadRequest, ErrorUnauthorized, ErrorForbidden, ErrorNotFound, ErrorUnexpected, Exception {\n\n        DailyPay sdk = DailyPay.builder()\n                .version(3L)\n                .security(Security.builder()\n                    .oauthClientCredentialsToken(SchemeOauthClientCredentialsToken.builder()\n                        .clientID(\"<id>\")\n                        .clientSecret(\"<value>\")\n                        .tokenURL(\"https://api.dailypay.com/oauth/token\")\n                        .build())\n                    .build())\n            .build();\n\n        ReadTransferRequest req = ReadTransferRequest.builder()\n                .transferId(\"aba332a2-24a2-46de-8257-5040e71ab210\")\n                .build();\n\n        ReadTransferResponse res = sdk.transfers().read()\n                .request(req)\n                .call();\n\n        if (res.transferData().isPresent()) {\n            // handle response\n        }\n    }\n}"
  /rest/transfers:
    parameters:
    - $ref: '#/components/parameters/apiversion'
    - $ref: '#/components/parameters/transferIncludes'
    get:
      tags:
      - Transfers
      summary: Get a list of transfers
      description: 'Returns a list of transfer objects.

        '
      operationId: listTransfers
      security:
      - oauth_user_token:
        - user:read
      parameters:
      - $ref: '#/components/parameters/filter.submitted_at__gt'
      - $ref: '#/components/parameters/filter'
      responses:
        '200':
          $ref: '#/components/responses/Transfers200'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/Unexpected'
      x-codeSamples:
      - lang: C#
        source: "using DailyPay.SDK.DotNet8;\nusing DailyPay.SDK.DotNet8.Models.Components;\nusing DailyPay.SDK.DotNet8.Models.Requests;\nusing System;\n\nvar sdk = new SDK(\n    version: 3,\n    security: new Security() {\n        OauthUserToken = \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n    }\n);\n\nListTransfersRequest req = new ListTransfersRequest() {\n    Include = \"estimated_funding_sources,final_funding_sources\",\n    FilterSubmittedAtGt = System.DateTime.Parse(\"2023-03-15T04:00:00Z\").ToUniversalTime(),\n};\n\nvar res = await sdk.Transfers.ListAsync(req);\n\n// handle response"
      - lang: Java
        source: "package hello.world;\n\nimport com.dailypay.sdk.DailyPay;\nimport com.dailypay.sdk.models.components.Security;\nimport com.dailypay.sdk.models.errors.*;\nimport com.dailypay.sdk.models.operations.ListTransfersRequest;\nimport com.dailypay.sdk.models.operations.ListTransfersResponse;\nimport java.lang.Exception;\nimport java.time.OffsetDateTime;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorBadRequest, ErrorUnauthorized, ErrorForbidden, ErrorUnexpected, Exception {\n\n        DailyPay sdk = DailyPay.builder()\n                .version(3L)\n                .security(Security.builder()\n                    .oauthUserToken(System.getenv().getOrDefault(\"OAUTH_USER_TOKEN\", \"\"))\n                    .build())\n            .build();\n\n        ListTransfersRequest req = ListTransfersRequest.builder()\n                .include(\"estimated_funding_sources,final_funding_sources\")\n                .filterSubmittedAtGt(OffsetDateTime.parse(\"2023-03-15T04:00:00Z\"))\n                .build();\n\n        ListTransfersResponse res = sdk.transfers().list()\n                .request(req)\n                .call();\n\n        if (res.transfersData().isPresent()) {\n            System.out.println(res.transfersData().get());\n        }\n    }\n}"
      - lang: Go
        source: "package main\n\nimport(\n\t\"context\"\n\t\"github.com/dailypay/dailypay-go-sdk/models/components\"\n\tdailypay \"github.com/dailypay/dailypay-go-sdk\"\n\t\"github.com/dailypay/dailypay-go-sdk/types\"\n\t\"github.com/dailypay/dailypay-go-sdk/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := dailypay.New(\n        dailypay.WithVersion(3),\n        dailypay.WithSecurity(components.Security{\n            OauthUserToken: dailypay.Pointer(\"<YOUR_OAUTH_USER_TOKEN_HERE>\"),\n        }),\n    )\n\n    res, err := s.Transfers.List(ctx, operations.ListTransfersRequest{\n        Include: dailypay.Pointer(\"estimated_funding_sources,final_funding_sources\"),\n        FilterSubmittedAtGt: types.MustNewTimeFromString(\"2023-03-15T04:00:00Z\"),\n    })\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.TransfersData != nil {\n        // handle response\n    }\n}"
      - lang: JavaScript
        source: "import { SDK } from \"@dailypay/dailypay\";\n\nconst sdk = new SDK({\n  version: 3,\n  security: {\n    oauthUserToken: \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n  },\n});\n\nasync function run() {\n  const result = await sdk.transfers.list({\n    include: \"estimated_funding_sources,final_funding_sources\",\n    filterSubmittedAtGt: new Date(\"2023-03-15T04:00:00Z\"),\n  });\n\n  console.log(result);\n}\n\nrun();"
      - lang: csharp
        label: listTransfers
        source: "using DailyPay.SDK.DotNet9;\nusing DailyPay.SDK.DotNet9.Models.Components;\nusing DailyPay.SDK.DotNet9.Models.Requests;\nusing System;\n\nvar sdk = new SDK(\n    version: 3,\n    security: new Security() {\n        OauthUserToken = \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n    }\n);\n\nListTransfersRequest req = new ListTransfersRequest() {\n    Include = \"estimated_funding_sources,final_funding_sources\",\n    FilterSubmittedAtGt = System.DateTime.Parse(\"2023-03-15T04:00:00Z\").ToUniversalTime(),\n};\n\nvar res = await sdk.Transfers.ListAsync(req);\n\n// handle response"
      - lang: java
        label: listTransfers
        source: "package hello.world;\n\nimport com.dailypay.sdk.DailyPay;\nimport com.dailypay.sdk.models.components.SchemeOauthClientCredentialsToken;\nimport com.dailypay.sdk.models.components.Security;\nimport com.dailypay.sdk.models.errors.*;\nimport com.dailypay.sdk.models.operations.ListTransfersResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws ErrorBadRequest, ErrorUnauthorized, ErrorForbidden, ErrorUnexpected, Exception {\n\n        DailyPay sdk = DailyPay.builder()\n                .version(3L)\n                .security(Security.builder()\n                    .oauthClientCredentialsToken(SchemeOauthClientCredentialsToken.builder()\n                        .clientID(\"<id>\")\n                        .clientSecret(\"<value>\")\n                        .tokenURL(\"https://api.dailypay.com/oauth/token\")\n                        .build())\n                    .build())\n            .build();\n\n        ListTransfersResponse res = sdk.transfers().list()\n                .call();\n\n        if (res.transfersData().isPresent()) {\n            // handle response\n        }\n    }\n}"
    post:
      tags:
      - Transfers
      summary: Request a transfer
      description: 'Request transfer of funds from an `EARNINGS_BALANCE` account to a

        personal `DEPOSITORY` or `CARD` account.

        '
      operationId: createTransfer
      security:
      - oauth_user_token:
        - user:read_write
      x-speakeasy-usage-example:
        title: Request a transfer
        description: Initiate a transfer of funds from an earnings balance account to a personal depository or card account.
        position: 2
      parameters:
      - $ref: '#/components/parameters/idempotency_key'
      requestBody:
        $ref: '#/components/requestBodies/TransferCreate'
      responses:
        '200':
          $ref: '#/components/responses/Transfer200'
        '400':
          $ref: '#/components/responses/TransferCreate400'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/Unexpected'
      x-codeSamples:
      - lang: C#
        source: "using DailyPay.SDK.DotNet8;\nusing DailyPay.SDK.DotNet8.Models.Components;\nusing DailyPay.SDK.DotNet8.Models.Requests;\n\nvar sdk = new SDK(\n    version: 3,\n    security: new Security() {\n        OauthUserToken = \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n    }\n);\n\nCreateTransferRequest req = new CreateTransferRequest() {\n    Include = \"estimated_funding_sources,final_funding_sources\",\n    IdempotencyKey = \"e2736aa1-78c4-4cc6-b0a6-848e733f232a\",\n    TransferCreateData = new TransferCreateData() {\n        Data = new TransferCreateResource() {\n            Attributes = new TransferCreateAttributes() {\n                Preview = true,\n                Amount = 15000,\n                Currency = \"USD\",\n                Schedule = TransferCreateAttributesSchedule.WithinThirtyMinutes,\n            },\n            Relationships = new TransferCreateRelationships() {\n                Origin = new AccountRelationship() {\n                    Data = new AccountIdentifier() {\n                        Id = \"123e4567-e89b-12d3-a456-426614174000\",\n                    },\n                },\n                Destination = new AccountRelationship() {\n                    Data = new AccountIdentifier() {\n                        Id = \"223e4567-e89b-12d3-a456-426614174001\",\n                    },\n                },\n                Person = new PersonRelationship() {\n                    Data = new PersonIdentifier() {\n                        Id = \"aa860051-c411-4709-9685-c1b716df611b\",\n                    },\n                },\n            },\n        },\n    },\n};\n\nvar res = await sdk.Transfers.CreateAsync(req);\n\n// handle response"
      - lang: Java
        source: "package hello.world;\n\nimport com.dailypay.sdk.DailyPay;\nimport com.dailypay.sdk.models.components.*;\nimport com.dailypay.sdk.models.errors.*;\nimport com.dailypay.sdk.models.operations.CreateTransferRequest;\nimport com.dailypay.sdk.models.operations.CreateTransferResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws TransferCreateError, ErrorUnauthorized, ErrorForbidden, ErrorConflict, ErrorUnexpected, Exception {\n\n        DailyPay sdk = DailyPay.builder()\n                .version(3L)\n                .security(Security.builder()\n                    .oauthUserToken(System.getenv().getOrDefault(\"OAUTH_USER_TOKEN\", \"\"))\n                    .build())\n            .build();\n\n        CreateTransferRequest req = CreateTransferRequest.builder()\n                .idempotencyKey(\"e2736aa1-78c4-4cc6-b0a6-848e733f232a\")\n                .transferCreateData(TransferCreateData.builder()\n                    .data(TransferCreateResource.builder()\n                        .attributes(TransferCreateAttributes.builder()\n                            .amount(15000L)\n                            .currency(\"USD\")\n                            .schedule(TransferCreateAttributesSchedule.WITHIN_THIRTY_MINUTES)\n                            .preview(true)\n                            .build())\n                        .relationships(TransferCreateRelationships.builder()\n                            .origin(AccountRelationship.builder()\n                                .data(AccountIdentifier.builder()\n                                    .id(\"123e4567-e89b-12d3-a456-426614174000\")\n                                    .build())\n                                .build())\n                            .destination(AccountRelationship.builder()\n                                .data(AccountIdentifier.builder()\n                                    .id(\"223e4567-e89b-12d3-a456-426614174001\")\n                                    .build())\n                                .build())\n                            .person(PersonRelationship.builder()\n                                .data(PersonIdentifier.builder()\n                                    .id(\"aa860051-c411-4709-9685-c1b716df611b\")\n                                    .build())\n                                .build())\n                            .build())\n                        .build())\n                    .build())\n                .include(\"estimated_funding_sources,final_funding_sources\")\n                .build();\n\n        CreateTransferResponse res = sdk.transfers().create()\n                .request(req)\n                .call();\n\n        if (res.transferData().isPresent()) {\n            System.out.println(res.transferData().get());\n        }\n    }\n}"
      - lang: Go
        source: "package main\n\nimport(\n\t\"context\"\n\t\"github.com/dailypay/dailypay-go-sdk/models/components\"\n\tdailypay \"github.com/dailypay/dailypay-go-sdk\"\n\t\"github.com/dailypay/dailypay-go-sdk/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := dailypay.New(\n        dailypay.WithVersion(3),\n        dailypay.WithSecurity(components.Security{\n            OauthUserToken: dailypay.Pointer(\"<YOUR_OAUTH_USER_TOKEN_HERE>\"),\n        }),\n    )\n\n    res, err := s.Transfers.Create(ctx, operations.CreateTransferRequest{\n        Include: dailypay.Pointer(\"estimated_funding_sources,final_funding_sources\"),\n        IdempotencyKey: \"e2736aa1-78c4-4cc6-b0a6-848e733f232a\",\n        TransferCreateData: components.TransferCreateData{\n            Data: components.TransferCreateResource{\n                Attributes: components.TransferCreateAttributes{\n                    Preview: dailypay.Pointer(true),\n                    Amount: 15000,\n                    Currency: \"USD\",\n                    Schedule: components.TransferCreateAttributesScheduleWithinThirtyMinutes,\n                },\n                Relationships: components.TransferCreateRelationships{\n                    Origin: components.AccountRelationship{\n                        Data: components.AccountIdentifier{\n                            ID: \"123e4567-e89b-12d3-a456-426614174000\",\n                        },\n                    },\n                    Destination: &components.AccountRelationship{\n                        Data: components.AccountIdentifier{\n                            ID: \"223e4567-e89b-12d3-a456-426614174001\",\n                        },\n                    },\n                    Person: &components.PersonRelationship{\n                        Data: components.PersonIdentifier{\n                            ID: \"aa860051-c411-4709-9685-c1b716df611b\",\n                        },\n                    },\n                },\n            },\n        },\n    })\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.TransferData != nil {\n        // handle response\n    }\n}"
      - lang: JavaScript
        source: "import { SDK } from \"@dailypay/dailypay\";\n\nconst sdk = new SDK({\n  version: 3,\n  security: {\n    oauthUserToken: \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n  },\n});\n\nasync function run() {\n  const result = await sdk.transfers.create({\n    include: \"estimated_funding_sources,final_funding_sources\",\n    idempotencyKey: \"e2736aa1-78c4-4cc6-b0a6-848e733f232a\",\n    transferCreateData: {\n      data: {\n        type: \"transfers\",\n        attributes: {\n          preview: true,\n          amount: 15000,\n          currency: \"USD\",\n          schedule: \"WITHIN_THIRTY_MINUTES\",\n        },\n        relationships: {\n          origin: {\n            data: {\n              type: \"accounts\",\n              id: \"123e4567-e89b-12d3-a456-426614174000\",\n            },\n          },\n          destination: {\n            data: {\n              type: \"accounts\",\n              id: \"223e4567-e89b-12d3-a456-426614174001\",\n            },\n          },\n          person: {\n            data: {\n              type: \"people\",\n              id: \"aa860051-c411-4709-9685-c1b716df611b\",\n            },\n          },\n        },\n      },\n    },\n  });\n\n  console.log(result);\n}\n\nrun();"
      - lang: csharp
        label: createTransfer
        source: "using DailyPay.SDK.DotNet9;\nusing DailyPay.SDK.DotNet9.Models.Components;\nusing DailyPay.SDK.DotNet9.Models.Requests;\n\nvar sdk = new SDK(\n    version: 3,\n    security: new Security() {\n        OauthUserToken = \"<YOUR_OAUTH_USER_TOKEN_HERE>\",\n    }\n);\n\nCreateTransferRequest req = new CreateTransferRequest() {\n    Include = \"estimated_funding_sources,final_funding_sources\",\n    IdempotencyKey = \"e2736aa1-78c4-4cc6-b0a6-848e733f232a\",\n    TransferCreateData = new TransferCreateData() {\n        Data = new TransferCreateResource() {\n            Attributes = new TransferCreateAttributes() {\n                Preview = true,\n                Amount = 15000,\n                Currency = \"USD\",\n                Schedule = TransferCreateAttributesSchedule.WithinThirtyMinutes,\n            },\n            Relationships = new TransferCreateRelationships() {\n                Origin = new AccountRelationship() {\n                    Data = new AccountIdentifier() {\n                        Id = \"123e4567-e89b-12d3-a456-426614174000\",\n                    },\n                },\n                Destination = new AccountRelationship() {\n                    Data = new AccountIdentifier() {\n                        Id = \"223e4567-e89b-12d3-a456-426614174001\",\n                    },\n                },\n                Person = new PersonRelationship() {\n                    Data = new PersonIdentifier() {\n                        Id = \"aa860051-c411-4709-9685-c1b716df611b\",\n                    },\n                },\n            },\n        },\n    },\n};\n\nvar res = await sdk.Transfers.CreateAsync(req);\n\n// handle response"
      - lang: java
        label: createTransfer
        source: "package hello.world;\n\nimport com.dailypay.sdk.DailyPay;\nimport com.dailypay.sdk.models.components.*;\nimport com.dailypay.sdk.models.errors.*;\nimport com.dailypay.sdk.models.operations.CreateTransferRequest;\nimport com.dailypay.sdk.models.operations.CreateTransferResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws TransferCreateError, ErrorUnauthorized, ErrorForbidden, ErrorUnexpected, Exception {\n\n        DailyPay sdk = DailyPay.builder()\n                .version(3L)\n                .security(Security.builder()\n                    .oauthClientCredentialsToken(SchemeOauthClientCredentialsToken.builder()\n                        .clientID(\"<id>\")\n                        .clientSecret(\"<value>\")\n                        .tokenURL(\"https://api.dailypay.com/oauth/token\")\n                        .build())\n                    .build())\n            .build();\n\n        CreateTransferRequest req = CreateTransferRequest.builder()\n                .idempotencyKey(\"ea9f2225-403b-4e2c-93b0-0eda090ffa65\")\n                .transferCreateData(TransferCreateData.builder()\n                    .data(TransferCreateResource.builder()\n                        .attributes(TransferAttributesInput.builder()\n                            .amount(2500L)\n                            .currency(\"USD\")\n                            .schedule(TransferAttributesSchedule.WITHIN_THIRTY_MINUTES)\n                            .preview(true)\n                            .build())\n                        .relationships(TransferCreateRelationships.builder()\n                            .origin(AccountRelationship.builder()\n                                .data(AccountIdentifier.builder()\n                                    .id(\"2bc7d781-3247-46f6-b60f-4090d214936a\")\n                                    .build())\n                                .build())\n                            .destination(AccountRelationship.builder()\n                                .data(AccountIdentifier.builder()\n                                    .id(\"2bc7d781-3247-46f6-b60f-4090d214936a\")\n                                    .build())\n                                .build())\n                            .person(PersonRelationship.builder()\n                                .data(PersonIdentifier.builder()\n                                    .id(\"3fa8f641-5717-4562-b3fc-2c963f66afa6\")\n                                    .build())\n                                .build())\n                            .build())\n                        .id(\"aba332a2-24a2-46de-8257-5040e71ab210\")\n                        .build())\n                    .build())\n                .build();\n\n        CreateTransferResponse res = sdk.transfers().create()\n                .request(req)\n                .call();\n\n        if (res.transferData().isPresent()) {\n            // handle response\n        }\n    }\n}"
components:
  responses:
    Unexpected:
      description: Unexpected error occured
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorUnexpected'
    NotFound:
      description: Resource was not found
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorNotFound'
    TransferCreate400:
      description: The request contained an error
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/TransferCreateError'
    Unauthorized:
      description: Invalid authentication credentials
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorUnauthorized'
    Forbidden:
      description: Not authorized to perform this operation
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorForbidden'
    Transfer200:
      description: Returns the newly created transfer object.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/TransferData'
    BadRequest:
      description: Bad Request
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorBadRequest'
    Transfers200:
      description: A list of transfer objects.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/TransfersData'
    Conflict:
      description: A conflict occurred with the current state of the resource
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorConflict'
  schemas:
    TransferLinks:
      type: object
      readOnly: true
      required:
      - self
      properties:
        self:
          $ref: '#/components/schemas/TransferLink'
    PaycheckRelationship:
      type: object
      readOnly: true
      required:
      - data
      properties:
        data:
          $ref: '#/components/schemas/PaycheckIdentifier'
    TransferRelationship:
      type: object
      required:
      - data
      properties:
        data:
          $ref: '#/components/schemas/TransferIdentifier'
    ErrorUnauthorized:
      type: object
      required:
      - errors
      properties:
        errors:
          description: A list of errors that occurred.
          type: array
          items:
            $ref: '#/components/schemas/ErrorUnauthorizedError'
    ErrorNotFound:
      type: object
      required:
      - errors
      properties:
        errors:
          description: A list of errors that occurred.
          type: array
          items:
            $ref: '#/components/schemas/ErrorNotFoundError'
    ErrorBadRequest:
      type: object
      required:
      - errors
      properties:
        errors:
          description: A list of errors that occurred.
          type: array
          items:
            $ref: '#/components/schemas/ErrorBadRequestError'
    Amount:
      type: integer
      minimum: 0
      example: 2500
      description: 'A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, `{ amount: 7250, currency: ''USD'' }` resolves to $72.50.'
    FundingSourceRelationships:
      type: object
      readOnly: true
      required:
      - source
      - transfer
      properties:
        source:
          $ref: '#/components/schemas/PaycheckRelationship'
        transfer:
          $ref: '#/components/schemas/TransferRelationship'
    FundingSourceIdentifier:
      type: object
      readOnly: true
      required:
      - type
      - id
      properties:
        type:
          type: string
          readOnly: true
          const: funding_sources
        id:
          type: string
          readOnly: true
          example: b5393c00b7c113fc2e5ae3e80c785bb2
    AccountRelationship:
      type: object
      required:
      - data
      properties:
        data:
          $ref: '#/components/schemas/AccountIdentifier'
    TransferLink:
      type: string
      format: uri
      readOnly: true
      example: https://api.dailypay.com/rest/transfers/aba332a2-24a2-46de-8257-5040e71ab210
    TransferAttributes:
      allOf:
      - $ref: '#/components/schemas/TransferCreateAttributes'
      - type: object
        required:
        - fee
        - resolved_at
        - status
        - submitted_at
        - preview
        description: "An object representing a transfer of money from one account to another. \nCreated when a person takes an advance against a future paycheck, or on a daily basis \nwhen we update estimated earnings based on current employment.\n"
        properties:
          status:
            type: string
            enum:
            - PENDING
            - SETTLED
            - FAILED
            description: The status of the transfer.
            x

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dailypay/refs/heads/main/openapi/dailypay-transfers-api-openapi.yml