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.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6aea30b32e2e76a4cbf6a7b5","collectionId":"dffb1d53-96ae-4cee-8de9-061f61a50480","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea30b32e2e76a4cbf6a7b5"},"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.4076","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":[],"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/activatecard","slug":"/v2/reference/activatecard","pageMetadata":{"openapi":"openapi-v2.json post /cards/activate","title":"Activate a card","description":"Activate a card\n","href":"/v2/reference/activatecard"},"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: \"Activate a card\"\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/activate","title":"Activate a card","description":"Activate a card\n","href":"/v2/reference/activatecard"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Activate a card\n","operationId":"activateCard","parameters":["ead99ae5-d3e9-4606-aa25-979de0a11045"],"requestBody":"c0e8cef9-9f4f-4106-b7ea-38633337e1a0","responses":{"200":"5a052a89-9999-49f1-97bb-c82e1065944f","400":"b2059482-a521-4b16-b700-1181922f4d5d","401":"9dcb8117-8f4a-44e7-801a-3cdff62948b1","403":"e3dfe994-e846-478f-b781-5130ae3955b1","422":"e53ed0d7-6510-4b0e-b0fc-97775100a2d3","500":"c14c86a1-12f3-4848-8ce0-18a0649879b3"},"summary":"Activate a card","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/activate","baseUrlOptions":["https://api.synctera.com/v2","https://api-sandbox.synctera.com/v2"],"title":"Activate a card","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ead99ae5-d3e9-4606-aa25-979de0a11045":{"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":{"activation_code":{"description":"An activation code provided with the card required to prove possession of the card","type":"string","isRequired":true,"uniqueKey":"activation_code","typeLabel":"string"},"customer_id":{"description":"The ID of the customer for which card is being activated","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string\u003cuuid>"}},"required":["activation_code","customer_id"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"activation_code":"\u003cstring>","customer_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7"}}},"exampleType":"generated"}},"description":"Card activation code","required":true,"exampleType":"generated"},"responses":{"5a052a89-9999-49f1-97bb-c82e1065944f":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Credit Card","description":"A card that can spend against a credit account","required":["card_details","tenant","type"],"properties":{"card_details":{"oneOf":[{"type":"object","title":"Physical Card","description":"A card that can spend against a credit account","required":["account_id","card_brand","card_product_id","creation_time","emboss_name","form","id","physical_card_format","shipping","card_fulfillment_status","card_status","status_reason"],"properties":{"account_id":{"description":"The ID of the account to which the card will be linked","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.account_id","typeLabel":"string\u003cuuid>"},"card_product_id":{"description":"The card product to which the card is attached","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.card_product_id","typeLabel":"string\u003cuuid>"},"creation_time":{"description":"The timestamp representing when the card issuance request was made","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.creation_time","typeLabel":"string\u003cdate-time>"},"emboss_name":{"description":"The customer details to emboss on the card - Defaults to customer first and last name. Is limited to 21 characters. Valid characters are A-Z, a-z, 0-9, space ( ), period (.), comma (,), forward slash (/), hyphen (-), ampersand (\u0026), single quote (').","properties":{"line_1":{"description":"line 1","example":"Jane Smith","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.emboss_name.line_1","typeLabel":"string"},"line_2":{"description":"line 2","example":"Acme Inc.","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.emboss_name.line_2","typeLabel":"string"}},"required":["line_1"],"type":"object","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.emboss_name","typeLabel":"object"},"id":{"description":"Card ID","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.id","typeLabel":"string\u003cuuid>"},"form":{"description":"PHYSICAL or VIRTUAL.","enum":["PHYSICAL","VIRTUAL"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.form","typeLabel":"enum\u003cstring>"},"shipping":{"description":"Details about the shipping method. If supplied this will override the default shipping address of the customer or account.","properties":{"address":{"type":"object","description":"The address to which the card will be shipped - Defaults to account shipping address if none supplied","required":["address_line_1","city","country_code","postal_code","state"],"properties":{"address_line_1":{"description":"Street address line 1","example":"100 Main St.","maxLength":100,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.address.address_line_1","typeLabel":"string"},"city":{"description":"City","example":"New York","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.address.city","typeLabel":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","pattern":"^[A-Z]{2}$","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.address.country_code","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"49633","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.address.postal_code","typeLabel":"string"},"state":{"description":"State, region, province, or prefecture.\nThis is the ISO-3166-2 subdivision code, excluding the country prefix.\nFor example, TX for Texas USA or TAM for Tamaulipas Mexico.\nIts length varies by country, e.g. 2 characters for US, 3 for MX.\n","example":"NY","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.address.state","typeLabel":"string"},"address_line_2":{"description":"Street address line 2","example":"Suite 99","maxLength":100,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.address.address_line_2","typeLabel":"string"}},"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.address","typeLabel":"object"},"care_of_line":{"description":"The name of the person to send in care of","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.care_of_line","typeLabel":"string"},"is_expedited_fulfillment":{"deprecated":true,"description":"Is the shipment expedited","type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.is_expedited_fulfillment","typeLabel":"boolean"},"method":{"description":"The shipping method.\n* `INTERNATIONAL_GROUND` is only available for addresses in Canada and Mexico.\n","enum":["INTERNATIONAL","INTERNATIONAL_GROUND","INTERNATIONAL_PRIORITY","LOCAL_MAIL","LOCAL_PRIORITY","OVERNIGHT","TWO_DAY"],"example":"LOCAL_MAIL","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.method","typeLabel":"enum\u003cstring>"},"phone_number":{"description":"The phone number of the recipient","example":"+14374570680","pattern":"^\\+[1-9]\\d{1,14}$","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.phone_number","typeLabel":"string"},"recipient_name":{"type":"object","description":"The name of the recipient to whom the card will be shipped","required":["first_name","last_name"],"properties":{"first_name":{"example":"Jane","maxLength":30,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.recipient_name.first_name","typeLabel":"string"},"last_name":{"example":"Smith","maxLength":30,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.recipient_name.last_name","typeLabel":"string"},"middle_name":{"example":"Anne","maxLength":30,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.recipient_name.middle_name","typeLabel":"string"}},"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping.recipient_name","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.shipping","typeLabel":"object"},"card_status":{"description":"The status indicating the card lifecycle state","enum":["ACTIVE","PENDING","REJECTED","SUSPENDED","TERMINATED","UNACTIVATED"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.card_status","typeLabel":"enum\u003cstring>"},"status_reason":{"description":"The reason for the card status\n\nCode | Description\n--- | ---\nNEW | Card activated\nREQ | Requested by you\nINA | Dormant\nUNK | Invalid shipping address\nNEG | Negative account balance\nREV | Account under review\nSUS | Suspicious activity\nOUT | Activity outside program parameters\nFRD | Confirmed fraud\nMAT | Matched with an OFAC list\nLOS | Card reported lost\nCLO | Card was cloned\nCOM | Account or card was compromised\nTMP | Awaiting customer confirmation\nPRC | Initiated by Processor\nISS | Initiated by Issuer\nEXP | Card expired\nKYC | Failed KYC\nINF | Information was validated\nACT | Account activity was validated\nAUX | Initiated by a third party\nPIN | PIN try limit reached\nSTO | Card reported stolen\nADD | Address issue\nNAM | Name issue\nSSN | SSN issue\nDOB | DOB issue\nEML | Email issue\nPHO | Phone issue\nFUL | Account/fulfillment mismatch\nOTH | Other\n","enum":["ACT","ADD","AUX","CLO","COM","DOB","EML","EXP","FRD","FUL","INA","INF","ISS","KYC","LOS","MAT","NAM","NEG","NEW","OTH","OUT","PHO","PIN","PRC","REQ","REV","SSN","STO","SUS","TMP","UNK"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.status_reason","typeLabel":"enum\u003cstring>"},"card_fulfillment_status":{"description":"The status indicating the state of the card issuance","enum":["DIGITALLY_PRESENTED","ISSUED","ORDERED","REISSUED","REJECTED","REORDERED","SHIPPED"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.card_fulfillment_status","typeLabel":"enum\u003cstring>"},"card_brand":{"description":"The brand of a card product","enum":["MASTERCARD","VISA"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.card_brand","typeLabel":"enum\u003cstring>"},"physical_card_format":{"description":"The format of a physical card product","enum":["CHIP","CONTACTLESS","MAGNETIC_STRIPE","PHYSICAL_COMBO"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0.physical_card_format","typeLabel":"enum\u003cstring>"},"business_id":{"description":"The business ID associated with this card. If no customer_id is supplied, a card can still be issued to a business, but cannot be activated or used until a customer is assigned via the PATCH /cards/{card_id} endpoint.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.business_id","typeLabel":"string\u003cuuid>"},"customer_id":{"description":"The ID of the customer to whom the card will be issued. If this is not populated with a valid customer_id the card cannot be activated or used for spend until it's assigned to a human customer via the PATCH /cards/{card_id} endpoint. If no business_id is passed, a customer_id is required.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.customer_id","typeLabel":"string\u003cuuid>"},"expiration_month":{"example":"06","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.expiration_month","typeLabel":"string"},"expiration_time":{"description":"The timestamp representing when the card would expire at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.expiration_time","typeLabel":"string\u003cdate-time>"},"expiration_year":{"example":"25","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.expiration_year","typeLabel":"string"},"is_pin_set":{"default":false,"description":"indicates whether a pin has been set on the card","example":true,"readOnly":true,"type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.0.is_pin_set","typeLabel":"boolean"},"last_four":{"description":"The last 4 digits of the card PAN","example":"1234","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.last_four","typeLabel":"string"},"last_updated_time":{"description":"The timestamp representing when the card was last modified at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.last_updated_time","typeLabel":"string\u003cdate-time>"},"metadata":{"additionalProperties":{"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.metadata.additionalProperties","typeLabel":"string"},"description":"Additional data to include in the request structured as key-value pairs","type":"object","uniqueKey":"oneOf.0.card_details.oneOf.0.metadata","typeLabel":"object"},"reissue_reason":{"description":"This is the reason the card needs to be reissued, if any. The reason determines several behaviours:\n - whether or not the new card will use the same PAN as the original card\n - the old card will be terminated and if so, when it will be terminated\n\nReason | Same PAN | Terminate Old Card\n---------------------- | -------- | ------------------\nAPPEARANCE | yes | on activation\nBANK_MIGRATION | yes | on activation\nDAMAGED | yes | on activation\nEXPIRATION | yes | on activation\nLOST | no | immediately\nPRODUCT_CHANGE | yes | on activation\nPROGRAM_CHANGE | yes | on activation\nSTOLEN | no | immediately\n\nFor all reasons, the new card will use the same PIN as the original card and digital wallet tokens will\nreassigned to the new card\n","enum":["APPEARANCE","BANK_MIGRATION","DAMAGED","EXPIRATION","LOST","PRODUCT_CHANGE","PROGRAM_CHANGE","STOLEN"],"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.reissue_reason","typeLabel":"enum\u003cstring>"},"reissued_from_id":{"description":"When reissuing a card, specify the card to be replaced here. When getting a card's details, if this card was issued as a reissuance of another card, this ID refers to the card was replaced. If this field is set, then reissue_reason must also be set.\n","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.reissued_from_id","typeLabel":"string\u003cuuid>"},"reissued_to_id":{"description":"If this card was reissued, this ID refers to the card that replaced it.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.reissued_to_id","typeLabel":"string\u003cuuid>"},"timestamp_pin_set":{"description":"Time when the PIN was last set or changed.","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.timestamp_pin_set","typeLabel":"string\u003cdate-time>"},"bulk_order_config_id":{"description":"The ID of the bulk order config which should be used for shipping this card as part of a bulk order.\nRefer to Bulk Issuance for details on ordering cards in bulk.\n","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.bulk_order_config_id","typeLabel":"string\u003cuuid>"},"card_image_id":{"description":"The ID of the custom card image used for this card","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.card_image_id","typeLabel":"string\u003cuuid>"},"memo":{"description":"Additional details about the reason for the status change","maxLength":255,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.memo","typeLabel":"string"},"pending_reasons":{"description":"reasons why the card status is PENDING","properties":{"is_waiting_for_bulk_shipment":{"description":"The card is to be shipping as part of a bulk shipment but that bulk shipment has not yet been released.\n","type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.0.pending_reasons.is_waiting_for_bulk_shipment","typeLabel":"boolean"},"is_waiting_for_image":{"description":"The card has a custom image and either that image hasn't yet been uploaded and approved or the card has not yet been processed by the periodic daily custom card image processing task.\n","type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.0.pending_reasons.is_waiting_for_image","typeLabel":"boolean"},"is_waiting_for_pin":{"description":"The card requires a PIN to be set before it can be issued (refer to the pin_issuance_policy of the related card product). The PIN has not yet been set and not enough time has passed to use a random PIN (if applicable).\n","type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.0.pending_reasons.is_waiting_for_pin","typeLabel":"boolean"}},"type":"object","uniqueKey":"oneOf.0.card_details.oneOf.0.pending_reasons","typeLabel":"object"},"fulfillment_details":{"properties":{"bulk_order_id":{"description":"The unique identifier of a bulk order in which the card was fulfilled","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.fulfillment_details.bulk_order_id","typeLabel":"string\u003cuuid>"},"ship_date":{"description":"The date that the card was shipped as reported by the card fulfillment provider","example":"2022-07-19","format":"date","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.fulfillment_details.ship_date","typeLabel":"string\u003cdate>"},"shipping_method":{"description":"The specific shipping method as reported by the card fulfillment provider","example":"UPS Next Day Air Saver","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.fulfillment_details.shipping_method","typeLabel":"string"},"tracking_number":{"description":"The shipment tracking number","example":"1ZW3268W1319325382","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.fulfillment_details.tracking_number","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.0.card_details.oneOf.0.fulfillment_details","typeLabel":"object"},"bin":{"description":"The bin number","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.0.bin","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.0","typeLabel":"Physical Card · object"},{"type":"object","title":"Virtual Card","description":"A card that can spend against a credit account","required":["account_id","card_brand","card_product_id","creation_time","emboss_name","expiration_month","expiration_year","form","id","last_four","card_status","status_reason"],"properties":{"account_id":{"description":"The ID of the account to which the card will be linked","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.account_id","typeLabel":"string\u003cuuid>"},"card_product_id":{"description":"The card product to which the card is attached","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.card_product_id","typeLabel":"string\u003cuuid>"},"creation_time":{"description":"The timestamp representing when the card issuance request was made","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.creation_time","typeLabel":"string\u003cdate-time>"},"emboss_name":{"description":"The customer details to emboss on the card - Defaults to customer first and last name. Is limited to 21 characters. Valid characters are A-Z, a-z, 0-9, space ( ), period (.), comma (,), forward slash (/), hyphen (-), ampersand (\u0026), single quote (').","properties":{"line_1":{"description":"line 1","example":"Jane Smith","type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.emboss_name.line_1","typeLabel":"string"},"line_2":{"description":"line 2","example":"Acme Inc.","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.emboss_name.line_2","typeLabel":"string"}},"required":["line_1"],"type":"object","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.emboss_name","typeLabel":"object"},"expiration_month":{"example":"06","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.expiration_month","typeLabel":"string"},"expiration_year":{"example":"25","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.expiration_year","typeLabel":"string"},"id":{"description":"Card ID","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.id","typeLabel":"string\u003cuuid>"},"last_four":{"description":"The last 4 digits of the card PAN","example":"1234","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.last_four","typeLabel":"string"},"form":{"description":"PHYSICAL or VIRTUAL.","enum":["PHYSICAL","VIRTUAL"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.form","typeLabel":"enum\u003cstring>"},"card_status":{"description":"The status indicating the card lifecycle state","enum":["ACTIVE","PENDING","REJECTED","SUSPENDED","TERMINATED","UNACTIVATED"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.card_status","typeLabel":"enum\u003cstring>"},"status_reason":{"description":"The reason for the card status\n\nCode | Description\n--- | ---\nNEW | Card activated\nREQ | Requested by you\nINA | Dormant\nUNK | Invalid shipping address\nNEG | Negative account balance\nREV | Account under review\nSUS | Suspicious activity\nOUT | Activity outside program parameters\nFRD | Confirmed fraud\nMAT | Matched with an OFAC list\nLOS | Card reported lost\nCLO | Card was cloned\nCOM | Account or card was compromised\nTMP | Awaiting customer confirmation\nPRC | Initiated by Processor\nISS | Initiated by Issuer\nEXP | Card expired\nKYC | Failed KYC\nINF | Information was validated\nACT | Account activity was validated\nAUX | Initiated by a third party\nPIN | PIN try limit reached\nSTO | Card reported stolen\nADD | Address issue\nNAM | Name issue\nSSN | SSN issue\nDOB | DOB issue\nEML | Email issue\nPHO | Phone issue\nFUL | Account/fulfillment mismatch\nOTH | Other\n","enum":["ACT","ADD","AUX","CLO","COM","DOB","EML","EXP","FRD","FUL","INA","INF","ISS","KYC","LOS","MAT","NAM","NEG","NEW","OTH","OUT","PHO","PIN","PRC","REQ","REV","SSN","STO","SUS","TMP","UNK"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.status_reason","typeLabel":"enum\u003cstring>"},"card_brand":{"description":"The brand of a card product","enum":["MASTERCARD","VISA"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1.card_brand","typeLabel":"enum\u003cstring>"},"business_id":{"description":"The business ID associated with this card. If no customer_id is supplied, a card can still be issued to a business, but cannot be activated or used until a customer is assigned via the PATCH /cards/{card_id} endpoint.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.business_id","typeLabel":"string\u003cuuid>"},"customer_id":{"description":"The ID of the customer to whom the card will be issued. If this is not populated with a valid customer_id the card cannot be activated or used for spend until it's assigned to a human customer via the PATCH /cards/{card_id} endpoint. If no business_id is passed, a customer_id is required.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.customer_id","typeLabel":"string\u003cuuid>"},"expiration_time":{"description":"The timestamp representing when the card would expire at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.expiration_time","typeLabel":"string\u003cdate-time>"},"is_pin_set":{"default":false,"description":"indicates whether a pin has been set on the card","example":true,"readOnly":true,"type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.1.is_pin_set","typeLabel":"boolean"},"last_updated_time":{"description":"The timestamp representing when the card was last modified at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.last_updated_time","typeLabel":"string\u003cdate-time>"},"metadata":{"additionalProperties":{"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.metadata.additionalProperties","typeLabel":"string"},"description":"Additional data to include in the request structured as key-value pairs","type":"object","uniqueKey":"oneOf.0.card_details.oneOf.1.metadata","typeLabel":"object"},"reissue_reason":{"description":"This is the reason the card needs to be reissued, if any. The reason determines several behaviours:\n - whether or not the new card will use the same PAN as the original card\n - the old card will be terminated and if so, when it will be terminated\n\nReason | Same PAN | Terminate Old Card\n---------------------- | -------- | ------------------\nAPPEARANCE | yes | on activation\nBANK_MIGRATION | yes | on activation\nDAMAGED | yes | on activation\nEXPIRATION | yes | on activation\nLOST | no | immediately\nPRODUCT_CHANGE | yes | on activation\nPROGRAM_CHANGE | yes | on activation\nSTOLEN | no | immediately\n\nFor all reasons, the new card will use the same PIN as the original card and digital wallet tokens will\nreassigned to the new card\n","enum":["APPEARANCE","BANK_MIGRATION","DAMAGED","EXPIRATION","LOST","PRODUCT_CHANGE","PROGRAM_CHANGE","STOLEN"],"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.reissue_reason","typeLabel":"enum\u003cstring>"},"reissued_from_id":{"description":"When reissuing a card, specify the card to be replaced here. When getting a card's details, if this card was issued as a reissuance of another card, this ID refers to the card was replaced. If this field is set, then reissue_reason must also be set.\n","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.reissued_from_id","typeLabel":"string\u003cuuid>"},"reissued_to_id":{"description":"If this card was reissued, this ID refers to the card that replaced it.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.reissued_to_id","typeLabel":"string\u003cuuid>"},"timestamp_pin_set":{"description":"Time when the PIN was last set or changed.","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.timestamp_pin_set","typeLabel":"string\u003cdate-time>"},"memo":{"description":"Additional details about the reason for the status change","maxLength":255,"type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.memo","typeLabel":"string"},"pending_reasons":{"description":"reasons why the card status is PENDING","properties":{"is_waiting_for_bulk_shipment":{"description":"The card is to be shipping as part of a bulk shipment but that bulk shipment has not yet been released.\n","type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.1.pending_reasons.is_waiting_for_bulk_shipment","typeLabel":"boolean"},"is_waiting_for_image":{"description":"The card has a custom image and either that image hasn't yet been uploaded and approved or the card has not yet been processed by the periodic daily custom card image processing task.\n","type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.1.pending_reasons.is_waiting_for_image","typeLabel":"boolean"},"is_waiting_for_pin":{"description":"The card requires a PIN to be set before it can be issued (refer to the pin_issuance_policy of the related card product). The PIN has not yet been set and not enough time has passed to use a random PIN (if applicable).\n","type":"boolean","uniqueKey":"oneOf.0.card_details.oneOf.1.pending_reasons.is_waiting_for_pin","typeLabel":"boolean"}},"type":"object","uniqueKey":"oneOf.0.card_details.oneOf.1.pending_reasons","typeLabel":"object"},"bin":{"description":"The bin number","type":"string","uniqueKey":"oneOf.0.card_details.oneOf.1.bin","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.card_details.oneOf.1","typeLabel":"Virtual Card · object"}],"isRequired":true,"uniqueKey":"oneOf.0.card_details","typeLabel":"Physical Card · object | Virtual Card · object"},"tenant":{"description":"The id of the tenant containing the resource.\n","example":"abcdef_ghijkl","type":"string","isRequired":true,"uniqueKey":"oneOf.0.tenant","typeLabel":"string"},"type":{"description":"The type of the card program and BIN","enum":["CREDIT","DEBIT","PREPAID"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"vendor_data":{"properties":{"episodesix":{"properties":{"card_number":{"description":"E6 internal card identifier. This is not a PAN.","type":"string","uniqueKey":"oneOf.0.vendor_data.episodesix.card_number","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.0.vendor_data.episodesix","typeLabel":"object"},"loan_pro":{"properties":{"card_id":{"type":"integer","uniqueKey":"oneOf.0.vendor_data.loan_pro.card_id","typeLabel":"integer"},"secure_payments_card_uuid":{"type":"string","uniqueKey":"oneOf.0.vendor_data.loan_pro.secure_payments_card_uuid","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.0.vendor_data.loan_pro","typeLabel":"object"}},"type":"object","uniqueKey":"oneOf.0.vendor_data","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"Credit Card · object"},{"type":"object","title":"Debit Card","description":"A card that can spend against a deposit account","required":["card_details","tenant","type"],"properties":{"card_details":{"oneOf":[{"type":"object","title":"Physical Card","description":"A card that can spend against a deposit account","required":["account_id","card_brand","card_product_id","creation_time","emboss_name","form","id","physical_card_format","shipping","card_fulfillment_status","card_status","status_reason"],"properties":{"account_id":{"description":"The ID of the account to which the card will be linked","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.account_id","typeLabel":"string\u003cuuid>"},"card_product_id":{"description":"The card product to which the card is attached","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.card_product_id","typeLabel":"string\u003cuuid>"},"creation_time":{"description":"The timestamp representing when the card issuance request was made","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.creation_time","typeLabel":"string\u003cdate-time>"},"emboss_name":{"description":"The customer details to emboss on the card - Defaults to customer first and last name. Is limited to 21 characters. Valid characters are A-Z, a-z, 0-9, space ( ), period (.), comma (,), forward slash (/), hyphen (-), ampersand (\u0026), single quote (').","properties":{"line_1":{"description":"line 1","example":"Jane Smith","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.emboss_name.line_1","typeLabel":"string"},"line_2":{"description":"line 2","example":"Acme Inc.","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.emboss_name.line_2","typeLabel":"string"}},"required":["line_1"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.emboss_name","typeLabel":"object"},"id":{"description":"Card ID","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.id","typeLabel":"string\u003cuuid>"},"form":{"description":"PHYSICAL or VIRTUAL.","enum":["PHYSICAL","VIRTUAL"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.form","typeLabel":"enum\u003cstring>"},"shipping":{"description":"Details about the shipping method. If supplied this will override the default shipping address of the customer or account.","properties":{"address":{"type":"object","description":"The address to which the card will be shipped - Defaults to account shipping address if none supplied","required":["address_line_1","city","country_code","postal_code","state"],"properties":{"address_line_1":{"description":"Street address line 1","example":"100 Main St.","maxLength":100,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.address.address_line_1","typeLabel":"string"},"city":{"description":"City","example":"New York","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.address.city","typeLabel":"string"},"country_code":{"description":"ISO-3166-1 Alpha-2 country code","example":"US","pattern":"^[A-Z]{2}$","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.address.country_code","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"49633","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.address.postal_code","typeLabel":"string"},"state":{"description":"State, region, province, or prefecture.\nThis is the ISO-3166-2 subdivision code, excluding the country prefix.\nFor example, TX for Texas USA or TAM for Tamaulipas Mexico.\nIts length varies by country, e.g. 2 characters for US, 3 for MX.\n","example":"NY","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.address.state","typeLabel":"string"},"address_line_2":{"description":"Street address line 2","example":"Suite 99","maxLength":100,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.address.address_line_2","typeLabel":"string"}},"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.address","typeLabel":"object"},"care_of_line":{"description":"The name of the person to send in care of","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.care_of_line","typeLabel":"string"},"is_expedited_fulfillment":{"deprecated":true,"description":"Is the shipment expedited","type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.is_expedited_fulfillment","typeLabel":"boolean"},"method":{"description":"The shipping method.\n* `INTERNATIONAL_GROUND` is only available for addresses in Canada and Mexico.\n","enum":["INTERNATIONAL","INTERNATIONAL_GROUND","INTERNATIONAL_PRIORITY","LOCAL_MAIL","LOCAL_PRIORITY","OVERNIGHT","TWO_DAY"],"example":"LOCAL_MAIL","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.method","typeLabel":"enum\u003cstring>"},"phone_number":{"description":"The phone number of the recipient","example":"+14374570680","pattern":"^\\+[1-9]\\d{1,14}$","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.phone_number","typeLabel":"string"},"recipient_name":{"type":"object","description":"The name of the recipient to whom the card will be shipped","required":["first_name","last_name"],"properties":{"first_name":{"example":"Jane","maxLength":30,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.recipient_name.first_name","typeLabel":"string"},"last_name":{"example":"Smith","maxLength":30,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.recipient_name.last_name","typeLabel":"string"},"middle_name":{"example":"Anne","maxLength":30,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.recipient_name.middle_name","typeLabel":"string"}},"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping.recipient_name","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.shipping","typeLabel":"object"},"card_status":{"description":"The status indicating the card lifecycle state","enum":["ACTIVE","PENDING","REJECTED","SUSPENDED","TERMINATED","UNACTIVATED"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.card_status","typeLabel":"enum\u003cstring>"},"status_reason":{"description":"The reason for the card status\n\nCode | Description\n--- | ---\nNEW | Card activated\nREQ | Requested by you\nINA | Dormant\nUNK | Invalid shipping address\nNEG | Negative account balance\nREV | Account under review\nSUS | Suspicious activity\nOUT | Activity outside program parameters\nFRD | Confirmed fraud\nMAT | Matched with an OFAC list\nLOS | Card reported lost\nCLO | Card was cloned\nCOM | Account or card was compromised\nTMP | Awaiting customer confirmation\nPRC | Initiated by Processor\nISS | Initiated by Issuer\nEXP | Card expired\nKYC | Failed KYC\nINF | Information was validated\nACT | Account activity was validated\nAUX | Initiated by a third party\nPIN | PIN try limit reached\nSTO | Card reported stolen\nADD | Address issue\nNAM | Name issue\nSSN | SSN issue\nDOB | DOB issue\nEML | Email issue\nPHO | Phone issue\nFUL | Account/fulfillment mismatch\nOTH | Other\n","enum":["ACT","ADD","AUX","CLO","COM","DOB","EML","EXP","FRD","FUL","INA","INF","ISS","KYC","LOS","MAT","NAM","NEG","NEW","OTH","OUT","PHO","PIN","PRC","REQ","REV","SSN","STO","SUS","TMP","UNK"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.status_reason","typeLabel":"enum\u003cstring>"},"card_fulfillment_status":{"description":"The status indicating the state of the card issuance","enum":["DIGITALLY_PRESENTED","ISSUED","ORDERED","REISSUED","REJECTED","REORDERED","SHIPPED"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.card_fulfillment_status","typeLabel":"enum\u003cstring>"},"card_brand":{"description":"The brand of a card product","enum":["MASTERCARD","VISA"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.card_brand","typeLabel":"enum\u003cstring>"},"physical_card_format":{"description":"The format of a physical card product","enum":["CHIP","CONTACTLESS","MAGNETIC_STRIPE","PHYSICAL_COMBO"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0.physical_card_format","typeLabel":"enum\u003cstring>"},"business_id":{"description":"The business ID associated with this card. If no customer_id is supplied, a card can still be issued to a business, but cannot be activated or used until a customer is assigned via the PATCH /cards/{card_id} endpoint.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.business_id","typeLabel":"string\u003cuuid>"},"customer_id":{"description":"The ID of the customer to whom the card will be issued. If this is not populated with a valid customer_id the card cannot be activated or used for spend until it's assigned to a human customer via the PATCH /cards/{card_id} endpoint. If no business_id is passed, a customer_id is required.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.customer_id","typeLabel":"string\u003cuuid>"},"expiration_month":{"example":"06","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.expiration_month","typeLabel":"string"},"expiration_time":{"description":"The timestamp representing when the card would expire at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.expiration_time","typeLabel":"string\u003cdate-time>"},"expiration_year":{"example":"25","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.expiration_year","typeLabel":"string"},"is_pin_set":{"default":false,"description":"indicates whether a pin has been set on the card","example":true,"readOnly":true,"type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.0.is_pin_set","typeLabel":"boolean"},"last_four":{"description":"The last 4 digits of the card PAN","example":"1234","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.last_four","typeLabel":"string"},"last_updated_time":{"description":"The timestamp representing when the card was last modified at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.last_updated_time","typeLabel":"string\u003cdate-time>"},"metadata":{"additionalProperties":{"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.metadata.additionalProperties","typeLabel":"string"},"description":"Additional data to include in the request structured as key-value pairs","type":"object","uniqueKey":"oneOf.1.card_details.oneOf.0.metadata","typeLabel":"object"},"reissue_reason":{"description":"This is the reason the card needs to be reissued, if any. The reason determines several behaviours:\n - whether or not the new card will use the same PAN as the original card\n - the old card will be terminated and if so, when it will be terminated\n\nReason | Same PAN | Terminate Old Card\n---------------------- | -------- | ------------------\nAPPEARANCE | yes | on activation\nBANK_MIGRATION | yes | on activation\nDAMAGED | yes | on activation\nEXPIRATION | yes | on activation\nLOST | no | immediately\nPRODUCT_CHANGE | yes | on activation\nPROGRAM_CHANGE | yes | on activation\nSTOLEN | no | immediately\n\nFor all reasons, the new card will use the same PIN as the original card and digital wallet tokens will\nreassigned to the new card\n","enum":["APPEARANCE","BANK_MIGRATION","DAMAGED","EXPIRATION","LOST","PRODUCT_CHANGE","PROGRAM_CHANGE","STOLEN"],"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.reissue_reason","typeLabel":"enum\u003cstring>"},"reissued_from_id":{"description":"When reissuing a card, specify the card to be replaced here. When getting a card's details, if this card was issued as a reissuance of another card, this ID refers to the card was replaced. If this field is set, then reissue_reason must also be set.\n","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.reissued_from_id","typeLabel":"string\u003cuuid>"},"reissued_to_id":{"description":"If this card was reissued, this ID refers to the card that replaced it.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.reissued_to_id","typeLabel":"string\u003cuuid>"},"timestamp_pin_set":{"description":"Time when the PIN was last set or changed.","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.timestamp_pin_set","typeLabel":"string\u003cdate-time>"},"bulk_order_config_id":{"description":"The ID of the bulk order config which should be used for shipping this card as part of a bulk order.\nRefer to Bulk Issuance for details on ordering cards in bulk.\n","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.bulk_order_config_id","typeLabel":"string\u003cuuid>"},"card_image_id":{"description":"The ID of the custom card image used for this card","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.card_image_id","typeLabel":"string\u003cuuid>"},"memo":{"description":"Additional details about the reason for the status change","maxLength":255,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.memo","typeLabel":"string"},"pending_reasons":{"description":"reasons why the card status is PENDING","properties":{"is_waiting_for_bulk_shipment":{"description":"The card is to be shipping as part of a bulk shipment but that bulk shipment has not yet been released.\n","type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.0.pending_reasons.is_waiting_for_bulk_shipment","typeLabel":"boolean"},"is_waiting_for_image":{"description":"The card has a custom image and either that image hasn't yet been uploaded and approved or the card has not yet been processed by the periodic daily custom card image processing task.\n","type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.0.pending_reasons.is_waiting_for_image","typeLabel":"boolean"},"is_waiting_for_pin":{"description":"The card requires a PIN to be set before it can be issued (refer to the pin_issuance_policy of the related card product). The PIN has not yet been set and not enough time has passed to use a random PIN (if applicable).\n","type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.0.pending_reasons.is_waiting_for_pin","typeLabel":"boolean"}},"type":"object","uniqueKey":"oneOf.1.card_details.oneOf.0.pending_reasons","typeLabel":"object"},"fulfillment_details":{"properties":{"bulk_order_id":{"description":"The unique identifier of a bulk order in which the card was fulfilled","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.fulfillment_details.bulk_order_id","typeLabel":"string\u003cuuid>"},"ship_date":{"description":"The date that the card was shipped as reported by the card fulfillment provider","example":"2022-07-19","format":"date","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.fulfillment_details.ship_date","typeLabel":"string\u003cdate>"},"shipping_method":{"description":"The specific shipping method as reported by the card fulfillment provider","example":"UPS Next Day Air Saver","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.fulfillment_details.shipping_method","typeLabel":"string"},"tracking_number":{"description":"The shipment tracking number","example":"1ZW3268W1319325382","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.fulfillment_details.tracking_number","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.1.card_details.oneOf.0.fulfillment_details","typeLabel":"object"},"bin":{"description":"The bin number","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.0.bin","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.0","typeLabel":"Physical Card · object"},{"type":"object","title":"Virtual Card","description":"A card that can spend against a deposit account","required":["account_id","card_brand","card_product_id","creation_time","emboss_name","expiration_month","expiration_year","form","id","last_four","card_status","status_reason"],"properties":{"account_id":{"description":"The ID of the account to which the card will be linked","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.account_id","typeLabel":"string\u003cuuid>"},"card_product_id":{"description":"The card product to which the card is attached","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.card_product_id","typeLabel":"string\u003cuuid>"},"creation_time":{"description":"The timestamp representing when the card issuance request was made","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.creation_time","typeLabel":"string\u003cdate-time>"},"emboss_name":{"description":"The customer details to emboss on the card - Defaults to customer first and last name. Is limited to 21 characters. Valid characters are A-Z, a-z, 0-9, space ( ), period (.), comma (,), forward slash (/), hyphen (-), ampersand (\u0026), single quote (').","properties":{"line_1":{"description":"line 1","example":"Jane Smith","type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.emboss_name.line_1","typeLabel":"string"},"line_2":{"description":"line 2","example":"Acme Inc.","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.emboss_name.line_2","typeLabel":"string"}},"required":["line_1"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.emboss_name","typeLabel":"object"},"expiration_month":{"example":"06","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.expiration_month","typeLabel":"string"},"expiration_year":{"example":"25","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.expiration_year","typeLabel":"string"},"id":{"description":"Card ID","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.id","typeLabel":"string\u003cuuid>"},"last_four":{"description":"The last 4 digits of the card PAN","example":"1234","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.last_four","typeLabel":"string"},"form":{"description":"PHYSICAL or VIRTUAL.","enum":["PHYSICAL","VIRTUAL"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.form","typeLabel":"enum\u003cstring>"},"card_status":{"description":"The status indicating the card lifecycle state","enum":["ACTIVE","PENDING","REJECTED","SUSPENDED","TERMINATED","UNACTIVATED"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.card_status","typeLabel":"enum\u003cstring>"},"status_reason":{"description":"The reason for the card status\n\nCode | Description\n--- | ---\nNEW | Card activated\nREQ | Requested by you\nINA | Dormant\nUNK | Invalid shipping address\nNEG | Negative account balance\nREV | Account under review\nSUS | Suspicious activity\nOUT | Activity outside program parameters\nFRD | Confirmed fraud\nMAT | Matched with an OFAC list\nLOS | Card reported lost\nCLO | Card was cloned\nCOM | Account or card was compromised\nTMP | Awaiting customer confirmation\nPRC | Initiated by Processor\nISS | Initiated by Issuer\nEXP | Card expired\nKYC | Failed KYC\nINF | Information was validated\nACT | Account activity was validated\nAUX | Initiated by a third party\nPIN | PIN try limit reached\nSTO | Card reported stolen\nADD | Address issue\nNAM | Name issue\nSSN | SSN issue\nDOB | DOB issue\nEML | Email issue\nPHO | Phone issue\nFUL | Account/fulfillment mismatch\nOTH | Other\n","enum":["ACT","ADD","AUX","CLO","COM","DOB","EML","EXP","FRD","FUL","INA","INF","ISS","KYC","LOS","MAT","NAM","NEG","NEW","OTH","OUT","PHO","PIN","PRC","REQ","REV","SSN","STO","SUS","TMP","UNK"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.status_reason","typeLabel":"enum\u003cstring>"},"card_brand":{"description":"The brand of a card product","enum":["MASTERCARD","VISA"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1.card_brand","typeLabel":"enum\u003cstring>"},"business_id":{"description":"The business ID associated with this card. If no customer_id is supplied, a card can still be issued to a business, but cannot be activated or used until a customer is assigned via the PATCH /cards/{card_id} endpoint.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.business_id","typeLabel":"string\u003cuuid>"},"customer_id":{"description":"The ID of the customer to whom the card will be issued. If this is not populated with a valid customer_id the card cannot be activated or used for spend until it's assigned to a human customer via the PATCH /cards/{card_id} endpoint. If no business_id is passed, a customer_id is required.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.customer_id","typeLabel":"string\u003cuuid>"},"expiration_time":{"description":"The timestamp representing when the card would expire at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.expiration_time","typeLabel":"string\u003cdate-time>"},"is_pin_set":{"default":false,"description":"indicates whether a pin has been set on the card","example":true,"readOnly":true,"type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.1.is_pin_set","typeLabel":"boolean"},"last_updated_time":{"description":"The timestamp representing when the card was last modified at","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.last_updated_time","typeLabel":"string\u003cdate-time>"},"metadata":{"additionalProperties":{"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.metadata.additionalProperties","typeLabel":"string"},"description":"Additional data to include in the request structured as key-value pairs","type":"object","uniqueKey":"oneOf.1.card_details.oneOf.1.metadata","typeLabel":"object"},"reissue_reason":{"description":"This is the reason the card needs to be reissued, if any. The reason determines several behaviours:\n - whether or not the new card will use the same PAN as the original card\n - the old card will be terminated and if so, when it will be terminated\n\nReason | Same PAN | Terminate Old Card\n---------------------- | -------- | ------------------\nAPPEARANCE | yes | on activation\nBANK_MIGRATION | yes | on activation\nDAMAGED | yes | on activation\nEXPIRATION | yes | on activation\nLOST | no | immediately\nPRODUCT_CHANGE | yes | on activation\nPROGRAM_CHANGE | yes | on activation\nSTOLEN | no | immediately\n\nFor all reasons, the new card will use the same PIN as the original card and digital wallet tokens will\nreassigned to the new card\n","enum":["APPEARANCE","BANK_MIGRATION","DAMAGED","EXPIRATION","LOST","PRODUCT_CHANGE","PROGRAM_CHANGE","STOLEN"],"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.reissue_reason","typeLabel":"enum\u003cstring>"},"reissued_from_id":{"description":"When reissuing a card, specify the card to be replaced here. When getting a card's details, if this card was issued as a reissuance of another card, this ID refers to the card was replaced. If this field is set, then reissue_reason must also be set.\n","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.reissued_from_id","typeLabel":"string\u003cuuid>"},"reissued_to_id":{"description":"If this card was reissued, this ID refers to the card that replaced it.","example":"7d943c51-e4ff-4e57-9558-08cab6b963c7","format":"uuid","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.reissued_to_id","typeLabel":"string\u003cuuid>"},"timestamp_pin_set":{"description":"Time when the PIN was last set or changed.","example":"2010-05-06T12:23:34.321Z","format":"date-time","readOnly":true,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.timestamp_pin_set","typeLabel":"string\u003cdate-time>"},"memo":{"description":"Additional details about the reason for the status change","maxLength":255,"type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.memo","typeLabel":"string"},"pending_reasons":{"description":"reasons why the card status is PENDING","properties":{"is_waiting_for_bulk_shipment":{"description":"The card is to be shipping as part of a bulk shipment but that bulk shipment has not yet been released.\n","type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.1.pending_reasons.is_waiting_for_bulk_shipment","typeLabel":"boolean"},"is_waiting_for_image":{"description":"The card has a custom image and either that image hasn't yet been uploaded and approved or the card has not yet been processed by the periodic daily custom card image processing task.\n","type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.1.pending_reasons.is_waiting_for_image","typeLabel":"boolean"},"is_waiting_for_pin":{"description":"The card requires a PIN to be set before it can be issued (refer to the pin_issuance_policy of the related card product). The PIN has not yet been set and not enough time has passed to use a random PIN (if applicable).\n","type":"boolean","uniqueKey":"oneOf.1.card_details.oneOf.1.pending_reasons.is_waiting_for_pin","typeLabel":"boolean"}},"type":"object","uniqueKey":"oneOf.1.card_details.oneOf.1.pending_reasons","typeLabel":"object"},"bin":{"description":"The bin number","type":"string","uniqueKey":"oneOf.1.card_details.oneOf.1.bin","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.card_details.oneOf.1","typeLabel":"Virtual Card · object"}],"isRequired":true,"uniqueKey":"oneOf.1.card_details","typeLabel":"Physical Card · object | Virtual Card · object"},"tenant":{"description":"The id of the tenant containing the resource.\n","example":"abcdef_ghijkl","type":"string","isRequired":true,"uniqueKey":"oneOf.1.tenant","typeLabel":"string"},"type":{"description":"The type of the card program and BIN","enum":["CREDIT","DEBIT","PREPAID"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"vendor_data":{"properties":{"episodesix":{"properties":{"card_number":{"description":"E6 internal card identifier. This is not a PAN.","type":"string","uniqueKey":"oneOf.1.vendor_data.episodesix.card_number","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.1.vendor_data.episodesix","typeLabel":"object"},"loan_pro":{"properties":{"card_id":{"type":"integer","uniqueKey":"oneOf.1.vendor_data.loan_pro.card_id","typeLabel":"integer"},"secure_payments_card_uuid":{"type":"string","uniqueKey":"oneOf.1.vendor_data.loan_pro.secure_payments_card_uuid","typeLabel":"string"}},"type":"object","uniqueKey":"oneOf.1.vendor_data.loan_pro","typeLabel":"object"}},"type":"object","uniqueKey":"oneOf.1.vendor_data","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Debit Card · object"}],"uniqueKey":"","typeLabel":"Credit Card · object | Debit Card · object"},"examples":{"Example":{"title":"Example","value":{"card_details":{"account_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","card_product_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","creation_time":"2010-05-06T12:23:34.321Z","emboss_name":{"line_1":"Jane Smith","line_2":"Acme Inc."},"id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","form":"PHYSICAL","shipping":{"address":{"address_line_1":"100 Main St.","city":"New York","country_code":"US","postal_code":"49633","state":"NY","address_line_2":"Suite 99"},"care_of_line":"\u003cstring>","is_expedited_fulfillment":true,"method":"LOCAL_MAIL","phone_number":"+14374570680","recipient_name":{"first_name":"Jane","last_name":"Smith","middle_name":"Anne"}},"card_status":"ACTIVE","status_reason":"ACT","card_fulfillment_status":"DIGITALLY_PRESENTED","card_brand":"MASTERCARD","physical_card_format":"CHIP","business_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","customer_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","expiration_month":"06","expiration_time":"2010-05-06T12:23:34.321Z","expiration_year":"25","is_pin_set":true,"last_four":"1234","last_updated_time":"2010-05-06T12:23:34.321Z","metadata":{},"reissue_reason":"APPEARANCE","reissued_from_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","reissued_to_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","timestamp_pin_set":"2010-05-06T12:23:34.321Z","bulk_order_config_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","card_image_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","memo":"\u003cstring>","pending_reasons":{"is_waiting_for_bulk_shipment":true,"is_waiting_for_image":true,"is_waiting_for_pin":true},"fulfillment_details":{"bulk_order_id":"7d943c51-e4ff-4e57-9558-08cab6b963c7","ship_date":"2022-07-19","shipping_method":"UPS Next Day Air Saver","tracking_number":"1ZW3268W1319325382"},"bin":"\u003cstring>"},"tenant":"abcdef_ghijkl","type":"CREDIT","vendor_data":{"episodesix":{"card_number":"\u003cstring>"},"loan_pro":{"card_id":123,"secure_payments_card_uuid":"\u003cstring>"}}}}},"exampleType":"generated"}},"description":"Card activated successfully","exampleType":"generated"},"b2059482-a521-4b16-b700-1181922f4d5d":{"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"},"9dcb8117-8f4a-44e7-801a-3cdff62948b1":{"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"},"e3dfe994-e846-478f-b781-5130ae3955b1":{"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"},"e53ed0d7-6510-4b0e-b0fc-97775100a2d3":{"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"},"c14c86a1-12f3-4848-8ce0-18a0649879b3":{"content":{"application/json":{"schema":{"description":"Synctera error responses in API v1 implement a custom error schema.","properties":{"code":{"description":"A machine-readable string that identifies the error for programmatic use.\n","example":"BAD_REQUEST_BODY","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable string explaining this particular error.\n","example":"Missing required fields: first_name, dob","type":"string","uniqueKey":"detail","typeLabel":"string"},"status":{"description":"HTTP status code for this response","example":400,"type":"integer","uniqueKey":"status","typeLabel":"integer"}},"title":"Synctera error response","type":"object","uniqueKey":"","typeLabel":"Synctera error response · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST_BODY","detail":"Missing required fields: first_name, dob","status":400}}},"exampleType":"generated"}},"description":"Internal server error","exampleType":"generated"}},"security":{"3b331130-e217-44cf-8c2a-199618740ff4":{"bearerAuth":{"bearerFormat":"api_key","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0728831c-8117-4f09-b930-9c30f984c1c6":{"description":"Production","url":"https://api.synctera.com/v2"},"ebddaf3a-b3fb-4655-b471-533a99abb3a1":{"description":"Sandbox (no real world financial impact)","url":"https://api-sandbox.synctera.com/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"api_key","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi-v2.json"},"subdomain":"synctera","siteName":"Synctera","title":"Activate a card - Synctera","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/reference/activatecard","matchLevel":0},"v0":{"href":"/reference/activatecard","matchLevel":1},"v1":{"href":"/v1/reference/activatecard","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T21:33:35.406Z","originalFileLocation":"v2/reference/activatecard.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=\"Activate a card\">\u003cmeta data-mint-head name=\"application-name\" content=\"Synctera\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/synctera/ehuaQmwUkP97clsK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Activate a card - Synctera\">\u003cmeta data-mint-head property=\"og:description\" content=\"Activate a card\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Synctera\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.synctera.com/v2/reference/activatecard\">\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=Activate+a+card\u0026amp;description=Activate+a+card%0A\u0026amp;theme=7eeaff4eadcf64de30804626\u0026amp;signature=f5d40dbd7df2c1f8e2dd4d82bf2df46d784878e8efb6f12bd2b8f26bd06d8a57\">\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=\"Activate a card - Synctera\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Activate a card\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://synctera.mintlify.site/_mintlify/api/og/v2?division=Cards\u0026amp;title=Activate+a+card\u0026amp;description=Activate+a+card%0A\u0026amp;theme=7eeaff4eadcf64de30804626\u0026amp;signature=f5d40dbd7df2c1f8e2dd4d82bf2df46d784878e8efb6f12bd2b8f26bd06d8a57\">\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/activatecard\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/reference/activatecard.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/activatecard#webpage\",\"url\":\"https://docs.synctera.com/v2/reference/activatecard\",\"name\":\"Activate a card\",\"description\":\"Activate a card\",\"dateModified\":\"2026-01-27T21:33:35.406Z\",\"isPartOf\":{\"@id\":\"https://docs.synctera.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.synctera.com/v2/reference/activatecard#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.synctera.com/v2/reference/activatecard#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\":\"Activate a card\",\"item\":\"https://docs.synctera.com/v2/reference/activatecard\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.synctera.com/v2/reference/activatecard#apireference\",\"headline\":\"Activate a card\",\"name\":\"Activate a card\",\"description\":\"Activate a card\",\"url\":\"https://docs.synctera.com/v2/reference/activatecard\",\"mainEntityOfPage\":{\"@id\":\"https://docs.synctera.com/v2/reference/activatecard#webpage\"},\"dateModified\":\"2026-01-27T21:33:35.406Z\",\"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","description":"Issue or reissue a new card for a customer\n","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","description":"This endpoint returns a URL address of the specified widget for a given card\n","href":"/v2/reference/getcardwidgeturl"},{"openapi":"openapi-v2.json get /cards/gateways","title":"List Gateways","href":"/v2/reference/listgateways"},{"openapi":"openapi-v2.json post /cards/gateways","title":"Create Gateway","href":"/v2/reference/creategateway"},{"openapi":"openapi-v2.json get /cards/gateways/{gateway_id}","title":"Get Gateway","href":"/v2/reference/getgateway"},{"openapi":"openapi-v2.json patch /cards/gateways/{gateway_id}","title":"Update Gateway","href":"/v2/reference/updategateway"},{"openapi":"openapi-v2.json get /cards/images","title":"List Card Image Details","href":"/v2/reference/listcardimagedetails"},{"openapi":"openapi-v2.json post /cards/images","title":"Create Card Image","href":"/v2/reference/createcardimage"},{"openapi":"openapi-v2.json get /cards/images/{card_image_id}","title":"Get Card Image Details","href":"/v2/reference/getcardimagedetails"},{"openapi":"openapi-v2.json patch /cards/images/{card_image_id}","title":"Update Card Image Details","href":"/v2/reference/updatecardimagedetails"},{"openapi":"openapi-v2.json get /cards/images/{card_image_id}/data","title":"Get Card Image Data","href":"/v2/reference/getcardimagedata"},{"openapi":"openapi-v2.json post /cards/images/{card_image_id}/data","title":"Upload Card Image","href":"/v2/reference/uploadcardimagedata"},{"openapi":"openapi-v2.json get /cards/products","title":"List Card Products","href":"/v2/reference/listcardproducts"},{"openapi":"openapi-v2.json get /cards/three_ds_decision_gateways","title":"List 3DS Decision Gateways","href":"/v2/reference/listthreedsdecisiongateways"},{"openapi":"openapi-v2.json post /cards/three_ds_decision_gateways","title":"Create 3DS Decision Gateway","href":"/v2/reference/createthreedsdecisiongateway"},{"openapi":"openapi-v2.json get /cards/three_ds_decision_gateways/{id}","title":"Get 3DS DecisionGateway","href":"/v2/reference/getthreedsdecisiongateway"},{"openapi":"openapi-v2.json patch /cards/three_ds_decision_gateways/{id}","title":"Update 3DS Decision Gateway","href":"/v2/reference/updatethreedsgateway"},{"openapi":"openapi-v2.json get /cards/{card_id}","title":"Get Card","href":"/v2/reference/getcard"},{"openapi":"openapi-v2.json patch /cards/{card_id}","title":"Update Card","href":"/v2/reference/updatecard"},{"openapi":"openapi-v2.json get /cards/{card_id}/barcodes","title":"Get Card Barcode","href":"/v2/reference/getcardbarcode"},{"openapi":"openapi-v2.json post /cards/{card_id}/client_token","title":"Get a client token","href":"/v2/reference/getclientaccesstoken"},{"openapi":"openapi-v2.json post /cards/{card_id}/pin","title":"Set Card PIN","href":"/v2/reference/setcardpin"},{"openapi":"openapi-v2.json get /cards/{card_id}/reveal","title":"Reveal Card Details","href":"/v2/reference/revealcarddetails"},{"openapi":"openapi-v2.json get /cards/{card_id}/widget_token","title":"Get a widget access token","href":"/v2/reference/getwidgetaccesstoken"}]},{"group":"Digital Wallet Tokens","pages":[{"openapi":"openapi-v2.json get /cards/digital_wallet_tokens","title":"List Digital Wallet Tokens","href":"/v2/reference/listdigitalwallettokens"},{"openapi":"openapi-v2.json get /cards/digital_wallet_tokens/{digital_wallet_token_id}","title":"Get Digital Wallet Token","href":"/v2/reference/getdigitalwallettoken"},{"openapi":"openapi-v2.json patch /cards/digital_wallet_tokens/{digital_wallet_token_id}","title":"Update Digital Wallet Token's life cycle status","href":"/v2/reference/updatedigitalwallettokenstatus"},{"openapi":"openapi-v2.json post /cards/{card_id}/digital_wallet_tokens/applepay","title":"Create digital wallet token provision request for Apple Pay","href":"/v2/reference/createdigitalwalletapple"},{"openapi":"openapi-v2.json post /cards/{card_id}/digital_wallet_tokens/googlepay","title":"Create digital wallet token provision request for Google Pay","href":"/v2/reference/createdigitalwalletgoogle"},{"openapi":"openapi-v2.json post /cards/{card_id}/digital_wallet_tokens/googlepay_upp","title":"Create digital wallet token provision request for Google Pay using Unified Push Provisioning (UPP)","href":"/v2/reference/createdigitalwalletgoogleupp"}]}]},{"group":"Money Movement","pages":[{"group":"Rewards","pages":[{"openapi":"openapi-v2.json get /reward_templates","title":"List reward templates","href":"/v2/reference/listrewardtemplates"},{"openapi":"openapi-v2.json post /reward_templates","title":"Create a reward template","href":"/v2/reference/createrewardtemplate"},{"openapi":"openapi-v2.json get /reward_templates/{reward_template_id}","title":"Get a Reward template","href":"/v2/reference/getrewardtemplate"},{"openapi":"openapi-v2.json patch /reward_templates/{reward_template_id}","title":"Patch Reward Template","href":"/v2/reference/patchrewardtemplate"},{"openapi":"openapi-v2.json get /rewards","title":"List rewards","href":"/v2/reference/listrewards"},{"openapi":"openapi-v2.json post /rewards","title":"Create a reward","href":"/v2/reference/createreward"},{"openapi":"openapi-v2.json get /rewards/{reward_id}","title":"Get Reward","href":"/v2/reference/getreward"},{"openapi":"openapi-v2.json post /rewards/{reward_id}/reverse","title":"Reverse a reward","href":"/v2/reference/reversereward"}]},{"group":"Reward Products","pages":[{"openapi":"openapi-v2.json get /reward_products","title":"List reward products","href":"/v2/reference/listrewardproducts"},{"openapi":"openapi-v2.json post /reward_products","title":"Create a reward product","href":"/v2/reference/createrewardproduct"},{"openapi":"openapi-v2.json get /reward_products/{reward_product_id}","title":"Get a reward product","href":"/v2/reference/getrewardproduct"},{"openapi":"openapi-v2.json patch /reward_products/{reward_product_id}","title":"Update a reward product","href":"/v2/reference/updaterewardproduct"},{"openapi":"openapi-v2.json get /reward_configs","title":"List reward configs","href":"/v2/reference/listrewardconfigs"},{"openapi":"openapi-v2.json post /reward_configs","title":"Create a reward config","href":"/v2/reference/createrewardconfig"},{"openapi":"openapi-v2.json get /reward_configs/{reward_config_id}","title":"Get a reward config","href":"/v2/reference/getrewardconfig"},{"openapi":"openapi-v2.json patch /reward_configs/{reward_config_id}","title":"Update a reward config","href":"/v2/reference/updaterewardconfig"}]},{"group":"Fees","pages":[{"openapi":"openapi-v2.json get /fee_templates","title":"List fee templates","href":"/v2/reference/listfeetemplates"},{"openapi":"openapi-v2.json post /fee_templates","title":"Create a fee template","href":"/v2/reference/createfeetemplate"},{"openapi":"openapi-v2.json get /fee_templates/{fee_template_id}","title":"Get a Fee template","href":"/v2/reference/getfeetemplate"},{"openapi":"openapi-v2.json patch /fee_templates/{fee_template_id}","title":"Patch Fee Template","href":"/v2/reference/patchfeetemplate"},{"openapi":"openapi-v2.json get /fees","title":"List fees","href":"/v2/reference/listfees"},{"openapi":"openapi-v2.json post /fees","title":"Create a fee","href":"/v2/reference/createfee"},{"openapi":"openapi-v2.json get /fees/{fee_id}","title":"Get Fee","href":"/v2/reference/getfee"},{"openapi":"openapi-v2.json post /fees/{fee_id}/reverse","title":"Reverse a fee","href":"/v2/reference/reversefee"}]},{"group":"Fee Products","pages":[{"openapi":"openapi-v2.json get /fee_products","title":"List fee products","href":"/v2/reference/listfeeproducts"},{"openapi":"openapi-v2.json post /fee_products","title":"Create a fee product","href":"/v2/reference/createfeeproduct"},{"openapi":"openapi-v2.json get /fee_products/{fee_product_id}","title":"Get a fee product","href":"/v2/reference/getfeeproduct"},{"openapi":"openapi-v2.json patch /fee_products/{fee_product_id}","title":"Update a fee product","href":"/v2/reference/updatefeeproduct"},{"openapi":"openapi-v2.json get /fee_configs","title":"List fee configs","href":"/v2/reference/listfeeconfigs"},{"openapi":"openapi-v2.json post /fee_configs","title":"Create a fee config","href":"/v2/reference/createfeeconfig"},{"openapi":"openapi-v2.json get /fee_configs/{fee_config_id}","title":"Get a fee config","href":"/v2/reference/getfeeconfig"},{"openapi":"openapi-v2.json patch /fee_configs/{fee_config_id}","title":"Update a fee config","href":"/v2/reference/updatefeeconfig"},{"openapi":"openapi-v2.json get /fee_categories","title":"List fee categories","href":"/v2/reference/listfeecategories"}]},{"group":"Batch Payments","pages":[{"openapi":"openapi-v2.json get /batch_templates","title":"Get Batch Payment Templates","href":"/v2/reference/getbatchpaymenttemplates"},{"openapi":"openapi-v2.json post /batch_templates","title":"Create Batch Payment Template","href":"/v2/reference/createbatchpaymenttemplate"},{"openapi":"openapi-v2.json get /batch_templates/{id}","title":"Get Batch Payment Template","href":"/v2/reference/getbatchpaymenttemplate"},{"openapi":"openapi-v2.json patch /batch_templates/{id}","title":"Update Batch Payment Template","href":"/v2/reference/updatebatchpaymenttemplate"},{"openapi":"openapi-v2.json get /batches","title":"Get Batch Payments","href":"/v2/reference/getbatchpayments"},{"openapi":"openapi-v2.json post /batches","title":"Create Batch Payments","href":"/v2/reference/createbatchpayments"},{"openapi":"openapi-v2.json get /batches/{id}","title":"Get BatchPayment","href":"/v2/reference/getbatchpayment"},{"openapi":"openapi-v2.json patch /batches/{id}","title":"Update Batch Payment","href":"/v2/reference/updatebatchpayment"}]},{"group":"Payments","pages":[{"openapi":"openapi-v2.json get /payments","title":"List payments","href":"/v2/reference/listmadepayments"},{"openapi":"openapi-v2.json post /payments","title":"Make a payment","href":"/v2/reference/makepayment"},{"openapi":"openapi-v2.json get /payments/{payment_id}","title":"Get payment","href":"/v2/reference/getpayment"},{"openapi":"openapi-v2.json patch /payments/{payment_id}","title":"Update payment","href":"/v2/reference/patchpayment"}]},{"group":"Cash Orders and Deposits (alpha)","pages":[{"openapi":"openapi-v2.json get /cash","title":"Get cash transfers","href":"/v2/reference/getcashtransfers"},{"openapi":"openapi-v2.json get /cash/authorization","title":"Get cash authorizations","href":"/v2/reference/getcashauthorizations"},{"openapi":"openapi-v2.json post /cash/authorization","title":"Cash Authorization for an upcoming transfer","href":"/v2/reference/createcashauthorization"},{"openapi":"openapi-v2.json get /cash/authorization/{id}","title":"Get cash order authorization","href":"/v2/reference/getcashorderauthorization"},{"openapi":"openapi-v2.json patch /cash/authorization/{id}","title":"Update a cash order authorization","href":"/v2/reference/patchcashorderauthorization"},{"openapi":"openapi-v2.json get /cash/{id}","title":"Get cash transfer","href":"/v2/reference/getcashtransfer"},{"openapi":"openapi-v2.json patch /cash/{id}","title":"Update a cash transfer","href":"/v2/reference/patchcashtransfer"}]},{"group":"In-Store Cash Deposits","pages":[{"openapi":"openapi-v2.json POST /cash/barcodes","title":"Create a barcode for a cash transaction","href":"/v2/reference/createbarcode"},{"openapi":"openapi-v2.json GET /cash/barcodes","title":"Get a list of barcodes","href":"/v2/reference/getbarcodes"},{"openapi":"openapi-v2.json GET /cash/barcodes/{barcode_id}","title":"Get a barcode","href":"/v2/reference/getbarcode"},{"openapi":"openapi-v2.json PATCH /cash/barcodes/{barcode_id}","title":"Update a barcode","href":"/v2/reference/updatebarcode"},{"openapi":"openapi-v2.json GET /cash/barcodes/retailer_map_url","title":"Get the available retailer map URL.","href":"/v2/reference/getretailermapurl"}]},{"group":"Wires","pages":[{"openapi":"openapi-v2.json get /wires","title":"List outgoing wires","href":"/v2/reference/listwires"},{"openapi":"openapi-v2.json post /wires","title":"Send a wire","href":"/v2/reference/createwire"},{"openapi":"openapi-v2.json get /wires/{wire_id}","title":"Get an outgoing wire by id","href":"/v2/reference/getwire"},{"openapi":"openapi-v2.json patch /wires/{wire_id}","title":"Cancel an outgoing wire","href":"/v2/reference/cancelwire"}]},{"group":"ACH","pages":[{"openapi":"openapi-v2.json get /ach","title":"List sent ACH transactions","href":"/v2/reference/listtransactionsout"},{"openapi":"openapi-v2.json post /ach","title":"Send an ACH","href":"/v2/reference/addtransactionout"},{"openapi":"openapi-v2.json get /ach/gateways","title":"List All Gateway Configurations","href":"/v2/reference/getallgatewayconfigs"},{"openapi":"openapi-v2.json post /ach/gateways","title":"Create New Gateway Endpoint Configuration","href":"/v2/reference/addgatewayconfig"},{"openapi":"openapi-v2.json delete /ach/gateways/{id}","title":"Delete Gateway Endpoint Configuration by ID","href":"/v2/reference/deletegatewayconfigbyid"},{"openapi":"openapi-v2.json get /ach/gateways/{id}","title":"Get Gateway Endpoint Configuration By ID","href":"/v2/reference/getgatewayconfigbyid"},{"openapi":"openapi-v2.json patch /ach/gateways/{id}","title":"Update Gateway Endpoint Configuration By ID","href":"/v2/reference/patchgatewayconfigbyid"},{"openapi":"openapi-v2.json get /ach/incoming","title":"List Incoming ACH Transactions","href":"/v2/reference/getincomingachlist"},{"openapi":"openapi-v2.json get /ach/incoming/{id}","title":"Get Incoming ACH Transaction By ID","href":"/v2/reference/getincomingachbyid"},{"openapi":"openapi-v2.json get /ach/{transaction_id}","title":"Get a sent ACH transaction","href":"/v2/reference/gettransactionout"},{"openapi":"openapi-v2.json patch /ach/{transaction_id}","title":"Update a sent ACH transaction","href":"/v2/reference/patchtransactionout"}]},{"group":"PaymentSchedules","pages":[{"openapi":"openapi-v2.json get /payment_schedules","title":"List payment schedules","href":"/v2/reference/listpaymentschedules"},{"openapi":"openapi-v2.json post /payment_schedules","title":"Create a payment schedule","href":"/v2/reference/createpaymentschedule"},{"openapi":"openapi-v2.json get /payment_schedules/payments","title":"List payments","href":"/v2/reference/listpayments"},{"openapi":"openapi-v2.json patch /payment_schedules/{payment_schedule_id}","title":"Update a payment schedule","href":"/v2/reference/patchpaymentschedule"}]},{"group":"Remote Check Deposit","pages":[{"openapi":"openapi-v2.json get /rdc/deposits","title":"List Remote Check Deposits","href":"/v2/reference/listrdcdeposits"},{"openapi":"openapi-v2.json post /rdc/deposits","title":"Create a Remote Check Deposit","href":"/v2/reference/createrdcdeposit"},{"openapi":"openapi-v2.json get /rdc/deposits/{deposit_id}","title":"Get Remote Check Deposit","href":"/v2/reference/getrdcdeposit"}]},{"group":"Internal Transfer","pages":[{"openapi":"openapi-v2.json post /transactions/internal_transfer","title":"Create an internal transfer","href":"/v2/reference/createinternaltransfer"},{"openapi":"openapi-v2.json get /transactions/internal_transfer/{id}","title":"Get an internal transfer","href":"/v2/reference/getinternaltransferbyid"},{"openapi":"openapi-v2.json patch /transactions/internal_transfer/{id}","title":"Update an internal transfer","href":"/v2/reference/updateinternaltransferbyid"}]},{"group":"Incoming Wires","pages":[{"openapi":"openapi-v2.json get /wires/incoming","title":"List incoming wires","href":"/v2/reference/listincomingwires"},{"openapi":"openapi-v2.json get /wires/incoming/{wire_id}","title":"Get incoming wire by id","href":"/v2/reference/getincomingwire"},{"openapi":"openapi-v2.json patch /wires/incoming/{wire_id}","title":"Update an incoming wire by id","href":"/v2/reference/patchincomingwire"}]},{"group":"Outgoing SyncteraPay","pages":[{"openapi":"openapi-v2.json post /synctera_pay","title":"Create Synctera Pay Transfer","href":"/v2/reference/createsyncterapaytransfer"},{"openapi":"openapi-v2.json get /synctera_pay","title":"Get Outgoing Synctera Pay Transfers","href":"/v2/reference/getsyncterapaytransfers"},{"openapi":"openapi-v2.json get /synctera_pay/{id}","title":"Get Outgoing Synctera Pay Transfer","href":"/v2/reference/getsyncterapaytransfer"},{"openapi":"openapi-v2.json patch /synctera_pay/{id}","title":"Update an Outgoing Synctera Pay Transfer","href":"/v2/reference/updatesyncterapaytransfer"},{"openapi":"openapi-v2.json post /synctera_pay/{id}/return","title":"Return a Synctera Pay Transfer","href":"/v2/reference/returnsyncterapaytransfer"},{"openapi":"openapi-v2.json get /synctera_pay/configurations","title":"Get Outgoing Synctera Pay Configurations","href":"/v2/reference/getsyncterapayconfigurations"},{"openapi":"openapi-v2.json get /synctera_pay/configurations/{id}","title":"Get Outgoing Synctera Pay Configuration","href":"/v2/reference/getsyncterapayconfiguration"},{"openapi":"openapi-v2.json get /synctera_pay/vendors","title":"List Outgoing Synctera Pay vendors","href":"/v2/reference/getsyncterapayvendors"},{"openapi":"openapi-v2.json get /synctera_pay/vendors/{id}","title":"Get an Outgoing Synctera Pay vendor","href":"/v2/reference/getsyncterapayvendor"}]},{"group":"Incoming SyncteraPay","pages":[{"openapi":"openapi-v2.json post /synctera_pay/incoming/transfers","title":"Create Incoming Synctera Pay Transfer","href":"/v2/reference/createincomingsyncterapaytransfer"},{"openapi":"openapi-v2.json get /synctera_pay/incoming/transfers","title":"List Incoming Synctera Pay Transfers","href":"/v2/reference/listincomingsyncterapaytransfers"},{"openapi":"openapi-v2.json get /synctera_pay/incoming/transfers/{id}","title":"Get Incoming Synctera Pay Transfer","href":"/v2/reference/getincomingsyncterapaytransfer"},{"openapi":"openapi-v2.json get /synctera_pay/incoming/configurations/{id}","title":"Get Incoming Synctera Pay Configuration","href":"/v2/reference/getincomingsyncterapayconfiguration"},{"openapi":"openapi-v2.json get /synctera_pay/incoming/configurations","title":"List Incoming Synctera Pay Configurations","href":"/v2/reference/listincomingsyncterapayconfigurations"}]}]},{"group":"Transactions","pages":[{"group":"Disputes","pages":[{"openapi":"openapi-v2.json get /disputes","title":"List disputes","href":"/v2/reference/listdisputes"},{"openapi":"openapi-v2.json post /disputes","title":"Dispute a transaction","href":"/v2/reference/createdispute"},{"openapi":"openapi-v2.json get /disputes/documents/{document_id}/contents","title":"Get dispute document contents","href":"/v2/reference/getdisputedocumentcontents"},{"openapi":"openapi-v2.json get /disputes/{dispute_id}","title":"Get a Dispute","href":"/v2/reference/getdispute"},{"openapi":"openapi-v2.json patch /disputes/{dispute_id}","title":"Update a dispute","href":"/v2/reference/updatedispute"},{"openapi":"openapi-v2.json post /disputes/{dispute_id}/actions","title":"Create a dispute action","href":"/v2/reference/createaction"},{"openapi":"openapi-v2.json post /disputes/{dispute_id}/documents","title":"Add a document to a dispute","href":"/v2/reference/adddisputedocument"}]},{"group":"Merchants","pages":[{"openapi":"openapi-v2.json get /mx/merchants/{merchant_guid}","title":"Get merchant from MX","href":"/v2/reference/mxreadmerchant"}]},{"group":"Transactions","pages":[{"openapi":"openapi-v2.json get /transactions/batchable","title":"Get Transactions From Batch Payments Templates","href":"/v2/reference/gettransactionsbatchpayments"},{"openapi":"openapi-v2.json get /transactions/pending","title":"List pending transactions","href":"/v2/reference/listpendingtransactions"},{"openapi":"openapi-v2.json get /transactions/pending/{id}","title":"Get a pending transaction","href":"/v2/reference/getpendingtransactionbyid"},{"openapi":"openapi-v2.json get /transactions/posted","title":"List posted transactions","href":"/v2/reference/listpostedtransactions"},{"openapi":"openapi-v2.json get /transactions/posted/{id}","title":"Get a posted transaction","href":"/v2/reference/getpostedtransactionbyid"}]}]},{"group":"Platform","pages":[{"group":"Webhooks","pages":[{"openapi":"openapi-v2.json delete /webhook_secrets","title":"Revoke the secret","href":"/v2/reference/revokesecret"},{"openapi":"openapi-v2.json post /webhook_secrets","title":"Create a secret","href":"/v2/reference/createsecret"},{"openapi":"openapi-v2.json put /webhook_secrets","title":"Replace an existing secret","href":"/v2/reference/replacesecret"},{"openapi":"openapi-v2.json get /webhooks","title":"List webhooks","href":"/v2/reference/listwebhooks"},{"openapi":"openapi-v2.json post /webhooks","title":"Create a webhook","href":"/v2/reference/createwebhook"},{"openapi":"openapi-v2.json post /webhooks/trigger","title":"Trigger an event","href":"/v2/reference/triggerevent"},{"openapi":"openapi-v2.json delete /webhooks/{webhook_id}","title":"Delete a webhook","href":"/v2/reference/deletewebhook"},{"openapi":"openapi-v2.json get /webhooks/{webhook_id}","title":"Get a webhook","href":"/v2/reference/getwebhook"},{"openapi":"openapi-v2.json put /webhooks/{webhook_id}","title":"Update a webhook","href":"/v2/reference/updatewebhook"},{"openapi":"openapi-v2.json get /webhooks/{webhook_id}/events","title":"List webhook events","href":"/v2/reference/listevents"},{"openapi":"openapi-v2.json get /webhooks/{webhook_id}/events/{event_id}","title":"Get webhook event","href":"/v2/reference/getevent"},{"openapi":"openapi-v2.json post /webhooks/{webhook_id}/events/{event_id}/resend","title":"Resend an event","href":"/v2/reference/resendevent"}]},{"group":"Documents","pages":[{"openapi":"openapi-v2.json get /documents","title":"List documents","href":"/v2/reference/listdocuments"},{"openapi":"openapi-v2.json post /documents","title":"Create a document","href":"/v2/reference/createdocument"},{"openapi":"openapi-v2.json delete /documents/{document_id}","title":"Delete a document","href":"/v2/reference/deletedocument"},{"openapi":"openapi-v2.json get /documents/{document_id}","title":"Get a document","href":"/v2/reference/getdocument"},{"openapi":"openapi-v2.json patch /documents/{document_id}","title":"Update a document","href":"/v2/reference/updatedocument"},{"openapi":"openapi-v2.json get /documents/{document_id}/contents","title":"Get contents of latest document version","href":"/v2/reference/getdocumentcontents"},{"openapi":"openapi-v2.json post /documents/{document_id}/versions","title":"Create a new document version","href":"/v2/reference/createdocumentversion"},{"openapi":"openapi-v2.json get /documents/{document_id}/versions/{document_version}/contents","title":"Get document contents by version","href":"/v2/reference/getdocumentversion"},{"openapi":"openapi-v2.json get /documents/{document_id}/versions/{document_version}","title":"Get a document by version","href":"/v2/reference/getdocumentversioncontents"}]},{"group":"Notes","pages":[{"openapi":"openapi-v2.json get /notes","title":"List notes","href":"/v2/reference/listnotes"},{"openapi":"openapi-v2.json post /notes","title":"Create a note","href":"/v2/reference/createnote"},{"openapi":"openapi-v2.json patch /notes/{note_id}","title":"Patch Note","href":"/v2/reference/patchnote"}]},{"group":"Cases","pages":[{"title":"List cases","openapi":"openapi-v2.json get /cases","href":"/v2/reference/listcases"},{"title":"Get case","openapi":"openapi-v2.json get /cases/{id}","href":"/v2/reference/getcase"}]},{"group":"Institutions","pages":[{"openapi":"openapi-v2.json get /institutions","title":"Retrieve a list of institutions","href":"/v2/reference/getinstitutions"}]},{"group":"EDD","pages":[{"openapi":"openapi-v2.json get /edd","title":"List EDD","href":"/v2/reference/listedd"},{"openapi":"openapi-v2.json post /edd","title":"Create a EDD","href":"/v2/reference/createedd"},{"openapi":"openapi-v2.json delete /edd/{edd_id}","title":"Delete a EDD","href":"/v2/reference/deleteedd"},{"openapi":"openapi-v2.json get /edd/{edd_id}","title":"Get a EDD","href":"/v2/reference/getedd"}]},{"group":"Migration Mappings","pages":[{"openapi":"openapi-v2.json get /migration_mappings","title":"List migration mappings","href":"/v2/reference/listmigrationmappings"},{"openapi":"openapi-v2.json post /migration_mappings","title":"Create a migration mapping","href":"/v2/reference/createmigrationmapping"},{"openapi":"openapi-v2.json get /migration_mappings/{mapping_id}","title":"Get migration mapping","href":"/v2/reference/getmigrationmapping"},{"openapi":"openapi-v2.json patch /migration_mappings/{mapping_id}","title":"Update migration mapping","href":"/v2/reference/updatemigrationmapping"},{"openapi":"openapi-v2.json delete /migration_mappings/{mapping_id}","title":"Delete migration mapping","href":"/v2/reference/deletemigrationmapping"}]},{"group":"Sandbox Wipe","pages":[{"openapi":"openapi-v2.json post /wipe","title":null,"href":"/v2/reference/wipeworkspace"}]}]},{"group":"Simulations","pages":[{"group":"Card Webhook Simulations","pages":[{"openapi":"openapi-v2.json post /cards/{card_id}/webhook_simulations/fulfillment","title":"Simulate Card Fulfillment Event","href":"/v2/reference/simulatecardfulfillmentevent"}]},{"group":"ACH Transaction Simulations","pages":[{"openapi":"openapi-v2.json post /ach/transaction_simulations/receiving_return","title":"Simulate receiving ACH return","href":"/v2/reference/achreturnsimulation"},{"openapi":"openapi-v2.json post /ach/transaction_simulations/receiving_transaction","title":"Simulate receiving ACH transaction","href":"/v2/reference/achtransactionsimulation"}]},{"group":"Wire Transaction Simulations","pages":[{"openapi":"openapi-v2.json post /wires/transaction_simulations/receiving_return","title":"Simulate receiving Wire transfer return","href":"/v2/reference/wirereturnsimulation"},{"openapi":"openapi-v2.json post /wires/transaction_simulations/receiving_transaction","title":"Simulate receiving Wire transaction","href":"/v2/reference/wiretransactionsimulation"}]},{"group":"Card Transaction Simulations","pages":[{"openapi":"openapi-v2.json post /cards/transaction_simulations/authorization","title":"Simulate authorization","href":"/v2/reference/simulateauthorization"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/authorization/advice","title":"Simulate authorization advice","href":"/v2/reference/simulateauthorizationadvice"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/clearing","title":"Simulate clearing or refund","href":"/v2/reference/simulateclearing"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/clearing/l2l3","title":"Simulate L2l3","href":"/v2/reference/simulatel2l3"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial","title":"Simulate financial","href":"/v2/reference/simulatefinancial"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial/advice","title":"Simulate financial advice","href":"/v2/reference/simulatefinancialadvice"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial/balance_inquiry","title":"Simulate balance inquiry","href":"/v2/reference/simulatebalanceinquiry"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial/original_credit","title":"Simulate OCT","href":"/v2/reference/simulateoriginalcredit"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/financial/withdrawal","title":"Simulate ATM withdrawal","href":"/v2/reference/simulatewithdrawal"},{"openapi":"openapi-v2.json post /cards/transaction_simulations/reversal","title":"Simulate reversal","href":"/v2/reference/simulatereversal"}]},{"group":"Dispute Simulations (beta)","pages":[{"openapi":"openapi-v2.json post /disputes/simulations/{dispute_id}/actions","title":"Simulate a network dispute action","href":"/v2/reference/simulatedisputeaction"}]},{"group":"In-Store Cash Deposit Simulations","pages":[{"openapi":"openapi-v1.json get /cash/transaction_simulations/barcodes/stores","title":"Retrieve Store Information for Barcode Simulation","href":"/v2/reference/simulatebarcodesstores"},{"openapi":"openapi-v1.json post /cash/transaction_simulations/barcodes/deposits","title":"Create a cash deposit transaction simulation for a barcode","href":"/v2/reference/simulatebarcodesdeposits"}]}]}]},{"tab":"Learning Center","pages":[{"title":"Learning Center","href":"/docs/learning-center"}]}]},{"version":"v0","pages":[{"title":"v0","href":"/reference/activatecard"}]},{"version":"v1","pages":[{"title":"v1","href":"/v1/reference/activatecard"}]}]},"basePath":"","title":"Activate a card - Synctera","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}