This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full Cards guide for a step-by-step walkthrough.
Note:
The Card Acquirer Response Codes with descriptions can be found here
Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Payaza Documentation","colors":{"primary":"#31044F","light":"#C4B5FD","dark":"#31044F"},"logo":{"light":"https://mintcdn.com/payazaafrica/ui3YNZKQDioJXnZa/images/dev-light.svg?fit=max\u0026auto=format\u0026n=ui3YNZKQDioJXnZa\u0026q=85\u0026s=b97f560ac5252499e096df1ec8097964","dark":"https://mintcdn.com/payazaafrica/ui3YNZKQDioJXnZa/images/dev-dark.svg?fit=max\u0026auto=format\u0026n=ui3YNZKQDioJXnZa\u0026q=85\u0026s=5e8daf7e1d6999ecca26b84e225b8472"},"favicon":"https://mintcdn.com/payazaafrica/ZNJujSOwGSjNHyWU/images/payazafavicon.svg?fit=max\u0026auto=format\u0026n=ZNJujSOwGSjNHyWU\u0026q=85\u0026s=dbff6a14dad529b5e3b96cfd67ecc544","navbar":{"links":[{"href":"mailto:support@payaza.africa","label":"Support"},{"icon":"credit-card","href":"https://payaza.africa/checkout","label":"Try Our Checkout"}],"primary":{"type":"button","label":"Dashboard","href":"https://business.payaza.africa"}},"footer":{"socials":{"x":"https://x.com/mypayaza","linkedin":"https://www.linkedin.com/company/payaza-africa","instagram":"https://www.instagram.com/mypayaza"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"payazaafrica","hasAudioNarration":false,"actualSubdomain":"payazaafrica","customDomains":["docs.payaza.africa"],"gitSource":{"type":"github","owner":"78-financials","repo":"payaza-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae085db6c1a15a18d9d7104","collectionId":"6baa26cc-479d-4342-b88b-83241e472418","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae085db6c1a15a18d9d7104"},"entitlements":{},"buildId":"6ae085db6c1a15a18d9d7104","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":59},{"language":"default","tag":"Documentation","count":23},{"language":"default","tag":"Payment Links","count":7},{"language":"default","tag":"Libraries \u0026 SDKs","count":6},{"language":"default","tag":"SDKs","count":6},{"language":"default","tag":"Accept Payments","count":6},{"language":"default","tag":"Split Settlements","count":5},{"language":"default","tag":"Subscriptions","count":5},{"language":"default","tag":"Auth-Capture-Void","count":5},{"language":"default","tag":"Refunds And Chargebacks","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: italic;\n font-weight: 100 1000;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Fp2ywxg089UriCZa4ET-DNl0.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: italic;\n font-weight: 100 1000;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Fp2ywxg089UriCZa4Hz-D.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 100 1000;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Hp2ywxg089UriCZ2IHSeH.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 100 1000;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: italic;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizBREVItHgc8qDIbSTKq4XkRiUa6zgTjmbI.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: italic;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizBREVItHgc8qDIbSTKq4XkRiUa6zETjmbI.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: italic;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizBREVItHgc8qDIbSTKq4XkRiUa6zoTjmbI.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: italic;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizBREVItHgc8qDIbSTKq4XkRiUa6zsTjmbI.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: italic;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizBREVItHgc8qDIbSTKq4XkRiUa6zUTjg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUS2zcLig.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUb2zcLig.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUQ2zcLig.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUR2zcLig.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUf2zc.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n.mdx-content th,body,li,p{font-family:\"DM Sans\",sans-serif!important}body,li,p,span{letter-spacing:.01rem}body,li,p{font-size:.9375rem;line-height:1.7}span{font-family:\"DM Sans\",sans-serif}h1,h2,h3,h4{font-family:\"Libre Franklin\",serif!important;font-weight:700;margin-top:1.5rem!important;margin-bottom:.75rem!important}.eyebrow{color:#9ca3af!important;font-size:.72rem!important;font-weight:500!important;text-transform:uppercase;letter-spacing:.08rem}.mdx-content h1{font-size:1.875rem!important;font-weight:800!important;letter-spacing:-.025rem;margin-top:0!important;margin-bottom:.625rem!important;line-height:1.2!important}.mdx-content h2{font-size:1.125rem!important;font-weight:700!important;border-top:1px solid #e5e7eb;padding-top:1.5rem!important;margin-top:2rem!important;margin-bottom:.625rem!important;line-height:1.3!important}.dark .mdx-content h2,.dark .mdx-content hr{border-top-color:rgba(255,255,255,.07)}.mdx-content h3{font-size:1rem!important;font-weight:600!important;margin-top:1.5rem!important;margin-bottom:.375rem!important;line-height:1.4!important}.mdx-content h4{font-size:.875rem!important;font-weight:600!important;margin-top:1rem!important;margin-bottom:.25rem!important}.mdx-content hr{border:0;border-top:1px solid #e5e7eb;margin:2rem 0!important}.mdx-content li,.mdx-content p{font-size:.9375rem!important;line-height:1.7!important}.mdx-content p{margin-bottom:.875rem!important}.mdx-content li{margin-bottom:.2rem}.mdx-content strong{font-weight:600}.callout{border-radius:.375rem!important;padding:.75rem 1rem!important;border:0!important;border-left:3px solid!important;gap:.5rem!important;margin-top:1rem!important;margin-bottom:1rem!important}.callout[class*=border-blue]{border-left-color:#3b82f6!important;background-color:rgba(59,130,246,.05)!important}.dark .callout[class*=border-blue]{background-color:rgba(59,130,246,.07)!important;border-left-color:#60a5fa!important}.callout[class*=border-yellow]{border-left-color:#f59e0b!important;background-color:rgba(245,158,11,.05)!important}.dark .callout[class*=border-yellow]{background-color:rgba(245,158,11,.07)!important;border-left-color:#fcd34d!important}.callout[class*=border-green]{border-left-color:#10b981!important;background-color:rgba(16,185,129,.05)!important}.dark .callout[class*=border-green]{background-color:rgba(16,185,129,.07)!important;border-left-color:#34d399!important}.callout[class*=border-red]{border-left-color:#ef4444!important;background-color:rgba(239,68,68,.05)!important}.dark .callout[class*=border-red]{background-color:rgba(239,68,68,.07)!important;border-left-color:#f87171!important}.mdx-content table{font-size:.875rem!important;width:100%;border-collapse:collapse;margin:1.25rem 0!important}.mdx-content th{font-weight:600!important;font-size:.7rem!important;text-transform:uppercase;letter-spacing:.07rem;text-align:left;padding:.625rem 1rem!important;border-bottom:2px solid #e5e7eb;color:#6b7280;white-space:nowrap}.mdx-content td{padding:.625rem 1rem!important;border-bottom:1px solid #f3f4f6;vertical-align:top;line-height:1.6}.dark .mdx-content th{border-bottom-color:rgba(255,255,255,.1);color:#9ca3af}.dark .mdx-content td{border-bottom-color:rgba(255,255,255,.05)}.mdx-content td:first-child{font-weight:500}.mdx-content :not(pre)>code{font-size:.8125rem!important;padding:.15rem .4rem!important;border-radius:.25rem!important;font-weight:500}.method-nav-pill{font-size:9px!important}aside a,aside li,aside p,aside span{font-size:.8rem!important;line-height:1.45rem!important;letter-spacing:.01rem}html:not(.dark) aside .bg-primary\\/10{background-color:transparent!important}aside{width:220px!important;min-width:220px!important;max-width:220px!important;flex-shrink:0!important}aside a{overflow:hidden;text-overflow:ellipsis;white-space:nowrap;max-width:100%;display:block}aside a>span,aside a>svg{flex-shrink:0}main{padding-left:1.75rem!important;padding-right:1.75rem!important}@media (max-width:1280px){aside{width:200px!important;min-width:200px!important;max-width:200px!important}}@media (max-width:768px){main{padding-left:1.25rem!important;padding-right:1.25rem!important}.mdx-content{max-width:100%}}header a[href*=\"payaza.africa/checkout\"]{display:inline-flex!important;align-items:center!important;gap:.4rem!important;padding:.35rem .85rem!important;border-radius:.5rem!important;font-size:.8rem!important;font-weight:600!important;transition:all .2s ease-in-out!important}header a[href*=\"payaza.africa/checkout\"] svg{width:.9rem!important;height:.9rem!important;transition:color .2s ease-in-out!important}html:not(.dark) header a[href*=\"payaza.africa/checkout\"]{background-color:#f3e8ff!important;color:#31044f!important;border:1px solid #d8b4fe!important}html:not(.dark) header a[href*=\"payaza.africa/checkout\"] svg{color:#31044f!important}html:not(.dark) header a[href*=\"payaza.africa/checkout\"]:hover{background-color:#31044f!important;color:#fff!important;border-color:#31044f!important}html:not(.dark) header a[href*=\"payaza.africa/checkout\"]:hover :before,html:not(.dark) header a[href*=\"payaza.africa/checkout\"]:hover [class*=fa-],html:not(.dark) header a[href*=\"payaza.africa/checkout\"]:hover i,html:not(.dark) header a[href*=\"payaza.africa/checkout\"]:hover svg{color:#fff!important;fill:#fff!important;stroke:#fff!important;filter:brightness(0) invert(1)!important}html.dark header a[href*=\"payaza.africa/checkout\"]{background-color:rgba(196,181,253,.1)!important;color:#c4b5fd!important;border:1px solid rgba(196,181,253,.3)!important}html.dark header a[href*=\"payaza.africa/checkout\"] svg{color:#c4b5fd!important}html.dark header a[href*=\"payaza.africa/checkout\"]:hover{background-color:#31044f!important;color:#fff!important;border-color:#c4b5fd!important}html.dark header a[href*=\"payaza.africa/checkout\"]:hover svg{color:#fff!important}"}],"page":{"pagePath":"api-reference/card-collection/card-charge","slug":"/api-reference/card-collection/card-charge","pageMetadata":{"title":"Card Charge","description":"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full [Cards guide](/guides/card-collection) for a step-by-step walkthrough. \n\n**Note:**\n\n- The Card Acquirer Response Codes with descriptions can be found \u003ca href=\"https://docs.google.com/spreadsheets/d/13AmGYgpGxEVNMnTtvBYg_NZaHaBbcp9ZbSfzhR-1ft4/edit?usp=sharing\" target=\"_blank\">here\u003c/a>\n- Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to \u003cb>support@payaza.africa\u003c/b>. You will be granted access once our team reviews and approves your request.\n","deprecated":null,"version":null,"openapi":"/openapi.json post /card/card_charge/","href":"/api-reference/card-collection/card-charge","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full \", _jsx(_components.a, {\n href: \"/guides/card-collection\",\n children: \"Cards guide\"\n }), \" for a step-by-step walkthrough.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Note:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"The Card Acquirer Response Codes with descriptions can be found \", _jsx(\"a\", {\n href: \"https://docs.google.com/spreadsheets/d/13AmGYgpGxEVNMnTtvBYg_NZaHaBbcp9ZbSfzhR-1ft4/edit?usp=sharing\",\n target: \"_blank\",\n children: \"here\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to \", _jsx(\"b\", {\n children: _jsx(_components.a, {\n href: \"mailto:support@payaza.africa\",\n children: \"support@payaza.africa\"\n })\n }), \". You will be granted access once our team reviews and approves your request.\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Card Charge","description":"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full [Cards guide](/guides/card-collection) for a step-by-step walkthrough. \n\n**Note:**\n\n- The Card Acquirer Response Codes with descriptions can be found \u003ca href=\"https://docs.google.com/spreadsheets/d/13AmGYgpGxEVNMnTtvBYg_NZaHaBbcp9ZbSfzhR-1ft4/edit?usp=sharing\" target=\"_blank\">here\u003c/a>\n- Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to \u003cb>support@payaza.africa\u003c/b>. You will be granted access once our team reviews and approves your request.\n","deprecated":null,"version":null,"openapi":"/openapi.json post /card/card_charge/","href":"/api-reference/card-collection/card-charge","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Card Collection"],"summary":"Card Charge","description":"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full [Cards guide](/guides/card-collection) for a step-by-step walkthrough. \n\n**Note:**\n\n- The Card Acquirer Response Codes with descriptions can be found \u003ca href=\"https://docs.google.com/spreadsheets/d/13AmGYgpGxEVNMnTtvBYg_NZaHaBbcp9ZbSfzhR-1ft4/edit?usp=sharing\" target=\"_blank\">here\u003c/a>\n- Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to \u003cb>support@payaza.africa\u003c/b>. You will be granted access once our team reviews and approves your request.\n","x-codeSamples":[{"lang":"3DS Authentication HTMl","label":"3DS Authentication HTML","source":"\u003cbody>\n \u003cdiv id='threedsChallengeRedirect' xmlns='http://www.w3.org/1999/html' style=' height: 100vh'>\n \u003cform id='threedsChallengeRedirectForm' method='POST' action='' target='challengeFrame'>\n \u003cinput type='hidden' name='creq' id=\"creq\" value=''/>\n \u003c/form>\n \u003ciframe id='challengeFrame' name='challengeFrame' width='100%' height='100%'>\u003c/iframe>\n \u003c/div>\n\n \u003cscript>\n const cardNumber = \"4187451844054629\"; // Card Number\n const expiryMonth = \"07\"; // Card Expiry Month\n const expiryYear = \"32\"; // Card Expiry Year\n const securityCode = \"100\"; // Card Security Code\n //const pin = \"1000\"// Card PIN //For NGN cards\n\n\n var myHeaders = new Headers();\n myHeaders.append(\"Authorization\", \"Payaza UFo3OC1QS0xJhsksksMjFFNEYtQ0VCNy00MjAzL4MDktQkU1NEM3NDY1RDRB\");\n myHeaders.append(\"Content-Type\", \"application/json\");\n\n var raw = JSON.stringify({\n \"service_type\": \"Account\",\n \"service_payload\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"johndoe@email.com\",\n \"phone_number\": \"090121980906\",\n \"amount\": 11,\n \"transaction_reference\": \"PL-1KBPSCJCR\" + Math.floor(\n (Math.random() * 10000000) + 1\n ),\n \"currency\": \"NGN\",\n \"description\": \"Test for 3DS\",\n \"card\": {\n \"expiryMonth\": expiryMonth,\n \"expiryYear\": expiryYear,\n \"securityCode\": securityCode,\n \"cardNumber\": cardNumber,\n //\"pin\": pin //For NGN cards\n\n }\n }\n });\n\n var requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n };\n\n fetch(\"https://api.payaza.africa/live/card/card_charge/\", requestOptions).then(response => response.text()).then(result => {\n result = JSON.parse(result);\n if (result.statusOk) { // ///Handle Success Response\n const creq = document.getElementById(\"creq\");\n creq.value = result.formData;\n const form = document.getElementById(\"threedsChallengeRedirectForm\");\n form.setAttribute(\"action\", result.threeDsUrl);\n form.submit();\n } else { // ///Handle Error\n console.log(\"Error found\", result.debugMessage)\n alert(\"Payment Failed: \" + result.debugMessage)\n }\n }).catch(error => {\n console.log(\"Error\", error)\n alert(\"Exception Error: \" + error.debugMessage)\n });\n\n\n\n / ///////////Internal Payment Notification\n window.addEventListener(\"message\", (event) => {\n console.log(\"::::::::::::::::::MESSAGE EVENT GOT BACK FROM BACK-END::::::::::::::::::::::\")\n try{\n const response = JSON.parse(event.data);\n console.log(\"Payment Notification\", response)\n if (response.statusOk !== undefined) {\n if (response.statusOk === true \u0026\u0026 response.paymentCompleted === true) { // ////Handle payment successful, do business logic\n alert(\"Payment Successful\")\n } else { // ///Handle Failed payment\n alert(\"Payment Failed\")\n }\n }\n }catch(error){\n console.log(\"Error from Parsing JSON\",error)\n }\n });\n\n \u003c/script>\n\u003c/body>"}],"security":["b9d26169-3ebe-4a68-83ea-323deedca6f4"],"requestBody":"2751314c-2ac9-4383-9339-d408b1546388","responses":{"200":"49992b09-6728-4a80-a90e-93bfadb28b22","400":"ca7a6294-0e98-46dd-b1c9-d5ae45c2cb22"},"method":"post","type":"path","servers":["188f488e-ff9e-4c4a-9990-f746d694e717"],"path":"/card/card_charge/","baseUrlOptions":["https://api.payaza.africa/live"],"title":"Card Charge","codeSamples":[{"label":"3DS Authentication HTML","lang":"3DS Authentication HTMl","source":"\u003cbody>\n \u003cdiv id='threedsChallengeRedirect' xmlns='http://www.w3.org/1999/html' style=' height: 100vh'>\n \u003cform id='threedsChallengeRedirectForm' method='POST' action='' target='challengeFrame'>\n \u003cinput type='hidden' name='creq' id=\"creq\" value=''/>\n \u003c/form>\n \u003ciframe id='challengeFrame' name='challengeFrame' width='100%' height='100%'>\u003c/iframe>\n \u003c/div>\n\n \u003cscript>\n const cardNumber = \"4187451844054629\"; // Card Number\n const expiryMonth = \"07\"; // Card Expiry Month\n const expiryYear = \"32\"; // Card Expiry Year\n const securityCode = \"100\"; // Card Security Code\n //const pin = \"1000\"// Card PIN //For NGN cards\n\n\n var myHeaders = new Headers();\n myHeaders.append(\"Authorization\", \"Payaza UFo3OC1QS0xJhsksksMjFFNEYtQ0VCNy00MjAzL4MDktQkU1NEM3NDY1RDRB\");\n myHeaders.append(\"Content-Type\", \"application/json\");\n\n var raw = JSON.stringify({\n \"service_type\": \"Account\",\n \"service_payload\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"johndoe@email.com\",\n \"phone_number\": \"090121980906\",\n \"amount\": 11,\n \"transaction_reference\": \"PL-1KBPSCJCR\" + Math.floor(\n (Math.random() * 10000000) + 1\n ),\n \"currency\": \"NGN\",\n \"description\": \"Test for 3DS\",\n \"card\": {\n \"expiryMonth\": expiryMonth,\n \"expiryYear\": expiryYear,\n \"securityCode\": securityCode,\n \"cardNumber\": cardNumber,\n //\"pin\": pin //For NGN cards\n\n }\n }\n });\n\n var requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n };\n\n fetch(\"https://api.payaza.africa/live/card/card_charge/\", requestOptions).then(response => response.text()).then(result => {\n result = JSON.parse(result);\n if (result.statusOk) { // ///Handle Success Response\n const creq = document.getElementById(\"creq\");\n creq.value = result.formData;\n const form = document.getElementById(\"threedsChallengeRedirectForm\");\n form.setAttribute(\"action\", result.threeDsUrl);\n form.submit();\n } else { // ///Handle Error\n console.log(\"Error found\", result.debugMessage)\n alert(\"Payment Failed: \" + result.debugMessage)\n }\n }).catch(error => {\n console.log(\"Error\", error)\n alert(\"Exception Error: \" + error.debugMessage)\n });\n\n\n\n / ///////////Internal Payment Notification\n window.addEventListener(\"message\", (event) => {\n console.log(\"::::::::::::::::::MESSAGE EVENT GOT BACK FROM BACK-END::::::::::::::::::::::\")\n try{\n const response = JSON.parse(event.data);\n console.log(\"Payment Notification\", response)\n if (response.statusOk !== undefined) {\n if (response.statusOk === true \u0026\u0026 response.paymentCompleted === true) { // ////Handle payment successful, do business logic\n alert(\"Payment Successful\")\n } else { // ///Handle Failed payment\n alert(\"Payment Failed\")\n }\n }\n }catch(error){\n console.log(\"Error from Parsing JSON\",error)\n }\n });\n\n \u003c/script>\n\u003c/body>"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Card Charge Request","required":["service_payload"],"properties":{"service_payload":{"type":"object","description":"","required":["first_name","last_name","email_address","phone_number","amount","transaction_reference","currency","description","card"],"properties":{"first_name":{"type":"string","description":"The first name of the customer.","example":"John","isRequired":true,"uniqueKey":"service_payload.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"The last name of the customer.","example":"Doe","isRequired":true,"uniqueKey":"service_payload.last_name","typeLabel":"string"},"email_address":{"type":"string","format":"email","description":"The email address of the customer.","example":"johndoe@hotmail.com","isRequired":true,"uniqueKey":"service_payload.email_address","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","description":"The phone number of the customer.","example":"0939344401","isRequired":true,"uniqueKey":"service_payload.phone_number","typeLabel":"string"},"amount":{"type":"number","format":"double","description":"The amount to be charged.","example":0.01,"isRequired":true,"uniqueKey":"service_payload.amount","typeLabel":"number\u003cdouble>"},"transaction_reference":{"type":"string","description":"The unique identifier given to a particular transaction.","example":"T13501973673737","isRequired":true,"uniqueKey":"service_payload.transaction_reference","typeLabel":"string"},"currency":{"type":"string","description":"Currency code for the transaction. The base currency is NGN","example":"USD","isRequired":true,"uniqueKey":"service_payload.currency","typeLabel":"string"},"description":{"type":"string","description":"Description for the payment.","example":"TEST","isRequired":true,"uniqueKey":"service_payload.description","typeLabel":"string"},"card":{"type":"object","description":"The details of the card.","required":["expiryMonth","expiryYear","securityCode","cardNumber"],"properties":{"expiryMonth":{"type":"string","description":"The month the card will expire.","example":"10","isRequired":true,"uniqueKey":"service_payload.card.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","description":"The year the card will expire","example":"26","isRequired":true,"uniqueKey":"service_payload.card.expiryYear","typeLabel":"string"},"securityCode":{"type":"string","description":"CVV/CVC code.","example":"686","isRequired":true,"uniqueKey":"service_payload.card.securityCode","typeLabel":"string"},"cardNumber":{"type":"string","description":"The number on the card.","example":"4865550017193640","isRequired":true,"uniqueKey":"service_payload.card.cardNumber","typeLabel":"string"},"pin":{"type":"string","description":"The PIN for the card. This is only required for NGN collections.","example":"1234","uniqueKey":"service_payload.card.pin","typeLabel":"string"}},"isRequired":true,"uniqueKey":"service_payload.card","typeLabel":"object"},"callback_url":{"type":"string","format":"uri","description":"The callback URL provided by the merchant (Kindly ensure this accepts POST requests).","example":"https://callbackurl.com","uniqueKey":"service_payload.callback_url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"service_payload","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Card Charge Request · object"},"examples":{"Card Charge Request":{"title":"Card Charge Request","value":{"service_payload":{"first_name":"John","last_name":"Doe","email_address":"johndoe@hotmail.com","phone_number":"0939344401","amount":0.01,"transaction_reference":"T13501973673737","currency":"USD","description":"TEST","card":{"expiryMonth":"10","expiryYear":"26","securityCode":"686","cardNumber":"4865550017193640"},"callback_url":"https://calbackurl.com"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"49992b09-6728-4a80-a90e-93bfadb28b22":{"description":"Card Charge Responses","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Card Charge 3DS Response","properties":{"statusOk":{"type":"boolean","description":"Indicates if the initial request was valid.","example":true,"uniqueKey":"oneOf.0.statusOk","typeLabel":"boolean"},"message":{"type":"string","description":"Response message.","example":"Authentication Required","uniqueKey":"oneOf.0.message","typeLabel":"string"},"debugMessage":{"type":"string","description":"Detailed debug message.","example":"3DS Authentication Required","uniqueKey":"oneOf.0.debugMessage","typeLabel":"string"},"descriptor":{"type":"string","description":"Payment descriptor (if available).","example":"","uniqueKey":"oneOf.0.descriptor","typeLabel":"string"},"waitForNotification":{"type":"boolean","description":"Whether the client should wait for a notification.","example":false,"uniqueKey":"oneOf.0.waitForNotification","typeLabel":"boolean"},"do3dsAuth":{"type":"boolean","description":"Flag indicating that 3DS authentication is required.","example":true,"uniqueKey":"oneOf.0.do3dsAuth","typeLabel":"boolean"},"threeDsUrl":{"type":"string","format":"uri","description":"The URL to which the 3DS challenge should be submitted.","example":"","uniqueKey":"oneOf.0.threeDsUrl","typeLabel":"string\u003curi>"},"formData":{"type":"string","description":"Base64 encoded form data or payload for the 3DS request.","example":"eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjQ5ZGJ...","uniqueKey":"oneOf.0.formData","typeLabel":"string"},"threeDsHtml":{"type":"string","description":"Full HTML form required to auto-submit the 3DS challenge.","example":"\u003cdiv id='threedsChallengeRedirect'> ... \u003c/div>","uniqueKey":"oneOf.0.threeDsHtml","typeLabel":"string"},"paymentCompleted":{"type":"boolean","description":"Indicates if the payment is complete.","example":false,"uniqueKey":"oneOf.0.paymentCompleted","typeLabel":"boolean"},"amountPaid":{"type":"number","description":"Amount successfully paid so far.","example":0,"uniqueKey":"oneOf.0.amountPaid","typeLabel":"number"},"valueAmount":{"type":"number","description":"Total value amount processed.","example":0,"uniqueKey":"oneOf.0.valueAmount","typeLabel":"number"}},"uniqueKey":"oneOf.0","typeLabel":"Card Charge 3DS Response · object"},{"type":"object","title":"Card Charge Successful Callback Response","properties":{"statusOk":{"type":"boolean","description":"Indicates if the transaction was successful.","example":true,"uniqueKey":"oneOf.1.statusOk","typeLabel":"boolean"},"message":{"type":"string","description":"Response message.","example":"Approved","uniqueKey":"oneOf.1.message","typeLabel":"string"},"debugMessage":{"type":"string","description":"Detailed debug message.","example":"Transaction Successful","uniqueKey":"oneOf.1.debugMessage","typeLabel":"string"},"description":{"type":"string","description":"Transaction narration.","example":"Test for 3DS","uniqueKey":"oneOf.1.description","typeLabel":"string"},"descriptor":{"type":"string","description":"Merchant descriptor.","example":" ","uniqueKey":"oneOf.1.descriptor","typeLabel":"string"},"waitForNotification":{"type":"boolean","description":"Indicates if the client should wait for a webhook.","example":true,"uniqueKey":"oneOf.1.waitForNotification","typeLabel":"boolean"},"transactionReference":{"type":"string","description":"Unique transaction reference.","example":"P1KRDXCD5630","uniqueKey":"oneOf.1.transactionReference","typeLabel":"string"},"customerReference":{"type":"string","description":"Customer reference ID.","example":"P1KRDXCD5630","uniqueKey":"oneOf.1.customerReference","typeLabel":"string"},"do3dsAuth":{"type":"boolean","description":"Whether 3DS authentication was required.","example":false,"uniqueKey":"oneOf.1.do3dsAuth","typeLabel":"boolean"},"paymentCompleted":{"type":"boolean","description":"Indicates if the payment is complete.","example":true,"uniqueKey":"oneOf.1.paymentCompleted","typeLabel":"boolean"},"amountPaid":{"type":"number","format":"double","description":"Total amount paid by the customer.","example":24,"uniqueKey":"oneOf.1.amountPaid","typeLabel":"number\u003cdouble>"},"valueAmount":{"type":"number","format":"double","description":"Settlement value (amount credited).","example":23.664,"uniqueKey":"oneOf.1.valueAmount","typeLabel":"number\u003cdouble>"},"payer_name":{"type":"string","description":"Name of the cardholder.","example":"John Doe","uniqueKey":"oneOf.1.payer_name","typeLabel":"string"},"source_bank_name":{"type":"string","description":"Name of the issuing bank.","example":"VISA","uniqueKey":"oneOf.1.source_bank_name","typeLabel":"string"},"payment_date":{"type":"string","description":"Timestamp of payment.","example":"2024-03-11+19:49:43.575475932","uniqueKey":"oneOf.1.payment_date","typeLabel":"string"},"created_at":{"type":"string","description":"Timestamp when the record was created.","example":"2024-03-11+19:49:43.575475932","uniqueKey":"oneOf.1.created_at","typeLabel":"string"},"rrn":{"type":"string","description":"Retrieval Reference Number.","example":"519219078440","uniqueKey":"oneOf.1.rrn","typeLabel":"string"},"risk":{"type":"object","description":"Risk assessment data.","example":{},"uniqueKey":"oneOf.1.risk","typeLabel":"object"},"acquirer_response_code":{"type":"string","description":"Response code from the acquirer.","example":"00","uniqueKey":"oneOf.1.acquirer_response_code","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"Card Charge Successful Callback Response · object"},{"type":"object","title":"Card Charge Failed Callback Response","properties":{"statusOk":{"type":"boolean","description":"Indicates if the transaction was successful.","example":false,"uniqueKey":"oneOf.2.statusOk","typeLabel":"boolean"},"message":{"type":"string","description":"User-friendly response message.","example":"Transaction Failed","uniqueKey":"oneOf.2.message","typeLabel":"string"},"debugMessage":{"type":"string","description":"Detailed reason for failure.","example":"BLOCKED","uniqueKey":"oneOf.2.debugMessage","typeLabel":"string"},"description":{"type":"string","description":"Transaction narration.","example":"Test for 3DS","uniqueKey":"oneOf.2.description","typeLabel":"string"},"waitForNotification":{"type":"boolean","description":"Indicates if a webhook notification is expected.","example":false,"uniqueKey":"oneOf.2.waitForNotification","typeLabel":"boolean"},"transactionReference":{"type":"string","description":"Unique transaction reference.","example":"PL-1KBPSCJCR2015021","uniqueKey":"oneOf.2.transactionReference","typeLabel":"string"},"do3dsAuth":{"type":"boolean","description":"Whether 3DS authentication was attempted.","example":false,"uniqueKey":"oneOf.2.do3dsAuth","typeLabel":"boolean"},"paymentCompleted":{"type":"boolean","description":"Indicates if funds were moved.","example":false,"uniqueKey":"oneOf.2.paymentCompleted","typeLabel":"boolean"},"amountPaid":{"type":"number","description":"Amount successfully charged (0 in failure cases).","example":0,"uniqueKey":"oneOf.2.amountPaid","typeLabel":"number"},"valueAmount":{"type":"number","description":"Settlement value.","example":0,"uniqueKey":"oneOf.2.valueAmount","typeLabel":"number"},"acquirer_response_code":{"type":"string","description":"Response code from the acquiring bank (empty if blocked by risk engine before reaching bank).","example":"","uniqueKey":"oneOf.2.acquirer_response_code","typeLabel":"string"},"risk":{"type":"object","description":"Risk assessment details.","properties":{"response":{"type":"object","properties":{"gatewayCode":{"type":"string","description":"Risk gateway decision.","example":"REJECTED","uniqueKey":"oneOf.2.risk.response.gatewayCode","typeLabel":"string"},"totalScore":{"type":"integer","description":"Total risk score assigned (higher usually means higher risk).","example":100,"uniqueKey":"oneOf.2.risk.response.totalScore","typeLabel":"integer"},"review":{"type":"object","properties":{"decision":{"type":"string","example":"NOT_REQUIRED","uniqueKey":"oneOf.2.risk.response.review.decision","typeLabel":"string"}},"uniqueKey":"oneOf.2.risk.response.review","typeLabel":"object"},"rule":{"type":"array","description":"List of risk rules triggered.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the rule triggered.","example":"3D Secure Passed","uniqueKey":"oneOf.2.risk.response.rule.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"Type of rule (e.g., EXTERNAL_RULE, MSO_RULE).","example":"EXTERNAL_RULE","uniqueKey":"oneOf.2.risk.response.rule.items.[INDEX].type","typeLabel":"string"},"data":{"type":"string","description":"Specific data point associated with the rule (optional).","example":"127.0.0.1","uniqueKey":"oneOf.2.risk.response.rule.items.[INDEX].data","typeLabel":"string"},"recommendation":{"type":"string","description":"Recommended action for this specific rule (optional).","example":"NO_ACTION","uniqueKey":"oneOf.2.risk.response.rule.items.[INDEX].recommendation","typeLabel":"string"}},"uniqueKey":"oneOf.2.risk.response.rule.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.risk.response.rule","typeLabel":"object[]"}},"uniqueKey":"oneOf.2.risk.response","typeLabel":"object"}},"uniqueKey":"oneOf.2.risk","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"Card Charge Failed Callback Response · object"}],"uniqueKey":"","typeLabel":"Card Charge 3DS Response · object | Card Charge Successful Callback Response · object | Card Charge Failed Callback Response · object"},"examples":{"Non-3DS Response":{"title":"Non-3DS Response","value":{"response_code":200,"response_message":"Operation Completed","response_content":{"statusOk":true,"message":"Approved","debugMessage":"Transaction Successful","description":"Test","descriptor":" ","waitForNotification":true,"transactionReference":"450Q03ed3dd613","customerReference":"450Q03ed3dd613","do3dsAuth":false,"paymentCompleted":true,"amountPaid":0.01,"valueAmount":0.0095,"rrn":"123456789012","risk":{},"acquirer_response_code":"00"},"status":"00"}},"3DS Response":{"title":"3DS Response","value":{"statusOk":true,"message":"Authentication Required","debugMessage":"3DS Authentication Required","descriptor":"","waitForNotification":false,"do3dsAuth":true,"threeDsUrl":"https://secure-acs2ui-bk2-indmum-mumrdc.wibmo.com/v1/acs/services/browser/creq/L/8642/f701e19d-3508-11ee-b753-67cae4cf81dc","formData":"eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjQ5ZGJmNTY4LWRjZjUtNDc1NS05ZjQ2LWU2MjIzMDk3MGU3MyIsImFjc1RyYW5zSUQiOiJmNzAxZTE5ZC0zNTA4LTExZWUtYjc1My02N2NhZTRjZjgxZGMiLCJjaGFsbGVuZ2VXaW5kb3dTaXplIjoiMDUiLCJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMi4wIn0","threeDsHtml":"\u003cdiv id='threedsChallengeRedirect' xmlns='http://www.w3.org/1999/html' style=' height: 100vh'> \u003cform id ='threedsChallengeRedirectForm' method='POST' action='https: //secure-acs2ui-bk2-indmum-mumrdc.wibmo.com/v1/acs/services/browser/creq/L/8642/f701e19d-3508-11ee-b753-67cae4cf81dc' target='challengeFrame'> \u003cinput type='hidden' name='creq' value='eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjQ5ZGJmNTY4LWRjZjUtNDc1NS05ZjQ2LWU2MjIzMDk3MGU3MyIsImFjc1RyYW5zSUQiOiJmNzAxZTE5ZC0zNTA4LTExZWUtYjc1My02N2NhZTRjZjgxZGMiLCJjaGFsbGVuZ2VXaW5kb3dTaXplIjoiMDUiLCJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMi4wIn0' /> \u003c/form> \u003ciframe id='challengeFrame' name='challengeFrame' width='100%' height='100%' >\u003c/iframe>\u003cscript id='authenticate-payer-script'> var e=document.getElementById('threedsChallengeRedirectForm'); if (e) { e.submit(); if (e.parentNode !== null) { e.parentNode.removeChild(e); } } \u003c/script> \u003c/div>","paymentCompleted":false,"amountPaid":0,"valueAmount":0}},"Successful Callback Response":{"title":"Successful Callback Response","value":{"statusOk":true,"message":"Approved","debugMessage":"Transaction Successful","description":"Test for 3DS","descriptor":" ","waitForNotification":true,"transactionReference":"P1KRDXCD5630","customerReference":"P1KRDXCD5630","do3dsAuth":false,"paymentCompleted":true,"amountPaid":24,"valueAmount":23.664,"payer_name":"John Doe","source_bank_name":"VISA","payment_date":"2024-03-11+19:49:43.575475932","created_at":"2024-03-11+19:49:43.575475932","rrn":"519219078440","risk":{},"acquirer_response_code":"00"}},"Failed Callback Response":{"title":"Failed Callback Response","value":{"statusOk":false,"message":"Transaction Failed","debugMessage":"BLOCKED","description":"Test for 3DS","waitForNotification":false,"transactionReference":"PL-1KBPSCJCR2015021","do3dsAuth":false,"paymentCompleted":false,"amountPaid":0,"valueAmount":0,"risk":{"response":{"gatewayCode":"REJECTED","review":{"decision":"NOT_REQUIRED"},"rule":[{"name":"3D Secure Passed","type":"EXTERNAL_RULE"},{"name":"AI: Average spend on this card in the last 30 days","type":"EXTERNAL_RULE"},{"name":"AI: No. of transactions with the card 10-40 days before this","type":"EXTERNAL_RULE"},{"name":"AI: Total spend on the card 10-40 days before this","type":"EXTERNAL_RULE"},{"name":"AI: Total spend, same card and merchant 10-40 days before this","type":"EXTERNAL_RULE"},{"name":"AI: mer_city","type":"EXTERNAL_RULE"},{"name":"Cards to IP address - Multiple cards associated to the same IP address","type":"EXTERNAL_RULE"},{"name":"Distinct card names to card","type":"EXTERNAL_RULE"},{"name":"Distinct card names to card high","type":"EXTERNAL_RULE"},{"name":"Distinct cards to IP address","type":"EXTERNAL_RULE"},{"data":"NO_RULES","name":"MSO_3D_SECURE","recommendation":"NO_ACTION","type":"MSO_RULE"},{"data":"539983","name":"MSO_BIN_RANGE","recommendation":"NO_ACTION","type":"MSO_RULE"},{"data":"127.0.0.1","name":"MSO_IP_ADDRESS_RANGE","recommendation":"NO_ACTION","type":"MSO_RULE"},{"data":"UK1","name":"MSO_IP_COUNTRY","recommendation":"NO_ACTION","type":"MSO_RULE"}],"totalScore":100}},"acquirer_response_code":""}}},"exampleType":"examples"}},"exampleType":"examples"},"ca7a6294-0e98-46dd-b1c9-d5ae45c2cb22":{"description":"Invalid request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"b9d26169-3ebe-4a68-83ea-323deedca6f4":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Payaza {{Public API Key in Base 64}}","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"188f488e-ff9e-4c4a-9990-f746d694e717":{"url":"https://api.payaza.africa/live","description":"The /live path is fixed and test transactions are performed by using the Test API Key with or without the X-TenantID header set to test."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Payaza {{Public API Key in Base 64}}","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"Payaza {{Public API Key in Base 64}}","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"payazaafrica","siteName":"Payaza Documentation","title":"Card Charge - Payaza Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T11:07:39.804Z","originalFileLocation":"api-reference/card-collection/card-charge.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full Cards guide for a step-by-step walkthrough. Note: - The Card Acquirer Response Codes with descriptions can be found here - Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Payaza Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Card Charge - Payaza Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full Cards guide for a step-by-step walkthrough. Note: - The Card Acquirer Response Codes with descriptions can be found here - Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payaza Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payaza.africa/api-reference/card-collection/card-charge\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://payazaafrica.mintlify.app/_mintlify/api/og/v2?division=Card+Collection\u0026amp;title=Card+Charge\u0026amp;description=This+endpoint+is+used+to+initiate+Card+payments+for+merchants+that+use+our+platform.+This+document+has+various+Request+bodies+and+HTML+text+that+are+necessary+f\u0026amp;theme=adb9ce2ec935984a68594865\u0026amp;signature=6b51a3867a415406702a0ebdda8a9caf12b9e0fb6f076f9c0e2e56bd2409a410\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Card Charge - Payaza Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full Cards guide for a step-by-step walkthrough. Note: - The Card Acquirer Response Codes with descriptions can be found here - Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://payazaafrica.mintlify.app/_mintlify/api/og/v2?division=Card+Collection\u0026amp;title=Card+Charge\u0026amp;description=This+endpoint+is+used+to+initiate+Card+payments+for+merchants+that+use+our+platform.+This+document+has+various+Request+bodies+and+HTML+text+that+are+necessary+f\u0026amp;theme=adb9ce2ec935984a68594865\u0026amp;signature=6b51a3867a415406702a0ebdda8a9caf12b9e0fb6f076f9c0e2e56bd2409a410\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/payazaafrica/bikKXSMRwL2Sgyda/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payaza Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#31044F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payaza.africa/api-reference/card-collection/card-charge\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/card-collection/card-charge.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.payaza.africa/#organization\",\"name\":\"Payaza Documentation\",\"url\":\"https://docs.payaza.africa\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/payazaafrica/ui3YNZKQDioJXnZa/images/dev-light.svg?fit=max\u0026auto=format\u0026n=ui3YNZKQDioJXnZa\u0026q=85\u0026s=b97f560ac5252499e096df1ec8097964\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.payaza.africa#website\",\"name\":\"Payaza Documentation\",\"url\":\"https://docs.payaza.africa\",\"publisher\":{\"@id\":\"https://docs.payaza.africa/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.payaza.africa/api-reference/card-collection/card-charge#webpage\",\"url\":\"https://docs.payaza.africa/api-reference/card-collection/card-charge\",\"name\":\"Card Charge\",\"description\":\"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full Cards guide for a step-by-step walkthrough. Note: - The Card Acquirer Response Codes with descriptions can be found here - Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.\",\"dateModified\":\"2026-10-27T11:07:39.804Z\",\"isPartOf\":{\"@id\":\"https://docs.payaza.africa#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payaza.africa/api-reference/card-collection/card-charge#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payaza.africa/api-reference/card-collection/card-charge#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payaza Documentation\",\"item\":\"https://docs.payaza.africa\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Card Charge\",\"item\":\"https://docs.payaza.africa/api-reference/card-collection/card-charge\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payaza.africa/api-reference/card-collection/card-charge#apireference\",\"headline\":\"Card Charge\",\"name\":\"Card Charge\",\"description\":\"This endpoint is used to initiate Card payments for merchants that use our platform. This document has various Request bodies and HTML text that are necessary for different integration purposes. See the full Cards guide for a step-by-step walkthrough. Note: - The Card Acquirer Response Codes with descriptions can be found here - Please be advised that card collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.\",\"url\":\"https://docs.payaza.africa/api-reference/card-collection/card-charge\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payaza.africa/api-reference/card-collection/card-charge#webpage\"},\"dateModified\":\"2026-10-27T11:07:39.804Z\",\"publisher\":{\"@id\":\"https://docs.payaza.africa/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.payaza.africa#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Payaza Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Payaza Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Libraries \u0026 SDKs","pages":[{"title":"Libraries \u0026 SDKs","href":"/api-reference/libraries/websdk"}]},{"tab":"API Reference","groups":[{"group":"Transfers","pages":[{"title":"Initiate A Transfer","deprecated":null,"version":null,"openapi":"/openapi.json post /payout-receptor/payout","href":"/api-reference/transfers/initiate-a-transfer"},{"title":"Transaction Status Query","deprecated":null,"version":null,"openapi":"/openapi.json get /payaza-account/api/v1/mainaccounts/merchant/transaction/{transaction_reference}","href":"/api-reference/transfers/transaction-status-query"},{"title":"Get Account Name Enquiry","deprecated":null,"version":null,"openapi":"/openapi.json post /payaza-account/api/v1/mainaccounts/merchant/provider/enquiry","href":"/api-reference/transfers/get-account-name-enquiry"},{"title":"Bank Codes","deprecated":null,"version":null,"openapi":"/openapi.json get /payaza-account/api/v1/mainaccounts/merchant/banks/{currency_code}","href":"/api-reference/transfers/bank-codes"}]},{"group":"Payaza Account","pages":[{"title":"View Payaza Account Details","deprecated":null,"version":null,"openapi":"/openapi.json get /payaza-account/api/v1/mainaccounts/merchant/enquiry/main","href":"/api-reference/payaza-account/view-payaza-account-details"}]},{"group":"Sub Accounts","pages":[{"title":"Create A Subaccount","deprecated":null,"version":null,"openapi":"/openapi.json post /payaza-account/api/v1/subaccounts/merchant","href":"/api-reference/sub-accounts/create-a-subaccount"},{"title":"View Payaza Sub Account Details","deprecated":null,"version":null,"openapi":"/openapi.json get /payaza-account/api/v1/subaccounts/merchant/enquiry/{payazaSubAccountReference}","href":"/api-reference/sub-accounts/view-payaza-sub-account-details"}]},{"group":"Apple Pay and Google Pay","pages":[{"title":"Initiate Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /merchant-collection/mobile_payment/initiate","href":"/api-reference/apple-pay-and-google-pay/initiate-payment"}]},{"group":"Virtual Accounts","pages":[{"title":"Create Static/Dynamic Virtual Account","deprecated":null,"version":null,"openapi":"/openapi.json post /merchant-collection/merchant/virtual_account/generate_virtual_account","href":"/api-reference/virtual-accounts/create-staticdynamic-virtual-account"},{"title":"Get Virtual Account Status","deprecated":null,"version":null,"openapi":"/openapi.json get /merchant-collection/merchant/virtual_account/detail/virtual_account/{virtualAccountNumber}","href":"/api-reference/virtual-accounts/get-virtual-account-status"},{"title":"Transaction Status Query","deprecated":null,"version":null,"openapi":"/openapi.json get /merchant-collection/transfer_notification_controller/transaction-query","href":"/api-reference/virtual-accounts/transaction-status-query"},{"title":"Fund Test Virtual Account","deprecated":null,"version":null,"openapi":"/openapi.json post /merchant-collection/payaza/virtual_account/fund_test_virtual_account","href":"/api-reference/virtual-accounts/fund-test-virtual-account"}]},{"group":"Payment Links","pages":[{"title":"Create Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json post /payment-link/merchant/create-payment-link","href":"/api-reference/payment-links/create-payment-link"},{"title":"Update Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json patch /payment-link/merchant/update-payment-link","href":"/api-reference/payment-links/update-payment-link"},{"title":"Activate Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json patch /payment-link/merchant/activate-payment-link","href":"/api-reference/payment-links/activate-payment-link"},{"title":"Deactivate Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json patch /payment-link/merchant/deactivate-payment-link","href":"/api-reference/payment-links/deactivate-payment-link"},{"title":"Fetch Payment Links","deprecated":null,"version":null,"openapi":"/openapi.json get /payment-link/merchant/fetch-payment-links","href":"/api-reference/payment-links/fetch-payment-links"},{"title":"Fetch Payment Link Transactions","description":"It retrieves the list of transactions for a specific payment link.","deprecated":null,"version":null,"openapi":"/openapi.json get /payment-link/merchant/fetch-payment-link-transactions","href":"/api-reference/payment-links/fetch-payment-link-transactions"}]},{"group":"Card Collection","pages":[{"title":"Card Charge","deprecated":null,"version":null,"openapi":"/openapi.json post /card/card_charge/","href":"/api-reference/card-collection/card-charge"},{"title":"Check Transaction Status","description":"This endpoint gets the transaction status corresponding to the provided transaction reference for a card transaction.","deprecated":null,"version":null,"openapi":"/openapi.json post /card/card_charge/transaction_status","href":"/api-reference/card-collection/check-transaction-status"},{"title":"Check Refund Status","deprecated":null,"version":null,"openapi":"/openapi.json post /card/card_charge/refund_status","href":"/api-reference/card-collection/check-refund-status"}]},{"group":"Refunds And Chargebacks","pages":[{"title":"Initiate Refund","deprecated":null,"version":null,"openapi":"/openapi.json post /refund-chargeback/refund/merchant/api/refund","href":"/api-reference/refunds-and-chargebacks/initiate-refund"},{"title":"Fetch Refund History","deprecated":null,"version":null,"openapi":"/openapi.json get /refund-chargeback/refund/merchant/api/refund_history","href":"/api-reference/refunds-and-chargebacks/fetch-refund-history"},{"title":"Accept Or Reject Chargeback","deprecated":null,"version":null,"openapi":"/openapi.json post /refund-chargeback/chargeback/merchant/api/accept_reject_chargeback","href":"/api-reference/refunds-and-chargebacks/accept-or-reject-chargeback"},{"title":"Chargeback Request","deprecated":null,"version":null,"openapi":"/openapi.json get /refund-chargeback/chargeback/merchant/api/chargeback_requests","href":"/api-reference/refunds-and-chargebacks/chargeback-request"},{"title":"Chargeback Transaction History","deprecated":null,"version":null,"openapi":"/openapi.json get /refund-chargeback/chargeback/merchant/api/chargeback_transaction_history","href":"/api-reference/refunds-and-chargebacks/chargeback-transaction-history"}]},{"group":"Momo, XOF And ZAR Collections","pages":[{"title":"Momo, XOF and ZAR Process Collection","deprecated":null,"version":null,"openapi":"/openapi.json post /subsidiary/collections/v1/process-collection","href":"/api-reference/momo-xof-and-zar-collections/momo-xof-and-zar-process-collection"},{"title":"Transaction Status Query","deprecated":null,"version":null,"openapi":"/openapi.json get /subsidiary/collections/v1/check-status","href":"/api-reference/momo-xof-and-zar-collections/transaction-status-query"},{"title":"Test Account Funding","deprecated":null,"version":null,"openapi":"/openapi.json post /subsidiary/funding/v1/process-collection","href":"/api-reference/momo-xof-and-zar-collections/test-account-funding"},{"title":"XOF Process OTP","deprecated":null,"version":null,"openapi":"/openapi.json post /subsidiary/collections/v1/process-otp","href":"/api-reference/momo-xof-and-zar-collections/xof-process-otp"}]},{"group":"Branches","pages":[{"title":"Fetch All Branches","deprecated":null,"version":null,"openapi":"/openapi.json get /branches/api/v1/merchant-branches","href":"/api-reference/branches/fetch-all-branches"}]},{"group":"Auth-Capture-Void","pages":[{"title":"Get All Authorizations","deprecated":null,"version":null,"openapi":"/openapi.json get /card/auth_capture/authorize","href":"/api-reference/auth-capture-void/get-all-authorizations"},{"title":"Authorize Transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /card/auth_capture/authorize","href":"/api-reference/auth-capture-void/authorize-transaction"},{"title":"Capture Transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /card/auth_capture/capture","href":"/api-reference/auth-capture-void/capture-transaction"},{"title":"Void Transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /card/auth_capture/void","href":"/api-reference/auth-capture-void/void-transaction"},{"title":"Get Single Authorization","deprecated":null,"version":null,"openapi":"/openapi.json get /card/auth_capture/authorize/{authorization_reference}","href":"/api-reference/auth-capture-void/get-single-authorization"}]},{"group":"Check Transaction Status(Merchant Reference)","pages":[{"title":"Check Transaction Status(Merchant Reference)","deprecated":null,"version":null,"openapi":"/openapi.json get /merchant-collection/transfer_notification_controller/merchant/transaction-query","href":"/api-reference/check-transaction-statusmerchant-reference/check-transaction-statusmerchant-reference"}]},{"group":"Subscription Plans","pages":[{"title":"List Plans","deprecated":null,"version":null,"openapi":"/openapi.json get /subscription/api/v1/subscription-plans","href":"/api-reference/subscription-plans/list-plans"},{"title":"Create Plan","deprecated":null,"version":null,"openapi":"/openapi.json post /subscription/api/v1/subscription-plans","href":"/api-reference/subscription-plans/create-plan"},{"title":"Get Plan Details","deprecated":null,"version":null,"openapi":"/openapi.json get /subscription/api/v1/subscription-plans/{planCode}","href":"/api-reference/subscription-plans/get-plan-details"},{"title":"Update Plan Details","deprecated":null,"version":null,"openapi":"/openapi.json patch /subscription/api/v1/subscription-plans/{planCode}","href":"/api-reference/subscription-plans/update-plan-details"}]},{"group":"Subscription Reads","pages":[{"title":"List Subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /subscription/api/v1/subscriptions","href":"/api-reference/subscription-reads/list-subscription"},{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /subscription/api/v1/subscriptions/{id}","href":"/api-reference/subscription-reads/get-subscription"},{"title":"Upcoming Charges","deprecated":null,"version":null,"openapi":"/openapi.json get /subscription/api/v1/subscriptions/{id}/upcoming","href":"/api-reference/subscription-reads/upcoming-charges"},{"title":"Subscription Charge History","deprecated":null,"version":null,"openapi":"/openapi.json get /subscription/api/v1/subscriptions/{id}/charges","href":"/api-reference/subscription-reads/subscription-charge-history"},{"title":"Subscription Event History","deprecated":null,"version":null,"openapi":"/openapi.json get /subscription/api/v1/subscriptions/{id}/events","href":"/api-reference/subscription-reads/subscription-event-history"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /subscription/api/v1/subscriptions","href":"/api-reference/subscriptions/create-subscription"}]},{"group":"Subscription Charge","pages":[{"title":"Charge Now","deprecated":null,"version":null,"openapi":"/openapi.json post /subscription/api/v1/subscriptions/{id}/charge-now","href":"/api-reference/subscription-charge/charge-now"},{"title":"Create Custom Charge","deprecated":null,"version":null,"openapi":"/openapi.json post /subscription/api/v1/subscriptions/{id}/charge-custom","href":"/api-reference/subscription-charge/create-custom-charge"}]},{"group":"Subscription Lifecycle","pages":[{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/openapi.json patch /subscription/api/v1/subscriptions/{id}/cancel","href":"/api-reference/subscription-lifecycle/cancel-subscription"},{"title":"Pause Subscription","deprecated":null,"version":null,"openapi":"/openapi.json patch /subscription/api/v1/subscriptions/{id}/pause","href":"/api-reference/subscription-lifecycle/pause-subscription"},{"title":"Resume Subscription","deprecated":null,"version":null,"openapi":"/openapi.json patch /subscription/api/v1/subscriptions/{id}/resume","href":"/api-reference/subscription-lifecycle/resume-subscription"},{"title":"Change Plan","deprecated":null,"version":null,"openapi":"/openapi.json post /subscription/api/v1/subscriptions/{id}/change-plan","href":"/api-reference/subscription-lifecycle/change-plan"}]},{"group":"Subscription Invoices","pages":[{"title":"List Invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /subscription/api/v1/invoices","href":"/api-reference/subscription-invoices/list-invoices"},{"title":"Get Invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/invoices/{invoiceId}","href":"/api-reference/subscription-invoices/get-invoice"}]},{"group":"Split Settlements","pages":[{"title":"Fetch Split Accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /settlement/settlement/merchant/split-account","href":"/api-reference/split-settlements/fetch-split-accounts"},{"title":"Create Split Account","deprecated":null,"version":null,"openapi":"/openapi.json post /settlement/settlement/merchant/split-account","href":"/api-reference/split-settlements/create-split-account"},{"title":"Update Split Account","deprecated":null,"version":null,"openapi":"/openapi.json put /settlement/settlement/merchant/split-account/{id}","href":"/api-reference/split-settlements/update-split-account"},{"title":"Delete Split Account","deprecated":null,"version":null,"openapi":"/openapi.json delete /settlement/settlement/merchant/split-account/{id}","href":"/api-reference/split-settlements/delete-split-account"}]}]}]},"basePath":"","title":"Card Charge - Payaza Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}