[{"data":1,"prerenderedAt":814},["ShallowReactive",2],{"navigation-docs_v2":3,"\u002Fv2\u002Foverview":124,"\u002Fv2\u002Foverview-surround":811},[4],{"title":5,"path":6,"stem":7,"children":8,"page":64},"V2","\u002Fv2","v2",[9,27,65,86,99,116],{"title":10,"path":11,"stem":12,"children":13},"Introduction","\u002Fv2\u002Foverview","v2\u002F1.overview\u002F1.index",[14,15,19,23],{"title":10,"path":11,"stem":12},{"title":16,"path":17,"stem":18},"Test Details","\u002Fv2\u002Foverview\u002Ftest-details","v2\u002F1.overview\u002F2.test-details",{"title":20,"path":21,"stem":22},"Errors","\u002Fv2\u002Foverview\u002Ferrors","v2\u002F1.overview\u002F3.Errors",{"title":24,"path":25,"stem":26},"Migrate from V1","\u002Fv2\u002Foverview\u002Fmigrate-from-v1","v2\u002F1.overview\u002F4.migrate-from-v1",{"title":28,"path":29,"stem":30,"children":31,"page":64},"General","\u002Fv2\u002Fgeneral","v2\u002F2.general",[32,36,40,44,48,52,56,60],{"title":33,"path":34,"stem":35},"Lookups","\u002Fv2\u002Fgeneral\u002Flookups","v2\u002F2.general\u002F1.lookups",{"title":37,"path":38,"stem":39},"Payment Methods","\u002Fv2\u002Fgeneral\u002Fpayment-methods","v2\u002F2.general\u002F2.payment-methods",{"title":41,"path":42,"stem":43},"Customers","\u002Fv2\u002Fgeneral\u002Fcustomers","v2\u002F2.general\u002F3.customers",{"title":45,"path":46,"stem":47},"Bank Accounts","\u002Fv2\u002Fgeneral\u002Fbank-accounts","v2\u002F2.general\u002F4.bank-accounts",{"title":49,"path":50,"stem":51},"Cards","\u002Fv2\u002Fgeneral\u002Fcards","v2\u002F2.general\u002F5.cards",{"title":53,"path":54,"stem":55},"Mandates","\u002Fv2\u002Fgeneral\u002Fmandates","v2\u002F2.general\u002F6.mandates",{"title":57,"path":58,"stem":59},"Products","\u002Fv2\u002Fgeneral\u002Fproducts","v2\u002F2.general\u002F8.products",{"title":61,"path":62,"stem":63},"Transactions","\u002Fv2\u002Fgeneral\u002Ftransactions","v2\u002F2.general\u002F9.transactions",false,{"title":66,"path":67,"stem":68,"children":69,"page":64},"Money In","\u002Fv2\u002Fmoney-in","v2\u002F3.money-in",[70,74,78,82],{"title":71,"path":72,"stem":73},"Checkout Link","\u002Fv2\u002Fmoney-in\u002Fcheckout-link","v2\u002F3.money-in\u002F1.checkout-link",{"title":75,"path":76,"stem":77},"Checkout Form","\u002Fv2\u002Fmoney-in\u002Fcheckout-form","v2\u002F3.money-in\u002F2.checkout-form",{"title":79,"path":80,"stem":81},"Electronic Mandates","\u002Fv2\u002Fmoney-in\u002Felectronic-mandates","v2\u002F3.money-in\u002F3.electronic-mandates",{"title":83,"path":84,"stem":85},"Collections","\u002Fv2\u002Fmoney-in\u002Fcollections","v2\u002F3.money-in\u002F4.collections",{"title":87,"path":88,"stem":89,"children":90,"page":64},"Money Out","\u002Fv2\u002Fmoney-out","v2\u002F4.money-out",[91,95],{"title":92,"path":93,"stem":94},"Payouts","\u002Fv2\u002Fmoney-out\u002Fpayouts","v2\u002F4.money-out\u002F1.payouts",{"title":96,"path":97,"stem":98},"Recipients","\u002Fv2\u002Fmoney-out\u002Frecipients","v2\u002F4.money-out\u002F2.recipients",{"title":100,"path":101,"stem":102,"children":103,"page":64},"Verification","\u002Fv2\u002Fverification","v2\u002F5.verification",[104,108,112],{"title":105,"path":106,"stem":107},"CDV","\u002Fv2\u002Fverification\u002Fcdv","v2\u002F5.verification\u002F1.cdv",{"title":109,"path":110,"stem":111},"AVS-R","\u002Fv2\u002Fverification\u002Favs-r","v2\u002F5.verification\u002F2.avs-r",{"title":113,"path":114,"stem":115},"SDO","\u002Fv2\u002Fverification\u002Fsdo","v2\u002F5.verification\u002F3.sdo",{"title":117,"path":118,"stem":119,"children":120,"page":64},"Webhooks","\u002Fv2\u002Fwebhooks","v2\u002F6.webhooks",[121],{"title":117,"path":122,"stem":123},"\u002Fv2\u002Fwebhooks\u002Fwebhooks","v2\u002F6.webhooks\u002F1.webhooks",{"id":125,"title":10,"body":126,"description":804,"extension":805,"links":806,"meta":807,"navigation":808,"path":11,"seo":809,"stem":12,"__hash__":810},"docs_v2\u002Fv2\u002F1.overview\u002F1.index.md",{"type":127,"value":128,"toc":798},"minimark",[129,134,160,164,170,174,179,185,189,192,794],[130,131,133],"h2",{"id":132},"notes","Notes",[135,136,137,141,148,151,154,157],"ul",{},[138,139,140],"li",{},"API endpoints are RESTful GET\u002FPOST HTTP requests",[138,142,143,144],{},"Body type must be ",[145,146,147],"code",{},"application\u002Fjson",[138,149,150],{},"All API calls made must include the authorization key in the header of the call.",[138,152,153],{},"Requests to the API will be limited to 100 requests per second to reduce the load on the platform.",[138,155,156],{},"Dates are to be specified as 'YYYY-MM-DD'",[138,158,159],{},"Timestamps are specified as 'YYYY-MM-DD HH:mm:ss' GMT+2 (South African Standard Time)",[130,161,163],{"id":162},"openapi-specification","OpenAPI Specification",[165,166,167],"p",{},[145,168,169],{},"https:\u002F\u002Fdocs.kwik.co.za\u002Fopenapi.json",[130,171,173],{"id":172},"path","Path",[165,175,176],{},[145,177,178],{},"https:\u002F\u002Fapi.kwik.co.za\u002F2.0\u002F",[180,181,182],"blockquote",{},[165,183,184],{},"When signing up a with Kwik Payments, two accounts will be created for you, a 'live' account and a 'test' account. Both will use the same API path but your API keys will determine if the data is for your testing account or your live account.",[130,186,188],{"id":187},"authentication","Authentication",[165,190,191],{},"Follow the ‘Basic Authorization’ standard, below is an example:",[193,194,195,329,412,564,697],"code-group",{},[196,197,203],"pre",{"className":198,"code":199,"filename":200,"language":201,"meta":202,"style":202},"language-javascript shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const hexString = Buffer.from(`${api_key}:${api_secret}`).toString('base64');\nconst headers = {\n 'Authorization': `Basic ${hexString}`,\n};\n","Node.js","javascript","",[145,204,205,280,293,323],{"__ignoreMap":202},[206,207,210,214,218,222,225,228,232,235,238,241,244,248,251,254,257,260,262,265,267,270,273,275,277],"span",{"class":208,"line":209},"line",1,[206,211,213],{"class":212},"spNyl","const",[206,215,217],{"class":216},"sTEyZ"," hexString ",[206,219,221],{"class":220},"sMK4o","=",[206,223,224],{"class":216}," Buffer",[206,226,227],{"class":220},".",[206,229,231],{"class":230},"s2Zo4","from",[206,233,234],{"class":216},"(",[206,236,237],{"class":220},"`${",[206,239,240],{"class":216},"api_key",[206,242,243],{"class":220},"}",[206,245,247],{"class":246},"sfazB",":",[206,249,250],{"class":220},"${",[206,252,253],{"class":216},"api_secret",[206,255,256],{"class":220},"}`",[206,258,259],{"class":216},")",[206,261,227],{"class":220},[206,263,264],{"class":230},"toString",[206,266,234],{"class":216},[206,268,269],{"class":220},"'",[206,271,272],{"class":246},"base64",[206,274,269],{"class":220},[206,276,259],{"class":216},[206,278,279],{"class":220},";\n",[206,281,283,285,288,290],{"class":208,"line":282},2,[206,284,213],{"class":212},[206,286,287],{"class":216}," headers ",[206,289,221],{"class":220},[206,291,292],{"class":220}," {\n",[206,294,296,299,303,305,307,310,313,315,318,320],{"class":208,"line":295},3,[206,297,298],{"class":220}," '",[206,300,302],{"class":301},"swJcz","Authorization",[206,304,269],{"class":220},[206,306,247],{"class":220},[206,308,309],{"class":220}," `",[206,311,312],{"class":246},"Basic ",[206,314,250],{"class":220},[206,316,317],{"class":216},"hexString",[206,319,256],{"class":220},[206,321,322],{"class":220},",\n",[206,324,326],{"class":208,"line":325},4,[206,327,328],{"class":220},"};\n",[196,330,335],{"className":331,"code":332,"filename":333,"language":334,"meta":202,"style":202},"language-php shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","$hex_string = base64_encode(\"$api_key:$api_secret\");\n$headers = [\n    'Authorization' => \"Basic $hex_string\",\n];\n","PHP","php",[145,336,337,369,381,407],{"__ignoreMap":202},[206,338,339,342,345,347,350,352,355,357,359,361,363,366],{"class":208,"line":209},[206,340,341],{"class":220},"$",[206,343,344],{"class":216},"hex_string ",[206,346,221],{"class":220},[206,348,349],{"class":230}," base64_encode",[206,351,234],{"class":220},[206,353,354],{"class":220},"\"$",[206,356,240],{"class":216},[206,358,247],{"class":246},[206,360,341],{"class":220},[206,362,253],{"class":216},[206,364,365],{"class":220},"\"",[206,367,368],{"class":220},");\n",[206,370,371,373,376,378],{"class":208,"line":282},[206,372,341],{"class":220},[206,374,375],{"class":216},"headers ",[206,377,221],{"class":220},[206,379,380],{"class":220}," [\n",[206,382,383,386,388,390,393,396,398,400,403,405],{"class":208,"line":295},[206,384,385],{"class":220},"    '",[206,387,302],{"class":246},[206,389,269],{"class":220},[206,391,392],{"class":220}," =>",[206,394,395],{"class":220}," \"",[206,397,312],{"class":246},[206,399,341],{"class":220},[206,401,402],{"class":216},"hex_string",[206,404,365],{"class":220},[206,406,322],{"class":220},[206,408,409],{"class":208,"line":325},[206,410,411],{"class":220},"];\n",[196,413,418],{"className":414,"code":415,"filename":416,"language":417,"meta":202,"style":202},"language-csharp shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","string credentials = $\"{apiKey}:{apiSecret}\";\nstring hexString = Convert.ToBase64String(Encoding.UTF8.GetBytes(credentials));\nvar headers = new Dictionary\u003Cstring, string>\n{\n    { \"Authorization\", \"Basic \" + hexString }\n};\n","C#","csharp",[145,419,420,456,496,526,531,559],{"__ignoreMap":202},[206,421,422,425,429,432,435,438,441,443,445,447,450,452,454],{"class":208,"line":209},[206,423,424],{"class":220},"string",[206,426,428],{"class":427},"sBMFI"," credentials",[206,430,431],{"class":220}," =",[206,433,434],{"class":220}," $\"",[206,436,437],{"class":220},"{",[206,439,440],{"class":216},"apiKey",[206,442,243],{"class":220},[206,444,247],{"class":246},[206,446,437],{"class":220},[206,448,449],{"class":216},"apiSecret",[206,451,243],{"class":220},[206,453,365],{"class":220},[206,455,279],{"class":220},[206,457,458,460,463,465,468,470,473,475,478,480,483,485,488,490,493],{"class":208,"line":282},[206,459,424],{"class":220},[206,461,462],{"class":427}," hexString",[206,464,431],{"class":220},[206,466,467],{"class":216}," Convert",[206,469,227],{"class":220},[206,471,472],{"class":230},"ToBase64String",[206,474,234],{"class":220},[206,476,477],{"class":216},"Encoding",[206,479,227],{"class":220},[206,481,482],{"class":216},"UTF8",[206,484,227],{"class":220},[206,486,487],{"class":230},"GetBytes",[206,489,234],{"class":220},[206,491,492],{"class":216},"credentials",[206,494,495],{"class":220},"));\n",[206,497,498,501,504,506,509,512,515,517,520,523],{"class":208,"line":295},[206,499,500],{"class":427},"var",[206,502,503],{"class":427}," headers",[206,505,431],{"class":220},[206,507,508],{"class":220}," new",[206,510,511],{"class":427}," Dictionary",[206,513,514],{"class":220},"\u003C",[206,516,424],{"class":220},[206,518,519],{"class":220},",",[206,521,522],{"class":220}," string",[206,524,525],{"class":220},">\n",[206,527,528],{"class":208,"line":325},[206,529,530],{"class":220},"{\n",[206,532,534,537,539,541,543,545,547,549,551,554,556],{"class":208,"line":533},5,[206,535,536],{"class":220},"    {",[206,538,395],{"class":220},[206,540,302],{"class":246},[206,542,365],{"class":220},[206,544,519],{"class":220},[206,546,395],{"class":220},[206,548,312],{"class":246},[206,550,365],{"class":220},[206,552,553],{"class":220}," +",[206,555,217],{"class":216},[206,557,558],{"class":220},"}\n",[206,560,562],{"class":208,"line":561},6,[206,563,328],{"class":220},[196,565,570],{"className":566,"code":567,"filename":568,"language":569,"meta":202,"style":202},"language-java shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","String credentials = apiKey + \":\" + apiSecret;\nString hexString = Base64.getEncoder().encodeToString(credentials.getBytes());\nMap\u003CString, String> headers = new HashMap\u003C>();\nheaders.put(\"Authorization\", \"Basic \" + hexString);\n","Java","java",[145,571,572,601,635,665],{"__ignoreMap":202},[206,573,574,577,580,582,585,588,590,592,594,596,599],{"class":208,"line":209},[206,575,576],{"class":212},"String",[206,578,579],{"class":216}," credentials ",[206,581,221],{"class":220},[206,583,584],{"class":216}," apiKey ",[206,586,587],{"class":220},"+",[206,589,395],{"class":220},[206,591,247],{"class":246},[206,593,365],{"class":220},[206,595,553],{"class":220},[206,597,598],{"class":216}," apiSecret",[206,600,279],{"class":220},[206,602,603,605,607,609,612,614,617,620,623,625,627,629,632],{"class":208,"line":282},[206,604,576],{"class":212},[206,606,217],{"class":216},[206,608,221],{"class":220},[206,610,611],{"class":216}," Base64",[206,613,227],{"class":220},[206,615,616],{"class":230},"getEncoder",[206,618,619],{"class":220},"().",[206,621,622],{"class":230},"encodeToString",[206,624,234],{"class":220},[206,626,492],{"class":216},[206,628,227],{"class":220},[206,630,631],{"class":230},"getBytes",[206,633,634],{"class":220},"());\n",[206,636,637,640,642,644,646,649,652,654,656,659,662],{"class":208,"line":295},[206,638,639],{"class":212},"Map",[206,641,514],{"class":220},[206,643,576],{"class":212},[206,645,519],{"class":220},[206,647,648],{"class":212}," String",[206,650,651],{"class":220},">",[206,653,287],{"class":216},[206,655,221],{"class":220},[206,657,508],{"class":658},"s7zQu",[206,660,661],{"class":212}," HashMap",[206,663,664],{"class":220},"\u003C>();\n",[206,666,667,670,672,675,677,679,681,683,685,687,689,691,693,695],{"class":208,"line":325},[206,668,669],{"class":216},"headers",[206,671,227],{"class":220},[206,673,674],{"class":230},"put",[206,676,234],{"class":220},[206,678,365],{"class":220},[206,680,302],{"class":246},[206,682,365],{"class":220},[206,684,519],{"class":220},[206,686,395],{"class":220},[206,688,312],{"class":246},[206,690,365],{"class":220},[206,692,553],{"class":220},[206,694,462],{"class":216},[206,696,368],{"class":220},[196,698,703],{"className":699,"code":700,"filename":701,"language":702,"meta":202,"style":202},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","hex_string = base64.b64encode(f\"{api_key}:{api_secret}\".encode()).decode()\nheaders = {\n    'Authorization': f'Basic {hex_string}'\n}\n","Python","python",[145,704,705,757,765,790],{"__ignoreMap":202},[206,706,707,709,711,714,716,719,721,724,726,729,731,733,735,737,739,741,743,745,748,751,754],{"class":208,"line":209},[206,708,344],{"class":216},[206,710,221],{"class":220},[206,712,713],{"class":216}," base64",[206,715,227],{"class":220},[206,717,718],{"class":230},"b64encode",[206,720,234],{"class":220},[206,722,723],{"class":212},"f",[206,725,365],{"class":246},[206,727,437],{"class":728},"sbssI",[206,730,240],{"class":230},[206,732,243],{"class":728},[206,734,247],{"class":246},[206,736,437],{"class":728},[206,738,253],{"class":230},[206,740,243],{"class":728},[206,742,365],{"class":246},[206,744,227],{"class":220},[206,746,747],{"class":230},"encode",[206,749,750],{"class":220},"()).",[206,752,753],{"class":230},"decode",[206,755,756],{"class":220},"()\n",[206,758,759,761,763],{"class":208,"line":282},[206,760,375],{"class":216},[206,762,221],{"class":220},[206,764,292],{"class":220},[206,766,767,769,771,773,775,778,781,783,785,787],{"class":208,"line":295},[206,768,385],{"class":220},[206,770,302],{"class":246},[206,772,269],{"class":220},[206,774,247],{"class":220},[206,776,777],{"class":212}," f",[206,779,780],{"class":246},"'Basic ",[206,782,437],{"class":728},[206,784,402],{"class":216},[206,786,243],{"class":728},[206,788,789],{"class":246},"'\n",[206,791,792],{"class":208,"line":325},[206,793,558],{"class":220},[795,796,797],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":202,"searchDepth":209,"depth":282,"links":799},[800,801,802,803],{"id":132,"depth":282,"text":133},{"id":162,"depth":282,"text":163},{"id":172,"depth":282,"text":173},{"id":187,"depth":282,"text":188},"Welcome to Kwik Payments API documentation","md",null,{},true,{"title":10,"description":804},"x9rR-2AAjDqr_bBKcc5KCmsARiZqsC-mFxvsgK9Gx8c",[806,812],{"title":16,"path":17,"stem":18,"description":813,"children":-1},"Comprehensive testing data including bank account numbers, card numbers, and dedicated testing accounts for simulating various collection scenarios in the testing environment. Essential for testing EFT Debit Orders, DebiCheck, mandates, and 3D Secure card transactions.",1780668561148]