[{"data":1,"prerenderedAt":881},["ShallowReactive",2],{"docs-navigation":3,"page-\u002Fgh\u002Fpayments\u002Fonline\u002Fcharge-api":787},[4,20,48,169,226,273,326,330,370,442,641,738],{"title":5,"path":6,"stem":7,"children":8,"page":19},"Shared","\u002F_shared","_shared",[9],{"title":10,"path":11,"stem":12,"children":13,"page":19},"Payments","\u002F_shared\u002Fpayments","_shared\u002Fpayments",[14],{"title":15,"path":16,"stem":17,"markets":18},"Webhook confirmation","\u002F_shared\u002Fpayments\u002F_webhook-note","_shared\u002Fpayments\u002F_webhook-note",null,false,{"title":21,"path":22,"stem":23,"children":24},"Api","\u002Fapi","api",[25,28,32,36,40,44],{"title":26,"path":22,"stem":27,"markets":18},"API Reference","api\u002Findex",{"title":29,"path":30,"stem":31,"markets":18},"Authentication","\u002Fapi\u002Fauthentication","api\u002Fauthentication",{"title":33,"path":34,"stem":35,"markets":18},"Errors","\u002Fapi\u002Ferrors","api\u002Ferrors",{"title":37,"path":38,"stem":39,"markets":18},"Pagination","\u002Fapi\u002Fpagination","api\u002Fpagination",{"title":41,"path":42,"stem":43,"markets":18},"Rate Limits","\u002Fapi\u002Frate-limits","api\u002Frate-limits",{"title":45,"path":46,"stem":47,"markets":18},"Supported Currencies","\u002Fapi\u002Fsupported-currencies","api\u002Fsupported-currencies",{"title":49,"path":50,"stem":51,"children":52},"Commerce","\u002Fcommerce","commerce",[53,56,64,85,108,122,132,151],{"title":49,"path":50,"stem":54,"markets":18,"order":55},"commerce\u002Findex",0,{"title":57,"path":58,"stem":59,"children":60,"markets":18,"order":63},"Get started","\u002Fcommerce\u002Fget-started","commerce\u002F1.get-started\u002Findex",[61],{"title":62,"path":58,"stem":59,"markets":18,"order":55},"Build Your First Store",1,{"title":65,"markets":18,"order":66,"path":67,"stem":68,"children":69},"Payment Pages",2,"\u002Fcommerce\u002Fpayment-pages","commerce\u002F2.payment-pages\u002Findex",[70,71,76,80],{"title":65,"path":67,"stem":68,"markets":18,"order":55},{"title":72,"path":73,"stem":74,"markets":18,"order":75},"Add Products to a Page","\u002Fcommerce\u002Fpayment-pages\u002Fadd-products","commerce\u002F2.payment-pages\u002Fadd-products",4,{"title":77,"path":78,"stem":79,"markets":18,"order":66},"Create a Payment Page","\u002Fcommerce\u002Fpayment-pages\u002Fcreate","commerce\u002F2.payment-pages\u002Fcreate",{"title":81,"path":82,"stem":83,"markets":18,"order":84},"Manage Payment Pages","\u002Fcommerce\u002Fpayment-pages\u002Fmanage","commerce\u002F2.payment-pages\u002Fmanage",3,{"title":86,"markets":18,"order":84,"path":87,"stem":88,"children":89},"Payment Requests","\u002Fcommerce\u002Fpayment-requests","commerce\u002F3.payment-requests\u002Findex",[90,91,95,99,103],{"title":86,"path":87,"stem":88,"markets":18,"order":55},{"title":92,"path":93,"stem":94,"markets":18,"order":66},"Create a Payment Request","\u002Fcommerce\u002Fpayment-requests\u002Fcreate","commerce\u002F3.payment-requests\u002Fcreate",{"title":96,"path":97,"stem":98,"markets":18,"order":75},"Manage Payment Requests","\u002Fcommerce\u002Fpayment-requests\u002Fmanage","commerce\u002F3.payment-requests\u002Fmanage",{"title":100,"path":101,"stem":102,"markets":18,"order":84},"Notify and Finalize Requests","\u002Fcommerce\u002Fpayment-requests\u002Fnotify-and-finalize","commerce\u002F3.payment-requests\u002Fnotify-and-finalize",{"title":104,"path":105,"stem":106,"markets":18,"order":107},"Verify a Payment Request","\u002Fcommerce\u002Fpayment-requests\u002Fverify","commerce\u002F3.payment-requests\u002Fverify",5,{"title":109,"markets":18,"order":75,"path":110,"stem":111,"children":112},"Products","\u002Fcommerce\u002Fproducts","commerce\u002F4.products\u002Findex",[113,114,118],{"title":109,"path":110,"stem":111,"markets":18,"order":55},{"title":115,"path":116,"stem":117,"markets":18,"order":66},"Create a Product","\u002Fcommerce\u002Fproducts\u002Fcreate","commerce\u002F4.products\u002Fcreate",{"title":119,"path":120,"stem":121,"markets":18,"order":84},"Manage Products","\u002Fcommerce\u002Fproducts\u002Fmanage","commerce\u002F4.products\u002Fmanage",{"title":123,"path":124,"stem":125,"children":126,"markets":18,"order":107},"Orders","\u002Fcommerce\u002Forders","commerce\u002F5.orders\u002Findex",[127,128],{"title":123,"path":124,"stem":125,"markets":18,"order":55},{"title":129,"path":130,"stem":131,"markets":18,"order":66},"Manage Orders","\u002Fcommerce\u002Forders\u002Fmanage","commerce\u002F5.orders\u002Fmanage",{"title":133,"markets":18,"order":134,"path":135,"stem":136,"children":137},"Storefronts",6,"\u002Fcommerce\u002Fstorefronts","commerce\u002F6.storefronts\u002Findex",[138,139,143,147],{"title":133,"path":135,"stem":136,"markets":18,"order":55},{"title":140,"path":141,"stem":142,"markets":18,"order":66},"Create a Storefront","\u002Fcommerce\u002Fstorefronts\u002Fcreate","commerce\u002F6.storefronts\u002Fcreate",{"title":144,"path":145,"stem":146,"markets":18,"order":84},"Publish and Manage Storefronts","\u002Fcommerce\u002Fstorefronts\u002Fmanage","commerce\u002F6.storefronts\u002Fmanage",{"title":148,"path":149,"stem":150,"markets":18,"order":75},"Products and Orders","\u002Fcommerce\u002Fstorefronts\u002Fproducts-and-orders","commerce\u002F6.storefronts\u002Fproducts-and-orders",{"title":152,"markets":18,"order":153,"path":154,"stem":155,"children":156,"page":19},"Concepts",7,"\u002Fcommerce\u002Fconcepts","commerce\u002F7.concepts",[157,161,165],{"title":158,"path":159,"stem":160,"markets":18,"order":84},"No-code Builder vs API Approach","\u002Fcommerce\u002Fconcepts\u002Fnocode-vs-api","commerce\u002F7.concepts\u002Fnocode-vs-api",{"title":162,"path":163,"stem":164,"markets":18,"order":66},"Commerce Order Lifecycle","\u002Fcommerce\u002Fconcepts\u002Forder-lifecycle","commerce\u002F7.concepts\u002Forder-lifecycle",{"title":166,"path":167,"stem":168,"markets":18,"order":63},"Payment Pages vs Payment Requests","\u002Fcommerce\u002Fconcepts\u002Fpayment-pages-vs-requests","commerce\u002F7.concepts\u002Fpayment-pages-vs-requests",{"title":170,"path":171,"stem":172,"children":173},"Developer Tools","\u002Fdeveloper-tools","developer-tools",[174,176,193,197,214,218,222],{"title":170,"path":171,"stem":175,"markets":18,"order":55},"developer-tools\u002Findex",{"title":177,"markets":18,"order":63,"path":178,"stem":179,"children":180,"page":19},"Integration toolkit","\u002Fdeveloper-tools\u002Fintegration","developer-tools\u002F1.integration",[181,185,189],{"title":182,"path":183,"stem":184,"markets":18,"order":63},"API keys","\u002Fdeveloper-tools\u002Fintegration\u002Fapi-keys","developer-tools\u002F1.integration\u002Fapi-keys",{"title":186,"path":187,"stem":188,"markets":18,"order":84},"Test payments","\u002Fdeveloper-tools\u002Fintegration\u002Ftest-payments","developer-tools\u002F1.integration\u002Ftest-payments",{"title":190,"path":191,"stem":192,"markets":18,"order":66},"Webhooks","\u002Fdeveloper-tools\u002Fintegration\u002Fwebhooks","developer-tools\u002F1.integration\u002Fwebhooks",{"title":194,"path":195,"stem":196,"markets":18,"order":66},"InlineJS","\u002Fdeveloper-tools\u002Finline-js","developer-tools\u002F2.inline-js",{"title":198,"markets":18,"order":84,"path":199,"stem":200,"children":201,"page":19},"Mobile SDKs","\u002Fdeveloper-tools\u002Fmobile-sdks","developer-tools\u002F3.mobile-sdks",[202,206,210],{"title":203,"path":204,"stem":205,"markets":18,"order":63},"Android SDK","\u002Fdeveloper-tools\u002Fmobile-sdks\u002Fandroid","developer-tools\u002F3.mobile-sdks\u002Fandroid",{"title":207,"path":208,"stem":209,"markets":18,"order":84},"Flutter SDK","\u002Fdeveloper-tools\u002Fmobile-sdks\u002Fflutter","developer-tools\u002F3.mobile-sdks\u002Fflutter",{"title":211,"path":212,"stem":213,"markets":18,"order":66},"iOS SDK","\u002Fdeveloper-tools\u002Fmobile-sdks\u002Fios","developer-tools\u002F3.mobile-sdks\u002Fios",{"title":215,"path":216,"stem":217,"markets":18,"order":75},"Server SDKs","\u002Fdeveloper-tools\u002Fserver-sdks","developer-tools\u002F4.server-sdks",{"title":219,"path":220,"stem":221,"markets":18,"order":107},"Plugins","\u002Fdeveloper-tools\u002Fplugins","developer-tools\u002F5.plugins",{"title":223,"path":224,"stem":225,"markets":18,"order":134},"MCP Server","\u002Fdeveloper-tools\u002Fmcp-server","developer-tools\u002F6.mcp-server",{"title":227,"path":228,"stem":229,"children":230},"Disbursements","\u002Fdisbursements","disbursements",[231,233,236],{"title":227,"path":228,"stem":232,"markets":18,"order":55},"disbursements\u002Findex",{"title":57,"path":234,"stem":235,"markets":18,"order":63},"\u002Fdisbursements\u002Fget-started","disbursements\u002F1.get-started",{"title":237,"markets":18,"order":66,"path":238,"stem":239,"children":240,"page":19},"Transfers","\u002Fdisbursements\u002Ftransfers","disbursements\u002Ftransfers",[241,245,253,257,261,265,269],{"title":242,"path":243,"stem":244,"markets":18},"Transfer recipients","\u002Fdisbursements\u002Ftransfers\u002Frecipients","disbursements\u002Ftransfers\u002F01.recipients",{"title":246,"path":247,"stem":248,"markets":249},"Verify an account number","\u002Fdisbursements\u002Ftransfers\u002Fverify-account","disbursements\u002Ftransfers\u002F02.verify-account",[250,251,252],"ng","gh","za",{"title":254,"path":255,"stem":256,"markets":18},"Send money to a single recipient","\u002Fdisbursements\u002Ftransfers\u002Fsingle-transfers","disbursements\u002Ftransfers\u002F03.single-transfers",{"title":258,"path":259,"stem":260,"markets":18},"Send money to multiple recipients","\u002Fdisbursements\u002Ftransfers\u002Fbulk-transfers","disbursements\u002Ftransfers\u002F04.bulk-transfers",{"title":262,"path":263,"stem":264,"markets":18},"Check your balance","\u002Fdisbursements\u002Ftransfers\u002Fbalance-management","disbursements\u002Ftransfers\u002F05.balance-management",{"title":266,"path":267,"stem":268,"markets":18},"Transfer approval","\u002Fdisbursements\u002Ftransfers\u002Ftransfer-approval","disbursements\u002Ftransfers\u002F06.transfer-approval",{"title":270,"path":271,"stem":272,"markets":18},"How transfers work","\u002Fdisbursements\u002Ftransfers\u002Fhow-transfers-work","disbursements\u002Ftransfers\u002F07.how-transfers-work",{"title":274,"path":275,"stem":251,"children":276,"page":19},"Gh","\u002Fgh",[277],{"title":10,"path":278,"stem":279,"children":280,"markets":18,"order":55},"\u002Fgh\u002Fpayments","gh\u002Fpayments\u002Findex",[281,282,316],{"title":10,"path":278,"stem":279,"markets":18,"order":55},{"title":283,"markets":18,"order":66,"path":284,"stem":285,"children":286},"Payment channels","\u002Fgh\u002Fpayments\u002Fchannels","gh\u002Fpayments\u002Fchannels\u002Findex",[287,289,294,298,308,312],{"title":288,"path":284,"stem":285,"markets":18,"order":55},"Overview",{"title":290,"path":291,"stem":292,"markets":18,"order":293},"Apple Pay","\u002Fgh\u002Fpayments\u002Fchannels\u002Fapple-pay","gh\u002Fpayments\u002Fchannels\u002Fapple-pay",98,{"title":295,"path":296,"stem":297,"markets":18,"order":66},"Cards","\u002Fgh\u002Fpayments\u002Fchannels\u002Fcards","gh\u002Fpayments\u002Fchannels\u002Fcards",{"title":299,"markets":18,"order":75,"path":300,"stem":301,"children":302},"Dedicated Virtual Accounts","\u002Fgh\u002Fpayments\u002Fchannels\u002Fdedicated-virtual-accounts","gh\u002Fpayments\u002Fchannels\u002Fdedicated-virtual-accounts\u002Findex",[303,304],{"title":299,"path":300,"stem":301,"markets":18},{"title":305,"path":306,"stem":307,"markets":18},"Create and Assign Dedicated Virtual Accounts","\u002Fgh\u002Fpayments\u002Fchannels\u002Fdedicated-virtual-accounts\u002Fcreate-and-assign-dedicated-virtual-accounts","gh\u002Fpayments\u002Fchannels\u002Fdedicated-virtual-accounts\u002Fcreate-and-assign-dedicated-virtual-accounts",{"title":309,"path":310,"stem":311,"markets":18,"order":63},"Mobile Money","\u002Fgh\u002Fpayments\u002Fchannels\u002Fmobile-money","gh\u002Fpayments\u002Fchannels\u002Fmobile-money",{"title":313,"path":314,"stem":315,"markets":18,"order":84},"Pay with Transfer","\u002Fgh\u002Fpayments\u002Fchannels\u002Fpwt","gh\u002Fpayments\u002Fchannels\u002Fpwt",{"title":317,"path":318,"stem":319,"children":320,"markets":18,"order":107},"In-person","\u002Fgh\u002Fpayments\u002Fin-person","gh\u002Fpayments\u002Fin-person\u002Findex",[321,322],{"title":288,"path":318,"stem":319,"markets":18,"order":55},{"title":323,"path":324,"stem":325,"markets":18,"order":63},"Virtual Terminal","\u002Fgh\u002Fpayments\u002Fin-person\u002Fvirtual-terminal","gh\u002Fpayments\u002Fin-person\u002Fvirtual-terminal",{"title":327,"path":328,"stem":329,"markets":18},"Home","\u002F","index",{"title":331,"path":332,"stem":333,"children":334,"page":19},"Ke","\u002Fke","ke",[335],{"title":10,"path":336,"stem":337,"children":338,"markets":18,"order":55},"\u002Fke\u002Fpayments","ke\u002Fpayments\u002Findex",[339,340,362],{"title":10,"path":336,"stem":337,"markets":18,"order":55},{"title":283,"markets":18,"order":66,"path":341,"stem":342,"children":343},"\u002Fke\u002Fpayments\u002Fchannels","ke\u002Fpayments\u002Fchannels\u002Findex",[344,345,348,351,354,358],{"title":288,"path":341,"stem":342,"markets":18,"order":55},{"title":290,"path":346,"stem":347,"markets":18,"order":293},"\u002Fke\u002Fpayments\u002Fchannels\u002Fapple-pay","ke\u002Fpayments\u002Fchannels\u002Fapple-pay",{"title":295,"path":349,"stem":350,"markets":18,"order":84},"\u002Fke\u002Fpayments\u002Fchannels\u002Fcards","ke\u002Fpayments\u002Fchannels\u002Fcards",{"title":309,"path":352,"stem":353,"markets":18,"order":66},"\u002Fke\u002Fpayments\u002Fchannels\u002Fmobile-money","ke\u002Fpayments\u002Fchannels\u002Fmobile-money",{"title":355,"path":356,"stem":357,"markets":18,"order":63},"M-PESA","\u002Fke\u002Fpayments\u002Fchannels\u002Fmpesa","ke\u002Fpayments\u002Fchannels\u002Fmpesa",{"title":359,"path":360,"stem":361,"markets":18,"order":75},"PesaLink","\u002Fke\u002Fpayments\u002Fchannels\u002Fpesalink","ke\u002Fpayments\u002Fchannels\u002Fpesalink",{"title":317,"path":363,"stem":364,"children":365,"markets":18,"order":107},"\u002Fke\u002Fpayments\u002Fin-person","ke\u002Fpayments\u002Fin-person\u002Findex",[366,367],{"title":288,"path":363,"stem":364,"markets":18,"order":55},{"title":323,"path":368,"stem":369,"markets":18,"order":63},"\u002Fke\u002Fpayments\u002Fin-person\u002Fvirtual-terminal","ke\u002Fpayments\u002Fin-person\u002Fvirtual-terminal",{"title":371,"path":372,"stem":373,"children":374},"Operations","\u002Foperations","operations",[375,377,386,395,404,421],{"title":371,"path":372,"stem":376,"markets":18,"order":55},"operations\u002Findex",{"title":378,"markets":18,"order":84,"path":379,"stem":380,"children":381,"page":19},"Refunds","\u002Foperations\u002Frefunds","operations\u002F3.refunds",[382],{"title":383,"path":384,"stem":385,"markets":18},"How to issue a refund","\u002Foperations\u002Frefunds\u002Fprocess-a-refund","operations\u002F3.refunds\u002Fprocess-a-refund",{"title":387,"markets":18,"order":75,"path":388,"stem":389,"children":390,"page":19},"Disputes","\u002Foperations\u002Fdisputes","operations\u002F4.disputes",[391],{"title":392,"path":393,"stem":394,"markets":18},"How to manage disputes","\u002Foperations\u002Fdisputes\u002Fmanage-disputes","operations\u002F4.disputes\u002Fmanage-disputes",{"title":396,"markets":18,"order":107,"path":397,"stem":398,"children":399,"page":19},"Settlements","\u002Foperations\u002Fsettlements","operations\u002F5.settlements",[400],{"title":401,"path":402,"stem":403,"markets":18},"Settlements reference","\u002Foperations\u002Fsettlements\u002Fview-settlements","operations\u002F5.settlements\u002Fview-settlements",{"title":405,"markets":18,"order":134,"path":406,"stem":407,"children":408,"page":19},"Verification","\u002Foperations\u002Fverification","operations\u002F6.verification",[409,413,417],{"title":410,"path":411,"stem":412,"markets":18,"order":84},"Resolve BVN","\u002Foperations\u002Fverification\u002Fresolve-bvn","operations\u002F6.verification\u002Fresolve-bvn",{"title":414,"path":415,"stem":416,"markets":18,"order":66},"Resolve Card BIN","\u002Foperations\u002Fverification\u002Fresolve-card-bin","operations\u002F6.verification\u002Fresolve-card-bin",{"title":418,"path":419,"stem":420,"markets":18,"order":75},"Verify BVN Match","\u002Foperations\u002Fverification\u002Fverify-bvn-match","operations\u002F6.verification\u002Fverify-bvn-match",{"title":152,"markets":18,"order":422,"path":423,"stem":424,"children":425,"page":19},8,"\u002Foperations\u002Fconcepts","operations\u002F8.concepts",[426,430,434,438],{"title":427,"path":428,"stem":429,"markets":18,"order":75},"Customer Lifecycle in Paystack","\u002Foperations\u002Fconcepts\u002Fcustomer-lifecycle","operations\u002F8.concepts\u002Fcustomer-lifecycle",{"title":431,"path":432,"stem":433,"markets":18,"order":66},"The Dispute Resolution Process","\u002Foperations\u002Fconcepts\u002Fdispute-resolution","operations\u002F8.concepts\u002Fdispute-resolution",{"title":435,"path":436,"stem":437,"markets":18,"order":63},"How Settlements Work","\u002Foperations\u002Fconcepts\u002Fhow-settlements-work","operations\u002F8.concepts\u002Fhow-settlements-work",{"title":439,"path":440,"stem":441,"markets":18,"order":84},"Refund Timelines by Channel","\u002Foperations\u002Fconcepts\u002Frefund-timelines","operations\u002F8.concepts\u002Frefund-timelines",{"title":10,"path":443,"stem":444,"children":445},"\u002Fpayments","payments",[446,448,486,538,576,607,625],{"title":10,"path":443,"stem":447,"markets":18,"order":55},"payments\u002Findex",{"title":283,"markets":18,"order":66,"path":449,"stem":450,"children":451},"\u002Fpayments\u002Fchannels","payments\u002F2.channels\u002Findex",[452,454,457,461,464,479,482],{"title":453,"path":449,"stem":450,"markets":18,"order":55},"Payment Channels",{"title":290,"path":455,"stem":456,"markets":18,"order":293},"\u002Fpayments\u002Fchannels\u002Fapple-pay","payments\u002F2.channels\u002Fapple-pay",{"title":458,"path":459,"stem":460,"markets":18,"order":75},"Bank Accounts","\u002Fpayments\u002Fchannels\u002Fbank","payments\u002F2.channels\u002Fbank",{"title":295,"path":462,"stem":463,"markets":18,"order":63},"\u002Fpayments\u002Fchannels\u002Fcards","payments\u002F2.channels\u002Fcards",{"title":299,"markets":18,"order":84,"path":465,"stem":466,"children":467},"\u002Fpayments\u002Fchannels\u002Fdedicated-virtual-accounts","payments\u002F2.channels\u002Fdedicated-virtual-accounts\u002Findex",[468,470,474],{"title":299,"path":465,"stem":466,"markets":469},[250,251],{"title":305,"path":471,"stem":472,"markets":473},"\u002Fpayments\u002Fchannels\u002Fdedicated-virtual-accounts\u002Fcreate-and-assign-dedicated-virtual-accounts","payments\u002F2.channels\u002Fdedicated-virtual-accounts\u002Fcreate-and-assign-dedicated-virtual-accounts",[250,251],{"title":475,"path":476,"stem":477,"markets":478},"Validate Customer","\u002Fpayments\u002Fchannels\u002Fdedicated-virtual-accounts\u002Fvalidate-customer","payments\u002F2.channels\u002Fdedicated-virtual-accounts\u002Fvalidate-customer",[250],{"title":313,"path":480,"stem":481,"markets":18,"order":66},"\u002Fpayments\u002Fchannels\u002Fpwt","payments\u002F2.channels\u002Fpwt",{"title":483,"path":484,"stem":485,"markets":18,"order":107},"USSD","\u002Fpayments\u002Fchannels\u002Fussd","payments\u002F2.channels\u002Fussd",{"title":487,"markets":18,"order":84,"path":488,"stem":489,"children":490},"Online","\u002Fpayments\u002Fonline","payments\u002F3.online\u002Findex",[491,493,507,526,530,534],{"title":492,"path":488,"stem":489,"markets":18,"order":55},"Online payments",{"title":494,"path":495,"stem":496,"children":497,"markets":18,"order":66},"Checkout","\u002Fpayments\u002Fonline\u002Fcheckout","payments\u002F3.online\u002F1.checkout\u002Findex",[498,499,503],{"title":494,"path":495,"stem":496,"markets":18,"order":55},{"title":500,"path":501,"stem":502,"markets":18},"How to integrate Popup Checkout","\u002Fpayments\u002Fonline\u002Fcheckout\u002Fpopup","payments\u002F3.online\u002F1.checkout\u002Fpopup",{"title":504,"path":505,"stem":506,"markets":18},"How to integrate Redirect Checkout","\u002Fpayments\u002Fonline\u002Fcheckout\u002Fredirect","payments\u002F3.online\u002F1.checkout\u002Fredirect",{"title":508,"markets":18,"order":84,"path":509,"stem":510,"children":511},"Charge API","\u002Fpayments\u002Fonline\u002Fcharge-api","payments\u002F3.online\u002F2.charge-api\u002Findex",[512,513,518,522],{"title":508,"path":509,"stem":510,"markets":18,"order":55},{"title":514,"path":515,"stem":516,"markets":517},"How to charge via bank transfer","\u002Fpayments\u002Fonline\u002Fcharge-api\u002Fbank-transfers","payments\u002F3.online\u002F2.charge-api\u002Fbank-transfers",[250,251],{"title":519,"path":520,"stem":521,"markets":18},"How to charge a card","\u002Fpayments\u002Fonline\u002Fcharge-api\u002Fcards","payments\u002F3.online\u002F2.charge-api\u002Fcards",{"title":523,"path":524,"stem":525,"markets":18},"Charge your first card in 10 minutes","\u002Fpayments\u002Fonline\u002Fcharge-api\u002Fquickstart","payments\u002F3.online\u002F2.charge-api\u002Fquickstart",{"title":527,"path":528,"stem":529,"markets":18},"Metadata reference","\u002Fpayments\u002Fonline\u002Fmetadata","payments\u002F3.online\u002Fmetadata",{"title":531,"path":532,"stem":533,"markets":18,"order":63},"Build your first checkout","\u002Fpayments\u002Fonline\u002Fquickstart","payments\u002F3.online\u002Fquickstart",{"title":535,"path":536,"stem":537,"markets":18},"Verify a payment","\u002Fpayments\u002Fonline\u002Fverify-payments","payments\u002F3.online\u002Fverify-payments",{"title":539,"markets":18,"order":75,"path":540,"stem":541,"children":542},"Recurring","\u002Fpayments\u002Frecurring","payments\u002F4.recurring\u002Findex",[543,545,561,565],{"title":544,"path":540,"stem":541,"markets":18,"order":55},"Recurring payments",{"title":546,"markets":18,"order":63,"path":547,"stem":548,"children":549},"Charge authorization","\u002Fpayments\u002Frecurring\u002Fcharge-authorization","payments\u002F4.recurring\u002F1.charge-authorization\u002Findex",[550,552,557],{"title":551,"path":547,"stem":548,"markets":18,"order":55},"How to set up recurring charges",{"title":553,"path":554,"stem":555,"markets":556,"order":66},"Direct Debit","\u002Fpayments\u002Frecurring\u002Fcharge-authorization\u002Fdirect-debit","payments\u002F4.recurring\u002F1.charge-authorization\u002Fdirect-debit",[250],{"title":558,"path":559,"stem":560,"markets":18,"order":63},"How to use partial debits","\u002Fpayments\u002Frecurring\u002Fcharge-authorization\u002Fpartial-debits","payments\u002F4.recurring\u002F1.charge-authorization\u002Fpartial-debits",{"title":562,"path":563,"stem":564,"markets":18,"order":66},"How to run bulk charges","\u002Fpayments\u002Frecurring\u002Fbulk-charge","payments\u002F4.recurring\u002F2.bulk-charge",{"title":566,"path":567,"stem":568,"children":569,"markets":18,"order":84},"Subscriptions","\u002Fpayments\u002Frecurring\u002Fsubscriptions","payments\u002F4.recurring\u002F3.subscriptions\u002Findex",[570,572],{"title":571,"path":567,"stem":568,"markets":18},"How subscriptions work",{"title":573,"path":574,"stem":575,"markets":18},"Set up your first subscription in 15 minutes","\u002Fpayments\u002Frecurring\u002Fsubscriptions\u002Fquickstart","payments\u002F4.recurring\u002F3.subscriptions\u002Fquickstart",{"title":317,"markets":18,"order":107,"path":577,"stem":578,"children":579},"\u002Fpayments\u002Fin-person","payments\u002F5.in-person\u002Findex",[580,582,604],{"title":581,"path":577,"stem":578,"markets":18,"order":55},"In-person payments",{"title":583,"markets":18,"order":63,"path":584,"stem":585,"children":586},"Physical Terminal","\u002Fpayments\u002Fin-person\u002Fphysical-terminal","payments\u002F5.in-person\u002F1.physical-terminal\u002Findex",[587,588,592,596,600],{"title":583,"path":584,"stem":585,"markets":18,"order":55},{"title":589,"path":590,"stem":591,"markets":18},"Custom Terminal apps","\u002Fpayments\u002Fin-person\u002Fphysical-terminal\u002Fcustom-apps","payments\u002F5.in-person\u002F1.physical-terminal\u002Fcustom-apps",{"title":593,"path":594,"stem":595,"markets":18,"order":63},"Your First Terminal Integration","\u002Fpayments\u002Fin-person\u002Fphysical-terminal\u002Fget-started","payments\u002F5.in-person\u002F1.physical-terminal\u002Fget-started",{"title":597,"path":598,"stem":599,"markets":18},"Invoice payments on Terminal","\u002Fpayments\u002Fin-person\u002Fphysical-terminal\u002Finvoice-payments","payments\u002F5.in-person\u002F1.physical-terminal\u002Finvoice-payments",{"title":601,"path":602,"stem":603,"markets":18},"Push payment requests","\u002Fpayments\u002Fin-person\u002Fphysical-terminal\u002Fpush-payment-requests","payments\u002F5.in-person\u002F1.physical-terminal\u002Fpush-payment-requests",{"title":323,"path":605,"stem":606,"markets":18,"order":66},"\u002Fpayments\u002Fin-person\u002Fvirtual-terminal","payments\u002F5.in-person\u002Fvirtual-terminal",{"title":608,"markets":18,"order":134,"path":609,"stem":610,"children":611},"Split payments","\u002Fpayments\u002Fsplit-payments","payments\u002F6.split-payments\u002Findex",[612,613,617,621],{"title":608,"path":609,"stem":610,"markets":18,"order":55},{"title":614,"path":615,"stem":616,"markets":18,"order":63},"Create a subaccount","\u002Fpayments\u002Fsplit-payments\u002Fsubaccounts","payments\u002F6.split-payments\u002F1.subaccounts",{"title":618,"path":619,"stem":620,"markets":18,"order":66},"Split a payment with a subaccount","\u002Fpayments\u002Fsplit-payments\u002Fsingle-split","payments\u002F6.split-payments\u002F2.single-split",{"title":622,"path":623,"stem":624,"markets":18,"order":84},"Split a payment across multiple subaccounts","\u002Fpayments\u002Fsplit-payments\u002Fmulti-split","payments\u002F6.split-payments\u002F3.multi-split",{"title":152,"markets":18,"order":153,"path":626,"stem":627,"children":628,"page":19},"\u002Fpayments\u002Fconcepts","payments\u002F7.concepts",[629,633,637],{"title":630,"path":631,"stem":632,"markets":18,"order":63},"Payment flow","\u002Fpayments\u002Fconcepts\u002Fpayment-flow","payments\u002F7.concepts\u002Fpayment-flow",{"title":634,"path":635,"stem":636,"markets":18,"order":84},"Transaction statuses","\u002Fpayments\u002Fconcepts\u002Ftransaction-statuses","payments\u002F7.concepts\u002Ftransaction-statuses",{"title":638,"path":639,"stem":640,"markets":18,"order":66},"Webhooks vs polling","\u002Fpayments\u002Fconcepts\u002Fwebhooks-vs-polling","payments\u002F7.concepts\u002Fwebhooks-vs-polling",{"title":642,"path":643,"stem":644,"children":645},"Use Cases","\u002Fuse-cases","use-cases",[646,649,670,687,704,721],{"title":647,"path":643,"stem":648,"markets":18,"order":55},"Use-cases","use-cases\u002Findex",{"title":650,"markets":18,"order":63,"path":651,"stem":652,"children":653,"page":19},"Fintech","\u002Fuse-cases\u002Ffintech","use-cases\u002F1.fintech",[654,658,662,666],{"title":655,"path":656,"stem":657,"markets":18},"Fund a Wallet with Paystack","\u002Fuse-cases\u002Ffintech\u002Fwallet-funding","use-cases\u002F1.fintech\u002F1.wallet-funding",{"title":659,"path":660,"stem":661,"markets":18},"Send Money Between Users","\u002Fuse-cases\u002Ffintech\u002Fpeer-to-peer-transfers","use-cases\u002F1.fintech\u002F2.peer-to-peer-transfers",{"title":663,"path":664,"stem":665,"markets":18},"Set Up Recurring Savings Contributions","\u002Fuse-cases\u002Ffintech\u002Fsavings-investment-apps","use-cases\u002F1.fintech\u002F3.savings-investment-apps",{"title":667,"path":668,"stem":669,"markets":18},"Automate Loan Repayment Collection","\u002Fuse-cases\u002Ffintech\u002Flending-loan-repayments","use-cases\u002F1.fintech\u002F4.lending-loan-repayments",{"title":671,"markets":18,"order":66,"path":672,"stem":673,"children":674,"page":19},"E-commerce","\u002Fuse-cases\u002Fecommerce","use-cases\u002F2.ecommerce",[675,679,683],{"title":676,"path":677,"stem":678,"markets":18},"Split Payments Between a Platform and Vendors","\u002Fuse-cases\u002Fecommerce\u002Fmarketplace-split-payments","use-cases\u002F2.ecommerce\u002F1.marketplace-split-payments",{"title":680,"path":681,"stem":682,"markets":18},"Charge Customers on a Monthly Subscription","\u002Fuse-cases\u002Fecommerce\u002Fsubscription-box-store","use-cases\u002F2.ecommerce\u002F2.subscription-box-store",{"title":684,"path":685,"stem":686,"markets":18},"Sell and Deliver Digital Products","\u002Fuse-cases\u002Fecommerce\u002Fdigital-downloads","use-cases\u002F2.ecommerce\u002F3.digital-downloads",{"title":688,"markets":18,"order":84,"path":689,"stem":690,"children":691,"page":19},"Gaming & entertainment","\u002Fuse-cases\u002Fgaming","use-cases\u002F3.gaming",[692,696,700],{"title":693,"path":694,"stem":695,"markets":18},"Accept In-app Purchases on Mobile","\u002Fuse-cases\u002Fgaming\u002Fin-app-purchases","use-cases\u002F3.gaming\u002F1.in-app-purchases",{"title":697,"path":698,"stem":699,"markets":18},"Offer Premium Membership Tiers","\u002Fuse-cases\u002Fgaming\u002Fsubscription-memberships","use-cases\u002F3.gaming\u002F2.subscription-memberships",{"title":701,"path":702,"stem":703,"markets":18},"Sell Virtual Currency (Coins\u002FGems)","\u002Fuse-cases\u002Fgaming\u002Fvirtual-currency-top-ups","use-cases\u002F3.gaming\u002F3.virtual-currency-top-ups",{"title":705,"markets":18,"order":75,"path":706,"stem":707,"children":708,"page":19},"Transportation","\u002Fuse-cases\u002Ftransportation","use-cases\u002F4.transportation",[709,713,717],{"title":710,"path":711,"stem":712,"markets":18},"Capture and Charge Rides with Preauthorization","\u002Fuse-cases\u002Ftransportation\u002Fride-hailing-payment-flow","use-cases\u002F4.transportation\u002F1.ride-hailing-payment-flow",{"title":714,"path":715,"stem":716,"markets":18},"Pay Drivers in Bulk After Each Shift","\u002Fuse-cases\u002Ftransportation\u002Ffleet-driver-payouts","use-cases\u002F4.transportation\u002F2.fleet-driver-payouts",{"title":718,"path":719,"stem":720,"markets":18},"Accept Toll and Ticket Payments Online","\u002Fuse-cases\u002Ftransportation\u002Ftoll-ticketing","use-cases\u002F4.transportation\u002F3.toll-ticketing",{"title":722,"markets":18,"order":107,"path":723,"stem":724,"children":725,"page":19},"Travel & hospitality","\u002Fuse-cases\u002Ftravel","use-cases\u002F5.travel",[726,730,734],{"title":727,"path":728,"stem":729,"markets":18},"Hold a Deposit on Hotel Booking","\u002Fuse-cases\u002Ftravel\u002Fhotel-booking-preauthorization","use-cases\u002F5.travel\u002F1.hotel-booking-preauthorization",{"title":731,"path":732,"stem":733,"markets":18},"Sell Flight Tickets and Process Refunds","\u002Fuse-cases\u002Ftravel\u002Fflight-ticketing-refunds","use-cases\u002F5.travel\u002F2.flight-ticketing-refunds",{"title":735,"path":736,"stem":737,"markets":18},"Sell Tour Experiences with Split Revenue","\u002Fuse-cases\u002Ftravel\u002Ftour-experience-bookings","use-cases\u002F5.travel\u002F3.tour-experience-bookings",{"title":739,"path":740,"stem":252,"children":741,"page":19},"Za","\u002Fza",[742],{"title":10,"path":743,"stem":744,"children":745,"markets":18,"order":55},"\u002Fza\u002Fpayments","za\u002Fpayments\u002Findex",[746,747,779],{"title":10,"path":743,"stem":744,"markets":18,"order":55},{"title":283,"markets":18,"order":66,"path":748,"stem":749,"children":750},"\u002Fza\u002Fpayments\u002Fchannels","za\u002Fpayments\u002Fchannels\u002Findex",[751,752,755,759,763,766,771,775],{"title":288,"path":748,"stem":749,"markets":18,"order":55},{"title":290,"path":753,"stem":754,"markets":18,"order":293},"\u002Fza\u002Fpayments\u002Fchannels\u002Fapple-pay","za\u002Fpayments\u002Fchannels\u002Fapple-pay",{"title":756,"path":757,"stem":758,"markets":18,"order":84},"Capitec Pay","\u002Fza\u002Fpayments\u002Fchannels\u002Fcapitec-pay","za\u002Fpayments\u002Fchannels\u002Fcapitec-pay",{"title":760,"path":761,"stem":762,"markets":18,"order":107},"Card Preauthorization","\u002Fza\u002Fpayments\u002Fchannels\u002Fcard-preauthorization","za\u002Fpayments\u002Fchannels\u002Fcard-preauthorization",{"title":295,"path":764,"stem":765,"markets":18,"order":63},"\u002Fza\u002Fpayments\u002Fchannels\u002Fcards","za\u002Fpayments\u002Fchannels\u002Fcards",{"title":767,"path":768,"stem":769,"markets":18,"order":770},"Google Pay","\u002Fza\u002Fpayments\u002Fchannels\u002Fgoogle-pay","za\u002Fpayments\u002Fchannels\u002Fgoogle-pay",99,{"title":772,"path":773,"stem":774,"markets":18,"order":66},"Instant EFT","\u002Fza\u002Fpayments\u002Fchannels\u002Finstant-eft","za\u002Fpayments\u002Fchannels\u002Finstant-eft",{"title":776,"path":777,"stem":778,"markets":18,"order":75},"QR code payments","\u002Fza\u002Fpayments\u002Fchannels\u002Fqr-codes","za\u002Fpayments\u002Fchannels\u002Fqr-codes",{"title":317,"path":780,"stem":781,"children":782,"markets":18,"order":107},"\u002Fza\u002Fpayments\u002Fin-person","za\u002Fpayments\u002Fin-person\u002Findex",[783,784],{"title":288,"path":780,"stem":781,"markets":18,"order":55},{"title":323,"path":785,"stem":786,"markets":18,"order":63},"\u002Fza\u002Fpayments\u002Fin-person\u002Fvirtual-terminal","za\u002Fpayments\u002Fin-person\u002Fvirtual-terminal",{"id":788,"title":508,"body":789,"description":874,"extension":875,"markets":18,"meta":876,"navigation":877,"path":509,"seo":878,"stem":510,"type":879,"whats_next":18,"__hash__":880},"content\u002Fpayments\u002F3.online\u002F2.charge-api\u002Findex.md",{"type":790,"value":791,"toc":871},"minimark",[792,796,799,802,818,855,862,865,868],[793,794,795],"p",{},"The Charge API is Paystack’s direct payment API for businesses that want to control how a payment is initiated and how each customer prompt is handled. Instead of sending customers to a hosted Checkout flow first, you submit a charge request to Paystack and respond to the result Paystack returns.",[793,797,798],{},"That makes the Charge API useful when you need a custom payment UI, tighter control over channel-specific behavior, or a server-orchestrated flow inside a mobile app, embedded product, or specialized checkout experience. It is also useful when the payment method itself determines the user experience, such as card prompts, temporary bank transfer accounts, USSD, or mobile money authorization on the customer’s phone.",[793,800,801],{},"The flow is usually multi-step.",[793,803,804,805,809,810,813,814,817],{},"First, you submit a charge request with the customer, amount, currency, and channel-specific fields. For cards, that includes the ",[806,807,808],"code",{},"card"," object. For bank transfer, it includes ",[806,811,812],{},"bank_transfer",". For mobile money, it includes ",[806,815,816],{},"mobile_money",".",[793,819,820,821,824,825,824,828,824,831,824,834,824,837,824,840,824,843,846,847,850,851,854],{},"Next, Paystack returns a charge state that tells you what should happen next. A card charge may return ",[806,822,823],{},"send_pin",", ",[806,826,827],{},"send_otp",[806,829,830],{},"send_phone",[806,832,833],{},"send_birthday",[806,835,836],{},"send_address",[806,838,839],{},"open_url",[806,841,842],{},"pending",[806,844,845],{},"success",", or ",[806,848,849],{},"failed",". Mobile money and some other channels can return ",[806,852,853],{},"pay_offline",", which means the customer must finish authorization on another device or network surface. Bank transfer flows can remain pending while the customer completes the transfer.",[793,856,857,858,861],{},"Finally, your server confirms the result with a webhook or the verify endpoint, because the payment may complete after the initial API response. See ",[859,860,630],"a",{"href":631}," for the full lifecycle.",[793,863,864],{},"Compared with Checkout, the Charge API gives you more control but also more responsibility. Your application must decide how to display prompts, when to poll or verify, how to handle redirects, and how to manage failed or incomplete flows.",[793,866,867],{},"That extra control has compliance implications. If you collect raw card details in your own interface, your business must be PCI DSS compliant. Paystack explicitly recommends that only compliant businesses use the direct card charging flow. If you want Paystack to host the payment UI and reduce scope, Checkout is usually the better fit.",[793,869,870],{},"In practice, choose Checkout when you want speed and a hosted payment surface. Choose the Charge API when you want channel-level control and are prepared to own the operational and compliance complexity that comes with it.",{"title":872,"searchDepth":66,"depth":66,"links":873},"",[],"Understand when to use the Charge API and how its multi-step payment flow works.","md",{},{"order":55},{"title":508,"description":874},"explanation","J8-s7__X-jjK0B2bD1MOZ8P7BPcX9iM8Z0IlyX83FTE",1794998081436]