\nSuccessful payments. Satisfied customers.\n
\n\nThe @migopayments SDK simplifies integrating payment options into your applications, enabling you to manage transactions and tokenize cards, all with a focus on security and ease of use.\n
\n\n## ๐งฐ Prerequisites\n\n- Install node.js in your environment\n- Access to **merchant** and **privateKey** credentials provided by MigoPayments.\n\n## ๐ฆ Installation\n\n```\n$ npm install @migopayments/sdk\n```\n\n## ๐ Initial Configuration\n\nInitialize the SDK with credentials provided by MigoPayments and set up the environment you wish to work in.\n\n```TypeScript\nimport { loadMigo } from \"@migopayments/sdk\";\n\nconst initSdk = async () => {\n const migo = await loadMigo({\n merchant: \"merchant_id\", // provided by Migo\n privateKey: \"private_key\", // provided by Migo\n environment: \"sandbox\",\n });\n\n // Use `migo` for your transactions\n};\n\ninitSdk();\n```\n\n| Environment | Description |\n| ----------- | ----------------------------------------------- |\n| sandbox | Use this to build and test your application ๐งช. |\n| production | Use this for production. |\n\nThe `migo` object will expose the multiple methods available in the SDK.\n\n## ๐งฉ The schema object\n\nThe schema object serves a crucial purpose in the SDK by dynamically validating payload information sent by the client. It is custom-tailored to each client, providing a unique framework for organizing and structuring data. By printing it to the console, you can gain valuable insight into how the SDK handles and enforces data validations, making it an indispensable tool for developers.\n\n```TypeScript\n// print out the schema\nconsole.log(JSON.stringify(migo.schema));\n```\n\nThe structure of the config comes in an array, because you can have multiple clients or different branches. So the basic structure is this:\n\n```json\n[\n {\n clients: [ { key: 'migoTest', name: 'Migo Test' }]\n processors: [\n {\n processor: 'processor1', // This is the key to send in some payloads\n processorName: 'Processor 1', // Friendly name of the processor,\n cards: true, // Flag to know if you can save cards\n installments: [1,2,3...], // How many installments it can handle,\n inputsMakePayment: [ // Super important part, to know how to create a payload to send when making a payment\n {\n //.....\n },\n {\n //.....\n },\n ],\n ...\n }\n ]\n },\n {\n //...\n }\n]\n```\n\nBUT in most cases, you will have just one client. So the array will come with one object. **Please** always make sure to print the migo.schema to check that you have assigned your client and the processor keys. If not please contact migo support to validate your credentials.\n\n## Tips for Implementing the SDK in Your Frontend\n\n- **Data Validation**: It's important to validate the data being inputted. Specifically, the `amount` field should not accept text.\n\n - **Suggestion**: Consider disabling the 'create transaction' button or turning it gray when the mandatory fields are not populated.\n\n- **Input Validation**: Inputs should be validated based on the type of data they are expected to contain, such as text or numbers.\n\n- **Security Enhancement**: For security purposes, do not use `console.log` specially in data like the merchant's `credentials` and `privateKey`.\n\n- **Handling customKeys**: When sending `customKeys`, if there's no error or feedback displayed, it can be confusing for the user.\n\n- **Field Validation**: There should be validation checks on input fields based on the required data type.\n\n- **Handling Non-Existent Tokenized Card Transactions**: If a search for a tokenized card transaction yields no results, a message indicating that no transaction was found should be displayed.\n\n## ๐ More information\n\n[SDK Full Documentation](https://migo-payments.stoplight.io/docs/api-externa/qusj16ro5lkyd-prerequisites)\n\n[MigoPayments](https://migopayments.com)","readmeFilename":"README.md"}