[{"_1":2,"_905":-5,"_906":-5},"loaderData",{"_3":4,"_904":-5},"root",{"_5":1,"_6":7,"_28":29,"_32":-7,"_33":34,"_51":52,"_108":109,"_152":153,"_900":901},"type","meta",[8,15,18,23,26],{"_9":10,"_11":12,"_13":14},"tagName","link","rel","icon","href","https://assets.apidog.com/app/project-icon/builtin/20.jpg",{"_9":10,"_11":16,"_13":17},"canonical","https://docs.confirmapay.com/doc-901890",{"_19":20,"_21":22},"name","description","content","Retain24 Developers' Guide - Confirma Payment Platform",{"_19":24,"_21":25},"keywords","Retain24 Developers' Guide, Confirma Payment Platform, API Design, API Specification, API Test, API Documentation, API Mock",{"_27":22},"title","i18nState",{"_30":31},"clientLocale","en-US","errorCodeMessage","clientConfig",{"_35":36,"_37":38,"_39":40,"_41":42,"_47":48,"_49":50},"apiBaseUrl","https://api.apidog.com","appWebUrl","https://app.apidog.com","apidocBuiltinPrefixPath","https://assets.apidog.com/app/static/apidoc","cloudMockBaseUrls",{"_43":44,"_45":46},"pathMode","https://mock.apidog.com/m1/{projectId}-{version}-{service}","idMode","https://mock.apidog.com/m2/{projectId}-{version}-{service}","apidocIsShowLogo",true,"webhookGenerateCodeDefaultUrl","https://your-api-server.com","urlConfig",{"_53":54,"_12":57,"_95":96,"_104":105},"home",{"_55":56},"index","https://apidog.com",{"_58":59,"_60":61,"_62":61,"_63":64,"_65":66,"_67":68,"_69":70,"_71":72,"_73":74,"_75":76,"_77":78,"_79":80,"_81":82,"_83":84,"_85":86,"_87":88,"_89":90,"_91":92,"_93":94},"apidoc","https://assets.apidog.com/app/static/brand/apidoc.png","apidog","https://assets.apidog.com/app/static/brand/apidog-logo-256.png","apidog europe","googleDiscovery","https://assets.apidog.com/app/static/brand/google-discovery.png","har","https://assets.apidog.com/app/static/brand/har.png","iodocs","https://assets.apidog.com/app/static/brand/io-doc.png","jmeter","https://assets.apidog.com/app/static/brand/jmeter.png","openapi","https://assets.apidog.com/app/static/brand/openapi.png","postman","https://assets.apidog.com/app/static/brand/postman.png","raml","https://assets.apidog.com/app/static/brand/raml.png","wadl","https://assets.apidog.com/app/static/brand/wadl.png","curl","https://assets.apidog.com/app/static/brand/curl.png","insomnia","https://assets.apidog.com/app/static/brand/insomnia.png","wsdl","https://assets.apidog.com/app/static/brand/wsdl.png","markdown","https://assets.apidog.com/app/static/brand/markdown.png","html","https://assets.apidog.com/app/static/brand/html.png","protobuf","https://assets.apidog.com/app/static/brand/protobuf.png","soapui","https://assets.apidog.com/app/static/brand/soapui.svg","javaProject","https://assets.apidog.com/app/static/brand/java-project.png","help",{"_55":97,"_98":99,"_100":101,"_102":103},"https://apidog.com/help","browserExtension","https://chromewebstore.google.com/detail/apidog-browser-extension/dmhljjnonlhapikmelaefohecogokhio","csv","https://apidog.com/help/reference/csv","appMcpServer","https://docs.apidog.com/apidog-mcp-server","assets",{"_106":107},"logo512Png","https://assets.apidog.com/static/logo/apidog-logo-512.png","envConfig",{"_110":58,"_111":112,"_113":112,"_114":115,"_116":117,"_118":119,"_120":56,"_121":60,"_122":31,"_123":124,"_125":126,"_128":129,"_130":131,"_132":133,"_134":135,"_136":137,"_138":139,"_145":146,"_147":48,"_148":149,"_150":151},"RELEASE_BASE","DEBUG_API_BASE","","DEBUG_WEB_URL_BASE","AGENT_SERVER_API_BASE","https://web-proxy.apidog.com","APP_REGION","GLOBAL","APP_NAME","Apidog","APP_HOMEPAGE","APP_NAME_LOWER","DEFAULT_LOCALE","APP_BROWSER_EXTENSION_ADAPTER","apidogAgentCrossRequest","APP_API_SERVER_HOSTNAMES",[127],"api.apidog.com","APP_SUPPORT_EMAIL","support@apidog.com","APP_SCRIPT_MAIN_OBJECTS","$","SERVER_PROTOCOL","http","SERVER_HOST","apidog-api-svc","DEFAULT_DOC_LAYOUT","TwoColumn","NOT_CUSTOM_DOMAIN_HOSTNAMES",[140,141,142,143,144],"www.apidog.com","apidog.com","www.apidog.io","apidog.io","share.apidog.com","SERVER_REQUEST_TIMEOUT",15000,"IS_SHARED_DOC_INDEPENDENT_DOMAIN","APIDOC_CUSTOM_DOMAIN_CNAME_REGEX",["R","\\d+\\.cname\\.apidog\\.com",""],"IS_ALWAYS_USE_ORIGIN_FETCH",false,"docsDataState",{"_154":155,"_157":158,"_657":658,"_729":730,"_735":736,"_769":770,"_782":783,"_784":785,"_786":787,"_815":816,"_877":878,"_879":880,"_888":889,"_890":891,"_894":895,"_897":898},"navigation",{"_5":156},"NONE","sidebarTree",{"_159":-7,"_160":-7,"_161":162,"_163":164,"_649":650,"_651":652,"_653":654,"_655":656},"goBackSidebarTreeApiFolderNode","rootSidebarTreeApiFolderNode","homeLink","/","sidebarTreeList",[165,180,186,192,198,204,210,216,222,228],{"_5":166,"_167":168,"_19":169,"_170":171,"_172":173,"_174":-7,"_175":176,"_12":-7,"_177":178,"_179":151},"doc","id",571637,"Developer Guide","key","doc.571637","parentId",0,"resourceName","tags",[],"to","/doc-571637","selected",{"_5":166,"_167":181,"_19":182,"_170":183,"_172":173,"_174":-7,"_175":184,"_12":-7,"_177":185,"_179":151},1758811,"Changelog","doc.1758811",[],"/doc-1758811",{"_5":166,"_167":187,"_19":188,"_170":189,"_172":173,"_174":-7,"_175":190,"_12":-7,"_177":191,"_179":151},829849,"Basic Flow Guide","doc.829849",[],"/doc-829849",{"_5":166,"_167":193,"_19":194,"_170":195,"_172":173,"_174":-7,"_175":196,"_12":-7,"_177":197,"_179":151},829653,"Viva Developers' Guide","doc.829653",[],"/doc-829653",{"_5":166,"_167":199,"_19":200,"_170":201,"_172":173,"_174":-7,"_175":202,"_12":-7,"_177":203,"_179":151},835045,"Epassi Developers' Guide","doc.835045",[],"/doc-835045",{"_5":166,"_167":205,"_19":206,"_170":207,"_172":173,"_174":-7,"_175":208,"_12":-7,"_177":209,"_179":48},901890,"Retain24 Developers' Guide","doc.901890",[],"/doc-901890",{"_5":166,"_167":211,"_19":212,"_170":213,"_172":173,"_174":-7,"_175":214,"_12":-7,"_177":215,"_179":151},1044403,"Resurs Developers' Guide","doc.1044403",[],"/doc-1044403",{"_5":166,"_167":217,"_19":218,"_170":219,"_172":173,"_174":-7,"_175":220,"_12":-7,"_177":221,"_179":151},1367244,"SoftPay Developers' Guide","doc.1367244",[],"/doc-1367244",{"_5":166,"_167":223,"_19":224,"_170":225,"_172":173,"_174":-7,"_175":226,"_12":-7,"_177":227,"_179":151},1618653,"Nexi Developers' Guide","doc.1618653",[],"/doc-1618653",{"_5":229,"_230":231,"_167":232,"_19":233,"_170":234,"_235":236,"_241":242,"_172":173,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":648,"_179":151,"_265":48},"apiDetailFolder","docId",571635,1600952,"v1","apiDetailFolder.1600952","shareSettings",{"_237":238,"_239":240},"directoryTreeDisplayStyle","GENERAL_FOLDER","folderContentsDisplayingSettings","CUSTOM_CONTENT","children",[243,266,280,299,361,381,476,495,556,569,598],{"_5":229,"_230":173,"_167":244,"_19":245,"_170":246,"_235":247,"_241":249,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},4127051,"Authentication","apiDetailFolder.4127051",{"_237":238,"_239":248},"HIDE",[250],{"_5":251,"_167":252,"_19":253,"_170":254,"_255":256,"_257":258,"_259":260,"_172":244,"_174":-7,"_175":261,"_20":-7,"_262":133,"_12":-7,"_177":263,"_179":151},"apiDetail",10817083,"Obtain a token","apiDetail.10817083","method","post","path","/{tenantCode}/v1/auth/token","status","released",[245],"apiType","/api-10817083","folderType","expanded",{"_5":229,"_230":173,"_167":267,"_19":268,"_170":269,"_235":270,"_241":271,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},4127052,"Callback","apiDetailFolder.4127052",{"_237":238,"_239":248},[272],{"_5":251,"_167":273,"_19":274,"_170":275,"_255":276,"_257":277,"_259":260,"_172":267,"_174":-7,"_175":278,"_20":-7,"_262":133,"_12":-7,"_177":279,"_179":151},12954229,"Redirect transaction flow","apiDetail.12954229","get","/{tenantCode}/v1/callback/viva",[268],"/api-12954229",{"_5":229,"_230":173,"_167":281,"_19":282,"_170":283,"_235":284,"_241":285,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},4127053,"Device","apiDetailFolder.4127053",{"_237":238,"_239":248},[286,293],{"_5":251,"_167":287,"_19":288,"_170":289,"_255":276,"_257":290,"_259":260,"_172":281,"_174":-7,"_175":291,"_20":-7,"_262":133,"_12":-7,"_177":292,"_179":151},12937996,"Terminal device details","apiDetail.12937996","/{tenantCode}/v1/device/terminal",[282],"/api-12937996",{"_5":251,"_167":294,"_19":295,"_170":296,"_255":276,"_257":295,"_259":260,"_172":281,"_174":-7,"_175":297,"_20":-7,"_262":133,"_12":-7,"_177":298,"_179":151},24614488,"/{tenantCode}/v1/device/configuration","apiDetail.24614488",[282],"/api-24614488",{"_5":229,"_230":173,"_167":300,"_19":301,"_170":302,"_235":303,"_241":304,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},4127054,"GiftCard","apiDetailFolder.4127054",{"_237":238,"_239":248},[305,312,319,326,334,341,347,354],{"_5":251,"_167":306,"_19":307,"_170":308,"_255":276,"_257":309,"_259":260,"_172":300,"_174":-7,"_175":310,"_20":-7,"_262":133,"_12":-7,"_177":311,"_179":151},15293583,"Get the available templates","apiDetail.15293583","/{tenantCode}/v1/gift-card/payment-channel/{paymentChannelId}/templates",[301],"/api-15293583",{"_5":251,"_167":313,"_19":314,"_170":315,"_255":276,"_257":316,"_259":260,"_172":300,"_174":-7,"_175":317,"_20":-7,"_262":133,"_12":-7,"_177":318,"_179":151},15293584,"Get template by Id","apiDetail.15293584","/{tenantCode}/v1/gift-card/payment-channel/{paymentChannelId}/templates/{id}",[301],"/api-15293584",{"_5":251,"_167":320,"_19":321,"_170":322,"_255":256,"_257":323,"_259":260,"_172":300,"_174":-7,"_175":324,"_20":-7,"_262":133,"_12":-7,"_177":325,"_179":151},15293585,"Create and Issue a Card","apiDetail.15293585","/{tenantCode}/v1/gift-card/payment-channel/{paymentChannelId}",[301],"/api-15293585",{"_5":251,"_167":327,"_19":328,"_170":329,"_255":330,"_257":331,"_259":260,"_172":300,"_174":-7,"_175":332,"_20":-7,"_262":133,"_12":-7,"_177":333,"_179":151},15293586,"Top Up a Card","apiDetail.15293586","patch","/{tenantCode}/v1/gift-card/{cardId}/payment-channel/{paymentChannelId}/top-up",[301],"/api-15293586",{"_5":251,"_167":335,"_19":336,"_170":337,"_255":276,"_257":338,"_259":260,"_172":300,"_174":-7,"_175":339,"_20":-7,"_262":133,"_12":-7,"_177":340,"_179":151},15293587,"Get a Card","apiDetail.15293587","/{tenantCode}/v1/gift-card/{cardId}/payment-channel/{paymentChannelId}",[301],"/api-15293587",{"_5":251,"_167":342,"_19":343,"_170":344,"_255":256,"_257":338,"_259":260,"_172":300,"_174":-7,"_175":345,"_20":-7,"_262":133,"_12":-7,"_177":346,"_179":151},15293588,"Validate a Card","apiDetail.15293588",[301],"/api-15293588",{"_5":251,"_167":348,"_19":349,"_170":350,"_255":351,"_257":338,"_259":260,"_172":300,"_174":-7,"_175":352,"_20":-7,"_262":133,"_12":-7,"_177":353,"_179":151},15293589,"Cancel a card","apiDetail.15293589","delete",[301],"/api-15293589",{"_5":251,"_167":355,"_19":356,"_170":357,"_255":351,"_257":358,"_259":260,"_172":300,"_174":-7,"_175":359,"_20":-7,"_262":133,"_12":-7,"_177":360,"_179":151},15293590,"Cancel the last topup of the card","apiDetail.15293590","/{tenantCode}/v1/gift-card/{cardId}/payment-channel/{paymentChannelId}/last-topup",[301],"/api-15293590",{"_5":229,"_230":173,"_167":362,"_19":363,"_170":364,"_235":365,"_241":366,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},4127055,"Payment","apiDetailFolder.4127055",{"_237":238,"_239":248},[367,374],{"_5":251,"_167":368,"_19":369,"_170":370,"_255":256,"_257":371,"_259":260,"_172":362,"_174":-7,"_175":372,"_20":-7,"_262":133,"_12":-7,"_177":373,"_179":151},10817084,"Create a new payment request","apiDetail.10817084","/{tenantCode}/v1/payment",[363],"/api-10817084",{"_5":251,"_167":375,"_19":376,"_170":377,"_255":256,"_257":378,"_259":260,"_172":362,"_174":-7,"_175":379,"_20":-7,"_262":133,"_12":-7,"_177":380,"_179":151},21774035,"Marks the day end","apiDetail.21774035","/{tenantCode}/v1/payment/eod",[363],"/api-21774035",{"_5":229,"_230":173,"_167":382,"_19":383,"_170":384,"_235":385,"_241":386,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},4127056,"PaymentChannel","apiDetailFolder.4127056",{"_237":238,"_239":248},[387,394,401,408,415,422,429,436,443,450,457,464,470],{"_5":251,"_167":388,"_19":389,"_170":390,"_255":276,"_257":391,"_259":260,"_172":382,"_174":-7,"_175":392,"_20":-7,"_262":133,"_12":-7,"_177":393,"_179":151},20179847,"Get payment channel merchants","apiDetail.20179847","/{tenantCode}/v1/payment-channel/{paymentChannelId}/merchants",[383],"/api-20179847",{"_5":251,"_167":395,"_19":396,"_170":397,"_255":276,"_257":398,"_259":260,"_172":382,"_174":-7,"_175":399,"_20":-7,"_262":133,"_12":-7,"_177":400,"_179":151},21650605,"Get available payment channels","apiDetail.21650605","/{tenantCode}/v1/payment-channel/available",[383],"/api-21650605",{"_5":251,"_167":402,"_19":403,"_170":404,"_255":276,"_257":405,"_259":260,"_172":382,"_174":-7,"_175":406,"_20":-7,"_262":133,"_12":-7,"_177":407,"_179":151},21650606,"Get configured payment channels","apiDetail.21650606","/{tenantCode}/v1/payment-channel",[383],"/api-21650606",{"_5":251,"_167":409,"_19":410,"_170":411,"_255":276,"_257":412,"_259":260,"_172":382,"_174":-7,"_175":413,"_20":-7,"_262":133,"_12":-7,"_177":414,"_179":151},21650607,"Get payment channel configuration requirements","apiDetail.21650607","/{tenantCode}/v1/payment-channel/{paymentChannelId}/configuration-requirements",[383],"/api-21650607",{"_5":251,"_167":416,"_19":417,"_170":418,"_255":256,"_257":419,"_259":260,"_172":382,"_174":-7,"_175":420,"_20":-7,"_262":133,"_12":-7,"_177":421,"_179":151},21650608,"Save payment channel configuration","apiDetail.21650608","/{tenantCode}/v1/payment-channel/{paymentChannelId}/configuration",[383],"/api-21650608",{"_5":251,"_167":423,"_19":424,"_170":425,"_255":256,"_257":426,"_259":260,"_172":382,"_174":-7,"_175":427,"_20":-7,"_262":133,"_12":-7,"_177":428,"_179":151},21774036,"Enable payment channel","apiDetail.21774036","/{tenantCode}/v1/payment-channel/{paymentChannelId}/enable",[383],"/api-21774036",{"_5":251,"_167":430,"_19":431,"_170":432,"_255":256,"_257":433,"_259":260,"_172":382,"_174":-7,"_175":434,"_20":-7,"_262":133,"_12":-7,"_177":435,"_179":151},21774037,"Disable payment channel","apiDetail.21774037","/{tenantCode}/v1/payment-channel/{paymentChannelId}/disable",[383],"/api-21774037",{"_5":251,"_167":437,"_19":438,"_170":439,"_255":256,"_257":440,"_259":260,"_172":382,"_174":-7,"_175":441,"_20":-7,"_262":133,"_12":-7,"_177":442,"_179":151},18213631,"Create a new account","apiDetail.18213631","/{tenantCode}/v1/payment-channel/{paymentChannelId}",[383],"/api-18213631",{"_5":251,"_167":444,"_19":445,"_170":446,"_255":276,"_257":447,"_259":260,"_172":382,"_174":-7,"_175":448,"_20":-7,"_262":133,"_12":-7,"_177":449,"_179":151},18213632,"Get payment channel stores","apiDetail.18213632","/{tenantCode}/v1/payment-channel/{paymentChannelId}/stores",[383],"/api-18213632",{"_5":251,"_167":451,"_19":452,"_170":453,"_255":276,"_257":454,"_259":260,"_172":382,"_174":-7,"_175":455,"_20":-7,"_262":133,"_12":-7,"_177":456,"_179":151},18213633,"Get payment method basic details","apiDetail.18213633","/{tenantCode}/v1/payment-channel/{paymentChannelId}/stores/{storeId}/payment-methods",[383],"/api-18213633",{"_5":251,"_167":458,"_19":459,"_170":460,"_255":276,"_257":461,"_259":260,"_172":382,"_174":-7,"_175":462,"_20":-7,"_262":133,"_12":-7,"_177":463,"_179":151},18213634,"Get payment method content","apiDetail.18213634","/{tenantCode}/v1/payment-channel/{paymentChannelId}/stores/{storeId}/payment-method/{paymentMethodId}/content",[383],"/api-18213634",{"_5":251,"_167":465,"_19":389,"_170":466,"_255":276,"_257":467,"_259":260,"_172":382,"_174":-7,"_175":468,"_20":-7,"_262":133,"_12":-7,"_177":469,"_179":151},21650609,"apiDetail.21650609","/{tenantCode}/v1/payment-channel/merchants",[383],"/api-21650609",{"_5":251,"_167":471,"_19":472,"_170":473,"_255":276,"_257":472,"_259":260,"_172":382,"_174":-7,"_175":474,"_20":-7,"_262":133,"_12":-7,"_177":475,"_179":151},24614489,"/{tenantCode}/v1/payment-channel/viva","apiDetail.24614489",[383],"/api-24614489",{"_5":229,"_230":173,"_167":477,"_19":478,"_170":479,"_235":480,"_241":481,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},4127057,"Report","apiDetailFolder.4127057",{"_237":238,"_239":248},[482,489],{"_5":251,"_167":483,"_19":484,"_170":485,"_255":276,"_257":486,"_259":260,"_172":477,"_174":-7,"_175":487,"_20":-7,"_262":133,"_12":-7,"_177":488,"_179":151},10851006,"Get End Of Day Reports","apiDetail.10851006","/{tenantCode}/v1/report/eod",[478],"/api-10851006",{"_5":251,"_167":490,"_19":491,"_170":492,"_255":256,"_257":486,"_259":260,"_172":477,"_174":-7,"_175":493,"_20":-7,"_262":133,"_12":-7,"_177":494,"_179":151},12048390,"Save End Of Day Reports","apiDetail.12048390",[478],"/api-12048390",{"_5":229,"_230":173,"_167":496,"_19":497,"_170":498,"_235":499,"_241":500,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},4127058,"Transaction","apiDetailFolder.4127058",{"_237":238,"_239":248},[501,508,515,521,528,535,542,549],{"_5":251,"_167":502,"_19":503,"_170":504,"_255":276,"_257":505,"_259":260,"_172":496,"_174":-7,"_175":506,"_20":-7,"_262":133,"_12":-7,"_177":507,"_179":151},20179850,"Get customer receipt for a transaction","apiDetail.20179850","/{tenantCode}/v1/transaction/{id}/receipt/customer",[497],"/api-20179850",{"_5":251,"_167":509,"_19":510,"_170":511,"_255":276,"_257":512,"_259":260,"_172":496,"_174":-7,"_175":513,"_20":-7,"_262":133,"_12":-7,"_177":514,"_179":151},10817086,"Get the transaction status","apiDetail.10817086","/{tenantCode}/v1/transaction/{id}",[497],"/api-10817086",{"_5":251,"_167":516,"_19":517,"_170":518,"_255":351,"_257":512,"_259":260,"_172":496,"_174":-7,"_175":519,"_20":-7,"_262":133,"_12":-7,"_177":520,"_179":151},10817087,"Cancel a transaction","apiDetail.10817087",[497],"/api-10817087",{"_5":251,"_167":522,"_19":523,"_170":524,"_255":256,"_257":525,"_259":260,"_172":496,"_174":-7,"_175":526,"_20":-7,"_262":133,"_12":-7,"_177":527,"_179":151},10817088,"Refund a transaction","apiDetail.10817088","/{tenantCode}/v1/transaction/{id}/refund",[497],"/api-10817088",{"_5":251,"_167":529,"_19":530,"_170":531,"_255":256,"_257":532,"_259":260,"_172":496,"_174":-7,"_175":533,"_20":-7,"_262":133,"_12":-7,"_177":534,"_179":151},10817089,"Generic Refund (Without existing Transaction Id)","apiDetail.10817089","/{tenantCode}/v1/transaction/refund",[497],"/api-10817089",{"_5":251,"_167":536,"_19":537,"_170":538,"_255":330,"_257":539,"_259":260,"_172":496,"_174":-7,"_175":540,"_20":-7,"_262":133,"_12":-7,"_177":541,"_179":151},24614490,"Update transaction status","apiDetail.24614490","/{tenantCode}/v1/transaction/{id}/status",[497],"/api-24614490",{"_5":251,"_167":543,"_19":544,"_170":545,"_255":276,"_257":546,"_259":260,"_172":496,"_174":-7,"_175":547,"_20":-7,"_262":133,"_12":-7,"_177":548,"_179":151},20179851,"Get merchant receipt for a transaction","apiDetail.20179851","/{tenantCode}/v1/transaction/{id}/receipt/merchant",[497],"/api-20179851",{"_5":251,"_167":550,"_19":551,"_170":552,"_255":256,"_257":553,"_259":260,"_172":496,"_174":-7,"_175":554,"_20":-7,"_262":133,"_12":-7,"_177":555,"_179":151},24614491,"Save a receipt for a transaction","apiDetail.24614491","/{tenantCode}/v1/transaction/{id}/receipt",[497],"/api-24614491",{"_5":229,"_230":173,"_167":557,"_19":558,"_170":559,"_235":560,"_241":561,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},5693227,"Storage","apiDetailFolder.5693227",{"_237":238,"_239":248},[562],{"_5":251,"_167":563,"_19":564,"_170":565,"_255":276,"_257":566,"_259":260,"_172":557,"_174":-7,"_175":567,"_20":-7,"_262":133,"_12":-7,"_177":568,"_179":151},24614492,"Gets a secure update url for the storage","apiDetail.24614492","/{tenantCode}/v1/storage/optio/update-url",[558],"/api-24614492",{"_5":229,"_230":173,"_167":570,"_19":571,"_170":572,"_235":573,"_241":574,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},5693228,"TenantWebhook","apiDetailFolder.5693228",{"_237":238,"_239":248},[575,581,586,592],{"_5":251,"_167":576,"_19":577,"_170":578,"_255":256,"_257":577,"_259":260,"_172":570,"_174":-7,"_175":579,"_20":-7,"_262":133,"_12":-7,"_177":580,"_179":151},24614493,"/{tenantCode}/v1/tenant-webhook/{provider}/viva/account","apiDetail.24614493",[571],"/api-24614493",{"_5":251,"_167":582,"_19":577,"_170":583,"_255":276,"_257":577,"_259":260,"_172":570,"_174":-7,"_175":584,"_20":-7,"_262":133,"_12":-7,"_177":585,"_179":151},24614494,"apiDetail.24614494",[571],"/api-24614494",{"_5":251,"_167":587,"_19":588,"_170":589,"_255":256,"_257":588,"_259":260,"_172":570,"_174":-7,"_175":590,"_20":-7,"_262":133,"_12":-7,"_177":591,"_179":151},24614495,"/{tenantCode}/v1/tenant-webhook/resurs/authorisation/transactions/{transactionUUID}","apiDetail.24614495",[571],"/api-24614495",{"_5":251,"_167":593,"_19":594,"_170":595,"_255":256,"_257":594,"_259":260,"_172":570,"_174":-7,"_175":596,"_20":-7,"_262":133,"_12":-7,"_177":597,"_179":151},24614496,"/{tenantCode}/v1/tenant-webhook/resurs/management/transactions/{transactionUUID}","apiDetail.24614496",[571],"/api-24614496",{"_5":229,"_230":173,"_167":599,"_19":600,"_170":601,"_235":602,"_241":603,"_172":232,"_174":-7,"_20":-7,"_264":229,"_12":-7,"_177":112,"_179":151,"_265":151},5693229,"Webhook","apiDetailFolder.5693229",{"_237":238,"_239":248},[604,610,615,621,626,632,637,643],{"_5":251,"_167":605,"_19":606,"_170":607,"_255":256,"_257":606,"_259":260,"_172":599,"_174":-7,"_175":608,"_20":-7,"_262":133,"_12":-7,"_177":609,"_179":151},24614497,"/v1/webhook/{provider}/viva/account","apiDetail.24614497",[600],"/api-24614497",{"_5":251,"_167":611,"_19":606,"_170":612,"_255":276,"_257":606,"_259":260,"_172":599,"_174":-7,"_175":613,"_20":-7,"_262":133,"_12":-7,"_177":614,"_179":151},24614498,"apiDetail.24614498",[600],"/api-24614498",{"_5":251,"_167":616,"_19":617,"_170":618,"_255":256,"_257":617,"_259":260,"_172":599,"_174":-7,"_175":619,"_20":-7,"_262":133,"_12":-7,"_177":620,"_179":151},24614499,"/v1/webhook/{provider}/viva/payment-created","apiDetail.24614499",[600],"/api-24614499",{"_5":251,"_167":622,"_19":617,"_170":623,"_255":276,"_257":617,"_259":260,"_172":599,"_174":-7,"_175":624,"_20":-7,"_262":133,"_12":-7,"_177":625,"_179":151},24614500,"apiDetail.24614500",[600],"/api-24614500",{"_5":251,"_167":627,"_19":628,"_170":629,"_255":256,"_257":628,"_259":260,"_172":599,"_174":-7,"_175":630,"_20":-7,"_262":133,"_12":-7,"_177":631,"_179":151},24614501,"/v1/webhook/{provider}/viva/payment-failed","apiDetail.24614501",[600],"/api-24614501",{"_5":251,"_167":633,"_19":628,"_170":634,"_255":276,"_257":628,"_259":260,"_172":599,"_174":-7,"_175":635,"_20":-7,"_262":133,"_12":-7,"_177":636,"_179":151},24614502,"apiDetail.24614502",[600],"/api-24614502",{"_5":251,"_167":638,"_19":639,"_170":640,"_255":256,"_257":639,"_259":260,"_172":599,"_174":-7,"_175":641,"_20":-7,"_262":133,"_12":-7,"_177":642,"_179":151},24614503,"/v1/webhook/{provider}/viva/reversal-created","apiDetail.24614503",[600],"/api-24614503",{"_5":251,"_167":644,"_19":639,"_170":645,"_255":276,"_257":639,"_259":260,"_172":599,"_174":-7,"_175":646,"_20":-7,"_262":133,"_12":-7,"_177":647,"_179":151},24614504,"apiDetail.24614504",[600],"/api-24614504","/folder-1600952","selectedSidebarTreeNode",{"_5":166,"_167":205,"_19":206,"_170":207,"_172":173,"_174":-7,"_175":208,"_12":-7,"_177":209,"_179":48},"parentSidebarTreeApiFolderNodes",[],"previousSidebarTreeNode",{"_5":166,"_167":199,"_19":200,"_170":201,"_172":173,"_174":-7,"_175":202,"_12":-7,"_177":203,"_179":151},"nextSidebarTreeNode",{"_5":166,"_167":211,"_19":212,"_170":213,"_172":173,"_174":-7,"_175":214,"_12":-7,"_177":215,"_179":151},"docsBaseConfig",{"_27":659,"_660":659,"_20":112,"_661":662,"_665":14,"_666":667,"_678":31,"_679":680,"_681":48,"_682":151,"_683":151,"_684":151,"_685":151,"_686":48,"_687":688,"_690":151,"_691":151,"_692":151,"_693":151,"_694":151,"_695":151,"_696":151,"_697":151,"_698":699,"_701":702,"_704":705,"_706":707,"_711":712,"_714":151,"_715":48,"_716":48,"_717":718,"_719":720,"_723":48,"_724":48,"_725":151,"_726":151,"_727":151,"_728":-7},"Confirma Payment Platform","siteName","logoSettings",{"_663":14,"_664":14},"light","dark","favicon","themePrimarySettings",{"_663":668,"_664":676},{"_669":670,"_671":672,"_673":674,"_675":670},"primaryColor","purple","textColor","WHITE","backgroundColor","#ffffff","accentColor",{"_669":670,"_671":672,"_673":677,"_675":670},"#1a1922","language","theme","system","displayThemeToggle","isShowPrefixUrl","isShowMaintainer","isShowTags","isShowUpdatedAt","isShowLastModifiedAt","displayFieldIds",[689],"api.label.sampleCode","hidePoweredBy","hideBuiltWith","hideRunInAppButton","hideTryItOutButton","exportable","hideCloneButton","hideMyAppButton","hideAppFormatExportOption","googleAnalytics",{"_700":112},"measurementId","visibilitySettings",{"_5":703},"PUBLIC","apiDocLayout","OneColumn","mockRule",{"_708":709,"_710":48},"rules",[],"enableSystemRule","corsProxySettings",{"_167":713},4,"enableVibeCodingViaMCP","enableCopyPage","enableLLMs","globalMetadata","[\n {\"name\": \"description\", \"content\": \"{{DESCRIPTION}}\"},\n {\"name\": \"keywords\", \"content\": \"{{KEYWORDS}}\"}\n]","robotsFile",{"_721":48,"_21":722},"enable","User-Agent: *\nAllow: /\n\nSitemap: {{SITEMAP_URL}}","enableSitemapFile","persistEnvVariables","showDataSchemas","showDataSchemasExample","showDataSchemasAutoGenerateExample","landingPageType","versionList",[731],{"_167":732,"_19":733,"_179":48,"_177":162,"_734":151},"553539","latest","disabled","resourceData",{"_5":166,"_737":738,"_756":757},"data",{"_167":205,"_19":206,"_739":112,"_21":740,"_741":173,"_742":743,"_744":745,"_746":747,"_748":749,"_750":751,"_752":751,"_5":112,"_175":753,"_754":755},"sidebarTitle","## Retain24 Developer's Guide\n\n\n\n\n \n \n1. Email your request to the support team to obtain sandbox credentials to use [Obtain a token](/api-10817083).

\n \nNow you are good to create a card or payment request and start integrating.\n \n \n \n1. Email your request to the support team to obtain sandbox credentials to use [Obtain a token](/api-10817083).\n1. Obtain your web certificate from Retain24 and forward it to the support team.

\n \nNow you are good to start using Retain24 Gift Card Provider.\n \n\n\n\n\n\n \n [View Gift Card Templates](/api-15293583) - Retrieve a list of available gift card templates.

\n [View a Gift Card Template](/api-15293584) - Retrieve a gift card to obtain it's template display content.

\n [Create a Gift Card](/api-15293585) - Issue a new gift card using the *template id*. You will find the gift card *id* from the response to use in [Create a new payment request](/api-10817084) as \"*giftCardIdentifierCode*\".

\n [Topup Gift Card](/api-15293586) - Add funds to an existing card.

\n [Get Gift Card Details](/api-15293587) - Retrieve details of an existing card.

\n [Validate Gift Card](/api-15293588) - Retrieve details of an existing card and validate pin at the same time. *(The pin is validated for payment requests. Use this if you need to validate a card without requesting for a payment)*

\n [Cancel Gift Card](/api-15293589) - Cancel an issued card.

\n [Cancel Last Topup](/api-15293590) - Cancel the last topup of the gift card.\n \n \n \n You can use the Cloud Api Integration by following the [Basic Flow Guide](/doc-829849)\n \n:::warning[]\nCancel transaction is not supported since the payment doesn't have any extra authorisation step.\n:::\n \n \n\n","folderId","projectId",588483,"moduleId",765322,"createdAt","2025-03-27T10:35:20.000Z","updatedAt","2025-03-27T11:36:46.000Z","creatorId",487397,"editorId",[],"visibility","INHERITED","extraData",{"_758":759,"_767":768},"apiFieldList",[760],{"_5":748,"_170":761,"_19":762,"_763":749,"_764":765,"_766":48},"updateAt","Last modified:","value","format","2025-03-27 11:36:46","hidden","dataSchemaDefinitions",{},"docsIdTypeData",{"_771":772,"_773":743,"_742":743,"_774":775,"_776":777,"_778":779,"_780":112,"_781":-7},"onlineType","APIDOC","onlineId","teamId",174792,"branchId",553539,"visitType","customDomain","subdirectory","specialFileType","notification",[],"footerBanner",[],"projectSetting",{"_788":789,"_791":792,"_807":808,"_809":810,"_811":812,"_813":814},"auth",{"_5":790},"noauth","advancedSettings",{"_793":151,"_794":151,"_795":48,"_796":797,"_798":151,"_799":151,"_800":801},"enableJsonc","enableBigint","responseValidate","isDefaultUrlEncoding",3,"enableTestScenarioSetting","enableYAPICompatScript","publishedDocUrlRules",{"_802":803,"_804":805,"_806":48},"defaultRule","RESOURCE_KEY_ONLY","resourceKeyStandard","LEGACY","enableResourceKeyStandard","securityScheme",{},"mockSettings",{},"preProcessors",[],"postProcessors",[],"environments",{"_817":818,"_857":858,"_873":874},"selectedEnvironment",{"_167":819,"_19":820,"_821":822,"_823":824,"_826":827,"_828":829,"_830":831,"_832":833,"_834":835,"_844":845,"_5":846,"_754":847,"_742":743,"_848":849,"_750":751,"_850":173,"_175":851,"_752":751,"_746":855,"_748":856},1625241,"Sandbox Env","baseUrl","https://sandbox.api.confirmapay.com","baseUrls",{"_825":822},"default","websocketBaseUrls",{},"socketioBaseUrls",{},"requestProxyAgentSettings",{},"variables",[],"parameters",{"_836":837,"_838":839,"_840":841,"_842":843},"cookie",[],"query",[],"header",[],"body",[],"registrationCenters",[],"normal","protected","projectType","HTTP","ordering",[852],{"_19":112,"_853":854},"color","#9373EE","2024-07-03T12:41:32.000Z","2024-07-06T06:46:20.000Z","environmentList",[859],{"_167":819,"_19":820,"_821":822,"_823":860,"_826":861,"_828":862,"_830":863,"_832":864,"_834":865,"_844":870,"_5":846,"_754":847,"_742":743,"_848":849,"_750":751,"_850":173,"_175":871,"_752":751,"_746":855,"_748":856},{"_825":822},{},{},{},[],{"_836":866,"_838":867,"_840":868,"_842":869},[],[],[],[],[],[872],{"_19":112,"_853":854},"servers",[875],{"_167":825,"_19":876},"Default Server","searchSettings",{},"versionSettings",[881],{"_776":777,"_882":48,"_19":733,"_883":733,"_815":884},"isDefaultVersion","slug",{"_885":886,"_887":819},"environmentIds",[819],"defaultEnvironmentId","seoInfos",["M"],"itemPathPrefix",{"_821":112,"_892":112,"_780":112,"_893":151},"versionSlug","isSharedDocIndependentDomain","appEnvMap",{"_896":124},"appBrowserExtensionAdapterKey","customCodes",{"_899":-7},"javascript","primaryColorVariable",{"_663":902,"_664":903},"--ui-primary-color-hover: var(--ui-primary-5);--ui-primary-color-active: var(--ui-primary-7);--ui-picker-basic-cell-hover-with-range-color: #36139c;--ui-picker-date-hover-range-border-color: #4e1be0;--ui-primary-base: #9373EE;--ui-primary-base-p: 147, 115, 238;--ui-primary-color-p: 147, 115, 238;--ui-primary-color: #9373EE;--ui-primary-10: #362b50;--ui-primary-9: #51407e;--ui-primary-8: #634e9b;--ui-primary-7: #7a60c4;--ui-primary-7-p: 122, 96, 196;--ui-primary-6: #9373EE;--ui-primary-6-p: 147, 115, 238;--ui-primary-5: #b499f4;--ui-primary-5-p: 180, 153, 244;--ui-primary-4: #cebaf8;--ui-primary-3: #dfd1fb;--ui-primary-2: #ebe2fc;--ui-primary-1: #f3eefe;--ui-primary-1-p: 243, 238, 254;--ui-primary-a: #f7f3fe;--ui-primary-b: #fbf9ff;--g-color-primary: #9373EE;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #ffffff;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","--ui-primary-color-hover: var(--ui-primary-7);--ui-primary-color-active: var(--ui-primary-5);--ui-picker-basic-cell-hover-with-range-color: #312865;--ui-picker-date-hover-range-border-color: #4b3d9c;--ui-primary-base: #8276C9;--ui-primary-base-p: 130, 118, 201;--ui-primary-color-p: 130, 118, 201;--ui-primary-color: #8276C9;--ui-primary-10: #dcd7f0;--ui-primary-9: #a69bd9;--ui-primary-8: #b0a5dd;--ui-primary-7: #9c90d4;--ui-primary-7-p: 156, 144, 212;--ui-primary-6: #8276C9;--ui-primary-6-p: 130, 118, 201;--ui-primary-5: #635a96;--ui-primary-5-p: 99, 90, 150;--ui-primary-4: #49436c;--ui-primary-3: #393452;--ui-primary-2: #312d46;--ui-primary-1: #252333;--ui-primary-1-p: 37, 35, 51;--ui-primary-a: #21202d;--ui-primary-b: #1e1c28;--g-color-primary: #8276C9;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #1a1922;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","routes/_index/route","actionData","errors"]

Retain24 Developers' Guide

Retain24 Developer's Guide#

Retain24 Developer's Guide