An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Body
application/json
Details of the Apple Pay External Card Transfer to create
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Synctera","colors":{"primary":"#00a5fb","light":"#00a5fb","dark":"#ffd200"},"logo":{"light":"https://mintcdn.com/synctera/VKLbRj1i5Qltvt7T/logo/light.png?fit=max\u0026auto=format\u0026n=VKLbRj1i5Qltvt7T\u0026q=85\u0026s=ab8bf397160af4319e0c7718764522cb","dark":"https://mintcdn.com/synctera/VKLbRj1i5Qltvt7T/logo/dark.png?fit=max\u0026auto=format\u0026n=VKLbRj1i5Qltvt7T\u0026q=85\u0026s=919430638125dbffac15274a667e9f75","href":"https://synctera.com/"},"favicon":"https://mintcdn.com/synctera/pDSOOmsGKwjC8uU7/favicon.png?fit=max\u0026auto=format\u0026n=pDSOOmsGKwjC8uU7\u0026q=85\u0026s=abb443d475485fa9811285908c40fa93","appearance":{"default":"light"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://app.synctera.com/login","label":"Log in"}],"primary":{"type":"button","label":"Contact Us","href":"https://synctera.com/contact-us"}},"footer":{"socials":{"x":"https://twitter.com/synctera","linkedin":"https://www.linkedin.com/company/synctera"}},"fonts":{"heading":{"family":"Open Sans"},"body":{"family":"Open Sans"}},"styling":{"codeblocks":"system","latex":true},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Postman Collection","icon":"gear-code","href":"https://www.postman.com/synctera/workspace/synctera-public-workspace/"},{"anchor":"Blog","icon":"newspaper","href":"https://synctera.com/blog"},{"anchor":"Platform Status","icon":"bolt","href":"https://status.synctera.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"synctera","hasAudioNarration":false,"actualSubdomain":"synctera","customDomains":["docs.synctera.com"],"gitSource":{"type":"gitlab","owner":"synctera","repo":"docs","projectId":76847357,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"edits":false,"thumbs":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aedfddadcc627c40f157f23","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":764},{"language":"default","tag":"Learning Center","count":243},{"language":"default","tag":"Cards","count":224},{"language":"default","tag":"Accounts","count":202},{"language":"default","tag":"Money Movement","count":193},{"language":"default","tag":"Guides","count":177},{"language":"default","tag":"Synctera for FinTechs","count":105},{"language":"default","tag":"Customers","count":102},{"language":"default","tag":"Synctera FAQ","count":91},{"language":"default","tag":"Platform","count":85}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":true},"customCss":[{"filePath":"style.css","content":"li[id=\"topbar-cta-button\"]>a>div>span{color:#000!important}li[id=\"topbar-cta-button\"]>a>div>svg>path{stroke:#000!important}.dark li[id=\"topbar-cta-button\"]>a>div>span{color:#000!important}"}],"page":{"pagePath":"v2/reference/createapplepayexternalcardtransfer","slug":"/v2/reference/createapplepayexternalcardtransfer","pageMetadata":{"openapi":"openapi-v2.json post /external_cards/transfers/applepay","title":"Create Apple Pay External Card Transfer","description":"> 🚧 Alpha\n> Apple Pay transfers is currently in Alpha release and spec is subject to change.\n\nCreate External Card Transfer using an Apple Pay card\n","href":"/v2/reference/createapplepayexternalcardtransfer"},"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 blockquote: \"blockquote\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.blockquote, {\n children: [\"\\n\", _jsx(_components.p, {\n children: \"🚧 Alpha\\nApple Pay transfers is currently in Alpha release and spec is subject to change.\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Create External Card Transfer using an Apple Pay card\"\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":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"openapi-v2.json post /external_cards/transfers/applepay","title":"Create Apple Pay External Card Transfer","description":"> 🚧 Alpha\n> Apple Pay transfers is currently in Alpha release and spec is subject to change.\n\nCreate External Card Transfer using an Apple Pay card\n","href":"/v2/reference/createapplepayexternalcardtransfer"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"> 🚧 Alpha\n> Apple Pay transfers is currently in Alpha release and spec is subject to change.\n\nCreate External Card Transfer using an Apple Pay card\n","operationId":"createApplePayExternalCardTransfer","parameters":["957fc60a-46a0-4f8d-a294-408bf15f2ed7"],"requestBody":"deb5c2c3-2ece-4bd5-a543-468257bd025e","responses":{"201":"83245512-d2e7-475a-ae55-94f85f84d875","400":"1fb7d908-8acd-460b-82e2-225a816b1530","401":"8f679fb2-2005-4343-a496-63ed18e4c9cf","403":"026c4eba-8114-4952-bc1f-3532b710dacc","422":"0aeff888-2821-4698-a6cb-f973e7c55a93","500":"f82fea06-2209-45a7-945e-10a0209595ee"},"summary":"Create Apple Pay External Card Transfer","tags":["External Cards"],"x-external":true,"method":"post","type":"path","servers":["0728831c-8117-4f09-b930-9c30f984c1c6","ebddaf3a-b3fb-4655-b471-533a99abb3a1"],"security":["3b331130-e217-44cf-8c2a-199618740ff4"],"path":"/external_cards/transfers/applepay","baseUrlOptions":["https://api.synctera.com/v2","https://api-sandbox.synctera.com/v2"],"title":"Create Apple Pay External Card Transfer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"957fc60a-46a0-4f8d-a294-408bf15f2ed7":{"description":"An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.","in":"header","name":"Idempotency-Key","schema":{"example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","type":"string","description":"An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["apple_pay_payment","customer_id","amount","originating_account_id"],"properties":{"amount":{"description":"Amount of the transfer in cents (USD)","minimum":1,"type":"integer","isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"originating_account_id":{"description":"The ID of the account to which the transfer will be initiated/received","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"originating_account_id","typeLabel":"string\u003cuuid>"},"apple_pay_payment":{"description":"Payload containing payment information, obtained from Apple following payment authorization","properties":{"token":{"description":"Single-use token containing all data necesary to complete the payment","properties":{"payment_data":{"description":"Encrypted payment data","properties":{"data":{"description":"Encrypted payment data, Base64 encoded","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_data.data","typeLabel":"string"},"header":{"description":"Dictionary of additional fields used for decrypting and verifying the payment data","properties":{"ephemeral_public_key":{"description":"X.509 encoded public key bytes","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_data.header.ephemeral_public_key","typeLabel":"string"},"public_key_hash":{"description":"Hash of the X.509 encoded public key bytes","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_data.header.public_key_hash","typeLabel":"string"},"transaction_id":{"description":"Device generated transaction identifier","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_data.header.transaction_id","typeLabel":"string"},"application_data":{"description":"SHA–256 hash, hex encoded as a string","type":"string","uniqueKey":"apple_pay_payment.token.payment_data.header.application_data","typeLabel":"string"}},"required":["ephemeral_public_key","public_key_hash","transaction_id"],"type":"object","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_data.header","typeLabel":"object"},"signature":{"description":"Signature of the payment and header data","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_data.signature","typeLabel":"string"},"version":{"description":"* RSA_v1 encryption is not currently supported. Version information about the payment token\n","enum":["EC_v1","RSA_v1"],"type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_data.version","typeLabel":"enum\u003cstring>"}},"required":["data","header","signature","version"],"type":"object","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_data","typeLabel":"object"},"payment_method":{"description":"Information about the card used in the transaction","properties":{"billing_address":{"properties":{"address_lines":{"description":"Street portion of the contact’s address","items":{"type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.address_lines.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.address_lines","typeLabel":"string[]"},"administrative_area":{"description":"The state for the contact","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.administrative_area","typeLabel":"string"},"country":{"description":"The name of the country or region for the contact","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.country","typeLabel":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","maxLength":2,"minLength":2,"type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.country_code","typeLabel":"string"},"email_address":{"description":"Email address","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.email_address","typeLabel":"string"},"family_name":{"description":"Family name","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.family_name","typeLabel":"string"},"given_name":{"description":"Given name","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.given_name","typeLabel":"string"},"locality":{"description":"The city for the contact","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.locality","typeLabel":"string"},"phone_number":{"description":"Phone number","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.phone_number","typeLabel":"string"},"phonetic_family_name":{"description":"Phonetic spelling of the contact’s family name","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.phonetic_family_name","typeLabel":"string"},"phonetic_given_name":{"description":"Phonetic spelling of the contact’s given name","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.phonetic_given_name","typeLabel":"string"},"postal_code":{"description":"Postal code","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.postal_code","typeLabel":"string"},"sub_administrative_area":{"description":"The subadministrative area (such as a county or other region) in a postal address","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.sub_administrative_area","typeLabel":"string"},"sub_locality":{"description":"Additional information associated with the location, typically defined at the city or town level (such as district or neighborhood), in a postal address","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.billing_address.sub_locality","typeLabel":"string"}},"type":"object","uniqueKey":"apple_pay_payment.token.payment_method.billing_address","typeLabel":"object"},"display_name":{"description":"Name that describes the card, suitable for display","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.display_name","typeLabel":"string"},"network":{"description":"Name of the payment network backing the card, suitable for display","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.network","typeLabel":"string"},"secure_element_pass":{"description":"A pass with a credential that the device stores in a certified payment information chip.","properties":{"device_account_identifier":{"description":"The unique identifier for the device-specific account number.","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_method.secure_element_pass.device_account_identifier","typeLabel":"string"},"device_account_number_suffix":{"description":"A display-ready version of the device-specific account number.","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_method.secure_element_pass.device_account_number_suffix","typeLabel":"string"},"pass_activation_state":{"description":"The activation state of the pass.","enum":["activated","activating","deactivated","requiresActivation","suspended"],"type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_method.secure_element_pass.pass_activation_state","typeLabel":"enum\u003cstring>"},"primary_account_identifier":{"description":"An opaque value that identifies the primary account number that funds the pass’s transactions.","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_method.secure_element_pass.primary_account_identifier","typeLabel":"string"},"primary_account_number_suffix":{"description":"A display-ready version of the primary account number.","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_method.secure_element_pass.primary_account_number_suffix","typeLabel":"string"},"device_pass_identifier":{"description":"An opaque value for the pass.","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.secure_element_pass.device_pass_identifier","typeLabel":"string"},"paired_terminal_identifier":{"description":"The unique identifier of the paired terminal.","type":"string","uniqueKey":"apple_pay_payment.token.payment_method.secure_element_pass.paired_terminal_identifier","typeLabel":"string"}},"required":["device_account_identifier","device_account_number_suffix","pass_activation_state","primary_account_identifier","primary_account_number_suffix"],"type":"object","uniqueKey":"apple_pay_payment.token.payment_method.secure_element_pass","typeLabel":"object"},"type":{"description":"Card payment type","enum":["credit","debit","prepaid","store"],"type":"string","uniqueKey":"apple_pay_payment.token.payment_method.type","typeLabel":"enum\u003cstring>"}},"type":"object","isRequired":true,"uniqueKey":"apple_pay_payment.token.payment_method","typeLabel":"object"},"transaction_identifier":{"description":"Unique identifier for this payment","type":"string","isRequired":true,"uniqueKey":"apple_pay_payment.token.transaction_identifier","typeLabel":"string"}},"required":["payment_data","payment_method","transaction_identifier"],"type":"object","isRequired":true,"uniqueKey":"apple_pay_payment.token","typeLabel":"object"},"billing_contact":{"properties":{"address_lines":{"description":"Street portion of the contact’s address","items":{"type":"string","uniqueKey":"apple_pay_payment.billing_contact.address_lines.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"apple_pay_payment.billing_contact.address_lines","typeLabel":"string[]"},"administrative_area":{"description":"The state for the contact","type":"string","uniqueKey":"apple_pay_payment.billing_contact.administrative_area","typeLabel":"string"},"country":{"description":"The name of the country or region for the contact","type":"string","uniqueKey":"apple_pay_payment.billing_contact.country","typeLabel":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","maxLength":2,"minLength":2,"type":"string","uniqueKey":"apple_pay_payment.billing_contact.country_code","typeLabel":"string"},"email_address":{"description":"Email address","type":"string","uniqueKey":"apple_pay_payment.billing_contact.email_address","typeLabel":"string"},"family_name":{"description":"Family name","type":"string","uniqueKey":"apple_pay_payment.billing_contact.family_name","typeLabel":"string"},"given_name":{"description":"Given name","type":"string","uniqueKey":"apple_pay_payment.billing_contact.given_name","typeLabel":"string"},"locality":{"description":"The city for the contact","type":"string","uniqueKey":"apple_pay_payment.billing_contact.locality","typeLabel":"string"},"phone_number":{"description":"Phone number","type":"string","uniqueKey":"apple_pay_payment.billing_contact.phone_number","typeLabel":"string"},"phonetic_family_name":{"description":"Phonetic spelling of the contact’s family name","type":"string","uniqueKey":"apple_pay_payment.billing_contact.phonetic_family_name","typeLabel":"string"},"phonetic_given_name":{"description":"Phonetic spelling of the contact’s given name","type":"string","uniqueKey":"apple_pay_payment.billing_contact.phonetic_given_name","typeLabel":"string"},"postal_code":{"description":"Postal code","type":"string","uniqueKey":"apple_pay_payment.billing_contact.postal_code","typeLabel":"string"},"sub_administrative_area":{"description":"The subadministrative area (such as a county or other region) in a postal address","type":"string","uniqueKey":"apple_pay_payment.billing_contact.sub_administrative_area","typeLabel":"string"},"sub_locality":{"description":"Additional information associated with the location, typically defined at the city or town level (such as district or neighborhood), in a postal address","type":"string","uniqueKey":"apple_pay_payment.billing_contact.sub_locality","typeLabel":"string"}},"type":"object","uniqueKey":"apple_pay_payment.billing_contact","typeLabel":"object"},"shipping_contact":{"properties":{"address_lines":{"description":"Street portion of the contact’s address","items":{"type":"string","uniqueKey":"apple_pay_payment.shipping_contact.address_lines.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"apple_pay_payment.shipping_contact.address_lines","typeLabel":"string[]"},"administrative_area":{"description":"The state for the contact","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.administrative_area","typeLabel":"string"},"country":{"description":"The name of the country or region for the contact","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.country","typeLabel":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","maxLength":2,"minLength":2,"type":"string","uniqueKey":"apple_pay_payment.shipping_contact.country_code","typeLabel":"string"},"email_address":{"description":"Email address","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.email_address","typeLabel":"string"},"family_name":{"description":"Family name","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.family_name","typeLabel":"string"},"given_name":{"description":"Given name","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.given_name","typeLabel":"string"},"locality":{"description":"The city for the contact","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.locality","typeLabel":"string"},"phone_number":{"description":"Phone number","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.phone_number","typeLabel":"string"},"phonetic_family_name":{"description":"Phonetic spelling of the contact’s family name","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.phonetic_family_name","typeLabel":"string"},"phonetic_given_name":{"description":"Phonetic spelling of the contact’s given name","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.phonetic_given_name","typeLabel":"string"},"postal_code":{"description":"Postal code","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.postal_code","typeLabel":"string"},"sub_administrative_area":{"description":"The subadministrative area (such as a county or other region) in a postal address","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.sub_administrative_area","typeLabel":"string"},"sub_locality":{"description":"Additional information associated with the location, typically defined at the city or town level (such as district or neighborhood), in a postal address","type":"string","uniqueKey":"apple_pay_payment.shipping_contact.sub_locality","typeLabel":"string"}},"type":"object","uniqueKey":"apple_pay_payment.shipping_contact","typeLabel":"object"}},"required":["token"],"type":"object","isRequired":true,"uniqueKey":"apple_pay_payment","typeLabel":"object"},"customer_id":{"description":"The customer_id of the cardholder","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string\u003cuuid>"},"merchant":{"description":"Merchant descriptor information that will be shown on statement and transaction details. If not provided, FinTech information will be used.","properties":{"address":{"properties":{"address_line_1":{"description":"Street address line 1","example":"100 Main St.","maxLength":100,"type":"string","isRequired":true,"uniqueKey":"merchant.address.address_line_1","typeLabel":"string"},"city":{"description":"City","example":"New York","type":"string","isRequired":true,"uniqueKey":"merchant.address.city","typeLabel":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","pattern":"^[A-Z]{2}$","type":"string","isRequired":true,"uniqueKey":"merchant.address.country_code","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"49633","type":"string","isRequired":true,"uniqueKey":"merchant.address.postal_code","typeLabel":"string"},"state":{"description":"State, region, province, or prefecture.\nThis is the ISO-3166-2 subdivision code, excluding the country prefix.\nFor example, TX for Texas USA or TAM for Tamaulipas Mexico.\nIts length varies by country, e.g. 2 characters for US, 3 for MX.\n","example":"NY","type":"string","isRequired":true,"uniqueKey":"merchant.address.state","typeLabel":"string"},"address_line_2":{"description":"Street address line 2","example":"Suite 99","maxLength":100,"type":"string","uniqueKey":"merchant.address.address_line_2","typeLabel":"string"}},"required":["address_line_1","city","country_code","postal_code","state"],"type":"object","isRequired":true,"uniqueKey":"merchant.address","typeLabel":"object"},"name":{"description":"Merchant's name","type":"string","isRequired":true,"uniqueKey":"merchant.name","typeLabel":"string"},"email":{"description":"Merchant's email","example":"alice@example.com","type":"string","uniqueKey":"merchant.email","typeLabel":"string"},"phone_number":{"description":"Merchant's phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.","example":"+14374570680","pattern":"^\\+[1-9]\\d{1,14}$","type":"string","uniqueKey":"merchant.phone_number","typeLabel":"string"}},"required":["address","name"],"type":"object","uniqueKey":"merchant","typeLabel":"object"},"tenant":{"description":"The id of the tenant containing the resource.\n","example":"abcdef_ghijkl","type":"string","uniqueKey":"tenant","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":2,"originating_account_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","apple_pay_payment":{"token":{"payment_data":{"data":"\u003cstring>","header":{"ephemeral_public_key":"\u003cstring>","public_key_hash":"\u003cstring>","transaction_id":"\u003cstring>","application_data":"\u003cstring>"},"signature":"\u003cstring>"},"payment_method":{"billing_address":{"address_lines":["\u003cstring>"],"administrative_area":"\u003cstring>","country":"\u003cstring>","country_code":"US","email_address":"\u003cstring>","family_name":"\u003cstring>","given_name":"\u003cstring>","locality":"\u003cstring>","phone_number":"\u003cstring>","phonetic_family_name":"\u003cstring>","phonetic_given_name":"\u003cstring>","postal_code":"\u003cstring>","sub_administrative_area":"\u003cstring>","sub_locality":"\u003cstring>"},"display_name":"\u003cstring>","network":"\u003cstring>"},"transaction_identifier":"\u003cstring>"},"billing_contact":{"address_lines":["\u003cstring>"],"administrative_area":"\u003cstring>","country":"\u003cstring>","country_code":"US","email_address":"\u003cstring>","family_name":"\u003cstring>","given_name":"\u003cstring>","locality":"\u003cstring>","phone_number":"\u003cstring>","phonetic_family_name":"\u003cstring>","phonetic_given_name":"\u003cstring>","postal_code":"\u003cstring>","sub_administrative_area":"\u003cstring>","sub_locality":"\u003cstring>"},"shipping_contact":{"address_lines":["\u003cstring>"],"administrative_area":"\u003cstring>","country":"\u003cstring>","country_code":"US","email_address":"\u003cstring>","family_name":"\u003cstring>","given_name":"\u003cstring>","locality":"\u003cstring>","phone_number":"\u003cstring>","phonetic_family_name":"\u003cstring>","phonetic_given_name":"\u003cstring>","postal_code":"\u003cstring>","sub_administrative_area":"\u003cstring>","sub_locality":"\u003cstring>"}},"customer_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","tenant":"abcdef_ghijkl"}}},"exampleType":"generated"}},"description":"Details of the Apple Pay External Card Transfer to create","required":true,"exampleType":"generated"},"responses":{"83245512-d2e7-475a-ae55-94f85f84d875":{"content":{"application/json":{"schema":{"type":"object","required":["account_id","amount","creation_time","currency","customer_id","id","last_updated_time","merchant","status","tenant","card_details","type"],"properties":{"card_details":{"type":"object","properties":{"address_verification_result":{"description":"Address verification results\n\nStatus | Description\n--- | ---\nVERIFIED | AVS verified\nNOT_VERIFIED | AVS not verified\nADDRESS_MISMATCH | ZIP code match, address no match\nZIP_MISMATCH | Address match, ZIP code no match\nADDRESS_AND_ZIP_MISMATCH | Address and ZIP code no match\n","enum":["ADDRESS_AND_ZIP_MISMATCH","ADDRESS_MISMATCH","NOT_VERIFIED","VERIFIED","ZIP_MISMATCH"],"type":"string","uniqueKey":"card_details.address_verification_result","typeLabel":"enum\u003cstring>"},"cvv2_result":{"description":"Card Verification Value results\n\nStatus | Description\n--- | ---\nVERIFIED | CVV and expiration date verified\nNOT_VERIFIED | CVV and expiration date not verified\nCVV_MISMATCH | Either CVV or expiration date does not match\nNOT_SUPPORTED | Issuer does not participate in CVV2 service\n","enum":["CVV_MISMATCH","NOT_SUPPORTED","NOT_VERIFIED","VERIFIED"],"type":"string","uniqueKey":"card_details.cvv2_result","typeLabel":"enum\u003cstring>"},"name_verification_result":{"description":"Issuer cardholder name verification result with Account Name Inquiry (ANI) service\nThe result of verifying the cardholder name against the name on file at the issuing institution.\nIf this fails, it means the issuing institution has a different person's name on file as the cardholder.\n\nStatus | Description\n--- | ---\nVERIFIED | ANI Name verified\nNOT_VERIFIED | ANI Name not verified\nNOT_SUPPORTED | Issuer does not participate in ANI service\nNAME_MISMATCH | ANI Name does not match\n","enum":["NAME_MISMATCH","NOT_SUPPORTED","NOT_VERIFIED","VERIFIED"],"type":"string","uniqueKey":"card_details.name_verification_result","typeLabel":"enum\u003cstring>"},"pull_details":{"description":"Additional PULL transfer details","properties":{"country":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","maxLength":2,"minLength":2,"type":"string","uniqueKey":"card_details.pull_details.country","typeLabel":"string"},"currency":{"description":"ISO 4217 Alpha-3 currency code","example":"USD","maxLength":3,"minLength":3,"type":"string","uniqueKey":"card_details.pull_details.currency","typeLabel":"string"},"network":{"description":"Payment network","type":"string","uniqueKey":"card_details.pull_details.network","typeLabel":"string"},"product_type":{"description":"Product type","enum":["CREDIT","DEBIT","PREPAID"],"type":"string","uniqueKey":"card_details.pull_details.product_type","typeLabel":"enum\u003cstring>"},"regulated":{"description":"Exemption status from debit card interchange fee standards","type":"boolean","uniqueKey":"card_details.pull_details.regulated","typeLabel":"boolean"}},"type":"object","uniqueKey":"card_details.pull_details","typeLabel":"object"},"pull_enabled":{"description":"Indicates if the card is able to perform PULL transfers.","type":"boolean","uniqueKey":"card_details.pull_enabled","typeLabel":"boolean"},"push_details":{"description":"Additional PUSH transfer details","properties":{"country":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","maxLength":2,"minLength":2,"type":"string","uniqueKey":"card_details.push_details.country","typeLabel":"string"},"currency":{"description":"ISO 4217 Alpha-3 currency code","example":"USD","maxLength":3,"minLength":3,"type":"string","uniqueKey":"card_details.push_details.currency","typeLabel":"string"},"funds_availability":{"description":"Estimated timeframe of funds availability\n\nValue | Description\n--- | ---\nNOW | Within 30 minutes\nNEXT | Within the next business day\nFEW | Within a few business days\n","enum":["FEW","NEXT","NOW"],"type":"string","uniqueKey":"card_details.push_details.funds_availability","typeLabel":"enum\u003cstring>"},"network":{"description":"Payment network","type":"string","uniqueKey":"card_details.push_details.network","typeLabel":"string"},"product_type":{"description":"Product type","enum":["CREDIT","DEBIT","PREPAID"],"type":"string","uniqueKey":"card_details.push_details.product_type","typeLabel":"enum\u003cstring>"},"regulated":{"description":"Exemption status from debit card interchange fee standards","type":"boolean","uniqueKey":"card_details.push_details.regulated","typeLabel":"boolean"}},"type":"object","uniqueKey":"card_details.push_details","typeLabel":"object"},"push_enabled":{"description":"Indicates if the card is able to perform PUSH transfers.","type":"boolean","uniqueKey":"card_details.push_enabled","typeLabel":"boolean"},"bin":{"description":"Bank Identification Number","type":"string","uniqueKey":"card_details.bin","typeLabel":"string"},"issuer":{"description":"Name of the issuing financial institution","type":"string","uniqueKey":"card_details.issuer","typeLabel":"string"},"last_four":{"description":"The last four digits of the card PAN","example":"1234","type":"string","uniqueKey":"card_details.last_four","typeLabel":"string"},"payment_account_reference":{"description":"A unique identifier associated with a specific cardholder PAN and its affiliated tokens","maxLength":29,"minLength":29,"type":"string","uniqueKey":"card_details.payment_account_reference","typeLabel":"string"}},"isRequired":true,"uniqueKey":"card_details","typeLabel":"object"},"type":{"description":"Type of transfer operation","enum":["APPLE_PAY_PULL"],"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"account_id":{"description":"The ID of the Synctera account into which or from which funds were moved","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"account_id","typeLabel":"string\u003cuuid>"},"amount":{"description":"Amount of the transfer in cents","type":"integer","isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"creation_time":{"example":"2010-05-06T12:23:34.321Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"creation_time","typeLabel":"string\u003cdate-time>"},"currency":{"description":"ISO 4217 Alpha-3 currency code","example":"USD","maxLength":3,"minLength":3,"type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"customer_id":{"description":"The customer_id of the cardholder","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string\u003cuuid>"},"id":{"description":"The ID of the transfer","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"last_updated_time":{"example":"2010-05-06T12:23:34.321Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"last_updated_time","typeLabel":"string\u003cdate-time>"},"merchant":{"description":"Merchant descriptor information that will be shown on statement and transaction details. If not provided, FinTech information will be used.","properties":{"address":{"properties":{"address_line_1":{"description":"Street address line 1","example":"100 Main St.","maxLength":100,"type":"string","isRequired":true,"uniqueKey":"merchant.address.address_line_1","typeLabel":"string"},"city":{"description":"City","example":"New York","type":"string","isRequired":true,"uniqueKey":"merchant.address.city","typeLabel":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","pattern":"^[A-Z]{2}$","type":"string","isRequired":true,"uniqueKey":"merchant.address.country_code","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"49633","type":"string","isRequired":true,"uniqueKey":"merchant.address.postal_code","typeLabel":"string"},"state":{"description":"State, region, province, or prefecture.\nThis is the ISO-3166-2 subdivision code, excluding the country prefix.\nFor example, TX for Texas USA or TAM for Tamaulipas Mexico.\nIts length varies by country, e.g. 2 characters for US, 3 for MX.\n","example":"NY","type":"string","isRequired":true,"uniqueKey":"merchant.address.state","typeLabel":"string"},"address_line_2":{"description":"Street address line 2","example":"Suite 99","maxLength":100,"type":"string","uniqueKey":"merchant.address.address_line_2","typeLabel":"string"}},"required":["address_line_1","city","country_code","postal_code","state"],"type":"object","isRequired":true,"uniqueKey":"merchant.address","typeLabel":"object"},"name":{"description":"Merchant's name","type":"string","isRequired":true,"uniqueKey":"merchant.name","typeLabel":"string"},"email":{"description":"Merchant's email","example":"alice@example.com","type":"string","uniqueKey":"merchant.email","typeLabel":"string"},"phone_number":{"description":"Merchant's phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.","example":"+14374570680","pattern":"^\\+[1-9]\\d{1,14}$","type":"string","uniqueKey":"merchant.phone_number","typeLabel":"string"}},"required":["address","name"],"type":"object","isRequired":true,"uniqueKey":"merchant","typeLabel":"object"},"status":{"description":"The status of the transfer","enum":["CANCELED","DECLINED","PENDING","SUCCEEDED","UNKNOWN"],"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"tenant":{"description":"The id of the tenant containing the resource.\n","example":"abcdef_ghijkl","type":"string","isRequired":true,"uniqueKey":"tenant","typeLabel":"string"},"network_decline_details":{"description":"If available, a human readable string indicating why a transfer was declined downstream of our system","type":"string","uniqueKey":"network_decline_details","typeLabel":"string"},"reason":{"description":"The reason for the status, e.g. INSUFFICIENT_FUNDS, SUSPECTED_FRAUD, NETWORK_DECLINED","type":"string","uniqueKey":"reason","typeLabel":"string"},"transaction_id":{"description":"The transaction ID","format":"uuid","type":"string","uniqueKey":"transaction_id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"card_details":{"address_verification_result":"ADDRESS_AND_ZIP_MISMATCH","cvv2_result":"CVV_MISMATCH","name_verification_result":"NAME_MISMATCH","pull_details":{"country":"US","currency":"USD","network":"\u003cstring>","product_type":"CREDIT","regulated":true},"pull_enabled":true,"push_details":{"country":"US","currency":"USD","funds_availability":"FEW","network":"\u003cstring>","product_type":"CREDIT","regulated":true},"push_enabled":true,"bin":"\u003cstring>","issuer":"\u003cstring>","last_four":"1234","payment_account_reference":"\u003cstring>"},"type":"APPLE_PAY_PULL","account_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","amount":123,"creation_time":"2010-05-06T12:23:34.321Z","currency":"USD","customer_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","id":"\u003cstring>","last_updated_time":"2010-05-06T12:23:34.321Z","merchant":{"address":{"address_line_1":"100 Main St.","city":"New York","country_code":"US","postal_code":"49633","state":"NY","address_line_2":"Suite 99"},"name":"\u003cstring>","email":"alice@example.com","phone_number":"+14374570680"},"status":"CANCELED","tenant":"abcdef_ghijkl","network_decline_details":"\u003cstring>","reason":"\u003cstring>","transaction_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}},"exampleType":"generated"}},"description":"Apple Pay External Card Transfer created","exampleType":"generated"},"1fb7d908-8acd-460b-82e2-225a816b1530":{"content":{"application/json":{"schema":{"description":"Synctera error responses in API v1 implement a custom error schema.","properties":{"code":{"description":"A machine-readable string that identifies the error for programmatic use.\n","example":"BAD_REQUEST_BODY","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable string explaining this particular error.\n","example":"Missing required fields: first_name, dob","type":"string","uniqueKey":"detail","typeLabel":"string"},"status":{"description":"HTTP status code for this response","example":400,"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"title":"Synctera error response","type":"object","uniqueKey":"","typeLabel":"Synctera error response · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST_BODY","detail":"Missing required fields: first_name, dob","status":400}}},"exampleType":"generated"}},"description":"Bad request","exampleType":"generated"},"8f679fb2-2005-4343-a496-63ed18e4c9cf":{"content":{"application/json":{"schema":{"description":"Synctera error responses in API v1 implement a custom error schema.","properties":{"code":{"description":"A machine-readable string that identifies the error for programmatic use.\n","example":"BAD_REQUEST_BODY","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable string explaining this particular error.\n","example":"Missing required fields: first_name, dob","type":"string","uniqueKey":"detail","typeLabel":"string"},"status":{"description":"HTTP status code for this response","example":400,"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"title":"Synctera error response","type":"object","uniqueKey":"","typeLabel":"Synctera error response · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST_BODY","detail":"Missing required fields: first_name, dob","status":400}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"026c4eba-8114-4952-bc1f-3532b710dacc":{"content":{"application/json":{"schema":{"description":"Synctera error responses in API v1 implement a custom error schema.","properties":{"code":{"description":"A machine-readable string that identifies the error for programmatic use.\n","example":"BAD_REQUEST_BODY","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable string explaining this particular error.\n","example":"Missing required fields: first_name, dob","type":"string","uniqueKey":"detail","typeLabel":"string"},"status":{"description":"HTTP status code for this response","example":400,"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"title":"Synctera error response","type":"object","uniqueKey":"","typeLabel":"Synctera error response · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST_BODY","detail":"Missing required fields: first_name, dob","status":400}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"0aeff888-2821-4698-a6cb-f973e7c55a93":{"content":{"application/json":{"schema":{"description":"Synctera error responses in API v1 implement a custom error schema.","properties":{"code":{"description":"A machine-readable string that identifies the error for programmatic use.\n","example":"BAD_REQUEST_BODY","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable string explaining this particular error.\n","example":"Missing required fields: first_name, dob","type":"string","uniqueKey":"detail","typeLabel":"string"},"status":{"description":"HTTP status code for this response","example":400,"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"title":"Synctera error response","type":"object","uniqueKey":"","typeLabel":"Synctera error response · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST_BODY","detail":"Missing required fields: first_name, dob","status":400}}},"exampleType":"generated"}},"description":"Unprocessable entity","exampleType":"generated"},"f82fea06-2209-45a7-945e-10a0209595ee":{"content":{"application/json":{"schema":{"description":"Synctera error responses in API v1 implement a custom error schema.","properties":{"code":{"description":"A machine-readable string that identifies the error for programmatic use.\n","example":"BAD_REQUEST_BODY","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable string explaining this particular error.\n","example":"Missing required fields: first_name, dob","type":"string","uniqueKey":"detail","typeLabel":"string"},"status":{"description":"HTTP status code for this response","example":400,"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"title":"Synctera error response","type":"object","uniqueKey":"","typeLabel":"Synctera error response · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST_BODY","detail":"Missing required fields: first_name, dob","status":400}}},"exampleType":"generated"}},"description":"Internal server error","exampleType":"generated"}},"security":{"3b331130-e217-44cf-8c2a-199618740ff4":{"bearerAuth":{"bearerFormat":"api_key","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0728831c-8117-4f09-b930-9c30f984c1c6":{"description":"Production","url":"https://api.synctera.com/v2"},"ebddaf3a-b3fb-4655-b471-533a99abb3a1":{"description":"Sandbox (no real world financial impact)","url":"https://api-sandbox.synctera.com/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"api_key","scheme":"bearer","type":"http","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":"openapi-v2.json"},"subdomain":"synctera","siteName":"Synctera","title":"Create Apple Pay External Card Transfer - Synctera","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/reference/createapplepayexternalcardtransfer","matchLevel":0},"v0":{"href":"/reference/listexternalcards","matchLevel":2},"v1":{"href":"/v1/reference/createapplepayexternalcardtransfer","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T21:33:35.450Z","originalFileLocation":"v2/reference/createapplepayexternalcardtransfer.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=\"description\" content=\"\u0026gt; 🚧 Alpha \u0026gt; Apple Pay transfers is currently in Alpha release and spec is subject to change. Create External Card Transfer using an Apple Pay card\">\u003cmeta data-mint-head name=\"application-name\" content=\"Synctera\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_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/synctera/ehuaQmwUkP97clsK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Apple Pay External Card Transfer - Synctera\">\u003cmeta data-mint-head property=\"og:description\" content=\"\u0026gt; 🚧 Alpha \u0026gt; Apple Pay transfers is currently in Alpha release and spec is subject to change. Create External Card Transfer using an Apple Pay card\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Synctera\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://synctera.mintlify.site/_mintlify/api/og/v2?division=External+Cards\u0026amp;title=Create+Apple+Pay+External+Card+Transfer\u0026amp;description=%3E+%F0%9F%9A%A7+Alpha%0A%3E+Apple+Pay+transfers+is+currently+in+Alpha+release+and+spec+is+subject+to+change.%0A%0ACreate+External+Card+Transfer+using+an+Apple+Pay+card%0A\u0026amp;theme=7eeaff4eadcf64de30804626\u0026amp;signature=308d757f0d94dd8e5c8a0d7ba861d8b213d3463cfbeb07bc8ec47cf8f54750a1\">\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=\"Create Apple Pay External Card Transfer - Synctera\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"\u0026gt; 🚧 Alpha \u0026gt; Apple Pay transfers is currently in Alpha release and spec is subject to change. Create External Card Transfer using an Apple Pay card\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://synctera.mintlify.site/_mintlify/api/og/v2?division=External+Cards\u0026amp;title=Create+Apple+Pay+External+Card+Transfer\u0026amp;description=%3E+%F0%9F%9A%A7+Alpha%0A%3E+Apple+Pay+transfers+is+currently+in+Alpha+release+and+spec+is+subject+to+change.%0A%0ACreate+External+Card+Transfer+using+an+Apple+Pay+card%0A\u0026amp;theme=7eeaff4eadcf64de30804626\u0026amp;signature=308d757f0d94dd8e5c8a0d7ba861d8b213d3463cfbeb07bc8ec47cf8f54750a1\">\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/synctera/ehuaQmwUkP97clsK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Synctera\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00a5fb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/reference/createapplepayexternalcardtransfer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.synctera.com/#organization\",\"name\":\"Synctera\",\"url\":\"https://docs.synctera.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/synctera/VKLbRj1i5Qltvt7T/logo/light.png?fit=max\u0026auto=format\u0026n=VKLbRj1i5Qltvt7T\u0026q=85\u0026s=ab8bf397160af4319e0c7718764522cb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.synctera.com#website\",\"name\":\"Synctera\",\"url\":\"https://docs.synctera.com\",\"publisher\":{\"@id\":\"https://docs.synctera.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer#webpage\",\"url\":\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer\",\"name\":\"Create Apple Pay External Card Transfer\",\"description\":\"> 🚧 Alpha > Apple Pay transfers is currently in Alpha release and spec is subject to change. Create External Card Transfer using an Apple Pay card\",\"dateModified\":\"2026-01-27T21:33:35.450Z\",\"isPartOf\":{\"@id\":\"https://docs.synctera.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cards\",\"item\":\"https://docs.synctera.com/v2/reference/createapplepaycsr\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"External Cards\",\"item\":\"https://docs.synctera.com/v2/reference/listexternalcards\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Apple Pay External Card Transfer\",\"item\":\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer#apireference\",\"headline\":\"Create Apple Pay External Card Transfer\",\"name\":\"Create Apple Pay External Card Transfer\",\"description\":\"> 🚧 Alpha > Apple Pay transfers is currently in Alpha release and spec is subject to change. Create External Card Transfer using an Apple Pay card\",\"url\":\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.synctera.com/v2/reference/createapplepayexternalcardtransfer#webpage\"},\"dateModified\":\"2026-01-27T21:33:35.450Z\",\"publisher\":{\"@id\":\"https://docs.synctera.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.synctera.com#website\"}}]}\u003c/script>","siteName":"Synctera","nav":{"global":{"anchors":[{"anchor":"Postman Collection","icon":"gear-code","href":"https://www.postman.com/synctera/workspace/synctera-public-workspace/"},{"anchor":"Blog","icon":"newspaper","href":"https://synctera.com/blog"},{"anchor":"Platform Status","icon":"bolt","href":"https://status.synctera.com/"}]},"versions":[{"version":"v2","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/v2/docs/platform-overview"}]},{"tab":"API Reference","groups":[{"group":"Synctera API","pages":[{"title":"Introduction","href":"/v2/reference/introduction"},{"title":"Need to Know","href":"/v2/reference/need-to-know"}]},{"group":"Customers","pages":[{"group":"Disclosures","pages":[{"openapi":"openapi-v2.json get /disclosures","title":"List disclosures","href":"/v2/reference/listdisclosures"},{"openapi":"openapi-v2.json post /disclosures","title":"Create disclosure record","href":"/v2/reference/createdisclosure"},{"openapi":"openapi-v2.json get /disclosures/{disclosure_id}","title":"Get disclosure","href":"/v2/reference/getdisclosure"}]},{"group":"Addresses","pages":[{"openapi":"openapi-v2.json get /addresses","title":"List Addresses","href":"/v2/reference/listaddresses"},{"openapi":"openapi-v2.json post /addresses","title":"Create a address","href":"/v2/reference/createaddress"},{"openapi":"openapi-v2.json get /addresses/{address_id}","title":"Get address information by id","href":"/v2/reference/getaddress"},{"openapi":"openapi-v2.json patch /addresses/{address_id}","title":"Update address information by id","href":"/v2/reference/updateaddress"}]},{"group":"Monitoring","pages":[{"openapi":"openapi-v2.json get /monitoring/alerts","title":"List monitoring alerts","href":"/v2/reference/listalerts"},{"openapi":"openapi-v2.json get /monitoring/alerts/{alert_id}","title":"Retrieve a monitoring alert","href":"/v2/reference/getalert"},{"openapi":"openapi-v2.json patch /monitoring/alerts/{alert_id}","title":"Update a monitoring alert","href":"/v2/reference/updatealert"},{"openapi":"openapi-v2.json get /monitoring/subscriptions","title":"List monitoring subscriptions","href":"/v2/reference/listsubscriptions"},{"openapi":"openapi-v2.json post /monitoring/subscriptions","title":"Subscribe a customer or business to monitoring","href":"/v2/reference/createsubscription"},{"openapi":"openapi-v2.json delete /monitoring/subscriptions/{subscription_id}","title":"Delete monitoring subscription","href":"/v2/reference/deletesubscription"},{"openapi":"openapi-v2.json get /monitoring/subscriptions/{subscription_id}","title":"Retrieve monitoring subscription","href":"/v2/reference/getsubscription"}]},{"group":"Persons","pages":[{"openapi":"openapi-v2.json get /persons","title":"List persons","href":"/v2/reference/listpersons"},{"openapi":"openapi-v2.json post /persons","title":"Create a person","href":"/v2/reference/createperson"},{"openapi":"openapi-v2.json post /persons/personal_ids","title":"Create a personal identifier","href":"/v2/reference/createpersonalid"},{"openapi":"openapi-v2.json delete /persons/personal_ids/{personal_id_id}","title":"Delete a personal identifier","href":"/v2/reference/deletepersonalid"},{"openapi":"openapi-v2.json patch /persons/personal_ids/{personal_id_id}","title":"Update a personal identifier","href":"/v2/reference/updatepersonalid"},{"openapi":"openapi-v2.json get /persons/{person_id}","title":"Get person","href":"/v2/reference/getperson"},{"openapi":"openapi-v2.json patch /persons/{person_id}","title":"Update person","href":"/v2/reference/updateperson"},{"openapi":"openapi-v2.json get /persons/personal_ids/{personal_id_id}/reveal","title":"Reveal Personal ID","href":"/v2/reference/personalidreveal"}]},{"group":"Relationships","pages":[{"openapi":"openapi-v2.json get /relationships","title":"List relationships","href":"/v2/reference/listrelationships"},{"openapi":"openapi-v2.json post /relationships","title":"Create a relationship","href":"/v2/reference/createrelationship"},{"openapi":"openapi-v2.json delete /relationships/{relationship_id}","title":"Delete relationship","href":"/v2/reference/deleterelationship"},{"openapi":"openapi-v2.json get /relationships/{relationship_id}","title":"Get relationship","href":"/v2/reference/getrelationship"},{"openapi":"openapi-v2.json patch /relationships/{relationship_id}","title":"Update relationship","href":"/v2/reference/updaterelationship"}]},{"group":"Businesses","pages":[{"openapi":"openapi-v2.json get /businesses","title":"List business","href":"/v2/reference/listbusinesses"},{"openapi":"openapi-v2.json post /businesses","title":"Create a business","href":"/v2/reference/createbusiness"},{"openapi":"openapi-v2.json get /businesses/{business_id}","title":"Get business","href":"/v2/reference/getbusiness"},{"openapi":"openapi-v2.json patch /businesses/{business_id}","title":"Patch business","href":"/v2/reference/updatebusiness"}]},{"group":"KYC/KYB Verifications","pages":[{"openapi":"openapi-v2.json get /verifications","title":"List verifications","href":"/v2/reference/listverifications1"},{"openapi":"openapi-v2.json post /verifications","title":"Create a verification","href":"/v2/reference/createverification"},{"openapi":"openapi-v2.json post /verifications/adhoc","title":"Check if an individual is on any watchlists","href":"/v2/reference/verifyadhoc"},{"openapi":"openapi-v2.json post /verifications/docv_session","title":"Initiate Document Verification Session","href":"/v2/reference/docvsession"},{"openapi":"openapi-v2.json post /verifications/verify","title":"Verify a customer's identity","href":"/v2/reference/verify"},{"openapi":"openapi-v2.json get /verifications/{verification_id}","title":"Get verification","href":"/v2/reference/getverification1"}]},{"group":"Credit Scores","pages":[{"openapi":"openapi-v2.json get /credit_scores","title":"List credit scores","href":"/v2/reference/listcreditscores"},{"openapi":"openapi-v2.json post /credit_scores","title":"Create a credit score and associate it with a customer","href":"/v2/reference/createcreditscores"},{"openapi":"openapi-v2.json get /credit_scores/{credit_score_id}","title":"Retrieve a credit score","href":"/v2/reference/getcreditscore"}]},{"group":"CRR","pages":[{"openapi":"openapi-v2.json get /crr","title":"List CRRs","href":"/v2/reference/listcrr"},{"openapi":"openapi-v2.json get /crr/external_scores","title":"List external scores","href":"/v2/reference/listexternalscores"},{"openapi":"openapi-v2.json post /crr/external_scores","title":"Create an external score","href":"/v2/reference/createexternalscore"},{"openapi":"openapi-v2.json get /crr/external_scores/{external_score_id}","title":"Get an external score","href":"/v2/reference/getexternalscore"},{"openapi":"openapi-v2.json patch /crr/external_scores/{external_score_id}","title":"Update an external score","href":"/v2/reference/updateexternalscore"},{"openapi":"openapi-v2.json delete /crr/external_scores/{external_score_id}","title":"Delete an external score","href":"/v2/reference/deleteexternalscore"}]}]},{"group":"Accounts","pages":[{"group":"External Accounts","pages":[{"openapi":"openapi-v2.json get /external_accounts","title":"List external accounts","href":"/v2/reference/listexternalaccounts"},{"openapi":"openapi-v2.json post /external_accounts","title":"Add an external account","href":"/v2/reference/addexternalaccounts"},{"openapi":"openapi-v2.json post /external_accounts/access_tokens","title":"Create a permanent access token for an external account","href":"/v2/reference/createaccesstoken"},{"openapi":"openapi-v2.json post /external_accounts/add_vendor_accounts","title":"Add external accounts through a vendor, such as Plaid.","href":"/v2/reference/addvendorexternalaccounts"},{"openapi":"openapi-v2.json post /external_accounts/link_tokens","title":"Create a link token to verify an external account","href":"/v2/reference/createverificationlinktoken"},{"openapi":"openapi-v2.json post /external_accounts/sync_vendor_accounts","title":"Sync external accounts through a vendor, such as Plaid.","href":"/v2/reference/syncvendorexternalaccounts"},{"openapi":"openapi-v2.json delete /external_accounts/{external_account_id}","title":"Delete an external account","href":"/v2/reference/deleteexternalaccount"},{"openapi":"openapi-v2.json get /external_accounts/{external_account_id}","title":"Get an external account","href":"/v2/reference/getexternalaccount"},{"openapi":"openapi-v2.json patch /external_accounts/{external_account_id}","title":"Patch an external account","href":"/v2/reference/updateexternalaccount"},{"openapi":"openapi-v2.json get /external_accounts/{external_account_id}/balance","title":"Get external account balances","href":"/v2/reference/getexternalaccountbalance"},{"openapi":"openapi-v2.json post /external_accounts/{external_account_id}/refresh_transactions","title":"Sync external account transactions through a vendor, such as Plaid","href":"/v2/reference/externalaccountrefreshtransactions"},{"openapi":"openapi-v2.json get /external_accounts/{external_account_id}/transactions","title":"List transactions of a given external account","href":"/v2/reference/getexternalaccounttransactions"}]},{"group":"Internal Accounts","pages":[{"openapi":"openapi-v2.json get /internal_accounts","title":"List internal accounts","href":"/v2/reference/listinternalaccounts"},{"openapi":"openapi-v2.json post /internal_accounts","title":"Add internal accounts","href":"/v2/reference/addinternalaccounts"},{"openapi":"openapi-v2.json get /internal_accounts/{internal_account_id}","title":"Get internal account by id","href":"/v2/reference/getinternalaccounts"},{"openapi":"openapi-v2.json patch /internal_accounts/{internal_account_id}","title":"Patch internal account","href":"/v2/reference/patchinternalaccount"}]},{"group":"Spend Controls","pages":[{"openapi":"openapi-v1.json get /spend_controls","title":"List Spend Controls","href":"/v2/reference/listspendcontrols"},{"openapi":"openapi-v1.json post /spend_controls","title":"Create Spend Control","href":"/v2/reference/createspendcontrol"},{"openapi":"openapi-v1.json get /spend_controls/{spend_control_id}","title":"Get Spend Control","href":"/v2/reference/getspendcontrol"},{"openapi":"openapi-v1.json patch /spend_controls/{spend_control_id}","title":"Update Spend Control","href":"/v2/reference/updatespendcontrol"}]},{"group":"Evaluation Overrides","pages":[{"openapi":"openapi-v2.json get /evaluation_overrides","title":"List risk evaluation overrides","href":"/v2/reference/listevaluationoverrides"},{"openapi":"openapi-v2.json post /evaluation_overrides","title":"Create a risk evaluation override","href":"/v2/reference/createevaluationoverride"},{"openapi":"openapi-v2.json get /evaluation_overrides/{evaluation_override_id}","title":"Get a risk evaluation override","href":"/v2/reference/getevaluationoverride"},{"openapi":"openapi-v2.json patch /evaluation_overrides/{evaluation_override_id}","title":"Update a risk evaluation override","href":"/v2/reference/updateevaluationoverride"},{"openapi":"openapi-v2.json delete /evaluation_overrides/{evaluation_override_id}","title":"Delete a risk evaluation override","href":"/v2/reference/deleteevaluationoverride"}]},{"group":"Plaid Core Exchange","pages":[{"openapi":"openapi-v2.json get /fdx_auth_requests","title":"List FDX authorization requests","href":"/v2/reference/listfdxauthrequests"},{"openapi":"openapi-v2.json get /fdx_auth_requests/authorization_test","title":"Authorization Test","href":"/v2/reference/getauthorizationtest"},{"openapi":"openapi-v2.json post /fdx_auth_requests/authorize","title":"Grant an FDX authorization request","href":"/v2/reference/grantfdxauthrequest"},{"openapi":"openapi-v2.json get /fdx_tokens","title":"List tokens","href":"/v2/reference/listfdxtoken"},{"openapi":"openapi-v2.json get /fdx_tokens/{fdx_token_id}","title":"Get an FDX token","href":"/v2/reference/getfdxtoken"}]},{"group":"Accounts","pages":[{"openapi":"openapi-v2.json get /accounts","title":"List accounts","href":"/v2/reference/listaccounts"},{"openapi":"openapi-v2.json post /accounts","title":"Create an account","href":"/v2/reference/createaccount"},{"openapi":"openapi-v2.json get /accounts/products","title":"List account products","href":"/v2/reference/listaccountresourceproducts"},{"openapi":"openapi-v2.json post /accounts/products","title":"Create an account product","href":"/v2/reference/createaccountresourceproduct"},{"openapi":"openapi-v2.json patch /accounts/products/{product_id}","title":"Patch account product","href":"/v2/reference/patchaccountproduct"},{"openapi":"openapi-v2.json get /accounts/stop_payments","title":null,"href":"/v2/reference/liststoppayment"},{"openapi":"openapi-v2.json get /accounts/templates","title":"List account templates","href":"/v2/reference/listaccounttemplates"},{"openapi":"openapi-v2.json post /accounts/templates","title":"Create an account template","href":"/v2/reference/createaccounttemplate"},{"openapi":"openapi-v2.json delete /accounts/templates/{template_id}","title":"Delete account template","href":"/v2/reference/deleteaccounttemplate"},{"openapi":"openapi-v2.json get /accounts/templates/{template_id}","title":"Get account template","href":"/v2/reference/getaccounttemplate"},{"openapi":"openapi-v2.json put /accounts/templates/{template_id}","title":"Update account template","href":"/v2/reference/updateaccounttemplate"},{"openapi":"openapi-v2.json patch /accounts/templates/{template_id}","title":"Patch account template","href":"/v2/reference/patchaccounttemplate"},{"openapi":"openapi-v2.json get /accounts/{account_id}","title":"Get account","href":"/v2/reference/getaccount"},{"openapi":"openapi-v2.json patch /accounts/{account_id}","title":"Patch account","href":"/v2/reference/patchaccount"},{"openapi":"openapi-v2.json put /accounts/{account_id}","title":"Update account","href":"/v2/reference/updateaccount"},{"openapi":"openapi-v2.json post /accounts/{account_id}/initiate_closure","title":"Initiate account closure","href":"/v2/reference/initiateaccountclosure"},{"openapi":"openapi-v2.json patch /accounts/{account_id}/initiate_closure","title":"Update account closure","href":"/v2/reference/updateaccountclosure"},{"openapi":"openapi-v2.json get /accounts/{account_id}/relationships","title":"List account relationships","href":"/v2/reference/listaccountrelationship"},{"openapi":"openapi-v2.json post /accounts/{account_id}/relationships","title":"Create account relationship","href":"/v2/reference/createaccountrelationship"},{"openapi":"openapi-v2.json delete /accounts/{account_id}/relationships/{relationship_id}","title":"Delete account relationship","href":"/v2/reference/deleteaccountrelationship"},{"openapi":"openapi-v2.json get /accounts/{account_id}/relationships/{relationship_id}","title":"Get account relationship","href":"/v2/reference/getaccountrelationship"},{"openapi":"openapi-v2.json put /accounts/{account_id}/relationships/{relationship_id}","title":"Update account relationship","href":"/v2/reference/updateaccountrelationship"}]},{"group":"Statements","pages":[{"openapi":"openapi-v2.json get /statements","title":"List statements","href":"/v2/reference/liststatements"},{"openapi":"openapi-v2.json get /statements/{statement_id}","title":"Get a statement","href":"/v2/reference/getstatement"},{"openapi":"openapi-v2.json get /statements/{statement_id}/transactions","title":"Get a statement's transactions","href":"/v2/reference/getstatementtransactions"}]},{"group":"Applications","pages":[{"openapi":"openapi-v2.json get /applications","title":"List applications","href":"/v2/reference/listapplications-1"},{"openapi":"openapi-v2.json post /applications","title":"Create an application","href":"/v2/reference/createapplication-1"},{"openapi":"openapi-v2.json get /applications/{application_id}","title":"Get an application","href":"/v2/reference/getapplication-1"},{"openapi":"openapi-v2.json patch /applications/{application_id}","title":"Modify an application","href":"/v2/reference/patchapplication-1"}]},{"group":"Adverse Actions","pages":[{"openapi":"openapi-v2.json get /adverse_actions","title":"List adverse action notices","href":"/v2/reference/listadverseactions"},{"openapi":"openapi-v2.json post /adverse_actions","title":"Create an adverse action notice","href":"/v2/reference/createadverseaction"},{"openapi":"openapi-v2.json get /adverse_actions/{adverse_action_id}","title":"Retrieve an adverse action notice","href":"/v2/reference/getadverseaction"}]},{"group":"Autopay","pages":[{"openapi":"openapi-v2.json get /autopay_configs","title":"List autopay configurations","href":"/v2/reference/listautopayconfigs"},{"openapi":"openapi-v2.json post /autopay_configs","title":"Create autopay configuration","href":"/v2/reference/createautopayconfig"},{"openapi":"openapi-v2.json get /autopay_configs/{autopay_config_id}","title":"Get autopay configuration","href":"/v2/reference/getautopayconfig"},{"openapi":"openapi-v2.json patch /autopay_configs/{autopay_config_id}","title":"Update autopay configuration","href":"/v2/reference/updateautopayconfig"},{"openapi":"openapi-v2.json delete /autopay_configs/{autopay_config_id}","title":"Delete autopay configuration","href":"/v2/reference/deleteautopayconfig"},{"openapi":"openapi-v2.json get /autopays","title":"List autopays","href":"/v2/reference/listautopays"},{"openapi":"openapi-v2.json get /autopays/{autopay_id}","title":"Get autopay","href":"/v2/reference/getautopay"},{"openapi":"openapi-v2.json patch /autopays/{autopay_id}","title":"Update autopay","href":"/v2/reference/patchautopay"}]}]},{"group":"Cards","pages":[{"group":"Apple Pay","pages":[{"openapi":"openapi-v2.json post /certificates/applepay/csr","title":"Create an Apple Pay CSR","href":"/v2/reference/createapplepaycsr"}]},{"group":"Bulk Issuance","pages":[{"openapi":"openapi-v2.json get /cards/bulk_issuance","title":"List Bulk Order Configurations","href":"/v2/reference/listbulkorderconfigs"},{"openapi":"openapi-v2.json post /cards/bulk_issuance","title":"Create a bulk order configuration","href":"/v2/reference/createbulkorderconfig"},{"openapi":"openapi-v2.json get /cards/bulk_issuance/{bulk_order_config_id}","title":"Get bulk order configuration","href":"/v2/reference/getbulkorderconfig"},{"openapi":"openapi-v2.json post /cards/bulk_issuance/{bulk_order_config_id}/fulfill","title":"Fulfill a bulk order","href":"/v2/reference/fulfillbulkorder"}]},{"group":"External Cards","pages":[{"openapi":"openapi-v2.json get /external_cards","title":"List External Cards","href":"/v2/reference/listexternalcards"},{"openapi":"openapi-v2.json post /external_cards/authenticate_3ds","title":"Authenticate 3DS","href":"/v2/reference/authenticate3ds"},{"openapi":"openapi-v2.json post /external_cards/initialize_3ds","title":"Initialize 3DS","href":"/v2/reference/initialize3ds"},{"openapi":"openapi-v2.json post /external_cards/lookup_3ds","title":"Lookup 3DS","href":"/v2/reference/lookup3ds"},{"openapi":"openapi-v2.json post /external_cards/tokens","title":"Create External Card from token","href":"/v2/reference/createexternalcardfromtoken"},{"openapi":"openapi-v2.json get /external_cards/transfers","title":"List External Transfers","href":"/v2/reference/listexternalcardtransfers"},{"openapi":"openapi-v2.json post /external_cards/transfers","title":"Create External Card Transfer","description":"Create External Card Transfer\n","href":"/v2/reference/createexternalcardtransfer"},{"openapi":"openapi-v2.json post /external_cards/transfers/applepay","title":"Create Apple Pay External Card Transfer","href":"/v2/reference/createapplepayexternalcardtransfer"},{"openapi":"openapi-v2.json post /external_cards/transfers/googlepay","title":"Create Google Pay External Card Transfer","description":"> 🚧 Alpha\n> Google Pay transfers is currently in Alpha release and spec is subject to change.\n\nCreate External Card Transfer using a Google Pay card.\n","href":"/v2/reference/creategooglepayexternalcardtransfer"},{"openapi":"openapi-v2.json get /external_cards/transfers/{transfer_id}","title":"Get External Card Transfer","href":"/v2/reference/getexternalcardtransfer"},{"openapi":"openapi-v2.json post /external_cards/transfers/{transfer_id}/reversals","title":"Create External Card Transfer Reversal","href":"/v2/reference/createexternalcardtransferreversal"},{"openapi":"openapi-v2.json delete /external_cards/{external_card_id}","title":"Delete External Card","href":"/v2/reference/deleteexternalcard"},{"openapi":"openapi-v2.json get /external_cards/{external_card_id}","title":"Get External Card","href":"/v2/reference/getexternalcard"},{"openapi":"openapi-v2.json patch /external_cards/{external_card_id}","title":"Update External Card","href":"/v2/reference/updateexternalcard"}]},{"group":"Cards","pages":[{"openapi":"openapi-v2.json get /cards","title":"List Cards","href":"/v2/reference/listcards"},{"openapi":"openapi-v2.json post /cards","title":"Issue a Card","href":"/v2/reference/issuecard"},{"openapi":"openapi-v2.json post /cards/activate","title":"Activate a card","href":"/v2/reference/activatecard"},{"openapi":"openapi-v2.json get /cards/card_widget_url","title":"Get card widget URL","href":"/v2/reference/getcardwidgeturl"},{"openapi":"openapi-v2.json get /cards/gateways","title":"List Gateways","href":"/v2/reference/listgateways"},{"openapi":"openapi-v2.json post /cards/gateways","title":"Create Gateway","href":"/v2/reference/creategateway"},{"openapi":"openapi-v2.json get /cards/gateways/{gateway_id}","title":"Get Gateway","href":"/v2/reference/getgateway"},{"openapi":"openapi-v2.json patch /cards/gateways/{gateway_id}","title":"Update Gateway","href":"/v2/reference/updategateway"},{"openapi":"openapi-v2.json get /cards/images","title":"List Card Image Details","href":"/v2/reference/listcardimagedetails"},{"openapi":"openapi-v2.json post /cards/images","title":"Create Card Image","href":"/v2/reference/createcardimage"},{"openapi":"openapi-v2.json get /cards/images/{card_image_id}","title":"Get Card Image Details","href":"/v2/reference/getcardimagedetails"},{"openapi":"openapi-v2.json patch /cards/images/{card_image_id}","title":"Update Card Image Details","href":"/v2/reference/updatecardimagedetails"},{"openapi":"openapi-v2.json get /cards/images/{card_image_id}/data","title":"Get Card Image Data","href":"/v2/reference/getcardimagedata"},{"openapi":"openapi-v2.json post /cards/images/{card_image_id}/data","title":"Upload Card Image","href":"/v2/reference/uploadcardimagedata"},{"openapi":"openapi-v2.json get /cards/products","title":"List Card Products","href":"/v2/reference/listcardproducts"},{"openapi":"openapi-v2.json get /cards/three_ds_decision_gateways","title":"List 3DS Decision Gateways","href":"/v2/reference/listthreedsdecisiongateways"},{"openapi":"openapi-v2.json post /cards/three_ds_decision_gateways","title":"Create 3DS Decision Gateway","href":"/v2/reference/createthreedsdecisiongateway"},{"openapi":"openapi-v2.json get /cards/three_ds_decision_gateways/{id}","title":"Get 3DS DecisionGateway","href":"/v2/reference/getthreedsdecisiongateway"},{"openapi":"openapi-v2.json patch /cards/three_ds_decision_gateways/{id}","title":"Update 3DS Decision Gateway","href":"/v2/reference/updatethreedsgateway"},{"openapi":"openapi-v2.json get /cards/{card_id}","title":"Get Card","href":"/v2/reference/getcard"},{"openapi":"openapi-v2.json patch /cards/{card_id}","title":"Update Card","href":"/v2/reference/updatecard"},{"openapi":"openapi-v2.json get /cards/{card_id}/barcodes","title":"Get Card Barcode","href":"/v2/reference/getcardbarcode"},{"openapi":"openapi-v2.json post /cards/{card_id}/client_token","title":"Get a client token","href":"/v2/reference/getclientaccesstoken"},{"openapi":"openapi-v2.json post /cards/{card_id}/pin","title":"Set Card PIN","href":"/v2/reference/setcardpin"},{"openapi":"openapi-v2.json get /cards/{card_id}/reveal","title":"Reveal Card Details","href":"/v2/reference/revealcarddetails"},{"openapi":"openapi-v2.json get /cards/{card_id}/widget_token","title":"Get a widget access token","href":"/v2/reference/getwidgetaccesstoken"}]},{"group":"Digital Wallet Tokens","pages":[{"openapi":"openapi-v2.json get /cards/digital_wallet_tokens","title":"List Digital Wallet Tokens","href":"/v2/reference/listdigitalwallettokens"},{"openapi":"openapi-v2.json get /cards/digital_wallet_tokens/{digital_wallet_token_id}","title":"Get Digital Wallet Token","href":"/v2/reference/getdigitalwallettoken"},{"openapi":"openapi-v2.json patch /cards/digital_wallet_tokens/{digital_wallet_token_id}","title":"Update Digital Wallet Token's life cycle status","href":"/v2/reference/updatedigitalwallettokenstatus"},{"openapi":"openapi-v2.json post /cards/{card_id}/digital_wallet_tokens/applepay","title":"Create digital wallet token provision request for Apple Pay","href":"/v2/reference/createdigitalwalletapple"},{"openapi":"openapi-v2.json post /cards/{card_id}/digital_wallet_tokens/googlepay","title":"Create digital wallet token provision request for Google Pay","href":"/v2/reference/createdigitalwalletgoogle"},{"openapi":"openapi-v2.json post /cards/{card_id}/digital_wallet_tokens/googlepay_upp","title":"Create digital wallet token provision request for Google Pay using Unified Push Provisioning (UPP)","href":"/v2/reference/createdigitalwalletgoogleupp"}]}]},{"group":"Money Movement","pages":[{"group":"Rewards","pages":[{"openapi":"openapi-v2.json get /reward_templates","title":"List reward templates","href":"/v2/reference/listrewardtemplates"},{"openapi":"openapi-v2.json post /reward_templates","title":"Create a reward template","href":"/v2/reference/createrewardtemplate"},{"openapi":"openapi-v2.json get /reward_templates/{reward_template_id}","title":"Get a Reward template","href":"/v2/reference/getrewardtemplate"},{"openapi":"openapi-v2.json patch /reward_templates/{reward_template_id}","title":"Patch Reward Template","href":"/v2/reference/patchrewardtemplate"},{"openapi":"openapi-v2.json get /rewards","title":"List rewards","href":"/v2/reference/listrewards"},{"openapi":"openapi-v2.json post /rewards","title":"Create a reward","href":"/v2/reference/createreward"},{"openapi":"openapi-v2.json get /rewards/{reward_id}","title":"Get Reward","href":"/v2/reference/getreward"},{"openapi":"openapi-v2.json post /rewards/{reward_id}/reverse","title":"Reverse a reward","href":"/v2/reference/reversereward"}]},{"group":"Reward Products","pages":[{"openapi":"openapi-v2.json get /reward_products","title":"List reward products","href":"/v2/reference/listrewardproducts"},{"openapi":"openapi-v2.json post /reward_products","title":"Create a reward product","href":"/v2/reference/createrewardproduct"},{"openapi":"openapi-v2.json get /reward_products/{reward_product_id}","title":"Get a reward product","href":"/v2/reference/getrewardproduct"},{"openapi":"openapi-v2.json patch /reward_products/{reward_product_id}","title":"Update a reward product","href":"/v2/reference/updaterewardproduct"},{"openapi":"openapi-v2.json get /reward_configs","title":"List reward configs","href":"/v2/reference/listrewardconfigs"},{"openapi":"openapi-v2.json post /reward_configs","title":"Create a reward config","href":"/v2/reference/createrewardconfig"},{"openapi":"openapi-v2.json get /reward_configs/{reward_config_id}","title":"Get a reward config","href":"/v2/reference/getrewardconfig"},{"openapi":"openapi-v2.json patch /reward_configs/{reward_config_id}","title":"Update a reward config","href":"/v2/reference/updaterewardconfig"}]},{"group":"Fees","pages":[{"openapi":"openapi-v2.json get /fee_templates","title":"List fee templates","href":"/v2/reference/listfeetemplates"},{"openapi":"openapi-v2.json post /fee_templates","title":"Create a fee template","href":"/v2/reference/createfeetemplate"},{"openapi":"openapi-v2.json get /fee_templates/{fee_template_id}","title":"Get a Fee template","href":"/v2/reference/getfeetemplate"},{"openapi":"openapi-v2.json patch /fee_templates/{fee_template_id}","title":"Patch Fee Template","href":"/v2/reference/patchfeetemplate"},{"openapi":"openapi-v2.json get /fees","title":"List fees","href":"/v2/reference/listfees"},{"openapi":"openapi-v2.json post /fees","title":"Create a fee","href":"/v2/reference/createfee"},{"openapi":"openapi-v2.json get /fees/{fee_id}","title":"Get Fee","href":"/v2/reference/getfee"},{"openapi":"openapi-v2.json post /fees/{fee_id}/reverse","title":"Reverse a fee","href":"/v2/reference/reversefee"}]},{"group":"Fee Products","pages":[{"openapi":"openapi-v2.json get /fee_products","title":"List fee products","href":"/v2/reference/listfeeproducts"},{"openapi":"openapi-v2.json post /fee_products","title":"Create a fee product","href":"/v2/reference/createfeeproduct"},{"openapi":"openapi-v2.json get /fee_products/{fee_product_id}","title":"Get a fee product","href":"/v2/reference/getfeeproduct"},{"openapi":"openapi-v2.json patch /fee_products/{fee_product_id}","title":"Update a fee product","href":"/v2/reference/updatefeeproduct"},{"openapi":"openapi-v2.json get /fee_configs","title":"List fee configs","href":"/v2/reference/listfeeconfigs"},{"openapi":"openapi-v2.json post /fee_configs","title":"Create a fee config","href":"/v2/reference/createfeeconfig"},{"openapi":"openapi-v2.json get /fee_configs/{fee_config_id}","title":"Get a fee config","href":"/v2/reference/getfeeconfig"},{"openapi":"openapi-v2.json patch /fee_configs/{fee_config_id}","title":"Update a fee config","href":"/v2/reference/updatefeeconfig"},{"openapi":"openapi-v2.json get /fee_categories","title":"List fee categories","href":"/v2/reference/listfeecategories"}]},{"group":"Batch Payments","pages":[{"openapi":"openapi-v2.json get /batch_templates","title":"Get Batch Payment Templates","href":"/v2/reference/getbatchpaymenttemplates"},{"openapi":"openapi-v2.json post /batch_templates","title":"Create Batch Payment Template","href":"/v2/reference/createbatchpaymenttemplate"},{"openapi":"openapi-v2.json get /batch_templates/{id}","title":"Get Batch Payment Template","href":"/v2/reference/getbatchpaymenttemplate"},{"openapi":"openapi-v2.json patch /batch_templates/{id}","title":"Update Batch Payment Template","href":"/v2/reference/updatebatchpaymenttemplate"},{"openapi":"openapi-v2.json get /batches","title":"Get Batch Payments","href":"/v2/reference/getbatchpayments"},{"openapi":"openapi-v2.json post /batches","title":"Create Batch Payments","href":"/v2/reference/createbatchpayments"},{"openapi":"openapi-v2.json get /batches/{id}","title":"Get BatchPayment","href":"/v2/reference/getbatchpayment"},{"openapi":"openapi-v2.json patch /batches/{id}","title":"Update Batch Payment","href":"/v2/reference/updatebatchpayment"}]},{"group":"Payments","pages":[{"openapi":"openapi-v2.json get /payments","title":"List payments","href":"/v2/reference/listmadepayments"},{"openapi":"openapi-v2.json post /payments","title":"Make a payment","href":"/v2/reference/makepayment"},{"openapi":"openapi-v2.json get /payments/{payment_id}","title":"Get payment","href":"/v2/reference/getpayment"},{"openapi":"openapi-v2.json patch /payments/{payment_id}","title":"Update payment","href":"/v2/reference/patchpayment"}]},{"group":"Cash Orders and Deposits (alpha)","pages":[{"openapi":"openapi-v2.json get /cash","title":"Get cash transfers","href":"/v2/reference/getcashtransfers"},{"openapi":"openapi-v2.json get /cash/authorization","title":"Get cash authorizations","href":"/v2/reference/getcashauthorizations"},{"openapi":"openapi-v2.json post /cash/authorization","title":"Cash Authorization for an upcoming transfer","href":"/v2/reference/createcashauthorization"},{"openapi":"openapi-v2.json get /cash/authorization/{id}","title":"Get cash order authorization","href":"/v2/reference/getcashorderauthorization"},{"openapi":"openapi-v2.json patch /cash/authorization/{id}","title":"Update a cash order authorization","href":"/v2/reference/patchcashorderauthorization"},{"openapi":"openapi-v2.json get /cash/{id}","title":"Get cash transfer","href":"/v2/reference/getcashtransfer"},{"openapi":"openapi-v2.json patch /cash/{id}","title":"Update a cash transfer","href":"/v2/reference/patchcashtransfer"}]},{"group":"In-Store Cash Deposits","pages":[{"openapi":"openapi-v2.json POST /cash/barcodes","title":"Create a barcode for a cash transaction","href":"/v2/reference/createbarcode"},{"openapi":"openapi-v2.json GET /cash/barcodes","title":"Get a list of barcodes","href":"/v2/reference/getbarcodes"},{"openapi":"openapi-v2.json GET /cash/barcodes/{barcode_id}","title":"Get a barcode","href":"/v2/reference/getbarcode"},{"openapi":"openapi-v2.json PATCH /cash/barcodes/{barcode_id}","title":"Update a barcode","href":"/v2/reference/updatebarcode"},{"openapi":"openapi-v2.json GET /cash/barcodes/retailer_map_url","title":"Get the available retailer map URL.","href":"/v2/reference/getretailermapurl"}]},{"group":"Wires","pages":[{"openapi":"openapi-v2.json get /wires","title":"List outgoing wires","href":"/v2/reference/listwires"},{"openapi":"openapi-v2.json post /wires","title":"Send a wire","href":"/v2/reference/createwire"},{"openapi":"openapi-v2.json get /wires/{wire_id}","title":"Get an outgoing wire by id","href":"/v2/reference/getwire"},{"openapi":"openapi-v2.json patch /wires/{wire_id}","title":"Cancel an outgoing wire","href":"/v2/reference/cancelwire"}]},{"group":"ACH","pages":[{"openapi":"openapi-v2.json get /ach","title":"List sent ACH transactions","href":"/v2/reference/listtransactionsout"},{"openapi":"openapi-v2.json post /ach","title":"Send an ACH","href":"/v2/reference/addtransactionout"},{"openapi":"openapi-v2.json get /ach/gateways","title":"List All Gateway Configurations","href":"/v2/reference/getallgatewayconfigs"},{"openapi":"openapi-v2.json post /ach/gateways","title":"Create New Gateway Endpoint Configuration","href":"/v2/reference/addgatewayconfig"},{"openapi":"openapi-v2.json delete /ach/gateways/{id}","title":"Delete Gateway Endpoint Configuration by ID","href":"/v2/reference/deletegatewayconfigbyid"},{"openapi":"openapi-v2.json get /ach/gateways/{id}","title":"Get Gateway Endpoint Configuration By ID","href":"/v2/reference/getgatewayconfigbyid"},{"openapi":"openapi-v2.json patch /ach/gateways/{id}","title":"Update Gateway Endpoint Configuration By ID","href":"/v2/reference/patchgatewayconfigbyid"},{"openapi":"openapi-v2.json get /ach/incoming","title":"List Incoming ACH Transactions","href":"/v2/reference/getincomingachlist"},{"openapi":"openapi-v2.json get /ach/incoming/{id}","title":"Get Incoming ACH Transaction By ID","href":"/v2/reference/getincomingachbyid"},{"openapi":"openapi-v2.json get /ach/{transaction_id}","title":"Get a sent ACH transaction","href":"/v2/reference/gettransactionout"},{"openapi":"openapi-v2.json patch /ach/{transaction_id}","title":"Update a sent ACH transaction","href":"/v2/reference/patchtransactionout"}]},{"group":"PaymentSchedules","pages":[{"openapi":"openapi-v2.json get /payment_schedules","title":"List payment schedules","href":"/v2/reference/listpaymentschedules"},{"openapi":"openapi-v2.json post /payment_schedules","title":"Create a payment schedule","href":"/v2/reference/createpaymentschedule"},{"openapi":"openapi-v2.json get /payment_schedules/payments","title":"List payments","href":"/v2/reference/listpayments"},{"openapi":"openapi-v2.json patch /payment_schedules/{payment_schedule_id}","title":"Update a payment schedule","href":"/v2/reference/patchpaymentschedule"}]},{"group":"Remote Check Deposit","pages":[{"openapi":"openapi-v2.json get /rdc/deposits","title":"List Remote Check Deposits","href":"/v2/reference/listrdcdeposits"},{"openapi":"openapi-v2.json post /rdc/deposits","title":"Create a Remote Check Deposit","href":"/v2/reference/createrdcdeposit"},{"openapi":"openapi-v2.json get /rdc/deposits/{deposit_id}","title":"Get Remote Check Deposit","href":"/v2/reference/getrdcdeposit"}]},{"group":"Internal Transfer","pages":[{"openapi":"openapi-v2.json post /transactions/internal_transfer","title":"Create an internal transfer","href":"/v2/reference/createinternaltransfer"},{"openapi":"openapi-v2.json get /transactions/internal_transfer/{id}","title":"Get an internal transfer","href":"/v2/reference/getinternaltransferbyid"},{"openapi":"openapi-v2.json patch /transactions/internal_transfer/{id}","title":"Update an internal transfer","href":"/v2/reference/updateinternaltransferbyid"}]},{"group":"Incoming Wires","pages":[{"openapi":"openapi-v2.json get /wires/incoming","title":"List incoming wires","href":"/v2/reference/listincomingwires"},{"openapi":"openapi-v2.json get /wires/incoming/{wire_id}","title":"Get incoming wire by id","href":"/v2/reference/getincomingwire"},{"openapi":"openapi-v2.json patch /wires/incoming/{wire_id}","title":"Update an incoming wire by id","href":"/v2/reference/patchincomingwire"}]},{"group":"Outgoing SyncteraPay","pages":[{"openapi":"openapi-v2.json post /synctera_pay","title":"Create Synctera Pay Transfer","href":"/v2/reference/createsyncterapaytransfer"},{"openapi":"openapi-v2.json get /synctera_pay","title":"Get Outgoing Synctera Pay Transfers","href":"/v2/reference/getsyncterapaytransfers"},{"openapi":"openapi-v2.json get /synctera_pay/{id}","title":"Get Outgoing Synctera Pay Transfer","href":"/v2/reference/getsyncterapaytransfer"},{"openapi":"openapi-v2.json patch /synctera_pay/{id}","title":"Update an Outgoing Synctera Pay Transfer","href":"/v2/reference/updatesyncterapaytransfer"},{"openapi":"openapi-v2.json post /synctera_pay/{id}/return","title":"Return a Synctera Pay Transfer","href":"/v2/reference/returnsyncterapaytransfer"},{"openapi":"openapi-v2.json get /synctera_pay/configurations","title":"Get Outgoing Synctera Pay Configurations","href":"/v2/reference/getsyncterapayconfigurations"},{"openapi":"openapi-v2.json get /synctera_pay/configurations/{id}","title":"Get Outgoing Synctera Pay Configuration","href":"/v2/reference/getsyncterapayconfiguration"},{"openapi":"openapi-v2.json get /synctera_pay/vendors","title":"List Outgoing Synctera Pay vendors","href":"/v2/reference/getsyncterapayvendors"},{"openapi":"openapi-v2.json get /synctera_pay/vendors/{id}","title":"Get an Outgoing Synctera Pay vendor","href":"/v2/reference/getsyncterapayvendor"}]},{"group":"Incoming SyncteraPay","pages":[{"openapi":"openapi-v2.json post /synctera_pay/incoming/transfers","title":"Create Incoming Synctera Pay Transfer","href":"/v2/reference/createincomingsyncterapaytransfer"},{"openapi":"openapi-v2.json get /synctera_pay/incoming/transfers","title":"List Incoming Synctera Pay Transfers","href":"/v2/reference/listincomingsyncterapaytransfers"},{"openapi":"openapi-v2.json get /synctera_pay/incoming/transfers/{id}","title":"Get Incoming Synctera Pay Transfer","href":"/v2/reference/getincomingsyncterapaytransfer"},{"openapi":"openapi-v2.json get /synctera_pay/incoming/configurations/{id}","title":"Get Incoming Synctera Pay Configuration","href":"/v2/reference/getincomingsyncterapayconfiguration"},{"openapi":"openapi-v2.json get /synctera_pay/incoming/configurations","title":"List Incoming Synctera Pay Configurations","href":"/v2/reference/listincomingsyncterapayconfigurations"}]}]},{"group":"Transactions","pages":[{"group":"Disputes","pages":[{"openapi":"openapi-v2.json get /disputes","title":"List disputes","href":"/v2/reference/listdisputes"},{"openapi":"openapi-v2.json post /disputes","title":"Dispute a transaction","href":"/v2/reference/createdispute"},{"openapi":"openapi-v2.json get /disputes/documents/{document_id}/contents","title":"Get dispute document contents","href":"/v2/reference/getdisputedocumentcontents"},{"openapi":"openapi-v2.json get /disputes/{dispute_id}","title":"Get a Dispute","href":"/v2/reference/getdispute"},{"openapi":"openapi-v2.json patch /disputes/{dispute_id}","title":"Update a dispute","href":"/v2/reference/updatedispute"},{"openapi":"openapi-v2.json post /disputes/{dispute_id}/actions","title":"Create a dispute action","href":"/v2/reference/createaction"},{"openapi":"openapi-v2.json post /disputes/{dispute_id}/documents","title":"Add a document to a dispute","href":"/v2/reference/adddisputedocument"}]},{"group":"Merchants","pages":[{"openapi":"openapi-v2.json get /mx/merchants/{merchant_guid}","title":"Get merchant from MX","href":"/v2/reference/mxreadmerchant"}]},{"group":"Transactions","pages":[{"openapi":"openapi-v2.json get /transactions/batchable","title":"Get Transactions From Batch Payments Templates","href":"/v2/reference/gettransactionsbatchpayments"},{"openapi":"openapi-v2.json get /transactions/pending","title":"List pending transactions","href":"/v2/reference/listpendingtransactions"},{"openapi":"openapi-v2.json get /transactions/pending/{id}","title":"Get a pending transaction","href":"/v2/reference/getpendingtransactionbyid"},{"openapi":"openapi-v2.json get /transactions/posted","title":"List posted transactions","href":"/v2/reference/listpostedtransactions"},{"openapi":"openapi-v2.json get /transactions/posted/{id}","title":"Get a posted transaction","href":"/v2/reference/getpostedtransactionbyid"}]}]},{"group":"Platform","pages":[{"group":"Webhooks","pages":[{"openapi":"openapi-v2.json delete /webhook_secrets","title":"Revoke the secret","href":"/v2/reference/revokesecret"},{"openapi":"openapi-v2.json post /webhook_secrets","title":"Create a secret","href":"/v2/reference/createsecret"},{"openapi":"openapi-v2.json put /webhook_secrets","title":"Replace an existing secret","href":"/v2/reference/replacesecret"},{"openapi":"openapi-v2.json get /webhooks","title":"List webhooks","href":"/v2/reference/listwebhooks"},{"openapi":"openapi-v2.json post /webhooks","title":"Create a webhook","href":"/v2/reference/createwebhook"},{"openapi":"openapi-v2.json post /webhooks/trigger","title":"Trigger an event","href":"/v2/reference/triggerevent"},{"openapi":"openapi-v2.json delete /webhooks/{webhook_id}","title":"Delete a webhook","href":"/v2/reference/deletewebhook"},{"openapi":"openapi-v2.json get /webhooks/{webhook_id}","title":"Get a webhook","href":"/v2/reference/getwebhook"},{"openapi":"openapi-v2.json put /webhooks/{webhook_id}","title":"Update a webhook","href":"/v2/reference/updatewebhook"},{"openapi":"openapi-v2.json get /webhooks/{webhook_id}/events","title":"List webhook events","href":"/v2/reference/listevents"},{"openapi":"openapi-v2.json get /webhooks/{webhook_id}/events/{event_id}","title":"Get webhook event","href":"/v2/reference/getevent"},{"openapi":"openapi-v2.json post /webhooks/{webhook_id}/events/{event_id}/resend","title":"Resend an event","href":"/v2/reference/resendevent"}]},{"group":"Documents","pages":[{"openapi":"openapi-v2.json get /documents","title":"List documents","href":"/v2/reference/listdocuments"},{"openapi":"openapi-v2.json post /documents","title":"Create a document","href":"/v2/reference/createdocument"},{"openapi":"openapi-v2.json delete /documents/{document_id}","title":"Delete a document","href":"/v2/reference/deletedocument"},{"openapi":"openapi-v2.json get /documents/{document_id}","title":"Get a document","href":"/v2/reference/getdocument"},{"openapi":"openapi-v2.json patch /documents/{document_id}","title":"Update a document","href":"/v2/reference/updatedocument"},{"openapi":"openapi-v2.json get /documents/{document_id}/contents","title":"Get contents of latest document version","href":"/v2/reference/getdocumentcontents"},{"openapi":"openapi-v2.json post /documents/{document_id}/versions","title":"Create a new document version","href":"/v2/reference/createdocumentversion"},{"openapi":"openapi-v2.json get /documents/{document_id}/versions/{document_version}/contents","title":"Get document contents by version","href":"/v2/reference/getdocumentversion"},{"openapi":"openapi-v2.json get /documents/{document_id}/versions/{document_version}","title":"Get a document by version","href":"/v2/reference/getdocumentversioncontents"}]},{"group":"Notes","pages":[{"openapi":"openapi-v2.json get /notes","title":"List notes","href":"/v2/reference/listnotes"},{"openapi":"openapi-v2.json post /notes","title":"Create a note","href":"/v2/reference/createnote"},{"openapi":"openapi-v2.json patch /notes/{note_id}","title":"Patch Note","href":"/v2/reference/patchnote"}]},{"group":"Cases","pages":[{"title":"List cases","openapi":"openapi-v2.json get /cases","href":"/v2/reference/listcases"},{"title":"Get case","openapi":"openapi-v2.json get /cases/{id}","href":"/v2/reference/getcase"}]},{"group":"Institutions","pages":[{"openapi":"openapi-v2.json get /institutions","title":"Retrieve a list of institutions","href":"/v2/reference/getinstitutions"}]},{"group":"EDD","pages":[{"openapi":"openapi-v2.json get /edd","title":"List EDD","href":"/v2/reference/listedd"},{"openapi":"openapi-v2.json post /edd","title":"Create a EDD","href":"/v2/reference/createedd"},{"openapi":"openapi-v2.json delete /edd/{edd_id}","title":"Delete a EDD","href":"/v2/reference/deleteedd"},{"openapi":"openapi-v2.json get /edd/{edd_id}","title":"Get a EDD","href":"/v2/reference/getedd"}]},{"group":"Migration Mappings","pages":[{"openapi":"openapi-v2.json get /migration_mappings","title":"List migration mappings","href":"/v2/reference/listmigrationmappings"},{"openapi":"openapi-v2.json post /migration_mappings","title":"Create a migration mapping","href":"/v2/reference/createmigrationmapping"},{"openapi":"openapi-v2.json get /migration_mappings/{mapping_id}","title":"Get migration mapping","href":"/v2/reference/getmigrationmapping"},{"openapi":"openapi-v2.json patch /migration_mappings/{mapping_id}","title":"Update migration mapping","href":"/v2/reference/updatemigrationmapping"},{"openapi":"openapi-v2.json delete /migration_mappings/{mapping_id}","title":"Delete migration mapping","href":"/v2/reference/deletemigrationmapping"}]},{"group":"Sandbox Wipe","pages":[{"openapi":"openapi-v2.json post /wipe","title":null,"href":"/v2/reference/wipeworkspace"}]}]},{"group":"Simulations","pages":[{"group":"Card Webhook Simulations","pages":[{"openapi":"openapi-v2.json post /cards/{card_id}/webhook_simulations/fulfillment","title":"Simulate Card Fulfillment Event","href":"/v2/reference/simulatecardfulfillmentevent"}]},{"group":"ACH Transaction Simulations","pages":[{"openapi":"openapi-v2.json post /ach/transaction_simulations/receiving_return","title":"Simulate receiving ACH return","href":"/v2/reference/achreturnsimulation"},{"openapi":"openapi-v2.json post /ach/transaction_simulations/receiving_transaction","title":"Simulate receiving ACH transaction","href":"/v2/reference/achtransactionsimulation"}]},{"group":"Wire Transaction Simulations","pages":[{"openapi":"openapi-v2.json post /wires/transaction_simulations/receiving_return","title":"Simulate receiving Wire transfer return","href":"/v2/reference/wirereturnsimulation"},{"openapi":"openapi-v2.json post /wires/transaction_simulations/receiving_transaction","title":"Simulate receiving Wire transaction","href":"/v2/reference/wiretransactionsimulation"}]},{"group":"Card Transaction Simulations","pages":[{"openapi":"openapi-v2.json post /cards/transaction_simulations/authorization","title":"Simulate authorization","href":"/v2/reference/simulateauthorization"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/authorization/advice","title":"Simulate authorization advice","href":"/v2/reference/simulateauthorizationadvice"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/clearing","title":"Simulate clearing or refund","href":"/v2/reference/simulateclearing"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/clearing/l2l3","title":"Simulate L2l3","href":"/v2/reference/simulatel2l3"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial","title":"Simulate financial","href":"/v2/reference/simulatefinancial"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial/advice","title":"Simulate financial advice","href":"/v2/reference/simulatefinancialadvice"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial/balance_inquiry","title":"Simulate balance inquiry","href":"/v2/reference/simulatebalanceinquiry"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial/original_credit","title":"Simulate OCT","href":"/v2/reference/simulateoriginalcredit"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial/withdrawal","title":"Simulate ATM withdrawal","href":"/v2/reference/simulatewithdrawal"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/reversal","title":"Simulate reversal","href":"/v2/reference/simulatereversal"}]},{"group":"Dispute Simulations (beta)","pages":[{"openapi":"openapi-v2.json post /disputes/simulations/{dispute_id}/actions","title":"Simulate a network dispute action","href":"/v2/reference/simulatedisputeaction"}]},{"group":"In-Store Cash Deposit Simulations","pages":[{"openapi":"openapi-v1.json get /cash/transaction_simulations/barcodes/stores","title":"Retrieve Store Information for Barcode Simulation","href":"/v2/reference/simulatebarcodesstores"},{"openapi":"openapi-v1.json post /cash/transaction_simulations/barcodes/deposits","title":"Create a cash deposit transaction simulation for a barcode","href":"/v2/reference/simulatebarcodesdeposits"}]}]}]},{"tab":"Learning Center","pages":[{"title":"Learning Center","href":"/docs/learning-center"}]}]},{"version":"v0","pages":[{"title":"v0","href":"/reference/listexternalcards"}]},{"version":"v1","pages":[{"title":"v1","href":"/v1/reference/createapplepayexternalcardtransfer"}]}]},"basePath":"","title":"Create Apple Pay External Card Transfer - Synctera","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}