{"id":27151408,"url":"https://github.com/checkout/frames-cordova","last_synced_at":"2026-04-29T17:04:16.089Z","repository":{"id":40427056,"uuid":"340382968","full_name":"checkout/frames-cordova","owner":"checkout","description":"A Cordova plugin for Checkout.com Frames product","archived":false,"fork":false,"pushed_at":"2023-07-18T16:48:20.000Z","size":29,"stargazers_count":0,"open_issues_count":2,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-08T14:44:35.583Z","etag":null,"topics":["cordova","cordova-plugin","payment-processing","phonegap","phonegap-plugin"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checkout.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-19T13:50:10.000Z","updated_at":"2023-10-30T16:20:34.000Z","dependencies_parsed_at":"2025-04-08T14:50:45.385Z","dependency_job_id":null,"html_url":"https://github.com/checkout/frames-cordova","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/checkout/frames-cordova","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkout%2Fframes-cordova","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkout%2Fframes-cordova/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkout%2Fframes-cordova/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkout%2Fframes-cordova/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checkout","download_url":"https://codeload.github.com/checkout/frames-cordova/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkout%2Fframes-cordova/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32435122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T13:34:34.882Z","status":"ssl_error","status_checked_at":"2026-04-29T13:34:29.830Z","response_time":110,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cordova","cordova-plugin","payment-processing","phonegap","phonegap-plugin"],"created_at":"2025-04-08T14:40:21.880Z","updated_at":"2026-04-29T17:04:16.065Z","avatar_url":"https://github.com/checkout.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cordova Checkout Plugin\nA Cordova plugin for Checkout.com Frames SDK - Start accepting online card payments in just a few minutes. Supports Android \u0026 iOS.\n\n## Installation\n```shell\ncordova plugin add @checkout.com/cordova-plugin-checkout\n```\n\n## Example Usage\n\nFirst you need to initialize the plugin using your public key.\nThis could be either a testing key (sandbox) or a production key\n\nSandbox:\n```javascript\ncordova.plugins.Checkout.initSandboxClient(\"pk_test_MyTESTPublicKey\", \n    function() {\n        // Success, no need to do anything\n    }, function (error) {\n        // Error, message returned\n    });\n```\n\nProduction:\n```javascript\ncordova.plugins.Checkout.initLiveClient(\"pk_MyLivePublicKey\", \n    function() {\n        // Success, no need to do anything\n    }, function (error) {\n        // Error, message returned\n    });\n```\n\nNow you can start tokenizing credit/debit cards.\n\n```javascript\nvar ckoCardTokenRequest = {\n    number: \"4543474002249996\",\n    expiry_month: \"6\",\n    expiry_year: \"2025\",\n    name: \"Bruce Wayne\",\n    cvv: \"956\",\n    billing_address: {\n        address_line1: \"Checkout.com\",\n        address_line2: \"90 Tottenham Court Road\",\n        city: \"London\",\n        state: \"London\",\n        zip: \"W1T 4TJ\",\n        country: \"GB\"\n    },\n    phone: {\n        country_code: \"+1\",\n        number: \"4155552671\"\n    }\n};\n\nfunction onSuccess(tokenResponse) {\n    console.log('Tokenization successful', tokenResponse);\n}\n\nfunction onError(errorMessage) {\n    console.log('Error generating token', errorMessage);\n}\n\ncordova.plugins.Checkout.generateToken(ckoCardTokenRequest, onSuccess, onError);\n```\n\nExample of TokenResponse:\n```javascript\n{\n    type: \"card\",\n    token: \"tok_ubfj2q76miwundwlk72vxt2i7q\",\n    expires_on: \"2019-08-24T14:15:22Z\",\n    expiry_month: \"6\",\n    expiry_year: \"2025\",\n    scheme: \"VISA\",\n    last4: \"9996\",\n    bin: \"454347\",\n    card_type: \"Credit\",\n    card_category: \"Consumer\",\n    issuer: \"GOTHAM STATE BANK\",\n    issuer_country: \"US\",\n    product_id: \"F\",\n    product_type: \"CLASSIC\",\n    billing_address: {\n        address_line1: \"Checkout.com\",\n        address_line2: \"90 Tottenham Court Road\",\n        city: \"London\",\n        state: \"London\",\n        zip: \"W1T 4TJ\",\n        country: \"GB\"\n    },\n    phone: {\n        country_code: \"+1\",\n        number: \"4155552671\"\n    },\n    name: \"Bruce Wayne\"\n}\n```\n\nOnce you get the token, you can later use it to [request a payment](https://api-reference.checkout.com/#operation/requestAPaymentOrPayout), without you having to process or store any sensitive information.\n\n\n## Documentation\n\n\n* [Checkout](#module_cko)\n    * [.initSandboxClient(publicKey, [success], [error])](#module_cko.initSandboxClient)\n    * [.initLiveClient(publicKey, [success], [error])](#module_cko.initLiveClient)\n    * [.generateToken(ckoCardTokenRequest, [success], [error])](#module_cko.generateToken)\n* [Models](#module_models)\n    * [CkoCardTokenRequest](#module_models.CkoCardTokenRequest) : \u003ccode\u003eObject\u003c/code\u003e\n    * [CkoCardTokenResponse](#module_models.CkoCardTokenResponse) : \u003ccode\u003eObject\u003c/code\u003e\n    * [Address](#module_models.Address) : \u003ccode\u003eObject\u003c/code\u003e\n    * [Phone](#module_models.Phone) : \u003ccode\u003eObject\u003c/code\u003e\n\n\n\u003cbr\u003e\n\n\u003ca name=\"module_cko\"\u003e\u003c/a\u003e\n\n## Checkout\n\u003ca name=\"module_cko.initSandboxClient\"\u003e\u003c/a\u003e\n\n### Checkout.initSandboxClient(publickey, [success], [error])\nInitialize Frames plugin in Sandbox mode\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| publicKey | \u003ccode\u003estring\u003c/code\u003e | Sandbox account public key |\n| [success] | \u003ccode\u003efunction\u003c/code\u003e | Success callback |\n| [error] | \u003ccode\u003efunction\u003c/code\u003e | Error callback |\n\n\u003ca name=\"module_cko.initLiveClient\"\u003e\u003c/a\u003e\n\n### Checkout.initLiveClient(publickey, [success], [error])\nInitialize Frames plugin in Live mode\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| publicKey | \u003ccode\u003estring\u003c/code\u003e | Live account public key |\n| [success] | \u003ccode\u003efunction\u003c/code\u003e | Success callback |\n| [error] | \u003ccode\u003efunction\u003c/code\u003e | Error callback |\n\n\u003ca name=\"module_cko.generateToken\"\u003e\u003c/a\u003e\n\n### Checkout.generateToken(ckoCardTokenRequest, success, error)\nGenerate a payment token\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| ckoCardTokenRequest | [\u003ccode\u003eCkoCardTokenRequest\u003c/code\u003e](#module_models.CkoCardTokenRequest) | payment token request object|\n| success | \u003ccode\u003efunction\u003c/code\u003e | Success callback returns [\u003ccode\u003eCkoCardTokenResponse\u003c/code\u003e](#module_models.CkoCardTokenResponse) |\n| error | \u003ccode\u003efunction\u003c/code\u003e | Error callback |\n\n\n\u003ca name=\"module_models\"\u003e\u003c/a\u003e\n\n## Models\n\u003ca name=\"module_models.CkoCardTokenRequest\"\u003e\u003c/a\u003e\n\n### CkoCardTokenRequest : \u003ccode\u003eObject\u003c/code\u003e\nParameters to create a payment token from a card\n\n**Properties**\n\n| Name | Type | Description | Required\n| --- | --- | --- | --- |\n| number | \u003ccode\u003estring\u003c/code\u003e | The card number | Required |\n| expiry_month | \u003ccode\u003estring\u003c/code\u003e | The expiry month of the card | Required |\n| expiry_year | \u003ccode\u003estring\u003c/code\u003e | The expiry year of the card | Required |\n| cvv | \u003ccode\u003estring\u003c/code\u003e | The card verification value/code. 3 digits, except for Amex (4 digits) | Optional |\n| name | \u003ccode\u003estring\u003c/code\u003e | The cardholder's name | Optional |\n| billing_address | [\u003ccode\u003eAddress\u003c/code\u003e](#module_models.Address) | The cardholder's billing address | Optional |\n| phone | [\u003ccode\u003ePhone\u003c/code\u003e](#module_models.Address) | The cardholder's phone number | Optional |\n\n\n\n\u003ca name=\"module_models.CkoCardTokenResponse\"\u003e\u003c/a\u003e\n\n### CkoCardTokenResponse : \u003ccode\u003eObject\u003c/code\u003e\nObject returned after successful tokenization\n\n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| type | \u003ccode\u003estring\u003c/code\u003e | The token type, in this case \"card\" |\n| token | \u003ccode\u003estring\u003c/code\u003e | The token value |\n| expires_on | \u003ccode\u003estring\u003c/code\u003e | The expiration datetime of the token |\n| expiry_month | \u003ccode\u003estring\u003c/code\u003e | The expiry month of the card |\n| expiry_year | \u003ccode\u003estring\u003c/code\u003e | The expiry year of the card |\n| name | \u003ccode\u003estring\u003c/code\u003e | The cardholder's name |\n| scheme | \u003ccode\u003estring\u003c/code\u003e | The card scheme |\n| last4 | \u003ccode\u003estring\u003c/code\u003e | The last 4 digit of the card number |\n| bin | \u003ccode\u003estring\u003c/code\u003e | The bin range of the card |\n| card_type | \u003ccode\u003estring\u003c/code\u003e | The card type |\n| card_category | \u003ccode\u003estring\u003c/code\u003e | The card category |\n| issuer | \u003ccode\u003estring\u003c/code\u003e | The card issuer name |\n| issuer_country | \u003ccode\u003estring\u003c/code\u003e | The card issuer country ISO |\n| product_id | \u003ccode\u003estring\u003c/code\u003e | The card product id |\n| product_type | \u003ccode\u003estring\u003c/code\u003e | The card product type |\n| billing_address | [\u003ccode\u003eAddress\u003c/code\u003e](#module_models.Address) | The cardholder's billing address |\n| phone | [\u003ccode\u003ePhone\u003c/code\u003e](#module_models.Address) | The cardholder's phone number |\n\n\n\u003ca name=\"module_models.Address\"\u003e\u003c/a\u003e\n\n### Address : \u003ccode\u003eObject\u003c/code\u003e\n\n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| address_line1 | \u003ccode\u003estring\u003c/code\u003e | The first line of the address |\n| address_line2 | \u003ccode\u003estring\u003c/code\u003e | The second line of the address |\n| city | \u003ccode\u003estring\u003c/code\u003e | The address city |\n| state | \u003ccode\u003estring\u003c/code\u003e | The address state |\n| zip | \u003ccode\u003estring\u003c/code\u003e | The address zip/postal code |\n| country | \u003ccode\u003estring\u003c/code\u003e | The two-letter ISO country code of the address |\n\n\n\u003ca name=\"module_models.Phone\"\u003e\u003c/a\u003e\n\n### Phone : \u003ccode\u003eObject\u003c/code\u003e\n\n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| country_code | \u003ccode\u003estring\u003c/code\u003e | The international country calling code. Required for some risk checks |\n| number | \u003ccode\u003estring\u003c/code\u003e | The phone number |\n\n\u003cbr\u003e\n\n\n## Unit Testing\n\nYou can test this plugin with [cordova-plugin-test-framework](https://github.com/apache/cordova-plugin-test-framework)\n\nInstall the tests plugin:\n```shell\ncordova plugin add @checkout.com/cordova-plugin-checkout/tests\n```\n\n\u003cbr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckout%2Fframes-cordova","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckout%2Fframes-cordova","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckout%2Fframes-cordova/lists"}