{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/rest/guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"How to find and display a user's available earnings","description":"Embed DailyPay On Demand Pay into your applications with our APIs and SDKs.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"how-to-find-and-display-a-users-available-earnings","__idx":0},"children":["How to find and display a user's available earnings"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-are-dailypay-available-earnings","__idx":1},"children":["What are DailyPay Available Earnings?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DailyPay Available Earnings is the portion of a user's balance that they can transfer before payday. The earnings available to transfer will never represent 100% of a user's earnings for a number of reasons, like tax or"," ","other withholding."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DailyPay automatically determines the percentage of earnings a user can transfer early. On"," ","payday, the user will receive the rest of their paycheck."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"displaying-available-earnings","__idx":2},"children":["Displaying Available Earnings"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-1-load-the-available-earnings-element","__idx":3},"children":["Option 1: Load the Available Earnings Element"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/earnings.c62f6c743bec00e8fadb85ff373454d8cf3280a0cab53d606d1f9d87f9cbaddd.dcfb6bc6.svg","alt":"Earnings"},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"See our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/rest/elements/available-earnings"},"children":["guide to embedding the available earnings element"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-2-query-the-accounts-endpoint","__idx":4},"children":["Option 2: Query the accounts endpoint"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"using-a-user-token","__idx":5},"children":["Using a user token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using an authorization token obtained on behalf of a user using ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/rest/guides/auth/authorization-code-flow"},"children":["authorization code flow"]},"  filter the"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/rest/reference/accounts/listaccounts"},"children":["accounts endpoint"]}," by account type:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","data-highlight":"/EARNINGS_BALANCE/","header":{"controls":{"copy":{}}},"source":"curl -i -X GET \\\n  -H 'Accept: application/vnd.api+json' \\\n  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \\\n  -H 'DailyPay-API-Version: 3' \\\n  'https://api.dailypay.com/rest/accounts?filter%5Baccount_type%5D=EARNINGS_BALANCE'  \n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"An available earnings of $120.00 USD:","data-highlight":"/EARNINGS_BALANCE/","header":{"title":"An available earnings of $120.00 USD:","controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"45298626-591f-4f55-ab31-49d3b8e5760c\",\n      \"type\": \"accounts\",\n      \"attributes\": {\n        \"name\": \"DailyPay Available Earnings\",\n        \"account_type\": \"EARNINGS_BALANCE\",\n        \"subtype\": \"ODP\",\n        \"balances\": {\n          \"available\": 12000, // [!code highlight]\n          \"current\": null,\n          \"currency\": \"USD\"\n        },\n        ...\n      },\n      \"relationships\": {...},\n      \"links\": {...}\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"with-client-credentials","__idx":6},"children":["With client credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/rest/guides/auth/client-credentials-flow"},"children":["client credentials authorization token"]}," filter the"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/rest/reference/accounts/listaccounts"},"children":["accounts endpoint"]}," by person id:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","data-highlight":"/filter%5Bperson.id%5D/","header":{"controls":{"copy":{}}},"source":"curl -i -X GET \\\n  -H 'Accept: application/vnd.api+json' \\\n  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \\\n  -H 'DailyPay-API-Version: 3' \\\n  'https://api.dailypay.com/rest/accounts?filter%5Bperson.id%5D=b9fae0ef-4a19-4356-9e82-47b25bbe2f3a'  \n\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Results will automatically be limited to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EARNINGS_BALANCE"]}," account types:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"An available earnings of $120.00 USD:","header":{"title":"An available earnings of $120.00 USD:","controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"45298626-591f-4f55-ab31-49d3b8e5760c\",\n      \"type\": \"accounts\",\n      \"attributes\": {\n        \"name\": \"DailyPay Available Earnings\",\n        \"account_type\": \"EARNINGS_BALANCE\", // [!code highlight]\n        \"subtype\": \"ODP\",\n        \"balances\": {\n          \"available\": 12000, // [!code highlight]\n          \"current\": null,\n          \"currency\": \"USD\"\n        },\n        ...\n      },\n      \"relationships\": {\n        \"data\": {\n          \"type\": \"people\",\n          \"id\": \"b9fae0ef-4a19-4356-9e82-47b25bbe2f3a\"\n        }\n      },\n      \"links\": {...}\n    }\n  ]\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"How to find and display a user's available earnings","id":"how-to-find-and-display-a-users-available-earnings","depth":1},{"value":"What are DailyPay Available Earnings?","id":"what-are-dailypay-available-earnings","depth":3},{"value":"Displaying Available Earnings","id":"displaying-available-earnings","depth":2},{"value":"Option 1: Load the Available Earnings Element","id":"option-1-load-the-available-earnings-element","depth":3},{"value":"Option 2: Query the accounts endpoint","id":"option-2-query-the-accounts-endpoint","depth":3},{"value":"Using a user token","id":"using-a-user-token","depth":4},{"value":"With client credentials","id":"with-client-credentials","depth":4}],"frontmatter":{"seo":{"title":"How to find and display a user's available earnings"}},"lastModified":"2026-07-14T14:30:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/rest/guides/available-earnings","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}