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.
These key-value pairs define custom HTTP headers that will be included in every HTTP request to the
gateway. Note that when updating this field, all key-value pairs will be replaced. They are not merged with
existing data.
Whether this gateway is invoked after the pending transaction/hold is created (POST_AUTH, the default) or before it exists (PRE_AUTH). PRE_AUTH gateways are not yet supported.
Amount fields available pre-auth, before the pending transaction/hold exists (excludes approved_amount and total_pending_amount, which are derived from the hold).
Request sent to gateway for pre-authorization, before the pending transaction/hold exists. Contains the same fields as gateway_authorization except for the ones that depend on the hold (transaction_id, balance, and the hold-derived amount fields).
Amount fields available pre-auth, before the pending transaction/hold exists (excludes approved_amount and total_pending_amount, which are derived from the hold).
Approve the transaction. The response body may optionally include a routing_config
to override the account funding sequence.
Response body for a 200 (approve) pre-authorization response. routing_config is only honored when the transaction's account is a router Zero Balance Account — it is ignored otherwise.
These key-value pairs define custom HTTP headers that will be included in every HTTP request to the
gateway. Note that when updating this field, all key-value pairs will be replaced. They are not merged with
existing data.
Whether this gateway is invoked after the pending transaction/hold is created (POST_AUTH, the default) or before it exists (PRE_AUTH). PRE_AUTH gateways are not yet supported.
Available options:
POST_AUTH,
PRE_AUTH
Was this page helpful?
{"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/creategateway","slug":"/v2/reference/creategateway","pageMetadata":{"openapi":"openapi-v2.json post /cards/gateways","title":"Create Gateway","description":"Create a new Authorization Gateway Configuration\n","href":"/v2/reference/creategateway"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new Authorization Gateway Configuration\"\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 /cards/gateways","title":"Create Gateway","description":"Create a new Authorization Gateway Configuration\n","href":"/v2/reference/creategateway"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"callbacks":{"gateway_authorization":"50fb5080-1d88-4d7c-b512-567122432f46","preauth_gateway_authorization":"cc55f3fb-ddf0-4ba9-b79e-547206cb2da0"},"description":"Create a new Authorization Gateway Configuration\n","operationId":"createGateway","parameters":["f352abe7-3b24-4d54-9453-8f7163e41a0f"],"requestBody":"b5412f81-2826-40dd-9eca-44b11264e6bb","responses":{"201":"23a948d9-4621-4f72-a8ed-38f33c13285d","400":"dc215b6a-b8b4-4937-827a-f48bb82a1ace","401":"fadddd21-70b1-46b9-bf3c-2189cf56c7e5","403":"6b6cd94a-d298-4b2b-a86e-0589c6cbde04","422":"9079eebe-a7d0-47c8-8d10-9114e6284676","500":"2630c92d-edca-4e6d-a418-34ef2c120095"},"summary":"Create Gateway","tags":["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":"/cards/gateways","baseUrlOptions":["https://api.synctera.com/v2","https://api-sandbox.synctera.com/v2"],"title":"Create Gateway","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f352abe7-3b24-4d54-9453-8f7163e41a0f":{"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":{"properties":{"card_products":{"description":"List of Card Product unique identifiers that will utilize the Gateway","items":{"example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"card_products.items.[INDEX]","typeLabel":"string\u003cuuid>"},"type":"array","isRequired":true,"uniqueKey":"card_products","typeLabel":"string\u003cuuid>[]"},"is_active":{"description":"Current status of the Authorization gateway","type":"boolean","isRequired":true,"uniqueKey":"is_active","typeLabel":"boolean"},"url":{"description":"URL of the Authorization gateway","format":"uri","maxLength":1000,"type":"string","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"custom_headers":{"additionalProperties":{"type":"string","uniqueKey":"custom_headers.additionalProperties","typeLabel":"string"},"description":"These key-value pairs define custom HTTP headers that will be included in every HTTP request to the\ngateway. Note that when updating this field, all key-value pairs will be replaced. They are not merged with\nexisting data.\n","type":"object","uniqueKey":"custom_headers","typeLabel":"object"},"standin":{"properties":{"enabled":{"type":"boolean","uniqueKey":"standin.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"standin","typeLabel":"object"},"type":{"description":"Whether this gateway is invoked after the pending transaction/hold is created (POST_AUTH, the default) or before it exists (PRE_AUTH). PRE_AUTH gateways are not yet supported.\n","enum":["POST_AUTH","PRE_AUTH"],"type":"string","uniqueKey":"type","typeLabel":"enum\u003cstring>"}},"required":["card_products","is_active","url"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"card_products":["7d943c51-e4ff-4e57-9558-08cab6b963c7"],"is_active":true,"url":"\u003cstring>","custom_headers":{},"standin":{"enabled":true}}}},"exampleType":"generated"}},"description":"Create a new Authorization Gateway Configuration","required":true,"exampleType":"generated"},"responses":{"23a948d9-4621-4f72-a8ed-38f33c13285d":{"content":{"application/json":{"schema":{"properties":{"card_products":{"description":"List of Card Product unique identifiers that will utilize the Gateway","items":{"example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"card_products.items.[INDEX]","typeLabel":"string\u003cuuid>"},"type":"array","isRequired":true,"uniqueKey":"card_products","typeLabel":"string\u003cuuid>[]"},"creation_time":{"description":"The timestamp representing when the gateway config request was made","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"creation_time","typeLabel":"string\u003cdate-time>"},"id":{"description":"Gateway ID","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"is_active":{"description":"Current status of the Authorization gateway","type":"boolean","isRequired":true,"uniqueKey":"is_active","typeLabel":"boolean"},"last_updated_time":{"description":"The timestamp representing when the gateway config was last modified at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"last_updated_time","typeLabel":"string\u003cdate-time>"},"tenant":{"description":"The id of the tenant containing the resource.\n","example":"abcdef_ghijkl","type":"string","isRequired":true,"uniqueKey":"tenant","typeLabel":"string"},"url":{"description":"URL of the Authorization gateway","format":"uri","maxLength":1000,"type":"string","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"custom_headers":{"additionalProperties":{"type":"string","uniqueKey":"custom_headers.additionalProperties","typeLabel":"string"},"description":"These key-value pairs define custom HTTP headers that will be included in every HTTP request to the\ngateway. Note that when updating this field, all key-value pairs will be replaced. They are not merged with\nexisting data.\n","type":"object","uniqueKey":"custom_headers","typeLabel":"object"},"standin":{"properties":{"enabled":{"type":"boolean","uniqueKey":"standin.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"standin","typeLabel":"object"},"type":{"description":"Whether this gateway is invoked after the pending transaction/hold is created (POST_AUTH, the default) or before it exists (PRE_AUTH). PRE_AUTH gateways are not yet supported.\n","enum":["POST_AUTH","PRE_AUTH"],"type":"string","uniqueKey":"type","typeLabel":"enum\u003cstring>"}},"required":["card_products","creation_time","id","is_active","last_updated_time","tenant","url"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"card_products":["7d943c51-e4ff-4e57-9558-08cab6b963c7"],"creation_time":"2010-05-06T12:23:34.321Z","id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","is_active":true,"last_updated_time":"2010-05-06T12:23:34.321Z","tenant":"abcdef_ghijkl","url":"\u003cstring>","custom_headers":{},"standin":{"enabled":true},"type":"POST_AUTH"}}},"exampleType":"generated"}},"description":"New Authorization Gateway Configuration created","exampleType":"generated"},"dc215b6a-b8b4-4937-827a-f48bb82a1ace":{"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"},"fadddd21-70b1-46b9-bf3c-2189cf56c7e5":{"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"},"6b6cd94a-d298-4b2b-a86e-0589c6cbde04":{"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"},"9079eebe-a7d0-47c8-8d10-9114e6284676":{"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"},"2630c92d-edca-4e6d-a418-34ef2c120095":{"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"}},"callbacks":[{"callbackName":"gateway_authorization","expression":"{$request.body#/url}","method":"post","resolved":{"operation":{"requestBody":"c3c7a2fe-ac8e-4e3a-82c6-da2098fcc294","responses":{"200":"5dbbe412-8a97-44a9-a9b6-cfff46984400","402":"f22689a8-00d5-4b27-98c6-2cb19112535a"},"method":"post","type":"path"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request sent to gateway for authorization.","required":["account_id","bin","card_format","card_id","customer_id","last_four","merchant","network_fraud","processor","processor_data","settlement_date","subnetwork","type","user","user_transaction_time","amount","balance","transaction_id"],"properties":{"amount":{"type":"object","description":"Amount fields available pre-auth, before the pending transaction/hold exists (excludes approved_amount and total_pending_amount, which are derived from the hold).\n","required":["approved_amount","total_pending_amount","amount","currency","currency_conversion"],"properties":{"amount":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"amount.amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","isRequired":true,"uniqueKey":"amount.currency","typeLabel":"string"},"currency_conversion":{"properties":{"conversion_rate":{"format":"float","type":"number","uniqueKey":"amount.currency_conversion.conversion_rate","typeLabel":"number\u003cfloat>"},"dynamic_currency_conversion":{"type":"boolean","uniqueKey":"amount.currency_conversion.dynamic_currency_conversion","typeLabel":"boolean"},"original_amount":{"format":"int64","type":"integer","uniqueKey":"amount.currency_conversion.original_amount","typeLabel":"integer\u003cint64>"},"original_currency_code":{"type":"string","uniqueKey":"amount.currency_conversion.original_currency_code","typeLabel":"string"},"original_currency_code_alpha":{"description":"ISO 4217 Alpha-3 currency code","example":"USD","maxLength":3,"minLength":3,"type":"string","uniqueKey":"amount.currency_conversion.original_currency_code_alpha","typeLabel":"string"},"raw_original_amount":{"format":"float","type":"number","uniqueKey":"amount.currency_conversion.raw_original_amount","typeLabel":"number\u003cfloat>"},"settlement_currency_conversion":{"properties":{"amount":{"format":"int64","type":"integer","uniqueKey":"amount.currency_conversion.settlement_currency_conversion.amount","typeLabel":"integer\u003cint64>"},"conversion_rate":{"format":"float","type":"number","uniqueKey":"amount.currency_conversion.settlement_currency_conversion.conversion_rate","typeLabel":"number\u003cfloat>"},"currency_code":{"type":"string","uniqueKey":"amount.currency_conversion.settlement_currency_conversion.currency_code","typeLabel":"string"},"currency_code_alpha":{"description":"ISO 4217 Alpha-3 currency code","example":"USD","maxLength":3,"minLength":3,"type":"string","uniqueKey":"amount.currency_conversion.settlement_currency_conversion.currency_code_alpha","typeLabel":"string"}},"type":"object","uniqueKey":"amount.currency_conversion.settlement_currency_conversion","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"amount.currency_conversion","typeLabel":"object"},"approved_amount":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"amount.approved_amount","typeLabel":"integer\u003cint64>"},"total_pending_amount":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"amount.total_pending_amount","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"amount","typeLabel":"object"},"balance":{"properties":{"available_balance":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"balance.available_balance","typeLabel":"integer\u003cint64>"}},"required":["available_balance"],"type":"object","isRequired":true,"uniqueKey":"balance","typeLabel":"object"},"transaction_id":{"description":"Unique identifier of the transaction.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"transaction_id","typeLabel":"string\u003cuuid>"},"account_id":{"description":"Unique identifier of the account.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"account_id","typeLabel":"string\u003cuuid>"},"bin":{"properties":{"country_code":{"type":"string","isRequired":true,"uniqueKey":"bin.country_code","typeLabel":"string"},"id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"bin.id","typeLabel":"string\u003cuuid>"}},"required":["country_code","id"],"type":"object","isRequired":true,"uniqueKey":"bin","typeLabel":"object"},"card_format":{"enum":["PHYSICAL","VIRTUAL"],"type":"string","isRequired":true,"uniqueKey":"card_format","typeLabel":"enum\u003cstring>"},"card_id":{"description":"Unique identifier of the card.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"card_id","typeLabel":"string\u003cuuid>"},"customer_id":{"description":"Unique identifier of the customer.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string\u003cuuid>"},"last_four":{"description":"Last four digits of the card PAN.","example":"1234","type":"string","isRequired":true,"uniqueKey":"last_four","typeLabel":"string"},"merchant":{"properties":{"city":{"type":"string","isRequired":true,"uniqueKey":"merchant.city","typeLabel":"string"},"country_code":{"type":"string","isRequired":true,"uniqueKey":"merchant.country_code","typeLabel":"string"},"mcc":{"type":"string","isRequired":true,"uniqueKey":"merchant.mcc","typeLabel":"string"},"mid":{"type":"string","isRequired":true,"uniqueKey":"merchant.mid","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"merchant.name","typeLabel":"string"},"payment_facilitator_id":{"type":"string","isRequired":true,"uniqueKey":"merchant.payment_facilitator_id","typeLabel":"string"},"postal_code":{"type":"string","isRequired":true,"uniqueKey":"merchant.postal_code","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"merchant.state","typeLabel":"string"},"sub_merchant_id":{"type":"string","isRequired":true,"uniqueKey":"merchant.sub_merchant_id","typeLabel":"string"}},"required":["city","country_code","mcc","mid","name","payment_facilitator_id","postal_code","state","sub_merchant_id"],"type":"object","isRequired":true,"uniqueKey":"merchant","typeLabel":"object"},"network_fraud":{"properties":{"transaction_risk_score":{"format":"int32","type":"integer","uniqueKey":"network_fraud.transaction_risk_score","typeLabel":"integer\u003cint32>"}},"type":"object","isRequired":true,"uniqueKey":"network_fraud","typeLabel":"object"},"processor":{"enum":["EPISODE_SIX","MARQETA"],"type":"string","isRequired":true,"uniqueKey":"processor","typeLabel":"enum\u003cstring>"},"processor_data":{"description":"An unstructured JSON blob containing raw transaction data from the processor.","type":"object","isRequired":true,"uniqueKey":"processor_data","typeLabel":"object"},"settlement_date":{"example":"2010-05-06T12:23:34.321Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"settlement_date","typeLabel":"string\u003cdate-time>"},"subnetwork":{"type":"string","isRequired":true,"uniqueKey":"subnetwork","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"user":{"properties":{"metadata":{"additionalProperties":{"type":"string","uniqueKey":"user.metadata.additionalProperties","typeLabel":"string"},"type":"object","uniqueKey":"user.metadata","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"user","typeLabel":"object"},"user_transaction_time":{"description":"The time when the transaction occurred.","example":"2010-05-06T12:23:34.321Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"user_transaction_time","typeLabel":"string\u003cdate-time>"},"acquirer_reference_id":{"type":"string","uniqueKey":"acquirer_reference_id","typeLabel":"string"},"banknet_reference_id":{"type":"string","uniqueKey":"banknet_reference_id","typeLabel":"string"},"card_category":{"type":"string","uniqueKey":"card_category","typeLabel":"string"},"dc_sign":{"type":"string","uniqueKey":"dc_sign","typeLabel":"string"},"digital_wallet_token_id":{"description":"Unique identifier of the digital wallet token.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"digital_wallet_token_id","typeLabel":"string\u003cuuid>"},"digital_wallet_token_reference_id":{"type":"string","uniqueKey":"digital_wallet_token_reference_id","typeLabel":"string"},"enhanced_transaction":{"properties":{"category":{"type":"string","isRequired":true,"uniqueKey":"enhanced_transaction.category","typeLabel":"string"},"enhanced_description":{"type":"string","isRequired":true,"uniqueKey":"enhanced_transaction.enhanced_description","typeLabel":"string"},"enhanced_raw":{"items":{"properties":{"amount":{"oneOf":[{"format":"float","type":"number","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].amount.oneOf.0","typeLabel":"number\u003cfloat>"},{"format":"float","type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].amount","typeLabel":"number\u003cfloat> | null"},"categorized_by":{"oneOf":[{"format":"int32","type":"integer","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].categorized_by.oneOf.0","typeLabel":"integer\u003cint32>"},{"format":"int32","type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].categorized_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].categorized_by","typeLabel":"integer\u003cint32> | null"},"category":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category","typeLabel":"string | null"},"category_guid":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category_guid.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category_guid.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category_guid","typeLabel":"string | null"},"described_by":{"oneOf":[{"format":"int32","type":"integer","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].described_by.oneOf.0","typeLabel":"integer\u003cint32>"},{"format":"int32","type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].described_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].described_by","typeLabel":"integer\u003cint32> | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].description","typeLabel":"string | null"},"extended_transaction_type":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].extended_transaction_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].extended_transaction_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].extended_transaction_type","typeLabel":"string | null"},"id":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].id","typeLabel":"string | null"},"is_bill_pay":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_bill_pay.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_bill_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_bill_pay","typeLabel":"boolean | null"},"is_direct_deposit":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_direct_deposit.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_direct_deposit.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_direct_deposit","typeLabel":"boolean | null"},"is_expense":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_expense.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_expense.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_expense","typeLabel":"boolean | null"},"is_fee":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_fee.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_fee","typeLabel":"boolean | null"},"is_income":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_income.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_income.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_income","typeLabel":"boolean | null"},"is_international":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_international.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_international.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_international","typeLabel":"boolean | null"},"is_overdraft_fee":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_overdraft_fee.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_overdraft_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_overdraft_fee","typeLabel":"boolean | null"},"is_payroll_advance":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_payroll_advance.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_payroll_advance.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_payroll_advance","typeLabel":"boolean | null"},"is_subscription":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_subscription.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_subscription.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_subscription","typeLabel":"boolean | null"},"memo":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].memo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].memo.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].memo","typeLabel":"string | null"},"merchant_category_code":{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_category_code","typeLabel":"string"},"merchant_guid":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_guid.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_guid.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_guid","typeLabel":"string | null"},"merchant_location_guid":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_location_guid.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_location_guid.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_location_guid","typeLabel":"string | null"},"original_description":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].original_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].original_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].original_description","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].type","typeLabel":"string | null"}},"type":"object","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"enhanced_transaction.enhanced_raw","typeLabel":"object[]"}},"required":["category","enhanced_description","enhanced_raw"],"type":"object","uniqueKey":"enhanced_transaction","typeLabel":"object"},"fees":{"properties":{"acquirer_user_fee":{"format":"int64","type":"integer","uniqueKey":"fees.acquirer_user_fee","typeLabel":"integer\u003cint64>"},"cross_border_issuer_fee":{"format":"int64","type":"integer","uniqueKey":"fees.cross_border_issuer_fee","typeLabel":"integer\u003cint64>"},"currency_conversion_issuer_fee":{"format":"int64","type":"integer","uniqueKey":"fees.currency_conversion_issuer_fee","typeLabel":"integer\u003cint64>"},"currency_conversion_user_fee":{"format":"int64","type":"integer","uniqueKey":"fees.currency_conversion_user_fee","typeLabel":"integer\u003cint64>"},"interchange_fee":{"format":"int64","type":"integer","uniqueKey":"fees.interchange_fee","typeLabel":"integer\u003cint64>"},"issuer_fee":{"format":"int64","type":"integer","uniqueKey":"fees.issuer_fee","typeLabel":"integer\u003cint64>"},"network_fee":{"format":"int64","type":"integer","uniqueKey":"fees.network_fee","typeLabel":"integer\u003cint64>"},"pindebit_user_fee":{"format":"int64","type":"integer","uniqueKey":"fees.pindebit_user_fee","typeLabel":"integer\u003cint64>"}},"type":"object","uniqueKey":"fees","typeLabel":"object"},"id":{"description":"Unique identifier assigned to each individual request.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"is_surcharge_free":{"description":"Indicates if the transaction is surcharge free.","type":"boolean","uniqueKey":"is_surcharge_free","typeLabel":"boolean"},"network":{"type":"string","uniqueKey":"network","typeLabel":"string"},"payment_channel":{"type":"string","uniqueKey":"payment_channel","typeLabel":"string"},"pos":{"properties":{"cardholder_verification_method":{"type":"string","uniqueKey":"pos.cardholder_verification_method","typeLabel":"string"},"cvv_presence":{"type":"string","uniqueKey":"pos.cvv_presence","typeLabel":"string"},"pan_entry_mode":{"type":"string","uniqueKey":"pos.pan_entry_mode","typeLabel":"string"},"pin_entry_mode":{"type":"string","uniqueKey":"pos.pin_entry_mode","typeLabel":"string"},"pin_present":{"type":"boolean","uniqueKey":"pos.pin_present","typeLabel":"boolean"},"terminal_capability":{"type":"string","uniqueKey":"pos.terminal_capability","typeLabel":"string"},"terminal_id":{"type":"string","uniqueKey":"pos.terminal_id","typeLabel":"string"}},"type":"object","uniqueKey":"pos","typeLabel":"object"},"three_ds_authentication_status":{"enum":["ACQUIRER_EXEMPT","AUTHENTICATED","EXEMPT","NOT_AUTHENTICATED"],"type":"string","uniqueKey":"three_ds_authentication_status","typeLabel":"enum\u003cstring>"},"verification":{"properties":{"online_security_transaction_code":{"type":"string","uniqueKey":"verification.online_security_transaction_code","typeLabel":"string"}},"type":"object","uniqueKey":"verification","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":{"amount":123,"currency":"\u003cstring>","currency_conversion":{"conversion_rate":123,"dynamic_currency_conversion":true,"original_amount":123,"original_currency_code":"\u003cstring>","original_currency_code_alpha":"USD","raw_original_amount":123,"settlement_currency_conversion":{"amount":123,"conversion_rate":123,"currency_code":"\u003cstring>","currency_code_alpha":"USD"}},"approved_amount":123,"total_pending_amount":123},"balance":{"available_balance":123},"transaction_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","account_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","bin":{"country_code":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"card_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","customer_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","last_four":"1234","merchant":{"city":"\u003cstring>","country_code":"\u003cstring>","mcc":"\u003cstring>","mid":"\u003cstring>","name":"\u003cstring>","payment_facilitator_id":"\u003cstring>","postal_code":"\u003cstring>","state":"\u003cstring>","sub_merchant_id":"\u003cstring>"},"network_fraud":{"transaction_risk_score":123},"processor_data":{},"settlement_date":"2010-05-06T12:23:34.321Z","subnetwork":"\u003cstring>","type":"\u003cstring>","user":{"metadata":{}},"user_transaction_time":"2010-05-06T12:23:34.321Z","acquirer_reference_id":"\u003cstring>","banknet_reference_id":"\u003cstring>","card_category":"\u003cstring>","dc_sign":"\u003cstring>","digital_wallet_token_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","digital_wallet_token_reference_id":"\u003cstring>","fees":{"acquirer_user_fee":123,"cross_border_issuer_fee":123,"currency_conversion_issuer_fee":123,"currency_conversion_user_fee":123,"interchange_fee":123,"issuer_fee":123,"network_fee":123,"pindebit_user_fee":123},"id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","is_surcharge_free":true,"network":"\u003cstring>","payment_channel":"\u003cstring>","pos":{"cardholder_verification_method":"\u003cstring>","cvv_presence":"\u003cstring>","pan_entry_mode":"\u003cstring>","pin_entry_mode":"\u003cstring>","pin_present":true,"terminal_capability":"\u003cstring>","terminal_id":"\u003cstring>"},"verification":{"online_security_transaction_code":"\u003cstring>"}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"5dbbe412-8a97-44a9-a9b6-cfff46984400":{"description":"Approve the funding request.\n","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"f22689a8-00d5-4b27-98c6-2cb19112535a":{"description":"Decline the funding request.\n*Note: while HTTP Code 402 is conventional, any code other than 200 will also be interpreted as a decline.\n","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{}}}},{"callbackName":"preauth_gateway_authorization","expression":"{$request.body#/url}","method":"post","resolved":{"operation":{"requestBody":"efa6b647-4b37-462f-9ee9-22650f44c395","responses":{"200":"3bfa3432-c378-4376-9138-9cf0d8039357","402":"f3b9015f-f124-4adc-b21c-047e762f1b87"},"method":"post","type":"path"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request sent to gateway for pre-authorization, before the pending transaction/hold exists. Contains the same fields as gateway_authorization except for the ones that depend on the hold (transaction_id, balance, and the hold-derived amount fields).\n","required":["account_id","bin","card_format","card_id","customer_id","last_four","merchant","network_fraud","processor","processor_data","settlement_date","subnetwork","type","user","user_transaction_time","amount"],"properties":{"amount":{"description":"Amount fields available pre-auth, before the pending transaction/hold exists (excludes approved_amount and total_pending_amount, which are derived from the hold).\n","properties":{"amount":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"amount.amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","isRequired":true,"uniqueKey":"amount.currency","typeLabel":"string"},"currency_conversion":{"properties":{"conversion_rate":{"format":"float","type":"number","uniqueKey":"amount.currency_conversion.conversion_rate","typeLabel":"number\u003cfloat>"},"dynamic_currency_conversion":{"type":"boolean","uniqueKey":"amount.currency_conversion.dynamic_currency_conversion","typeLabel":"boolean"},"original_amount":{"format":"int64","type":"integer","uniqueKey":"amount.currency_conversion.original_amount","typeLabel":"integer\u003cint64>"},"original_currency_code":{"type":"string","uniqueKey":"amount.currency_conversion.original_currency_code","typeLabel":"string"},"original_currency_code_alpha":{"description":"ISO 4217 Alpha-3 currency code","example":"USD","maxLength":3,"minLength":3,"type":"string","uniqueKey":"amount.currency_conversion.original_currency_code_alpha","typeLabel":"string"},"raw_original_amount":{"format":"float","type":"number","uniqueKey":"amount.currency_conversion.raw_original_amount","typeLabel":"number\u003cfloat>"},"settlement_currency_conversion":{"properties":{"amount":{"format":"int64","type":"integer","uniqueKey":"amount.currency_conversion.settlement_currency_conversion.amount","typeLabel":"integer\u003cint64>"},"conversion_rate":{"format":"float","type":"number","uniqueKey":"amount.currency_conversion.settlement_currency_conversion.conversion_rate","typeLabel":"number\u003cfloat>"},"currency_code":{"type":"string","uniqueKey":"amount.currency_conversion.settlement_currency_conversion.currency_code","typeLabel":"string"},"currency_code_alpha":{"description":"ISO 4217 Alpha-3 currency code","example":"USD","maxLength":3,"minLength":3,"type":"string","uniqueKey":"amount.currency_conversion.settlement_currency_conversion.currency_code_alpha","typeLabel":"string"}},"type":"object","uniqueKey":"amount.currency_conversion.settlement_currency_conversion","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"amount.currency_conversion","typeLabel":"object"}},"required":["amount","currency","currency_conversion"],"type":"object","isRequired":true,"uniqueKey":"amount","typeLabel":"object"},"account_id":{"description":"Unique identifier of the account.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"account_id","typeLabel":"string\u003cuuid>"},"bin":{"properties":{"country_code":{"type":"string","isRequired":true,"uniqueKey":"bin.country_code","typeLabel":"string"},"id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"bin.id","typeLabel":"string\u003cuuid>"}},"required":["country_code","id"],"type":"object","isRequired":true,"uniqueKey":"bin","typeLabel":"object"},"card_format":{"enum":["PHYSICAL","VIRTUAL"],"type":"string","isRequired":true,"uniqueKey":"card_format","typeLabel":"enum\u003cstring>"},"card_id":{"description":"Unique identifier of the card.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"card_id","typeLabel":"string\u003cuuid>"},"customer_id":{"description":"Unique identifier of the customer.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string\u003cuuid>"},"last_four":{"description":"Last four digits of the card PAN.","example":"1234","type":"string","isRequired":true,"uniqueKey":"last_four","typeLabel":"string"},"merchant":{"properties":{"city":{"type":"string","isRequired":true,"uniqueKey":"merchant.city","typeLabel":"string"},"country_code":{"type":"string","isRequired":true,"uniqueKey":"merchant.country_code","typeLabel":"string"},"mcc":{"type":"string","isRequired":true,"uniqueKey":"merchant.mcc","typeLabel":"string"},"mid":{"type":"string","isRequired":true,"uniqueKey":"merchant.mid","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"merchant.name","typeLabel":"string"},"payment_facilitator_id":{"type":"string","isRequired":true,"uniqueKey":"merchant.payment_facilitator_id","typeLabel":"string"},"postal_code":{"type":"string","isRequired":true,"uniqueKey":"merchant.postal_code","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"merchant.state","typeLabel":"string"},"sub_merchant_id":{"type":"string","isRequired":true,"uniqueKey":"merchant.sub_merchant_id","typeLabel":"string"}},"required":["city","country_code","mcc","mid","name","payment_facilitator_id","postal_code","state","sub_merchant_id"],"type":"object","isRequired":true,"uniqueKey":"merchant","typeLabel":"object"},"network_fraud":{"properties":{"transaction_risk_score":{"format":"int32","type":"integer","uniqueKey":"network_fraud.transaction_risk_score","typeLabel":"integer\u003cint32>"}},"type":"object","isRequired":true,"uniqueKey":"network_fraud","typeLabel":"object"},"processor":{"enum":["EPISODE_SIX","MARQETA"],"type":"string","isRequired":true,"uniqueKey":"processor","typeLabel":"enum\u003cstring>"},"processor_data":{"description":"An unstructured JSON blob containing raw transaction data from the processor.","type":"object","isRequired":true,"uniqueKey":"processor_data","typeLabel":"object"},"settlement_date":{"example":"2010-05-06T12:23:34.321Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"settlement_date","typeLabel":"string\u003cdate-time>"},"subnetwork":{"type":"string","isRequired":true,"uniqueKey":"subnetwork","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"user":{"properties":{"metadata":{"additionalProperties":{"type":"string","uniqueKey":"user.metadata.additionalProperties","typeLabel":"string"},"type":"object","uniqueKey":"user.metadata","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"user","typeLabel":"object"},"user_transaction_time":{"description":"The time when the transaction occurred.","example":"2010-05-06T12:23:34.321Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"user_transaction_time","typeLabel":"string\u003cdate-time>"},"acquirer_reference_id":{"type":"string","uniqueKey":"acquirer_reference_id","typeLabel":"string"},"banknet_reference_id":{"type":"string","uniqueKey":"banknet_reference_id","typeLabel":"string"},"card_category":{"type":"string","uniqueKey":"card_category","typeLabel":"string"},"dc_sign":{"type":"string","uniqueKey":"dc_sign","typeLabel":"string"},"digital_wallet_token_id":{"description":"Unique identifier of the digital wallet token.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"digital_wallet_token_id","typeLabel":"string\u003cuuid>"},"digital_wallet_token_reference_id":{"type":"string","uniqueKey":"digital_wallet_token_reference_id","typeLabel":"string"},"enhanced_transaction":{"properties":{"category":{"type":"string","isRequired":true,"uniqueKey":"enhanced_transaction.category","typeLabel":"string"},"enhanced_description":{"type":"string","isRequired":true,"uniqueKey":"enhanced_transaction.enhanced_description","typeLabel":"string"},"enhanced_raw":{"items":{"properties":{"amount":{"oneOf":[{"format":"float","type":"number","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].amount.oneOf.0","typeLabel":"number\u003cfloat>"},{"format":"float","type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].amount","typeLabel":"number\u003cfloat> | null"},"categorized_by":{"oneOf":[{"format":"int32","type":"integer","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].categorized_by.oneOf.0","typeLabel":"integer\u003cint32>"},{"format":"int32","type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].categorized_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].categorized_by","typeLabel":"integer\u003cint32> | null"},"category":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category","typeLabel":"string | null"},"category_guid":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category_guid.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category_guid.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].category_guid","typeLabel":"string | null"},"described_by":{"oneOf":[{"format":"int32","type":"integer","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].described_by.oneOf.0","typeLabel":"integer\u003cint32>"},{"format":"int32","type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].described_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].described_by","typeLabel":"integer\u003cint32> | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].description","typeLabel":"string | null"},"extended_transaction_type":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].extended_transaction_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].extended_transaction_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].extended_transaction_type","typeLabel":"string | null"},"id":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].id","typeLabel":"string | null"},"is_bill_pay":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_bill_pay.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_bill_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_bill_pay","typeLabel":"boolean | null"},"is_direct_deposit":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_direct_deposit.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_direct_deposit.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_direct_deposit","typeLabel":"boolean | null"},"is_expense":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_expense.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_expense.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_expense","typeLabel":"boolean | null"},"is_fee":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_fee.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_fee","typeLabel":"boolean | null"},"is_income":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_income.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_income.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_income","typeLabel":"boolean | null"},"is_international":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_international.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_international.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_international","typeLabel":"boolean | null"},"is_overdraft_fee":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_overdraft_fee.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_overdraft_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_overdraft_fee","typeLabel":"boolean | null"},"is_payroll_advance":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_payroll_advance.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_payroll_advance.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_payroll_advance","typeLabel":"boolean | null"},"is_subscription":{"oneOf":[{"type":"boolean","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_subscription.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_subscription.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].is_subscription","typeLabel":"boolean | null"},"memo":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].memo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].memo.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].memo","typeLabel":"string | null"},"merchant_category_code":{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_category_code","typeLabel":"string"},"merchant_guid":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_guid.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_guid.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_guid","typeLabel":"string | null"},"merchant_location_guid":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_location_guid.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_location_guid.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].merchant_location_guid","typeLabel":"string | null"},"original_description":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].original_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].original_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].original_description","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX].type","typeLabel":"string | null"}},"type":"object","uniqueKey":"enhanced_transaction.enhanced_raw.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"enhanced_transaction.enhanced_raw","typeLabel":"object[]"}},"required":["category","enhanced_description","enhanced_raw"],"type":"object","uniqueKey":"enhanced_transaction","typeLabel":"object"},"fees":{"properties":{"acquirer_user_fee":{"format":"int64","type":"integer","uniqueKey":"fees.acquirer_user_fee","typeLabel":"integer\u003cint64>"},"cross_border_issuer_fee":{"format":"int64","type":"integer","uniqueKey":"fees.cross_border_issuer_fee","typeLabel":"integer\u003cint64>"},"currency_conversion_issuer_fee":{"format":"int64","type":"integer","uniqueKey":"fees.currency_conversion_issuer_fee","typeLabel":"integer\u003cint64>"},"currency_conversion_user_fee":{"format":"int64","type":"integer","uniqueKey":"fees.currency_conversion_user_fee","typeLabel":"integer\u003cint64>"},"interchange_fee":{"format":"int64","type":"integer","uniqueKey":"fees.interchange_fee","typeLabel":"integer\u003cint64>"},"issuer_fee":{"format":"int64","type":"integer","uniqueKey":"fees.issuer_fee","typeLabel":"integer\u003cint64>"},"network_fee":{"format":"int64","type":"integer","uniqueKey":"fees.network_fee","typeLabel":"integer\u003cint64>"},"pindebit_user_fee":{"format":"int64","type":"integer","uniqueKey":"fees.pindebit_user_fee","typeLabel":"integer\u003cint64>"}},"type":"object","uniqueKey":"fees","typeLabel":"object"},"id":{"description":"Unique identifier assigned to each individual request.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"is_surcharge_free":{"description":"Indicates if the transaction is surcharge free.","type":"boolean","uniqueKey":"is_surcharge_free","typeLabel":"boolean"},"network":{"type":"string","uniqueKey":"network","typeLabel":"string"},"payment_channel":{"type":"string","uniqueKey":"payment_channel","typeLabel":"string"},"pos":{"properties":{"cardholder_verification_method":{"type":"string","uniqueKey":"pos.cardholder_verification_method","typeLabel":"string"},"cvv_presence":{"type":"string","uniqueKey":"pos.cvv_presence","typeLabel":"string"},"pan_entry_mode":{"type":"string","uniqueKey":"pos.pan_entry_mode","typeLabel":"string"},"pin_entry_mode":{"type":"string","uniqueKey":"pos.pin_entry_mode","typeLabel":"string"},"pin_present":{"type":"boolean","uniqueKey":"pos.pin_present","typeLabel":"boolean"},"terminal_capability":{"type":"string","uniqueKey":"pos.terminal_capability","typeLabel":"string"},"terminal_id":{"type":"string","uniqueKey":"pos.terminal_id","typeLabel":"string"}},"type":"object","uniqueKey":"pos","typeLabel":"object"},"three_ds_authentication_status":{"enum":["ACQUIRER_EXEMPT","AUTHENTICATED","EXEMPT","NOT_AUTHENTICATED"],"type":"string","uniqueKey":"three_ds_authentication_status","typeLabel":"enum\u003cstring>"},"verification":{"properties":{"online_security_transaction_code":{"type":"string","uniqueKey":"verification.online_security_transaction_code","typeLabel":"string"}},"type":"object","uniqueKey":"verification","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":{"amount":123,"currency":"\u003cstring>","currency_conversion":{"conversion_rate":123,"dynamic_currency_conversion":true,"original_amount":123,"original_currency_code":"\u003cstring>","original_currency_code_alpha":"USD","raw_original_amount":123,"settlement_currency_conversion":{"amount":123,"conversion_rate":123,"currency_code":"\u003cstring>","currency_code_alpha":"USD"}}},"account_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","bin":{"country_code":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"card_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","customer_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","last_four":"1234","merchant":{"city":"\u003cstring>","country_code":"\u003cstring>","mcc":"\u003cstring>","mid":"\u003cstring>","name":"\u003cstring>","payment_facilitator_id":"\u003cstring>","postal_code":"\u003cstring>","state":"\u003cstring>","sub_merchant_id":"\u003cstring>"},"network_fraud":{"transaction_risk_score":123},"processor_data":{},"settlement_date":"2010-05-06T12:23:34.321Z","subnetwork":"\u003cstring>","type":"\u003cstring>","user":{"metadata":{}},"user_transaction_time":"2010-05-06T12:23:34.321Z","acquirer_reference_id":"\u003cstring>","banknet_reference_id":"\u003cstring>","card_category":"\u003cstring>","dc_sign":"\u003cstring>","digital_wallet_token_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","digital_wallet_token_reference_id":"\u003cstring>","fees":{"acquirer_user_fee":123,"cross_border_issuer_fee":123,"currency_conversion_issuer_fee":123,"currency_conversion_user_fee":123,"interchange_fee":123,"issuer_fee":123,"network_fee":123,"pindebit_user_fee":123},"id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","is_surcharge_free":true,"network":"\u003cstring>","payment_channel":"\u003cstring>","pos":{"cardholder_verification_method":"\u003cstring>","cvv_presence":"\u003cstring>","pan_entry_mode":"\u003cstring>","pin_entry_mode":"\u003cstring>","pin_present":true,"terminal_capability":"\u003cstring>","terminal_id":"\u003cstring>"},"verification":{"online_security_transaction_code":"\u003cstring>"}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"3bfa3432-c378-4376-9138-9cf0d8039357":{"content":{"application/json":{"schema":{"description":"Response body for a 200 (approve) pre-authorization response. routing_config is only honored when the transaction's account is a router Zero Balance Account — it is ignored otherwise.\n","properties":{"routing_config":{"properties":{"account_sequence":{"description":"Ordered account funding sequence, excluding the router Zero Balance Account itself: the Zero Balance Account always funds first implicitly and must not be included here. Each entry must be a member of the Zero Balance Account's routable_account_ids. For example, to fund the Zero Balance Account, then R1, then R2, then DDA, return [R1, R2, DDA]. Only usable when the transaction's account is a router Zero Balance Account.\n","items":{"properties":{"account_id":{"example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"routing_config.account_sequence.items.[INDEX].account_id","typeLabel":"string\u003cuuid>"}},"required":["account_id"],"type":"object","uniqueKey":"routing_config.account_sequence.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"routing_config.account_sequence","typeLabel":"object[]"}},"required":["account_sequence"],"type":"object","uniqueKey":"routing_config","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"routing_config":{"account_sequence":[{"account_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7"}]}}}},"exampleType":"generated"}},"description":"Approve the transaction. The response body may optionally include a routing_config\nto override the account funding sequence.\n","exampleType":"generated"},"f3b9015f-f124-4adc-b21c-047e762f1b87":{"content":{"application/json":{"schema":{"description":"Response body for a non-200 (decline) pre-authorization response.","properties":{"decline_reason":{"description":"Reason the fintech's pre-authorization gateway declined the transaction.","enum":["GATEWAY_INSUFFICIENT_FUNDS","GATEWAY_SUSPECTED_FRAUD","GATEWAY_TRANSACTION_NOT_PERMITTED"],"type":"string","uniqueKey":"decline_reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"decline_reason":"GATEWAY_INSUFFICIENT_FUNDS"}}},"exampleType":"generated"}},"description":"Decline the transaction.\n*Note: while HTTP Code 402 is conventional, any code other than 200 will also be interpreted as a decline.\n","exampleType":"generated"}},"security":{}}}}],"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 Gateway - Synctera","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/reference/creategateway","matchLevel":0},"v0":{"href":"/reference/creategateway","matchLevel":1},"v1":{"href":"/v1/reference/creategateway","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T21:33:35.492Z","originalFileLocation":"v2/reference/creategateway.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=\"Create a new Authorization Gateway Configuration\">\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 Gateway - Synctera\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new Authorization Gateway Configuration\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Synctera\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.synctera.com/v2/reference/creategateway\">\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=Cards\u0026amp;title=Create+Gateway\u0026amp;description=Create+a+new+Authorization+Gateway+Configuration%0A\u0026amp;theme=7eeaff4eadcf64de30804626\u0026amp;signature=b44c9bbcd8210d1a43aa0ba2cfe811814d1f1b9de2a1f9ea8d15c1ae43891827\">\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 Gateway - Synctera\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new Authorization Gateway Configuration\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://synctera.mintlify.site/_mintlify/api/og/v2?division=Cards\u0026amp;title=Create+Gateway\u0026amp;description=Create+a+new+Authorization+Gateway+Configuration%0A\u0026amp;theme=7eeaff4eadcf64de30804626\u0026amp;signature=b44c9bbcd8210d1a43aa0ba2cfe811814d1f1b9de2a1f9ea8d15c1ae43891827\">\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/creategateway\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/reference/creategateway.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/creategateway#webpage\",\"url\":\"https://docs.synctera.com/v2/reference/creategateway\",\"name\":\"Create Gateway\",\"description\":\"Create a new Authorization Gateway Configuration\",\"dateModified\":\"2026-01-27T21:33:35.492Z\",\"isPartOf\":{\"@id\":\"https://docs.synctera.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.synctera.com/v2/reference/creategateway#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.synctera.com/v2/reference/creategateway#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cards\",\"item\":\"https://docs.synctera.com/v2/reference/createapplepaycsr\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cards\",\"item\":\"https://docs.synctera.com/v2/reference/listcards\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Gateway\",\"item\":\"https://docs.synctera.com/v2/reference/creategateway\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.synctera.com/v2/reference/creategateway#apireference\",\"headline\":\"Create Gateway\",\"name\":\"Create Gateway\",\"description\":\"Create a new Authorization Gateway Configuration\",\"url\":\"https://docs.synctera.com/v2/reference/creategateway\",\"mainEntityOfPage\":{\"@id\":\"https://docs.synctera.com/v2/reference/creategateway#webpage\"},\"dateModified\":\"2026-01-27T21:33:35.492Z\",\"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","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","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","description":"List of gateways matching query parameters\n","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","description":"Get the details of an Authorization Gateway that has been configured\n","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/creategateway"}]},{"version":"v1","pages":[{"title":"v1","href":"/v1/reference/creategateway"}]}]},"basePath":"","title":"Create Gateway - 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"]}