Creates a new address for an existing payee contact.
This endpoint will:
Verify the payee exists and belongs to the specified user
Validate the address information and format
Check that the payee hasn’t exceeded the maximum of 5 addresses
Create and store the new address for future check payments
Each payee can have up to 20 different addresses to support multiple locations
or address changes. These addresses can be used when sending physical check payments.
The Unix timestamp (in seconds) indicating when the response was generated.
Example:
1718006400
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paywint API Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-dark.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=f12d90d73ed14c836d511ba59f126f89","dark":"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-light.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=dd0531c96945bbfd4f68f70bde733ca7"},"favicon":"https://mintcdn.com/paywint/orA5aITV2zVCFn-B/favicon.ico?fit=max\u0026auto=format\u0026n=orA5aITV2zVCFn-B\u0026q=85\u0026s=6eb5a2357ac8b399600e7997771b7068","api":{"openapi":{"source":"https://api.sandbox.paywint.com/openapi.json?v=1.0.0","directory":"api-reference"}},"navbar":{"links":[{"href":"mailto:support@paywint.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.paywint.com"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@paywint","facebook":"https://www.facebook.com/paywintonline","instagram":"https://www.instagram.com/paywint","x":"https://x.com/paywint","linkedin":"https://www.linkedin.com/company/paywint","threads":"https://www.threads.net/@paywint"}},"seo":{"indexing":"all"},"fonts":{"family":"Inter","weight":400},"styling":{"eyebrows":"breadcrumbs","latex":false},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paywint","hasAudioNarration":false,"actualSubdomain":"paywint","customDomains":["developer.paywint.com"],"gitSource":{"type":"github","owner":"paywint-developer","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9292e38209ab1c632e1e9:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":79},{"language":"default","tag":"Cross Border Payments","count":12},{"language":"default","tag":"Bank Accounts","count":8},{"language":"default","tag":"Payments","count":7},{"language":"default","tag":"Guidelines","count":7},{"language":"default","tag":"URL Standards","count":7},{"language":"default","tag":"Cards","count":6},{"language":"default","tag":"Payee Management","count":6},{"language":"default","tag":"KYC \u0026 KYB","count":5},{"language":"default","tag":"Payee Addresses","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"llms-txt-v2","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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payees/addresses/add","slug":"/api-reference/payees/addresses/add","pageMetadata":{"title":"Add Payee Address","openapi":"POST /api/platform/address/create-payee-address/{user_id}","description":"Creates a new address for an existing payee contact.\n\nThis endpoint will:\n- Verify the payee exists and belongs to the specified user\n- Validate the address information and format\n- Check that the payee hasn't exceeded the maximum of 5 addresses\n- Create and store the new address for future check payments\n\nEach payee can have up to 20 different addresses to support multiple locations\nor address changes. These addresses can be used when sending physical check payments.","href":"/api-reference/payees/addresses/add"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a new address for an existing payee contact.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint will:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Verify the payee exists and belongs to the specified user\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Validate the address information and format\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Check that the payee hasn’t exceeded the maximum of 5 addresses\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Create and store the new address for future check payments\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Each payee can have up to 20 different addresses to support multiple locations\\nor address changes. These addresses can be used when sending physical check payments.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"Add Payee Address","openapi":"POST /api/platform/address/create-payee-address/{user_id}","description":"Creates a new address for an existing payee contact.\n\nThis endpoint will:\n- Verify the payee exists and belongs to the specified user\n- Validate the address information and format\n- Check that the payee hasn't exceeded the maximum of 5 addresses\n- Create and store the new address for future check payments\n\nEach payee can have up to 20 different addresses to support multiple locations\nor address changes. These addresses can be used when sending physical check payments.","href":"/api-reference/payees/addresses/add"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Platform Address"],"summary":"Create Payee Mailing Address","description":"Creates a new address for an existing payee contact.\n\nThis endpoint will:\n- Verify the payee exists and belongs to the specified user\n- Validate the address information and format\n- Check that the payee hasn't exceeded the maximum of 5 addresses\n- Create and store the new address for future check payments\n\nEach payee can have up to 20 different addresses to support multiple locations\nor address changes. These addresses can be used when sending physical check payments.","operationId":"create_payee_address_api_platform_address_create_payee_address__user_id__post","parameters":["be451129-b759-4264-bd8f-2e8e6391904c","28589fd8-5168-45eb-a80d-7fd52127c378","afebef2e-f83a-479d-a1b3-440fe0fd380a"],"requestBody":"10d66bd3-2b02-4ca5-aec8-cdf3ef6ec6da","responses":{"200":"094f797f-ad08-4d38-92a1-8758efe85932","422":"e6573bbd-451b-42bd-972e-28b7ffcb48ef"},"method":"post","type":"path","servers":["44a613da-32d2-4c57-bda9-25c34c98d8e8","d63574fc-ac93-4daa-ba67-9fa825653088"],"security":[],"path":"/api/platform/address/create-payee-address/{user_id}","baseUrlOptions":["https://api.paywint.com","https://api.sandbox.paywint.com"],"title":"Create Payee Mailing Address","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"be451129-b759-4264-bd8f-2e8e6391904c":{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Unique identifier (UUID) of the user","title":"User Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Unique identifier (UUID) of the user","example":"f47ac10b-****-****-****-0e02b2c3d479"},"28589fd8-5168-45eb-a80d-7fd52127c378":{"name":"X-Platform-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.","title":"X-Platform-Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request."},"afebef2e-f83a-479d-a1b3-440fe0fd380a":{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string","description":"HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.","title":"X-Signature","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"payee_id":{"type":"string","format":"uuid4","title":"Payee Id","description":"Unique identifier (UUID) of the payee for whom this address is being created.","example":"f47ac10b-****-****-****-0e02b2c3d479","isRequired":true,"uniqueKey":"payee_id","typeLabel":"string\u003cuuid4>"},"name":{"type":"string","maxLength":100,"minLength":2,"title":"Name","description":"Recipient's first name.","example":"John","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"address_line_1":{"type":"string","maxLength":100,"title":"Address Line 1","description":"Street address including apartment, suite, or unit number.","example":"123 Main Street, Apt 4B","isRequired":true,"uniqueKey":"address_line_1","typeLabel":"string"},"city":{"type":"string","maxLength":40,"title":"City","description":"City name.","example":"New York","isRequired":true,"uniqueKey":"city","typeLabel":"string"},"state":{"type":"string","maxLength":30,"title":"State","description":"State, province, or region.","example":"NY","isRequired":true,"uniqueKey":"state","typeLabel":"string"},"zipcode":{"type":"string","maxLength":10,"title":"Zipcode","description":"Postal code or ZIP code.","example":"10001","isRequired":true,"uniqueKey":"zipcode","typeLabel":"string"},"country":{"type":"string","maxLength":40,"title":"Country","description":"Country name.","example":"United States","isRequired":true,"uniqueKey":"country","typeLabel":"string"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"Recipient's last name (optional).","maxLength":100,"example":"Smith","uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"Recipient's last name (optional).","example":"Smith","uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_name","typeLabel":"string | null"},"address_line_2":{"oneOf":[{"type":"string","title":"Address Line 2","description":"Street address including apartment, suite, or unit number.","maxLength":100,"example":"123 Main Street, Apt 4B","uniqueKey":"address_line_2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address Line 2","description":"Street address including apartment, suite, or unit number.","example":"123 Main Street, Apt 4B","uniqueKey":"address_line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address_line_2","typeLabel":"string | null"},"company_name":{"oneOf":[{"type":"string","title":"Company Name","description":"Full name of the payee's company.","maxLength":100,"example":"Meta Corp","uniqueKey":"company_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Company Name","description":"Full name of the payee's company.","example":"Meta Corp","uniqueKey":"company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"company_name","typeLabel":"string | null"}},"type":"object","required":["payee_id","name","address_line_1","city","state","zipcode","country"],"title":"ExternalContactAddressCreate","uniqueKey":"","typeLabel":"ExternalContactAddressCreate · object"},"examples":{"Example":{"title":"Example","value":{"payee_id":"f47ac10b-****-****-****-0e02b2c3d479","name":"John","address_line_1":"123 Main Street, Apt 4B","city":"New York","state":"NY","zipcode":"10001","country":"United States","last_name":"Smith","address_line_2":"123 Main Street, Apt 4B","company_name":"Meta Corp"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"094f797f-ad08-4d38-92a1-8758efe85932":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success","description":"Indicates whether the request was processed successfully.","default":true,"example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","title":"Message","description":"A short, human-readable message describing the result of the request.","default":"Success","example":"Operation completed.","uniqueKey":"message","typeLabel":"string"},"data":{"oneOf":[{"type":"object","title":"ExternalContactAddressRead","description":"The main response payload, if applicable","properties":{"address_id":{"type":"string","format":"uuid4","title":"Address Id","description":"Unique identifier (UUID) for this address record.","example":"a1b2c3d4-****-****-****-e5f6g7h8i9j0","uniqueKey":"data.oneOf.0.address_id","typeLabel":"string\u003cuuid4>"},"fist_name":{"type":"string","maxLength":100,"minLength":2,"title":"Fist Name","description":"Recipient's first name.","example":"John","uniqueKey":"data.oneOf.0.fist_name","typeLabel":"string"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"Recipient's last name (optional).","maxLength":100,"example":"Doe","uniqueKey":"data.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"Recipient's last name (optional).","example":"Doe","uniqueKey":"data.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.last_name","typeLabel":"string | null"},"address_line_1":{"type":"string","maxLength":100,"title":"Address Line 1","description":"Street address including apartment, suite, or unit number.","example":"123 Main Street, Apt 4B","uniqueKey":"data.oneOf.0.address_line_1","typeLabel":"string"},"address_line_2":{"oneOf":[{"type":"string","title":"Address Line 2","description":"Street address including apartment, suite, or unit number.","maxLength":100,"example":"123 Main Street, Apt 4B","uniqueKey":"data.oneOf.0.address_line_2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address Line 2","description":"Street address including apartment, suite, or unit number.","example":"123 Main Street, Apt 4B","uniqueKey":"data.oneOf.0.address_line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.address_line_2","typeLabel":"string | null"},"company_name":{"oneOf":[{"type":"string","title":"Company Name","description":"Full name of the payee's company.","maxLength":100,"example":"Meta Corp","uniqueKey":"data.oneOf.0.company_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Company Name","description":"Full name of the payee's company.","example":"Meta Corp","uniqueKey":"data.oneOf.0.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.company_name","typeLabel":"string | null"},"city":{"type":"string","maxLength":40,"title":"City","description":"City name.","example":"New York","uniqueKey":"data.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","maxLength":30,"title":"State","description":"State, province, or region.","example":"NY","uniqueKey":"data.oneOf.0.state","typeLabel":"string"},"zipcode":{"type":"string","maxLength":10,"title":"Zipcode","description":"Postal code or ZIP code.","example":"10001","uniqueKey":"data.oneOf.0.zipcode","typeLabel":"string"},"country":{"type":"string","maxLength":40,"title":"Country","description":"Country name.","example":"United States","uniqueKey":"data.oneOf.0.country","typeLabel":"string"},"is_default":{"type":"boolean","title":"Is Default","description":"Mark this address as the default payee address.","default":false,"uniqueKey":"data.oneOf.0.is_default","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"ISO 8601 timestamp indicating when this address record was created.","example":"2024-01-15T10:30:00Z","uniqueKey":"data.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","description":"ISO 8601 timestamp indicating when this address record was updated.","format":"date-time","example":"2024-01-15T10:30:00Z","uniqueKey":"data.oneOf.0.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Updated At","description":"ISO 8601 timestamp indicating when this address record was updated.","example":"2024-01-15T10:30:00Z","uniqueKey":"data.oneOf.0.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.oneOf.0","typeLabel":"ExternalContactAddressRead · object"},{"type":"null","description":"The main response payload, if applicable","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"ExternalContactAddressRead · object | null"},"queryGeneratedTime":{"oneOf":[{"type":"number","title":"Querygeneratedtime","description":"The Unix timestamp (in seconds) indicating when the response was generated.","default":1783679844.273462,"example":1718006400,"uniqueKey":"queryGeneratedTime.oneOf.0","typeLabel":"number"},{"type":"null","title":"Querygeneratedtime","description":"The Unix timestamp (in seconds) indicating when the response was generated.","default":1783679844.273462,"example":1718006400,"uniqueKey":"queryGeneratedTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"queryGeneratedTime","typeLabel":"number | null"}},"type":"object","title":"CommonResponse[ExternalContactAddressRead]","uniqueKey":"","typeLabel":"CommonResponse[ExternalContactAddressRead] · object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"Operation completed.","data":{"address_id":"a1b2c3d4-****-****-****-e5f6g7h8i9j0","fist_name":"John","last_name":"Doe","address_line_1":"123 Main Street, Apt 4B","address_line_2":"123 Main Street, Apt 4B","company_name":"Meta Corp","city":"New York","state":"NY","zipcode":"10001","country":"United States","is_default":false,"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z"},"queryGeneratedTime":1718006400}}},"exampleType":"generated"}},"exampleType":"generated"},"e6573bbd-451b-42bd-972e-28b7ffcb48ef":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"44a613da-32d2-4c57-bda9-25c34c98d8e8":{"url":"https://api.paywint.com"},"d63574fc-ac93-4daa-ba67-9fa825653088":{"url":"https://api.sandbox.paywint.com"}}},"originalFileLocation":"https://api.sandbox.paywint.com/openapi.json?v=1.0.0"},"subdomain":"paywint","siteName":"Paywint API Documentation","title":"Add Payee Address - Paywint API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/payees/addresses/add.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=\"system\"}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=\"description\" content=\"Creates a new address for an existing payee contact. This endpoint will: - Verify the payee exists and belongs to the specified user - Validate the address information and format - Check that the payee hasn\u0026#x27;t exceeded the maximum of 5 addresses - Create and store the new address for future check payments Each payee can have up to 20 different addresses to support multiple locations or address changes. These addresses can be used when sending physical check payments.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_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/paywint/Rui-6qiiIEQFwPVS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add Payee Address - Paywint API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new address for an existing payee contact. This endpoint will: - Verify the payee exists and belongs to the specified user - Validate the address information and format - Check that the payee hasn\u0026#x27;t exceeded the maximum of 5 addresses - Create and store the new address for future check payments Each payee can have up to 20 different addresses to support multiple locations or address changes. These addresses can be used when sending physical check payments.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.paywint.com/api-reference/payees/addresses/add\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paywint.mintlify.site/_mintlify/api/og/v2?division=Payee+Addresses\u0026amp;title=Add+Payee+Address\u0026amp;description=Creates+a+new+address+for+an+existing+payee+contact.%0A%0AThis+endpoint+will%3A%0A-+Verify+the+payee+exists+and+belongs+to+the+specified+user%0A-+Validate+the+address+inf\u0026amp;theme=797b9154450531e0ce6f7e8b\u0026amp;signature=bd0d741030b32578bc5eecd13a238f531c61224c73682ea1ed5f52c5d90058ea\">\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=\"Add Payee Address - Paywint API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new address for an existing payee contact. This endpoint will: - Verify the payee exists and belongs to the specified user - Validate the address information and format - Check that the payee hasn\u0026#x27;t exceeded the maximum of 5 addresses - Create and store the new address for future check payments Each payee can have up to 20 different addresses to support multiple locations or address changes. These addresses can be used when sending physical check payments.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywint.mintlify.site/_mintlify/api/og/v2?division=Payee+Addresses\u0026amp;title=Add+Payee+Address\u0026amp;description=Creates+a+new+address+for+an+existing+payee+contact.%0A%0AThis+endpoint+will%3A%0A-+Verify+the+payee+exists+and+belongs+to+the+specified+user%0A-+Validate+the+address+inf\u0026amp;theme=797b9154450531e0ce6f7e8b\u0026amp;signature=bd0d741030b32578bc5eecd13a238f531c61224c73682ea1ed5f52c5d90058ea\">\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/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.paywint.com/api-reference/payees/addresses/add\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payees/addresses/add.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.paywint.com/#organization\",\"name\":\"Paywint API Documentation\",\"url\":\"https://developer.paywint.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-dark.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=f12d90d73ed14c836d511ba59f126f89\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.paywint.com#website\",\"name\":\"Paywint API Documentation\",\"url\":\"https://developer.paywint.com\",\"publisher\":{\"@id\":\"https://developer.paywint.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.paywint.com/api-reference/payees/addresses/add#webpage\",\"url\":\"https://developer.paywint.com/api-reference/payees/addresses/add\",\"name\":\"Add Payee Address\",\"description\":\"Creates a new address for an existing payee contact. This endpoint will: - Verify the payee exists and belongs to the specified user - Validate the address information and format - Check that the payee hasn't exceeded the maximum of 5 addresses - Create and store the new address for future check payments Each payee can have up to 20 different addresses to support multiple locations or address changes. These addresses can be used when sending physical check payments.\",\"isPartOf\":{\"@id\":\"https://developer.paywint.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.paywint.com/api-reference/payees/addresses/add#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.paywint.com/api-reference/payees/addresses/add#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payee Addresses\",\"item\":\"https://developer.paywint.com/api-reference/payees/addresses/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add Payee Address\",\"item\":\"https://developer.paywint.com/api-reference/payees/addresses/add\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.paywint.com/api-reference/payees/addresses/add#apireference\",\"headline\":\"Add Payee Address\",\"name\":\"Add Payee Address\",\"description\":\"Creates a new address for an existing payee contact. This endpoint will: - Verify the payee exists and belongs to the specified user - Validate the address information and format - Check that the payee hasn't exceeded the maximum of 5 addresses - Create and store the new address for future check payments Each payee can have up to 20 different addresses to support multiple locations or address changes. These addresses can be used when sending physical check payments.\",\"url\":\"https://developer.paywint.com/api-reference/payees/addresses/add\",\"mainEntityOfPage\":{\"@id\":\"https://developer.paywint.com/api-reference/payees/addresses/add#webpage\"},\"publisher\":{\"@id\":\"https://developer.paywint.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.paywint.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paywint API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Paywint API Documentation","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"rocket","pages":[{"title":"Get Started","href":"/get-started/overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Users","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/users/overview"},{"title":"Create User","openapi":"POST /api/platform/users/create","href":"/api-reference/users/create"},{"title":"List Users","openapi":"POST /api/platform/users/list","href":"/api-reference/users/list"},{"title":"Get User","openapi":"GET /api/platform/users/get/{user_id}","href":"/api-reference/users/get"}]},{"group":"KYC \u0026 KYB","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/compliance/overview"},{"title":"Submit KYC","openapi":"GET /api/platform/persona/platform-user/inquiry/{user_id}","href":"/api-reference/compliance/kyc/create-enquiry-link"},{"title":"Get KYC","openapi":"GET /api/platform/users/kyc/{user_id}","href":"/api-reference/compliance/kyc/get"},{"title":"Submit KYB","openapi":"POST /api/platform/kyb/submit-kyb/{user_id}","href":"/api-reference/compliance/kyb/submit"},{"title":"Get KYB","openapi":"GET /api/platform/kyb/{user_id}","href":"/api-reference/compliance/kyb/get"}]},{"group":"Wallet","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/wallet/overview"},{"title":"Get Wallet","openapi":"GET /api/platform/wallet/get/{user_id}","href":"/api-reference/wallet/get"},{"title":"Fund Wallet / ACH Pull","openapi":"POST /api/platform/wallet/fund-wallet/{user_id}","href":"/api-reference/wallet/fund"},{"title":"Withdraw Fund","openapi":"POST /api/platform/withdrawals/withdraw-fund/{user_id}","href":"/api-reference/wallet/withdraw"}]},{"group":"Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payments/overview"},{"title":"Create Payment","openapi":"POST /api/platform/payment/create-payment","href":"/api-reference/payments/create"},{"title":"Mail Check","openapi":"POST /api/platform/payment/mail-check/{user_id}","href":"/api-reference/payments/mail-check"},{"title":"Get Payment Details","openapi":"GET /api/platform/payment/get-payment/{payment_id}","href":"/api-reference/payments/get"},{"title":"List Payments","openapi":"POST /api/platform/payment/list-payment","href":"/api-reference/payments/list"},{"title":"List User Payments","openapi":"POST /api/platform/payment/list-payment/{user_id}","href":"/api-reference/payments/list-sent"},{"title":"List User Received Payments","openapi":"POST /api/platform/payment/list-received-payment/{user_id}","href":"/api-reference/payments/list-received"}]},{"group":"Accept Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payments/checkout/overview"},{"title":"Create Payment Link","openapi":"POST /api/platform/payment/create-payment-link/{user_id}","href":"/api-reference/payments/checkout/create-payment-link"},{"title":"Create Checkout SDK Token","openapi":"POST /api/checkout/token/platform","href":"/api-reference/payments/checkout/create-checkout-token"}]},{"group":"Cross Border Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/cross-boarder-payments/overview"},{"title":"Create a Cross-Border Payment","openapi":"POST /api/platform/cross-border/create-payment","href":"/api-reference/cross-boarder-payments/create-a-cross-border-payment"},{"title":"List Payout Banks","openapi":"GET /api/platform/cross-border/payout-banks","href":"/api-reference/cross-boarder-payments/list-payout-banks"},{"title":"Get Exchange Rates","openapi":"GET /api/platform/cross-border/rates","href":"/api-reference/cross-boarder-payments/get-exchange-rates"},{"title":"Get Payee Rules (Mandatory Fields)","openapi":"GET /api/platform/cross-border/payee-rules","href":"/api-reference/cross-boarder-payments/get-payee-rules"},{"title":"Add a Payee Address","openapi":"POST /api/platform/cross-border/payee/address/{user_id}","href":"/api-reference/cross-boarder-payments/add-payee-address"},{"title":"Get a Payee Address","openapi":"GET /api/platform/cross-border/payee/address/{user_id}/{address_id}","href":"/api-reference/cross-boarder-payments/get-a-payee-address"},{"title":"Edit a Payee Address","openapi":"PATCH /api/platform/cross-border/payee/address/{user_id}/{address_id}","href":"/api-reference/cross-boarder-payments/edit-a-payee-address"},{"title":"List Payee Addresses","openapi":"GET /api/platform/cross-border/payee/addresses/{user_id}","href":"/api-reference/cross-boarder-payments/list-payee-addresses"},{"title":"Add a Payee Bank","openapi":"POST /api/platform/cross-border/payee/bank/{user_id}","href":"/api-reference/cross-boarder-payments/add-payee-bank"},{"title":"List Payee Banks","openapi":"GET /api/platform/cross-border/payee/banks/{user_id}","href":"/api-reference/cross-boarder-payments/list-payee-banks"},{"title":"Delete a Payee Bank","openapi":"DELETE /api/platform/cross-border/payee/bank/{user_id}/{bank_uuid}","href":"/api-reference/cross-boarder-payments/delete-payee-bank"}]},{"group":"Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/bank-accounts/overview"},{"title":"Add Bank Account","openapi":"POST /api/platform/accounts/add-account","href":"/api-reference/bank-accounts/add"},{"title":"Get Bank Account","openapi":"GET /api/platform/accounts/get-account/{account_id}","href":"/api-reference/bank-accounts/get"},{"title":"Set Bank Account To Default","openapi":"POST /api/platform/accounts/set-default/{user_id}","href":"/api-reference/bank-accounts/set-default"},{"title":"List Bank Accounts","openapi":"GET /api/platform/accounts/list/{user_id}","href":"/api-reference/bank-accounts/list"},{"title":"Release Micro-Deposit","openapi":"POST /api/platform/accounts/release-micro-deposit/{user_id}","href":"/api-reference/bank-accounts/release-micro-deposit"},{"title":"Verify Micro-Deposit","openapi":"POST /api/platform/accounts/verify-micro-deposit/{user_id}","href":"/api-reference/bank-accounts/verify-micro-deposit"},{"title":"Delete Bank Account","openapi":"DELETE /api/platform/accounts/delete/{user_id}","href":"/api-reference/bank-accounts/delete"}]},{"group":"Paywint Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/paywint-bank-accounts/overview"},{"title":"Open Paywint Bank Account","openapi":"POST /api/platform/accounts/open-pw-bank-account/{user_id}","href":"/api-reference/paywint-bank-accounts/open"},{"title":"List Paywint Bank Accounts","openapi":"GET /api/platform/accounts/list-pw-banks/{user_id}","href":"/api-reference/paywint-bank-accounts/list"},{"title":"Paywint Bank Account Withdrawal","openapi":"POST /api/platform/withdrawals/transfer-from-pw-bank/{user_id}","href":"/api-reference/paywint-bank-accounts/withdrawal"},{"title":"List Paywint Bank Account Transactions","openapi":"POST /api/platform/accounts/list-pw-transactions/{user_id}","href":"/api-reference/paywint-bank-accounts/list-transactions"}]},{"group":"Cards","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/cards/overview"},{"title":"Add Card","openapi":"POST /api/platform/card/add/secure-link/{user_id}","href":"/api-reference/cards/add"},{"title":"Update Card","openapi":"POST /api/platform/card/update/secure-link/{user_id}","href":"/api-reference/cards/update"},{"title":"Get Card","openapi":"GET /api/platform/card/get-card/{card_id}","href":"/api-reference/cards/get"},{"title":"List Cards","openapi":"GET /api/platform/card/list/{user_id}","href":"/api-reference/cards/list"},{"title":"Delete Card","openapi":"DELETE /api/platform/card/delete/{user_id}","href":"/api-reference/cards/delete"}]},{"group":"Check","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/checks/overview"},{"title":"Add Check Address","openapi":"POST /api/platform/check/add-address/{user_id}","href":"/api-reference/checks/add-address"},{"title":"Update Check Address","openapi":"PATCH /api/platform/check/update-address/{user_id}","href":"/api-reference/checks/update-address"},{"title":"Update Check Config","openapi":"POST /api/platform/check/update-config/{user_id}","href":"/api-reference/checks/update-config"}]},{"group":"Payee Management","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/overview"},{"title":"Create Payee","openapi":"POST /api/platform/payee/create/{user_id}","href":"/api-reference/payees/create"},{"title":"Update Payee","openapi":"PUT /api/platform/payee/update/{user_id}","href":"/api-reference/payees/update"},{"title":"Get Payee","openapi":"POST /api/platform/payee/get/{user_id}","href":"/api-reference/payees/get"},{"title":"List Payees","openapi":"POST /api/platform/payee/list-payee/{user_id}","href":"/api-reference/payees/list"},{"title":"Delete Payee","openapi":"DELETE /api/platform/payee/delete/{user_id}","href":"/api-reference/payees/delete"}]},{"group":"Payee Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/bank-accounts/overview"},{"title":"Add Payee Bank Account","openapi":"POST /api/platform/accounts/add-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/add"},{"title":"Get Payee Bank Account","openapi":"POST /api/platform/accounts/get-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/get"},{"title":"List Payee Bank Accounts","openapi":"POST /api/platform/accounts/list-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/list"},{"title":"Delete Payee Bank Account","openapi":"DELETE /api/platform/accounts/delete-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/delete"}]},{"group":"Payee Cards","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/cards/overview"},{"title":"Add Payee Card","openapi":"POST /api/platform/card/add-payee-card/{user_id}","href":"/api-reference/payees/cards/add"},{"title":"Get Payee Card","openapi":"POST /api/platform/card/get-payee-card/{user_id}","href":"/api-reference/payees/cards/get"},{"title":"List Payee Cards","openapi":"POST /api/platform/card/list-payee-card/{user_id}","href":"/api-reference/payees/cards/list"},{"title":"Delete Payee Card","openapi":"DELETE /api/platform/card/delete-payee-card/{user_id}","href":"/api-reference/payees/cards/delete"}]},{"group":"Payee Addresses","expanded":false,"pages":[{"title":"Overview","description":"Create, list, update, and delete mailing addresses saved for a user's payees.","icon":"book-open","href":"/api-reference/payees/addresses/overview"},{"title":"Add Payee Address","openapi":"POST /api/platform/address/create-payee-address/{user_id}","href":"/api-reference/payees/addresses/add"},{"title":"List Payee Address","openapi":"POST /api/platform/address/list-payee-address/{user_id}","description":"Retrieves all saved addresses for an existing payee contact.\n\nThis endpoint will:\n- Verify the payee exists and belongs to the specified user\n- Fetch the payee’s saved addresses\n- Return the addresses along with a `total_records` count\n\nEach payee can have up to 5 addresses.","href":"/api-reference/payees/addresses/list"},{"title":"Update Payee Address","openapi":"PATCH /api/platform/address/update-payee-address/{user_id}","href":"/api-reference/payees/addresses/update"},{"title":"Delete Payee Address","openapi":"DELETE /api/platform/address/delete-payee-address/{user_id}","href":"/api-reference/payees/addresses/delete"}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]},{"tab":"Guidelines","icon":"list-check","pages":[{"title":"Guidelines","href":"/guidelines/url-standards/overview"}]}]},"basePath":"","title":"Add Payee Address - Paywint API Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}