[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12},"actionData","errors","root",{"_374":375,"_376":377,"_378":-5,"_379":380,"_381":382,"_383":384,"_385":386,"_330":387,"_388":389,"_339":-7,"_341":-7,"_390":391,"_392":74,"_393":394,"_395":394,"_396":-7,"_397":398,"_399":400,"_401":402,"_403":404,"_346":347,"_405":-7,"_406":33,"_407":33},"routes/_docs/_index",{"_330":331,"_332":74,"_333":-7,"_334":335,"_336":-7,"_337":338,"_339":-7,"_340":-7,"_341":-7,"_38":37,"_342":-7,"_343":335,"_344":-7,"_345":33,"_346":347,"_348":349},"routes/_docs.$productname/_index",{"_50":51,"_52":53,"_54":-7,"_55":56,"_57":58,"_59":33},"routes/_docs.$productname.$/_index",{"_13":14,"_15":16,"_17":18,"_19":20,"_21":-7,"_22":-7,"_23":24,"_25":26,"_27":-7,"_28":29,"_30":31,"_32":33,"_34":35},"type","html","content","

We're excited to help you get up and running with our enhanced payment processing platform! Whether you're migrating from another processor or setting up payments for the first time, we've designed our API to make integration as smooth and straightforward as possible.

Who This Guide Is For

We've organised this guide based on how you currently process payments:

Direct API Integration - You send payment requests directly to our API endpoints

Enhanced Payment Pages - You use our hosted payment pages for checkout

PayByLink - You send payment links to customers via email or text

Hosted Payment Fields - You embed our secure payment fields in your website

WooCommerce - You use our WooCommerce plugin for your online store

What You'll Find in This Guide

For each integration type, we provide:

Step-by-step instructions written in plain language
Code examples and API specifications
Troubleshooting tips and best practices
Testing guidelines to ensure everything works smoothly

Ready to Get Started?

For existing merchants: The migration process is designed to be completed in phases, allowing you to test each step before moving forward.

For new merchants: You can typically have payments up and running within hours using our streamlined setup process.

Let's dive into the specific steps for your integration type and get you successfully connected to our platform.

","contentUpdatedAt","Fri, 08 Aug 2025 04:45:14 GMT","path","docs/welcome-to-the-new-novatti-proxy-api","generatorLanguages","SHUBApiDetails","exploreUrl","https://explore.swaggerhub.com","currentToc",{"_13":14,"_45":46,"_39":47,"_19":20,"_48":49},"shubUrl","apiRenderer","TOGGLE","routingSettings",{"_41":42,"_43":44},"isTemplatePreview",false,"metaInfo",{"_36":37,"_38":37,"_39":40},"canonicalUrl","http://novatti.portal.swaggerhub.com/proxy/docs/welcome-to-the-new-novatti-proxy-api","pageUrl","title","Getting Started with Our Payment Processor: A Simple Guide | Novatti API | Novatti API","routing","browser","credentialsEnabled",true,"tableOfContentsId","7b29f025-e9c8-424b-9e2c-0a7119209c8e","Getting Started with Our Payment Processor: A Simple Guide","children",[],"sections",{"_82":83,"_84":85},"currentProduct",{"_61":73,"_63":74,"_65":56,"_67":75,"_69":44,"_70":33,"_76":77,"_78":79,"_71":80,"_72":81},"currentProductRole","productSlug","proxy","products",[60,53],"isTemplate",{"_61":62,"_63":64,"_65":66,"_67":68,"_69":44,"_70":33,"_71":-7,"_72":-7},"id","057c2922-cf8e-494b-91ea-3c25e59e5ad0","name","Flexipin API","slug","flexepin","description","","canAccess","hidden","logoImageHref","logoImageDarkModeHref","ea34d0bc-e02f-47fe-9f42-bbbec595cd45","Novatti API","A guide for merchants to connect to our API and enable seamless, secure payment acceptance.","logoAttachmentId","def16517-7d1d-44fe-90f7-178806c56c5a","logoDarkModeAttachmentId","facacafe-b83f-4e3a-bde9-002db2e3c46e","https://novatti.portal.swaggerhub.com/services/api/attachments/def16517-7d1d-44fe-90f7-178806c56c5a","https://novatti.portal.swaggerhub.com/services/api/attachments/facacafe-b83f-4e3a-bde9-002db2e3c46e","page",{"_324":325,"_326":327,"_328":325,"_329":325},"items",[86],{"_39":87,"_65":87,"_88":89},"docs","tableOfContents",[90,91,92,93,94,95,96,97,98,99,100,101],{"_13":14,"_45":46,"_39":47,"_19":20,"_48":323},{"_13":14,"_45":309,"_39":310,"_19":311,"_48":312},{"_13":14,"_45":305,"_39":306,"_19":307,"_48":308},{"_13":138,"_45":291,"_39":292,"_141":293,"_19":294,"_144":295,"_146":296,"_148":297},{"_13":138,"_45":215,"_39":216,"_141":217,"_19":218,"_144":145,"_146":219,"_148":220},{"_13":138,"_45":190,"_39":191,"_141":192,"_19":193,"_144":145,"_146":194,"_148":195},{"_13":138,"_45":163,"_39":164,"_141":165,"_19":166,"_144":167,"_146":168,"_148":169},{"_13":138,"_45":139,"_39":140,"_141":142,"_19":143,"_144":145,"_146":147,"_148":149},{"_13":14,"_45":134,"_39":135,"_19":136,"_48":137},{"_13":14,"_45":130,"_39":131,"_19":132,"_48":133},{"_13":14,"_45":126,"_39":127,"_19":128,"_48":129},{"_13":14,"_45":102,"_39":103,"_19":104,"_48":105},"f2c16295-01a2-48d8-ba9c-64192b9823f6","Apple Pay Integration","docs/apple-pay-integration",[106,107,108,109],{"_13":14,"_45":122,"_39":123,"_19":124,"_48":125},{"_13":14,"_45":118,"_39":119,"_19":120,"_48":121},{"_13":14,"_45":114,"_39":115,"_19":116,"_48":117},{"_13":14,"_45":110,"_39":111,"_19":112,"_48":113},"605a1f55-668a-4270-a766-7482b2611105","4 - Payment Processing Example","docs/4-payment-processing-example",[],"cff957bb-9a8c-4291-9c8b-e3e0e2dde2aa","3 - Merchant Validation Example","docs/3-merchant-validation-example",[],"4b469dfb-af78-40f1-bd04-b53fcfadee77","2 - Validate Merchant","docs/2-validate-merchant",[],"f14d9ae7-f938-453e-9bf6-0bf027de4f9f","1 - Merchant Setup","docs/merchant-setup",[],"3bf6f41b-58d0-47cd-ab68-95bf77bd1bc1","Google Pay Integration","docs/google-pay-integration",[],"5dccbc0e-9f76-46d5-88ec-804d999508f7","Test Cards for Sandbox","docs/test-cards-for-sandbox",[],"4f5becfd-fdbc-42f2-9a6c-5655aac89d7b","OneStep Payment Response Codes","docs/one-step-payment-response-codes",[],"apiUrl","a5b9c31d-efbb-4c86-8743-07dbf44aa439","Apple Pay API","url","https://api.swaggerhub.com/apis/novatti/ApplePay/1.0.0/swagger.json","docs/apple-pay-v-1-0-0","apiSpec","openapi-3.1.0","operations",[154],"schemas",[150,151],{"_63":153},{"_63":152},"ValidateMerchantResponse","ValidateMerchantRequest",{"_155":156,"_19":157,"_158":159,"_160":161,"_162":33},"method","post","/proxy","summary","Validate Apple Pay Merchant","operationId","validateMerchant","deprecated","4bf09503-bc65-42a8-80ef-6cde3b9a9018","Capture Context API","https://api.swaggerhub.com/apis/novatti/Capture-Context/1.0.0/swagger.json","docs/capture-context-api-v-1-0-0","openapi-3.0.0",[184],[170,171,172,173,174,175,176],{"_63":183},{"_63":182},{"_63":181},{"_63":180},{"_63":179},{"_63":178},{"_63":177},"ErrorResponse","ResponseContextDetails","ResponseResult","CaptureContextResponse","ContextDetails","RequestHeader","CaptureContextRequest",{"_155":156,"_19":185,"_186":187,"_158":188,"_160":189,"_162":33},"/api-proxy-v1/proxy","tag","Capture Context","Create Capture Context","createCaptureContext","184f8eb2-dad5-4df2-b35c-c1e0afa1b13e","Direct Debit API","https://api.swaggerhub.com/apis/novatti/DirectDebit/1.0.3/swagger.json","docs/direct-debit-api-v-1-0-3",[210],[196,197,198,199,200,201,202,203],{"_63":209},{"_63":182},{"_63":208},{"_63":207},{"_63":206},{"_63":205},{"_63":204},{"_63":177},"OrderResult","DirectDebitResponse","Customer","BankAccount","DirectDebitOrder","DirectDebitRequest",{"_155":156,"_19":211,"_186":212,"_158":213,"_160":214,"_162":33},"/v1/issue","orders","Create a direct debit order","createDirectDebitOrder","bb911469-3470-487d-b082-ceb55023fce2","Payments API","https://api.swaggerhub.com/apis/novatti/NovattiAPI/2.2.21/swagger.json","docs/novatti-api-v-2-2-21-2",[221,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236],[],{"_155":156,"_19":287,"_186":288,"_158":289,"_160":290,"_162":33},{"_155":156,"_19":284,"_186":238,"_158":285,"_160":286,"_162":33},{"_155":156,"_19":281,"_186":238,"_158":282,"_160":283,"_162":33},{"_155":156,"_19":278,"_186":238,"_158":279,"_160":280,"_162":33},{"_155":156,"_19":274,"_186":275,"_158":276,"_160":277,"_162":33},{"_155":156,"_19":270,"_186":271,"_158":272,"_160":273,"_162":33},{"_155":156,"_19":267,"_186":261,"_158":268,"_160":269,"_162":33},{"_155":156,"_19":263,"_186":264,"_158":265,"_160":266,"_162":33},{"_155":156,"_19":260,"_186":261,"_158":262,"_162":33},{"_155":156,"_19":257,"_186":245,"_158":258,"_160":259,"_162":33},{"_155":156,"_19":254,"_186":245,"_158":255,"_160":256,"_162":33},{"_155":156,"_19":251,"_186":245,"_158":252,"_160":253,"_162":33},{"_155":156,"_19":248,"_186":245,"_158":249,"_160":250,"_162":33},{"_155":156,"_19":244,"_186":245,"_158":246,"_160":247,"_162":33},{"_155":156,"_19":241,"_186":238,"_158":242,"_160":243,"_162":33},{"_155":156,"_19":237,"_186":238,"_158":239,"_160":240,"_162":33},"/api-proxy-v1/proxy(oneStepPaymentWithApplePay-DoNotUseTextInBrackets)","Payments","Create a One Step Payment with Apple Pay","createApplePayPayment","/api-proxy-v1/proxy(VerifyAccount-DoNotUseTextInBrackets)","Verify account with card details or secure token","verifyAccount","/transaction/notification","Webhooks","Transaction status change notification","processTransactionNotification","/v1/delete","Delete webhook subscription","deleteWebhookSubscription","/v1/update","Update webhook URL","updateWebhookUrl","/v1/retrieve","List subscribed webhooks","listWebhookSubscriptions","/v1/addWebhook","Subscribe to webhook notifications","subscribeToWebhook","/api-proxy-v1/proxy(TransactionStatus-DoNotUseTextInBrackets)","Queries","Get transaction status","/api-proxy-v1/proxy(SurchargeInquiry-DoNotUseTextInBrackets)","Surcharge","Calculate surcharge for a payment method","calculateSurcharge","/v3/query","List transactions for a merchant","listTransactions","/api-proxy-v1/proxy(Tokenize-DoNotUseTextInBrackets)","Tokenisation","Tokenize card data for secure storage","tokenizeCard","/api-proxy-v1/proxy(Refund-DoNotUseTextInBrackets)","Refunds","Process a refund for an existing payment","refundPayment","/api-proxy-v1/proxy(OneStepPaymentWithToken-DoNotUseTextInBrackets)","Create a One Step Payment using a Secure Token","createTokenPayment","/api-proxy-v1/proxy(oneStepPaymentWithCardAndTokenisation-DoNotUseTextInBrackets)","Create a One Step Payment with Card Data and Tokenisation","createPaymentWithTokenisation","/api-proxy-v1/proxy(oneStepPaymentWithCard-DoNotUseTextInBrackets)","Create a One Step Payment with Card Data","createPayment","/oauth/token","Authentication","Generate an authentication token","generateToken","a7c8c485-10f0-4e51-b4a2-c8255206b027","Authentication for all APIs","https://api.swaggerhub.com/apis/novatti/common-authentication/1.0.0/swagger.json","docs/novatti-unify-authentication-api-v-1-0-0","openapi-3.0.3",[303],[298,299,300],{"_63":302},{"_63":301},{"_63":177},"TokenResponse","TokenRequest",{"_155":156,"_19":287,"_186":288,"_158":304,"_160":290,"_162":33},"Generate an authentication token for Direct and Order API","00ea934c-ca6d-4119-9af1-b0ed1b18ebed","PayByLink, Direct Debit, AliPay, WeChatPay and UnionPay","docs/order-api",[],"3739e3ed-8629-4e28-a433-d5404a6c8b9c","Hosted Payment Fields - Integration Guide","docs/hosted-payment-fields-integration-guide",[313,314],{"_13":14,"_45":319,"_39":320,"_19":321,"_48":322},{"_13":14,"_45":315,"_39":316,"_19":317,"_48":318},"41416dea-9037-40e3-8483-c412f95f6111","Hosted Payment Fields - Styling Guide","docs/hosted-payment-fields-styling-guide",[],"46bdaaa9-fe65-4521-8722-053ccd0917cc","Hosted Payment Fields - Start Guide","docs/hosted-payment-fields-start-guide",[],[],"number",1,"size",10,"totalElements","totalPages","user",{"_372":373},"portalName","portalCustomDomain","portalSubdomain","novatti","gtmKey","landingPageData",{"_63":74,"_76":355,"_78":356,"_357":358,"_359":360,"_361":360,"_362":33,"_67":363,"_348":349,"_71":364,"_72":365,"_366":-7,"_367":-7,"_368":-7,"_369":-7,"_370":-7,"_371":-7},"organizationRole","highestRole","platformAdmin","previewMode","swaggerhubOrgName","templates","customDomainActive","swaggerhubOrgId","e0a454e9-c702-4499-8421-be51abffeece","footer",{"_350":33,"_351":352,"_353":-7,"_354":-7},"visible","links",[],"imageHref","imageDarkModeHref","552d8f65-eb06-445c-8d26-a6f7a97d3def","ada831d5-dc8f-4ae9-bd1c-e52c495cbfbd","fontName","Montserrat","accentColor","#F9A600","accentColorDarkMode","offline",[],"https://novatti.portal.swaggerhub.com/services/api/attachments/552d8f65-eb06-445c-8d26-a6f7a97d3def","https://novatti.portal.swaggerhub.com/services/api/attachments/ada831d5-dc8f-4ae9-bd1c-e52c495cbfbd","heroImageHref","heroImageDarkModeHref","illustrationImageHref","illustrationImageDarkModeHref","faviconHref","faviconDarkModeHref","profile","https://profile.id.smartbear.com/","appMode","portal","locale","en","notification","bugsnagApiKey","15dbd45f0b623fe8ba7056c9f5a3165d","editorKey","eyJhbGciOiJFUzI1NiJ9.eyJleHAiOjE4MjcyNzM1OTksImp0aSI6IjRkMGE0Zjc3LTk0YTktNGRjNC1iZjdiLTNmYTM3MjcwYjUxYiIsImRpc3RyaWJ1dGlvbkNoYW5uZWwiOlsic2giLCJkcnVwYWwiXSwid2hpdGVMYWJlbCI6dHJ1ZSwiZmVhdHVyZXMiOlsiRFJVUCIsIkRPIiwiRlAiLCJTQyIsIlRPQyIsIlRQTCIsIlBPRSIsIkNDIiwiTUYiLCJTRUUiLCJCT1giLCJDTVQiLCJUQyIsIlJIIl0sInZjIjoiZDllZWYyZTgifQ.8pGGsuIWKK_0gvsKin0Qr4v6saiOpRVl1cp_xfPNPu7zh2Q4R2mGHr3WCjvk0VR1y7m3djHEIc2tNMx5poHrww","env","prod","flags",{"_449":44,"_450":44,"_451":33,"_452":44,"_453":33,"_454":33,"_455":44,"_456":44,"_457":44,"_458":44,"_459":33,"_460":325,"_461":44,"_462":33,"_463":464,"_465":44,"_466":44,"_467":44,"_468":33,"_469":33,"_470":44,"_471":33,"_472":33,"_473":44,"_474":44,"_475":44,"_476":33,"_477":33,"_478":44},{"_372":373,"_447":448},"layout","default","amplitudeData",{"_443":444,"_445":446},"portalMetaName","mode","system","sessionMode","preferredColorScheme","license",{"_13":442},"apiHubPlan",{"_422":44,"_423":424,"_425":426,"_427":428},"appConfig",{"_408":409,"_410":24,"_411":412,"_413":414,"_415":416,"_417":418,"_419":68,"_420":421},"apiHubUrl","https://app.swaggerhub.com/hub/e0a454e9-c702-4499-8421-be51abffeece","cutoverDate","isExternalLoginEnabled","isCustomDomain","platformUiUrl","https://platform.smartbear.com","shubExploreUrl","pactflowAppUrl","https://app.pactflow.io","reflectAppUrl","https://auth.reflect.run/oauth2/authorize?response_type=code&client_id=7taop7pbojn2nlj536vshmmgn&redirect_uri=https%3A%2F%2Fapp.reflect.run%2Foauth%2Fsso&identity_provider=SmartBear","shubAppUrl","https://app.swaggerhub.com","portalRootUrl","https://{portalname}.portal.swaggerhub.com","portalAppUrl","catalogAppUrl","https://catalog.swaggerhub.com","platformManaged","gates",{"_434":33,"_435":33,"_436":33,"_437":44,"_438":44,"_439":33,"_440":33,"_441":44},"productMeters",{"_429":432,"_431":432,"_433":325},"templateMeters",{"_429":430,"_431":430},"limit",0,"currentUsage",2,"warningThreshold","sbFooterRemoved","subdomainEditingEnabled","customDomainEnabled","consumerSideOnline","requestAccessEnabled","attachmentManagerEnabled","privateAndHiddenProductsEnabled","collaborationEnabled","paid","amplitudeApiKey","79eb0fee7c605a4e0d80273236e85fa9","portalData",{},"proxyToken","754de24f-631b-4d32-8194-65774cbb9f25","api-hub-agent-force","api-hub-ai-based-standardization-rules-generation","api-hub-ai-diff-based-generation","api-hub-graph-ql-specification-support","api-hub-insight-hub-integration","api-hub-new-features-for-3-1-editor","api-hub-next-editor-for-2-0-and-3-0","api-hub-rollout-reflect-app-switcher","api-hub-rollout-reflect-landing-page","api-hub-spectral-js-evaluator","api-hub-standardization-page-redesign","api-hub-welcome-bar-message-index","catalog-access-control","catalog-recent-apis","catalog-trial-redirects","http://catalog.swaggerhub.com?orgId={orgId}","halo-ai-api-hub-api-design-diff","halo-ai-api-hub-mcp-server-generation","halo-ai-api-hub-open-api-design-generation","halo-ai-api-hub-open-api-generation-by-implementation","portal-auth-restructure","portal-permanent-markdown-editing-support","swagger-ai-agents-support","swagger-github-app-integration","swagger-new-panel-mechanism","swagger-products-rebrand","swagger-studio-elements-support","swagger-studio-import-stoplight","swagger-studio-oas-3-1-domains","swagger-studio-oas-3-2-support"]