Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
setup_request_id
string
required
ID of the setup request.
Response
The setup request.
id
string
Example:
"trq_XyZ789AbC"
status
enum<string>
Current status of the setup request
Available options:
RequiresPaymentMethod,
RequiresAction,
Processing,
Succeeded,
Failed,
Canceled
Example:
"RequiresPaymentMethod"
payer_id
string | null
ID of the payer associated with this setup request
Example:
"pyr_AbC123XyZ"
payment_method
object | null
Payment method associated with this setup request
session_identifier
string
External session identifier for this setup request
Example:
"trq_XyZ789AbC_abc123..."
description
string | null
Optional description of the setup request
Example:
"Tokenize payment method for customer"
failure_code
string | null
Error code if the setup request failed
Example:
"validation_failed"
failure_message
string | null
Human-readable error message if the setup request failed
Example:
"Payment method validation failed"
expires_at
string<date-time> | null
When the setup request expires
Example:
"2025-12-31T23:59:59Z"
completed_at
string<date-time> | null
When the setup request was completed
Example:
"2025-10-08T18:25:00Z"
ip_address
string | null
IP address of the client making the setup request
Example:
"192.168.1.1"
user_agent
string | null
User agent string of the client making the setup request
Example:
"Mozilla/5.0..."
metadata
object | null
Optional metadata as key-value pairs. Values must be strings.
Show child attributes
Example:
{ "custom_field": "value", "source": "api" }
created_at
string<date-time>
Example:
"2025-10-08T18:20:31Z"
updated_at
string<date-time>
Example:
"2025-10-08T18:25:00Z"
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Acclaim","colors":{"primary":"#ff7c0c","light":"#ff7d0c","dark":"#ff7c0c"},"logo":{"light":"https://mintcdn.com/acclaim/ad5N5falKr6NRACl/logo/light.svg?fit=max\u0026auto=format\u0026n=ad5N5falKr6NRACl\u0026q=85\u0026s=69721ac4077b43dcbf0e9689df283a1e","dark":"https://mintcdn.com/acclaim/ad5N5falKr6NRACl/logo/dark.svg?fit=max\u0026auto=format\u0026n=ad5N5falKr6NRACl\u0026q=85\u0026s=c0e6abc332055650e426de1b60a78056"},"favicon":"https://mintcdn.com/acclaim/7frkHJbjmuhlaCp_/favicon.png?fit=max\u0026auto=format\u0026n=7frkHJbjmuhlaCp_\u0026q=85\u0026s=568c4d07119fae122bb970f503324bb9","appearance":{"default":"light"},"navbar":{"links":[{"href":"https://app.withacclaim.com/","label":"Login"}]},"footer":{"socials":{"x":"https://x.com/withacclaim","github":"https://github.com/WithAcclaim","linkedin":"https://www.linkedin.com/company/withacclaim","facebook":"https://facebook.com/withacclaim","youtube":"https://www.youtube.com/@withacclaim"}},"seo":{"metatags":{"canonical":"https://docs.withacclaim.com"}},"integrations":{"gtm":{"tagId":"GTM-MTKRCF2W"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"acclaim","hasAudioNarration":false,"actualSubdomain":"acclaim","customDomains":["docs.withacclaim.com"],"gitSource":{"type":"github","owner":"withacclaim","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af62ca782d60f6ef170ff98","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Guides","count":262},{"language":"default","tag":"DISBURSE","count":228},{"language":"default","tag":"Supported countries","count":210},{"language":"default","tag":"API Reference","count":65},{"language":"default","tag":"DISBURSE API","count":24},{"language":"default","tag":"ACCEPT API","count":24},{"language":"default","tag":"ACCEPT","count":23},{"language":"default","tag":"Developers","count":13},{"language":"default","tag":"TREASURY API","count":12},{"language":"default","tag":"TREASURY","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@withacclaim.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6a174aba7c586350c4403c0a","deploymentId":"69c044edbfae8e8141df4939","questionText":"What countries and payment methods does Acclaim support for payouts?","status":"active","generatedBy":"manual","createdAt":"2026-05-27T19:49:14.911Z","updatedAt":"2026-05-27T19:49:14.911Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".acclaim-landing-hero{background:linear-gradient(\n 165deg,\n rgb(255 247 237) 0%,\n rgb(250 250 249) 42%,\n rgb(255 255 255) 100%\n );border-bottom:1px solid rgb(255 124 12 / 0.14)}.dark .acclaim-landing-hero{background:linear-gradient(\n 165deg,\n rgb(24 24 27) 0%,\n rgb(28 25 23) 45%,\n rgb(12 10 9) 100%\n );border-bottom-color:rgb(255 124 12 / 0.22)}"}]}
{"page":{"pagePath":"api/setup-requests/retrieve-a-setup-request","slug":"/api/setup-requests/retrieve-a-setup-request","pageMetadata":{"title":"Retrieve a setup request","description":null,"deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /setup_requests/{setup_request_id}","href":"/api/setup-requests/retrieve-a-setup-request","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a setup request","description":null,"deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /setup_requests/{setup_request_id}","href":"/api/setup-requests/retrieve-a-setup-request","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/acclaim/c63a50036dd7fee4/analytics.js"],"openApiReferenceData":{"operation":{"tags":["Setup Requests"],"summary":"Retrieve a setup request","parameters":["2367dbe5-0a63-45d3-99a0-07e341fc59ee"],"responses":{"200":"d47390dd-8183-4596-8212-072beb80db2a","default":"2c3d4d21-a278-4670-8462-185909fd8f7e"},"method":"get","type":"path","servers":["fd6dc2e6-fa2b-4d05-a26a-362b5e50c6b3"],"security":["36a2f868-e053-4941-842e-97a3f243f862"],"path":"/setup_requests/{setup_request_id}","baseUrlOptions":["https://api.withacclaim.com/v1"],"title":"Retrieve a setup request","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2367dbe5-0a63-45d3-99a0-07e341fc59ee":{"name":"setup_request_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of the setup request.","uniqueKey":"","typeLabel":"string"},"description":"ID of the setup request."}},"responses":{"d47390dd-8183-4596-8212-072beb80db2a":{"description":"The setup request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"trq_XyZ789AbC","uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","enum":["RequiresPaymentMethod","RequiresAction","Processing","Succeeded","Failed","Canceled"],"example":"RequiresPaymentMethod","description":"Current status of the setup request","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"payer_id":{"oneOf":[{"type":"string","example":"pyr_AbC123XyZ","description":"ID of the payer associated with this setup request","uniqueKey":"payer_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"pyr_AbC123XyZ","description":"ID of the payer associated with this setup request","uniqueKey":"payer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payer_id","typeLabel":"string | null"},"payment_method":{"oneOf":[{"type":"object","description":"Payment method associated with this setup request","additionalProperties":true,"uniqueKey":"payment_method.oneOf.0","typeLabel":"object"},{"type":"null","description":"Payment method associated with this setup request","additionalProperties":true,"uniqueKey":"payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method","typeLabel":"object | null"},"session_identifier":{"type":"string","example":"trq_XyZ789AbC_abc123...","description":"External session identifier for this setup request","uniqueKey":"session_identifier","typeLabel":"string"},"description":{"oneOf":[{"type":"string","example":"Tokenize payment method for customer","description":"Optional description of the setup request","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Tokenize payment method for customer","description":"Optional description of the setup request","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"failure_code":{"oneOf":[{"type":"string","example":"validation_failed","description":"Error code if the setup request failed","uniqueKey":"failure_code.oneOf.0","typeLabel":"string"},{"type":"null","example":"validation_failed","description":"Error code if the setup request failed","uniqueKey":"failure_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure_code","typeLabel":"string | null"},"failure_message":{"oneOf":[{"type":"string","example":"Payment method validation failed","description":"Human-readable error message if the setup request failed","uniqueKey":"failure_message.oneOf.0","typeLabel":"string"},{"type":"null","example":"Payment method validation failed","description":"Human-readable error message if the setup request failed","uniqueKey":"failure_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure_message","typeLabel":"string | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","example":"2025-12-31T23:59:59Z","description":"When the setup request expires","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2025-12-31T23:59:59Z","description":"When the setup request expires","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2025-10-08T18:25:00Z","description":"When the setup request was completed","uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2025-10-08T18:25:00Z","description":"When the setup request was completed","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"},"ip_address":{"oneOf":[{"type":"string","example":"192.168.1.1","description":"IP address of the client making the setup request","uniqueKey":"ip_address.oneOf.0","typeLabel":"string"},{"type":"null","example":"192.168.1.1","description":"IP address of the client making the setup request","uniqueKey":"ip_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"ip_address","typeLabel":"string | null"},"user_agent":{"oneOf":[{"type":"string","example":"Mozilla/5.0...","description":"User agent string of the client making the setup request","uniqueKey":"user_agent.oneOf.0","typeLabel":"string"},{"type":"null","example":"Mozilla/5.0...","description":"User agent string of the client making the setup request","uniqueKey":"user_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_agent","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","description":"Optional metadata as key-value pairs. Values must be strings.","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"custom_field":"value","source":"api"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional metadata as key-value pairs. Values must be strings.","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"custom_field":"value","source":"api"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","example":"2025-10-08T18:20:31Z","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2025-10-08T18:25:00Z","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"trq_XyZ789AbC","status":"RequiresPaymentMethod","payer_id":"pyr_AbC123XyZ","payment_method":{},"session_identifier":"trq_XyZ789AbC_abc123...","description":"Tokenize payment method for customer","failure_code":"validation_failed","failure_message":"Payment method validation failed","expires_at":"2025-12-31T23:59:59Z","completed_at":"2025-10-08T18:25:00Z","ip_address":"192.168.1.1","user_agent":"Mozilla/5.0...","metadata":{"custom_field":"value","source":"api"},"created_at":"2025-10-08T18:20:31Z","updated_at":"2025-10-08T18:25:00Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"2c3d4d21-a278-4670-8462-185909fd8f7e":{"description":"Error payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"invalid_request","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field: amount","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"},"request_id":{"type":"string","example":"req_7lYt4o2x","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"Missing required field: amount","details":{},"request_id":"req_7lYt4o2x"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"36a2f868-e053-4941-842e-97a3f243f862":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"fd6dc2e6-fa2b-4d05-a26a-362b5e50c6b3":{"url":"https://api.withacclaim.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.withacclaim.com/openapi.yaml"},"subdomain":"acclaim","siteName":"Acclaim","title":"Retrieve a setup request - Acclaim","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api/setup-requests/retrieve-a-setup-request.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Acclaim\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a setup request - Acclaim\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Acclaim\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://acclaim.mintlify.site/_mintlify/api/og/v2?division=Setup+Requests\u0026amp;title=Retrieve+a+setup+request\u0026amp;theme=7e6b9380bba72137be6ba959\u0026amp;signature=a4e1a3ccb2cd190509660da26fb32a696d30b35f5937e7a4f643489d0f1a1d8b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a setup request - Acclaim\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://acclaim.mintlify.site/_mintlify/api/og/v2?division=Setup+Requests\u0026amp;title=Retrieve+a+setup+request\u0026amp;theme=7e6b9380bba72137be6ba959\u0026amp;signature=a4e1a3ccb2cd190509660da26fb32a696d30b35f5937e7a4f643489d0f1a1d8b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/acclaim/RvsLo7pr1CB1LUYx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Acclaim\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff7c0c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/setup-requests/retrieve-a-setup-request.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.withacclaim.com/#organization\",\"name\":\"Acclaim\",\"url\":\"https://docs.withacclaim.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/acclaim/ad5N5falKr6NRACl/logo/light.svg?fit=max\u0026auto=format\u0026n=ad5N5falKr6NRACl\u0026q=85\u0026s=69721ac4077b43dcbf0e9689df283a1e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.withacclaim.com#website\",\"name\":\"Acclaim\",\"url\":\"https://docs.withacclaim.com\",\"publisher\":{\"@id\":\"https://docs.withacclaim.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request#webpage\",\"url\":\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request\",\"name\":\"Retrieve a setup request\",\"isPartOf\":{\"@id\":\"https://docs.withacclaim.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"ACCEPT API\",\"item\":\"https://docs.withacclaim.com/api/payers/list-payers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Setup Requests\",\"item\":\"https://docs.withacclaim.com/api/setup-requests/list-setup-requests\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a setup request\",\"item\":\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request#apireference\",\"headline\":\"Retrieve a setup request\",\"name\":\"Retrieve a setup request\",\"url\":\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withacclaim.com/api/setup-requests/retrieve-a-setup-request#webpage\"},\"publisher\":{\"@id\":\"https://docs.withacclaim.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.withacclaim.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Acclaim\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Acclaim\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/setup-requests/retrieve-a-setup-request.md","siteName":"Acclaim","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/guides/getting-started/overview"}]},{"tab":"Developers","icon":"code-merge","pages":[{"title":"Developers","href":"/developers/getting-started"}]},{"tab":"API Reference","icon":"code","pages":[{"group":"ACCLAIM API","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Authentication","href":"/api/auth"},{"title":"Errors","href":"/api/errors"},{"title":"Pagination","href":"/api/pagination"},{"title":"Changelog","href":"/api/changelog"}]},{"group":"ACCEPT API","icon":"arrow-circle-down","expanded":true,"pages":[{"group":"Payers","pages":[{"title":"List payers","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payers","href":"/api/payers/list-payers"},{"title":"Create a payer","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payers","href":"/api/payers/create-a-payer"},{"title":"Retrieve a payer","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payers/{payer_id}","href":"/api/payers/retrieve-a-payer"},{"title":"Update a payer","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml patch /payers/{payer_id}","href":"/api/payers/update-a-payer"},{"title":"Delete a payer","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml delete /payers/{payer_id}","href":"/api/payers/delete-a-payer"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods for a payer","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payers/{payer_id}/payment_methods","href":"/api/payment-methods/list-payment-methods-for-a-payer"},{"title":"Retrieve a payment method","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payers/{payer_id}/payment_methods/{payment_method_id}","href":"/api/payment-methods/retrieve-a-payment-method"},{"title":"Update a payment method","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml patch /payers/{payer_id}/payment_methods/{payment_method_id}","href":"/api/payment-methods/update-a-payment-method"},{"title":"Delete a payment method","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml delete /payers/{payer_id}/payment_methods/{payment_method_id}","href":"/api/payment-methods/delete-a-payment-method"}]},{"group":"Payment Requests","pages":[{"title":"List payment requests","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payment_requests","href":"/api/payment-requests/list-payment-requests"},{"title":"Create a payment request","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payment_requests","href":"/api/payment-requests/create-a-payment-request"},{"title":"Retrieve a payment request","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payment_requests/{payment_request_id}","href":"/api/payment-requests/retrieve-a-payment-request"},{"title":"Update a payment request","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml patch /payment_requests/{payment_request_id}","href":"/api/payment-requests/update-a-payment-request"},{"title":"Cancel a payment request","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payment_requests/{payment_request_id}/cancel","href":"/api/payment-requests/cancel-a-payment-request"},{"title":"Confirm a payment request","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payment_requests/{payment_request_id}/confirm","href":"/api/payment-requests/confirm-a-payment-request"}]},{"group":"Setup Requests","pages":[{"title":"List setup requests","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /setup_requests","href":"/api/setup-requests/list-setup-requests"},{"title":"Create a setup request","description":"Create a setup request for securely storing a payment method. The request will be in RequiresPaymentMethod status until a payment method is provided.","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /setup_requests","href":"/api/setup-requests/create-a-setup-request"},{"title":"Retrieve a setup request","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /setup_requests/{setup_request_id}","href":"/api/setup-requests/retrieve-a-setup-request"},{"title":"Update a setup request","description":"Update a setup request. Only provided fields will be updated. Can update description, payer, payment method, and expiration date.","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml patch /setup_requests/{setup_request_id}","href":"/api/setup-requests/update-a-setup-request"},{"title":"Cancel a setup request","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /setup_requests/{setup_request_id}/cancel","href":"/api/setup-requests/cancel-a-setup-request"},{"title":"Confirm a setup request","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /setup_requests/{setup_request_id}/confirm","href":"/api/setup-requests/confirm-a-setup-request"}]},{"group":"Refunds","pages":[{"title":"Create a refund for a payment","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payments/{payment_id}/refunds","href":"/api/refunds/create-a-refund-for-a-payment"},{"title":"List refunds","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /refunds","href":"/api/refunds/list-refunds"},{"title":"Retrieve a refund","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /refunds/{refund_id}","href":"/api/refunds/retrieve-a-refund"}]}]},{"group":"DISBURSE API","icon":"arrow-circle-up","expanded":true,"pages":[{"group":"Payees","pages":[{"title":"List payees","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payees","href":"/api/treasury-payees/list-payees"},{"title":"Create a payee","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payees","href":"/api/treasury-payees/create-a-payee"},{"title":"Retrieve a payee","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payees/{payee_id}","href":"/api/payees/retrieve-a-payee"},{"title":"Update a payee","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml patch /payees/{payee_id}","href":"/api/payees/update-a-payee"},{"title":"Create or update a payee by identifier","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml put /payees/{identifier}","href":"/api/payees/create-or-update-a-payee-by-identifier"}]},{"group":"Payout methods","pages":[{"title":"List payout methods for a payee","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payees/{payee_id}/payout_methods","href":"/api/payout-methods/list-payout-methods-for-a-payee"},{"title":"Create a payout method for a payee","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payees/{payee_id}/payout_methods","href":"/api/payout-methods/create-a-payout-method-for-a-payee"},{"title":"Retrieve a payout method","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payees/{payee_id}/payout_methods/{payout_method_id}","href":"/api/payout-methods/retrieve-a-payout-method"},{"title":"Update a payout method","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml patch /payees/{payee_id}/payout_methods/{payout_method_id}","href":"/api/payout-methods/update-a-payout-method"},{"title":"Delete a payout method","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml delete /payees/{payee_id}/payout_methods/{payout_method_id}","href":"/api/payout-methods/delete-a-payout-method"},{"title":"Generate payout method schemas","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payout_method_schemas","href":"/api/payout-methods/generate-payout-method-schemas"}]},{"group":"Payouts","pages":[{"title":"List payouts","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payouts","href":"/api/payouts/list-payouts"},{"title":"Create a payout","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payouts","href":"/api/payouts/create-a-payout"},{"title":"Retrieve a payout","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payouts/{payout_id}","href":"/api/payouts/retrieve-a-payout"},{"title":"Update a payout","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml patch /payouts/{payout_id}","href":"/api/payouts/update-a-payout"},{"title":"Cancel a payout","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payouts/{payout_id}/cancel","href":"/api/payouts/cancel-a-payout"}]},{"group":"Payout batches","pages":[{"title":"List payout batches","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payout_batches","href":"/api/payout-batches/list-payout-batches"},{"title":"Create a payout batch","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payout_batches","href":"/api/payout-batches/create-a-payout-batch"},{"title":"Retrieve a payout batch","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payout_batches/{batch_id}","href":"/api/payout-batches/retrieve-a-payout-batch"},{"title":"List payouts in a batch","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /payout_batches/{batch_id}/items","href":"/api/payout-batches/list-payouts-in-a-batch"},{"title":"Add payouts to a batch","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payout_batches/{batch_id}/add_items","href":"/api/payout-batches/add-payouts-to-a-batch"},{"title":"Remove payouts from a batch","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payout_batches/{batch_id}/remove_items","href":"/api/payout-batches/remove-payouts-from-a-batch"},{"title":"Process a payout batch","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payout_batches/{batch_id}/process","href":"/api/payout-batches/process-a-payout-batch"},{"title":"Cancel a payout batch","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /payout_batches/{batch_id}/cancel","href":"/api/payout-batches/cancel-a-payout-batch"}]}]},{"group":"TREASURY API","icon":"layer-group","expanded":true,"pages":[{"group":"Treasury accounts","pages":[{"title":"List treasury accounts","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /treasury_accounts","href":"/api/treasury-treasury-accounts/list-treasury-accounts"},{"title":"Create a treasury account","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /treasury_accounts","href":"/api/treasury-treasury-accounts/create-a-treasury-account"},{"title":"Retrieve a treasury account","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /treasury_accounts/{treasury_account_id}","href":"/api/treasury-treasury-accounts/retrieve-a-treasury-account"},{"title":"List treasury transactions","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /treasury_accounts/{treasury_account_id}/transactions","href":"/api/treasury-treasury-accounts/list-treasury-transactions"},{"title":"Retrieve a treasury transaction","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /treasury_accounts/{treasury_account_id}/transactions/{transaction_id}","href":"/api/treasury-treasury-accounts/retrieve-a-treasury-transaction"},{"title":"Transfer between treasury accounts","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /treasury_accounts/{treasury_account_id}/transfers","href":"/api/treasury-treasury-accounts/transfer-between-treasury-accounts"}]},{"group":"Funding","pages":[{"title":"Deposit from a settlement account","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /treasury_accounts/{treasury_account_id}/fundings","href":"/api/treasury-funding/deposit-from-a-settlement-account"},{"title":"Withdraw to a settlement account","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml post /treasury_accounts/{treasury_account_id}/withdrawals","href":"/api/treasury-funding/withdraw-to-a-settlement-account"},{"title":"List settlement accounts","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /settlement_accounts","href":"/api/treasury-funding/list-settlement-accounts"},{"title":"Retrieve a settlement account","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /settlement_accounts/{settlement_account_id}","href":"/api/treasury-funding/retrieve-a-settlement-account"},{"title":"List virtual accounts","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /virtual_accounts","href":"/api/treasury-funding/list-virtual-accounts"},{"title":"Retrieve a virtual account","deprecated":null,"version":null,"openapi":"https://api.withacclaim.com/openapi.yaml get /virtual_accounts/{virtual_account_id}","href":"/api/treasury-funding/retrieve-a-virtual-account"}]}]}]}]},"basePath":"","title":"Retrieve a setup request - Acclaim","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}