{"_id":"@afriex/checkout","_rev":"6-490c02c5da5998b2944102e99745c20b","name":"@afriex/checkout","dist-tags":{"latest":"3.0.1"},"versions":{"1.0.0":{"name":"@afriex/checkout","version":"1.0.0","license":"MIT","_id":"@afriex/checkout@1.0.0","maintainers":[{"name":"luckyv","email":"luckyvictory54@gmail.com"}],"dist":{"shasum":"66bfd0e99854e7282c0b1ec08fab87d3cba92fbd","tarball":"https://registry.npmjs.org/@afriex/checkout/-/checkout-1.0.0.tgz","fileCount":8,"integrity":"sha512-Jtd+4yEn5F+enMDEyWqfcoJIZ4gUkIAzFHIn3Xo5qkBa12Wl0izhcgZAY3BsVz9VvC92K8Ke1bfat37dUrZ7SA==","signatures":[{"sig":"MEUCIQCEwxjUGJAonEWkmBxkKsHXSJmFbrbBWYgY19dwbwM66QIgX1H1vhJRbEWJLrX2g7OuAbT+VXOtyZyU1/vnm8jcov8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":6863},"main":"./dist/index.js","type":"module","_from":"file:afriex-checkout-1.0.0.tgz","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"}},"scripts":{"build":"tsc","clean":"rimraf dist","type-check":"tsc --noEmit"},"_npmUser":{"name":"luckyv","email":"luckyvictory54@gmail.com"},"_resolved":"/tmp/92ef1d948bb8162398bab069ebe9cbde/afriex-checkout-1.0.0.tgz","_integrity":"sha512-Jtd+4yEn5F+enMDEyWqfcoJIZ4gUkIAzFHIn3Xo5qkBa12Wl0izhcgZAY3BsVz9VvC92K8Ke1bfat37dUrZ7SA==","_npmVersion":"11.13.0","description":"Checkout service for Afriex SDK","directories":{},"_nodeVersion":"24.16.0","dependencies":{"@afriex/core":"1.3.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^6.1.3","typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/checkout_1.0.0_1780017906199_0.15904876121787637","host":"s3://npm-registry-packages-npm-production"}},"2.0.0":{"name":"@afriex/checkout","version":"2.0.0","author":{"name":"Victory Lucky","email":"luckyvictory54@gmail.com"},"license":"MIT","_id":"@afriex/checkout@2.0.0","maintainers":[{"name":"luckyv","email":"luckyvictory54@gmail.com"}],"homepage":"https://github.com/Afri-exchange/afriex-sdk#readme","bugs":{"url":"https://github.com/Afri-exchange/afriex-sdk/issues"},"dist":{"shasum":"8246df5aebc0741d4188870794574f23066d6218","tarball":"https://registry.npmjs.org/@afriex/checkout/-/checkout-2.0.0.tgz","fileCount":8,"integrity":"sha512-orwsg4lcJwQNva+ORsnUSJtKR2sdszW7p7AZ+SIWbLYwyxY+WXpWhw0KtJ20geSoArrBI9xJ5A/x12KHVVBSvw==","signatures":[{"sig":"MEUCIB3xdhKut4cY8mlT3yRG25cxaEg0PUv1Jm8oxcmuN8kLAiEAgHd+BoS/Fc7guyMv5lKocXclpOsTOatpKjGIP/iX/aM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@afriex%2fcheckout@2.0.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":7939},"main":"./dist/index.js","type":"module","_from":"file:afriex-checkout-2.0.0.tgz","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"}},"scripts":{"build":"tsc","clean":"rimraf dist","type-check":"tsc --noEmit"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:dc2042f4-d1ac-4504-8504-137fea98ca9d"}},"_resolved":"/tmp/24b34a0a80f2fcdc19a2e1c9a0d7f198/afriex-checkout-2.0.0.tgz","_integrity":"sha512-orwsg4lcJwQNva+ORsnUSJtKR2sdszW7p7AZ+SIWbLYwyxY+WXpWhw0KtJ20geSoArrBI9xJ5A/x12KHVVBSvw==","repository":{"url":"git+https://github.com/Afri-exchange/afriex-sdk.git","type":"git","directory":"packages/checkout"},"_npmVersion":"11.13.0","description":"Checkout service for Afriex SDK","directories":{},"_nodeVersion":"24.16.0","dependencies":{"@afriex/core":"1.3.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^6.1.3","typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/checkout_2.0.0_1780148867545_0.7814855624688282","host":"s3://npm-registry-packages-npm-production"}},"2.0.1":{"name":"@afriex/checkout","version":"2.0.1","author":{"name":"Victory Lucky","email":"luckyvictory54@gmail.com"},"license":"MIT","_id":"@afriex/checkout@2.0.1","maintainers":[{"name":"luckyv","email":"luckyvictory54@gmail.com"}],"homepage":"https://github.com/Afri-exchange/afriex-sdk#readme","bugs":{"url":"https://github.com/Afri-exchange/afriex-sdk/issues"},"dist":{"shasum":"bfdafa08934691f609166a5376d08916c8902758","tarball":"https://registry.npmjs.org/@afriex/checkout/-/checkout-2.0.1.tgz","fileCount":8,"integrity":"sha512-jjFlDoWlCLx8mqdAvulXvKHERN2YglKr4jKQ+2HvYR7xLiwI8jGtnR/62OQ4mkIyBI9TJWtYf7RY7YW9t8E3fw==","signatures":[{"sig":"MEUCIEp47cbKe6meSCrMJmVYGtumIbvUouAUaZFFRTRtZjYEAiEAr2UXR1m/W1MRhGm0zoe7IfMLB+n3PQxK1oLHAI+9M3g=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@afriex%2fcheckout@2.0.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":7948},"main":"./dist/index.js","type":"module","_from":"file:afriex-checkout-2.0.1.tgz","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"}},"scripts":{"build":"tsc","clean":"rimraf dist","type-check":"tsc --noEmit"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:dc2042f4-d1ac-4504-8504-137fea98ca9d"}},"_resolved":"/tmp/2a5b539427fb3ee8c701445dc8bd6981/afriex-checkout-2.0.1.tgz","_integrity":"sha512-jjFlDoWlCLx8mqdAvulXvKHERN2YglKr4jKQ+2HvYR7xLiwI8jGtnR/62OQ4mkIyBI9TJWtYf7RY7YW9t8E3fw==","repository":{"url":"git+https://github.com/Afri-exchange/afriex-sdk.git","type":"git","directory":"packages/checkout"},"_npmVersion":"11.16.0","description":"Checkout service for Afriex SDK","directories":{},"_nodeVersion":"24.18.0","dependencies":{"@afriex/core":"2.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^6.1.3","typescript":"^5.9.3"},"_npmOperationalInternal":{"tmp":"tmp/checkout_2.0.1_1783858652570_0.15508404843532042","host":"s3://npm-registry-packages-npm-production"}},"2.0.2":{"name":"@afriex/checkout","version":"2.0.2","keywords":["tanstack-intent"],"author":{"name":"Victory Lucky","email":"luckyvictory54@gmail.com"},"license":"MIT","_id":"@afriex/checkout@2.0.2","maintainers":[{"name":"luckyv","email":"luckyvictory54@gmail.com"}],"homepage":"https://github.com/Afri-exchange/afriex-sdk#readme","bugs":{"url":"https://github.com/Afri-exchange/afriex-sdk/issues"},"dist":{"shasum":"c29626021e9c145f01d0826183693863f61f5a3a","tarball":"https://registry.npmjs.org/@afriex/checkout/-/checkout-2.0.2.tgz","fileCount":9,"integrity":"sha512-lEDkvqWJpibp2XMjEeaPUGRd7+jxBYkGasQb9e+W5j+d8phJOmUHFaYII9P3iodgRyBQ8Lmx28N9tw2tkw1o/Q==","signatures":[{"sig":"MEQCIFaAfmImET+vEKiBqn8jft0pvoUSOMk7Dsb+H53oiugaAiBljpAjR2wQhMG1on3KSVGwryLS+5vnnVy1oOElOvnfrw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@afriex%2fcheckout@2.0.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":18890},"main":"./dist/index.js","type":"module","_from":"file:afriex-checkout-2.0.2.tgz","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"}},"scripts":{"build":"tsc","clean":"rimraf dist","type-check":"tsc --noEmit"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:dc2042f4-d1ac-4504-8504-137fea98ca9d"}},"_resolved":"/tmp/c17075ecd94e5d2f825f7154bd843581/afriex-checkout-2.0.2.tgz","_integrity":"sha512-lEDkvqWJpibp2XMjEeaPUGRd7+jxBYkGasQb9e+W5j+d8phJOmUHFaYII9P3iodgRyBQ8Lmx28N9tw2tkw1o/Q==","repository":{"url":"git+https://github.com/Afri-exchange/afriex-sdk.git","type":"git","directory":"packages/checkout"},"_npmVersion":"11.16.0","description":"Checkout service for Afriex SDK","directories":{},"_nodeVersion":"24.18.0","dependencies":{"@afriex/core":"2.0.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^6.1.3","typescript":"^7.0.2","@tanstack/intent":"^0.3.6"},"_npmOperationalInternal":{"tmp":"tmp/checkout_2.0.2_1786546418732_0.2425041800873764","host":"s3://npm-registry-packages-npm-production"}},"3.0.0":{"name":"@afriex/checkout","version":"3.0.0","keywords":["tanstack-intent"],"author":{"name":"Victory Lucky","email":"luckyvictory54@gmail.com"},"license":"MIT","_id":"@afriex/checkout@3.0.0","maintainers":[{"name":"luckyv","email":"luckyvictory54@gmail.com"}],"homepage":"https://github.com/Afri-exchange/afriex-sdk#readme","bugs":{"url":"https://github.com/Afri-exchange/afriex-sdk/issues"},"dist":{"shasum":"8bfce7f638c47340e4b15ac6fd78da60a07df13c","tarball":"https://registry.npmjs.org/@afriex/checkout/-/checkout-3.0.0.tgz","fileCount":9,"integrity":"sha512-joio3XFsL+ELQePqphBAvi8xSJGMfqF4N/3Y1RPSPhwC+wQbYo5W/9tL+brzHfx+pLJ7KzzXcr8hoQtwZfurPg==","signatures":[{"sig":"MEUCIDJ+vRUibrA8+qmfmF506ydzipuU3wxbVlFw7RNKkBJ8AiEA64AvQNewTjP1T694cqquYJkJrdMUrvpvnl19HGu0QQM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@afriex%2fcheckout@3.0.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":19456},"main":"./dist/index.js","type":"module","_from":"file:afriex-checkout-3.0.0.tgz","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"}},"scripts":{"build":"tsc","clean":"rimraf dist tsconfig.tsbuildinfo","type-check":"tsc --noEmit"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:dc2042f4-d1ac-4504-8504-137fea98ca9d"}},"_resolved":"/tmp/82104ec4a945d1939e888bf93158677b/afriex-checkout-3.0.0.tgz","_integrity":"sha512-joio3XFsL+ELQePqphBAvi8xSJGMfqF4N/3Y1RPSPhwC+wQbYo5W/9tL+brzHfx+pLJ7KzzXcr8hoQtwZfurPg==","repository":{"url":"git+https://github.com/Afri-exchange/afriex-sdk.git","type":"git","directory":"packages/checkout"},"_npmVersion":"11.17.0","description":"Checkout service for Afriex SDK","directories":{},"_nodeVersion":"24.19.0","dependencies":{"@afriex/core":"2.1.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^6.1.3","typescript":"^7.0.2","@tanstack/intent":"^0.3.6"},"_npmOperationalInternal":{"tmp":"tmp/checkout_3.0.0_1787048786774_0.4403986020188668","host":"s3://npm-registry-packages-npm-production"}},"3.0.1":{"name":"@afriex/checkout","version":"3.0.1","description":"Checkout service for Afriex SDK","type":"module","main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"}},"dependencies":{"@afriex/core":"2.1.0"},"devDependencies":{"@tanstack/intent":"^0.3.6","rimraf":"^6.1.3","typescript":"^7.0.2"},"publishConfig":{"access":"public"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/Afri-exchange/afriex-sdk.git","directory":"packages/checkout"},"author":{"name":"Victory Lucky","email":"luckyvictory54@gmail.com"},"keywords":["tanstack-intent"],"scripts":{"build":"tsc","type-check":"tsc --noEmit","clean":"rimraf dist tsconfig.tsbuildinfo"},"_id":"@afriex/checkout@3.0.1","bugs":{"url":"https://github.com/Afri-exchange/afriex-sdk/issues"},"homepage":"https://github.com/Afri-exchange/afriex-sdk#readme","_integrity":"sha512-Kt6wW0x/2Igk2X1ixPDOFY4fp9V5mM3rZ6XqG2LxziLkLLN7OPw9Wzbe3I/x2+K0RzC0Mhkdo/r0OTz3tlh2hA==","_resolved":"/tmp/3c7722f3b5cc2dc6b689ccebc5bebb2a/afriex-checkout-3.0.1.tgz","_from":"file:afriex-checkout-3.0.1.tgz","_nodeVersion":"24.19.0","_npmVersion":"11.17.0","dist":{"integrity":"sha512-Kt6wW0x/2Igk2X1ixPDOFY4fp9V5mM3rZ6XqG2LxziLkLLN7OPw9Wzbe3I/x2+K0RzC0Mhkdo/r0OTz3tlh2hA==","shasum":"2776615b278a9cce4619bb0f7826582e4de1d2d8","tarball":"https://registry.npmjs.org/@afriex/checkout/-/checkout-3.0.1.tgz","fileCount":9,"unpackedSize":19526,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@afriex%2fcheckout@3.0.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDjs+GgbdZSCH/NMGEsVo2xWghOiQ/gng084/KMOb3XCgIgCgtXWBmvQ37ZgQOshw1H5L3x5zqIrgZt4kVN/6mFgWk="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:dc2042f4-d1ac-4504-8504-137fea98ca9d"}},"directories":{},"maintainers":[{"name":"luckyv","email":"luckyvictory54@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/checkout_3.0.1_1787059978922_0.8406399647598268"},"_hasShrinkwrap":false}},"time":{"created":"2026-05-29T01:25:05.994Z","modified":"2026-08-18T13:32:59.423Z","1.0.0":"2026-05-29T01:25:06.348Z","2.0.0":"2026-05-30T13:47:47.726Z","2.0.1":"2026-07-12T12:17:32.707Z","2.0.2":"2026-08-12T14:53:38.877Z","3.0.0":"2026-08-18T10:26:26.937Z","3.0.1":"2026-08-18T13:32:59.123Z"},"bugs":{"url":"https://github.com/Afri-exchange/afriex-sdk/issues"},"author":{"name":"Victory Lucky","email":"luckyvictory54@gmail.com"},"license":"MIT","homepage":"https://github.com/Afri-exchange/afriex-sdk#readme","keywords":["tanstack-intent"],"repository":{"type":"git","url":"git+https://github.com/Afri-exchange/afriex-sdk.git","directory":"packages/checkout"},"description":"Checkout service for Afriex SDK","maintainers":[{"name":"luckyv","email":"luckyvictory54@gmail.com"}],"readme":"# @afriex/checkout\n\nCheckout service for the Afriex SDK. Provides hosted payment checkout sessions.\n\n## Installation\n\n```bash\nnpm install @afriex/checkout\n# or\npnpm add @afriex/checkout\n```\n\n## Usage\n\n```typescript\nimport { CheckoutService } from \"@afriex/checkout\";\nimport { HttpClient } from \"@afriex/core\";\n\nconst httpClient = new HttpClient(config);\nconst checkoutService = new CheckoutService(httpClient);\n\n// Create a checkout session\nconst session = await checkoutService.createSession({\n  amount: 500000,\n  currency: \"NGN\",\n  merchantReference: \"order-2026-05-12-001\",\n  redirectUrl: \"https://yourapp.com/checkout/return\",\n  customer: {\n    name: \"John Doe\",\n    email: \"john@example.com\",\n    phone: \"+2348192837465\",\n    countryCode: \"NG\",\n  },\n  channels: [\"VIRTUAL_BANK_ACCOUNT\"],\n  metadata: {\n    orderId: \"ord_123\",\n    cartId: \"cart_456\",\n  },\n});\n\n// Redirect user to checkout URL\nwindow.location.href = session.checkoutUrl;\n```\n\n`amount` is sent in minor units. For example, NGN 5,000.00 should be passed as `500000`.\n\n## API\n\n### `createSession(request: CreateCheckoutSessionRequest): Promise<CheckoutSession>`\n\nCreates a hosted checkout session where customers can complete payments.\n\n**Parameters:**\n\n- `request.amount` - Integer amount in minor currency units, minimum `100`\n- `request.currency` - Uppercase 3-letter ISO 4217 currency code\n- `request.merchantReference` - Unique reference used to identify the session end-to-end\n- `request.redirectUrl` - HTTPS URL to return the customer to after checkout\n- `request.customer` - Customer information (`name`, `email`, `phone`, `countryCode`)\n- `request.channels` - Optional allowed payment channels. Defaults to `VIRTUAL_BANK_ACCOUNT` when omitted\n- `request.metadata` - Optional flat key/value metadata where all values are strings\n\n**Returns:**\n\n- `CheckoutSession` - Contains the hosted `checkoutUrl`\n\n## License\n\nMIT\n","readmeFilename":"README.md"}