{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-direct-link/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Direct Link payout","siteUrl":"https://docs.omno.com"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"direct-link-payout","__idx":0},"children":["Direct Link payout"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send funds to a customer with no Omno UI, using a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["directRouteId"]},". Direct Link payout supports ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["APM"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps","__idx":1},"children":["Steps"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1-create-the-payout","__idx":2},"children":["1. Create the payout"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v3/public/payout"]}," with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["directRouteId"]}," and the required ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreatePayoutRequest"]}," fields."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.omno.com/v3/public/payout\" \\\n  -H \"Authorization: Bearer <access_token>\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"orderId\": \"order-2026-000124\",\n    \"value\": 100.00,\n    \"currency\": \"EUR\",\n    \"kycVerified\": true,\n    \"customer\": {\n      \"externalUserId\": \"3183818381183\",\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"email\": \"john.doe@example.com\",\n      \"phoneNumber\": \"1 1234567890\",\n      \"dateOfBirth\": \"1990-12-01\",\n      \"billing\": {\n        \"address\": \"123 Main St\",\n        \"city\": \"Atlanta\",\n        \"state\": \"GA\",\n        \"countryCode\": \"US\",\n        \"postalCode\": \"30308\"\n      }\n    },\n    \"directRouteId\": \"944732c4608c441aa91379478b91f76e\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"payoutId\": \"944732c4608c441aa91379478b91f76e\",\n  \"status\": \"CREATED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreatePayoutRequest"]}," fields:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique identifier for the payout."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order-2026-000124"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payout amount."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100.00"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["currency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO 4217 currency."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EUR"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kycVerified"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the customer is KYC-verified in your system."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomerRequest"]}]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["directRouteId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes (Direct Link)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Direct Link Route ID."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["944732c4608c441aa91379478b91f76e"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantAdditionalData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional data for the transaction."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-start-processing","__idx":3},"children":["2. Start processing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v3/public/payout/{payoutId}/process/direct-link"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browser"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalData"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  \"https://api.omno.com/v3/public/payout/944732c4608c441aa91379478b91f76e/process/direct-link\" \\\n  -H \"Authorization: Bearer <access_token>\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"browser\": {\n      \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64)\",\n      \"language\": \"en-US\",\n      \"customerIp\": \"203.0.113.10\",\n      \"javascriptEnabled\": true\n    },\n    \"additionalData\": {}\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/direct-link/payin-apm#the-browser-object"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Browser"]}," field table"]}," for how to collect each value. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalData"]}," carries the destination details for the payout method; your Omno integration team provides the exact keys for your providers."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3-confirm-or-reject-if-manual-approval-applies","__idx":4},"children":["3. Confirm or reject (if manual approval applies)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the payout enters ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WAITING_FOR_CONFIRMATION"]},", confirm or reject it via the API — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/concepts/payouts"},"children":["Payouts & manual approval"]}," and the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["payout API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"4-final-status","__idx":5},"children":["4. Final status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Determine the outcome from a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/concepts/webhooks"},"children":["webhook"]}," or a GET on the transaction."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"failure-states","__idx":6},"children":["Failure states"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rejected"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}," after a reject call; never sent to a provider."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PSP failure"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FAILED"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Timeout"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIMEOUT"]},"; may resolve later."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pending resolving asynchronously"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]},"; final status via webhook."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"build-it-","__idx":7},"children":["Build it →"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/direct-link/payin-apm"},"children":["Pay-in: APM"]}," · ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/concepts/payouts"},"children":["Payouts & manual approval"]}," · ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["Other APIs → Payouts"]}]}]}]},"headings":[{"value":"Direct Link payout","id":"direct-link-payout","depth":1},{"value":"Steps","id":"steps","depth":2},{"value":"1. Create the payout","id":"1-create-the-payout","depth":3},{"value":"2. Start processing","id":"2-start-processing","depth":3},{"value":"3. Confirm or reject (if manual approval applies)","id":"3-confirm-or-reject-if-manual-approval-applies","depth":3},{"value":"4. Final status","id":"4-final-status","depth":3},{"value":"Failure states","id":"failure-states","depth":2},{"value":"Build it →","id":"build-it-","depth":2}],"frontmatter":{"title":"Payout","description":"Send a Direct Link APM payout on Omno v3 — create with a directRouteId, start processing, confirm or reject if manual approval applies, reconcile by webhook.","seo":{"title":"Direct Link payout"}},"lastModified":"2026-11-06T11:46:00.426Z","pagePropGetterError":{"message":"","name":""}},"slug":"/direct-link/payout","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}