--- title: Introduction slug: introduction docTags: createdAt: 2024-05-20T15:06:32.222Z --- ## Welcome to Judopay Accept simple and secure payments in your app or website with Judopay’s SDKs. Quickly capture your customer’s card details for immediate payments or save them securely for future payments. ### To get started :::CtaButton{label=">>> Click to sign up for your Sandbox Account >>>" externalHref="https://www.judopay.com/contact/apply-sandbox-account" openInNewTab="true"} ::: Then, you will receive access to your Judopay dashboard and the sandbox environment. :::hint{type="info"} There is a due diligence process to complete before you go live, so please speak to a member of the team before doing any development work. ::: To follow the steps to quickly integrate and produce a test card payment using Judopay’s Web SDK, see [Start Integrating with Judopay](docId\:UuVcDjXTcajyQHD4xFPYE). *** # Important to Consider When Integrating your App ## When to have Multiple JudoIds You can have: - One judoId - Multiple judoIds A **judoId **can be allocated for a route or location basis. Multiple judoIds can also be created to take into account a more granular set of transaction reporting, for example to separate online transactions, the location where transactions took place, or the most used payment method. All judoId's can have different configurations enabled. *** ## Permissions You will receive your** API credentials** when setting up your account with Judopay. These credentials control the **permissions **enabled on your sandbox and live **token and secret** pair(s). Each Token and Secret pair will have specific permissions configured. *The following illustration provides a helpful overview on the permissions that need to be set up, in order for each step in the payment flow to be able to take place\:* ![permissions flow diagram](https://api.archbee.com/api/optimize/QGXTyW3MgdNcMjdEa0v8r/wc4cbDIDwerIOVcoiSnXh_permissionsflow.png) *** ## Possible Configuration Examples: Depending on the payment methods, currencies and card schemes you want to accept, you can configure these specifically, (for example Visa, Mastercard, Apple Pay, Card, PayPal), or set to accept **All**. Check your judoIds and tokens are configured and enabled as appropriate. :::hint{type="warning"} If you want to include **AMEX**, contact [Customer Support](mailto\:help@judopay.com) to set this up. AMEX is not automatically added and requires a separate configuration. ::: - Payment Methods - Transaction Medium (ECOM / MOTO) - Currencies - Card Schemes - Transaction Types - Block Payments from a Specific Region *** # Using our Transaction API Interact with our [Transaction API Reference](docId\:bcXNM5keOk-nlNrZTafUT) in the following ways: - Select your integration version - See the authentication methods available - How to create a `/paymentsession` - Authenticate all requests or a specific request - Manually test a request - View example success and error responses For more information, see [How to use our Transaction API Reference Documentation](docId\:ApyEqDsYCdRKUxgGnLHup). *** ## Authentication Methods In online and mobile payments, **security is a number one concern**. Authentication and verification of the identity of the cardholder is important for preventing fraudulent transactions and refunds. Each request to Judopay’s Transaction API requires authentication. Depending on how you integrate with Judopay, the following methods are recommended to authenticate requests: - Using our [SDKs](docId:40dWE6LBub7vdKza1QYDC): - `/paymentsession` - Calling directly to our [Transaction API](docId\:bcXNM5keOk-nlNrZTafUT): - `/paymentsession`, or - TokenSecretAuth - The token and secret pair For more information, see [Authentication Methods](docId\:ylKW5coh5NQnfQ3j_Wjk2). *** # Testing your Integration **Prior to Testing - Prerequisites** Make sure you have the following set up prior to testing: - You are using **sandbox **tokens in the **sandbox **environment. - You are using **test cards** in the **sandbox **environment. - Your judoIds and tokens are configured and enabled as appropriate. You need your [sandbox account](https://www.judopay.com/apply-sandbox-account) so you can process test transactions while developing your app. :::CtaButton{label=">>> Click to sign up for your Sandbox Account >>>" externalHref="https://www.judopay.com/contact/apply-sandbox-account" openInNewTab="true"} ::: *** ## Sandbox Environment The purpose of the sandbox environment is to allow you to test and replicate various use cases, payment flows and scenarios that your app should support. Use the [Test Cards](docId:_OBafnuC1Umhk-vIhHs5D) and data to test your integration is working correctly. This will give you confidence that all is working as expected when your integration goes live. ### Direct API Integration Scenarios (Card Payments): - [Payment flows including 3D Secure 2 ](docId\:BdCGiYQDm3mlE-UBxp1yR) - [Payments](docId\:NQ7C98PanEmfgukhbPucB) - [PreAuths](docId\:gwWUVrKwOnC5YVk6qhMMi) - [Refunds](docId\:mEbkvLfMxdP3kOlys0uDa) - [Collections](docId\:yVjgZT2gxWBDxm3m0wEmu) - [Voids](docId\:DMBAKsKJll551SuxQIPuM) - [SaveCard](docId\:N6BoW_dLQrQO_olwrjvFK) - [CheckCard](docId:3ssySZe0ATrwUJRQsIqOv) - [Merchant Initiated Transactions](docId\:gB1c-OQBH7UUW8rzUSawt) - [GET a list or GET an individual transaction(s)](docId\:ZIA7Tb_A4KYbkM0v4Okjy) For more information see, [Testing your Direct (API) Integration](docId:6BaHfdUikW3XMs1PV8OEx). *** ### Web Payments Integration Scenarios (Card Payments): - [Payments](docId\:ZV5mPxMMQxjq1RP3FAyxK) - [PreAuths](docId\:ZV5mPxMMQxjq1RP3FAyxK) - [CheckCard](docId\:ZV5mPxMMQxjq1RP3FAyxK) For more information see, [Testing Web Payments - Card Payments](docId\:ZV5mPxMMQxjq1RP3FAyxK). *** ### Mobile SDK Integration Scenarios (Card Payments): - [Android](docId\:VZB3q7wp2Hf0LJGdO8VnD) - [iOS](docId:9t9c80aDjPMu0BaiyS7SK) For more information see, [Testing your Mobile SDK Integration](docId\:GvThUybG_KBeT2SxnyNLO). *** ### Web SDK Integration Scenarios (Card Payments): - [Payments](docId\:a33b4PWt6BRoFeJpgHDH2) - [PreAuths](docId\:a33b4PWt6BRoFeJpgHDH2) - [CheckCard](docId\:a33b4PWt6BRoFeJpgHDH2) - [Token Payments](docId\:a33b4PWt6BRoFeJpgHDH2) - [Token PreAuths](docId\:a33b4PWt6BRoFeJpgHDH2) For more information see, [Testing Web SDK - Card Payments](docId\:a33b4PWt6BRoFeJpgHDH2). *** ### Wallet Payment Scenarios (via direct API Integration): - [Apple Pay™](docId\:hq1tYqLiKePvZyqLW-L07) - [Google Pay™](docId\:hq1tYqLiKePvZyqLW-L07) For more information see, [Testing Digital Wallet Payments - via API](docId\:hq1tYqLiKePvZyqLW-L07). *** ### Wallet Payment Scenarios (via Web SDK Integration): - [Apple Pay™](docId\:t13itu-7QX7Ylrxgvj5jt) - [Google Pay™](docId\:t13itu-7QX7Ylrxgvj5jt) For more information see, [Testing Digital Wallet Payments - via Web SDK](docId\:t13itu-7QX7Ylrxgvj5jt). *** ### Wallet Payment Scenarios (via Mobile SDK Integration): - [Apple Pay™](docId\:hYAnZIM115Id6daBs-bkP) - [Google Pay™](docId\:PDWr34AvmT3iws1j8xtsQ) For more information see, [Testing your Wallet Payment Integration](docId\:IyacWLIdSCQIKMCfrrkhp). *** # Key Terms Familiarise yourself with the key terms we use, to help you with your integration: ## judoId The judoId is a unique ID supplied by Judopay, which you add to the request body of each transaction request. - String of numbers - Maximum length 9 characters - Format: 100100100 - Do not include spaces or dashes *** ## API Credentials You will receive your** API credentials** when setting up your account with Judopay. These credentials control the **permissions **enabled on your sandbox and live **token and secret** pair(s). Each Token and Secret pair will have specific permissions configured. For more information, see [Token and Secret App Permissions](docId\:S_8hOAMytkgY13t0P657-). *** ## 3D Secure 2 :::hint{type="info"} We support all versions of the 3D Secure protocol up to and including version 3DS2.2 ::: 3D Secure 2.0 aims to improve the security and consumer experience, including helping merchants achieve Strong Customer Authentication (SCA) compliance under PSD2. The Payment Services Directive (PSD2), has introduced a new regulatory requirement: **Strong Customer Authentication** (SCA). The aim of the SCA is to add an increased layer of security for card not present transactions, when making mobile and online payments. :::hint{type="warning"} Make sure your account has **3D Secure 2 API credentials **enabled. Contact ​Customer Support​​ to set this up. ::: In the 3D Secure 2 payment flow, the Issuer will make a decision on whether they have enough authentication data to proceed with the transaction, or if they require the cardholder to further authenticate the transaction with additional Strong Customer Authentication (SCA) checks. For more information, see [Improving Authentication in your Payment Flow](docId:0YQDP4kpyOiJJ6UNudn9f). To authenticate the transaction, merchants can verify the consumer's identity with the Issuer. To be compliant with SCA, 3D Secure 2 transactions have **additional authentication and transaction information** within the payment flow. For more information on 3D Secure 2, see [What is 3D Secure?](docId\:WpFMF662qaIGEGrpU_Mow) *** ## Merchant-Initiated-Transactions Merchant-Initiated-Transactions (MIT)s, for example: - Subscription type payments - Unscheduled transactions - tips - increase in taxi fares For more information, see [Merchant Initiated Transactions](docId\:ek1dldO8cGr9DI226zlyf). :::hint{type="warning"} MITs are also impacted by **SCA**. You need to** tag your MIT / Recurring transactions** correctly to ensure your transactions are not declined by your customers’ issuing bank. ::: *** ## Card Token Payments Use the card token in the request body, instead of the card number. The card token is a randomly generated string linked to a card saved securely within the Judopay Card Vault. You will not take on additional PCI scope, as the card token does not have any sensitive card information, so it can be stored in your database. *** ## Alternative Payments Alternative Payment Methods refers to a** range of payment methods** beyond the traditional ways of paying with cards and cash. Currently Judopay accepts the following alternative payment methods: - [PayByLink via API](docId:44rRmA0kRzsQsVnri7Qbw) - [PayPal](docId\:RCuemK4qqk-M-NDM0Nh8g) **(BETA)** *** ## Wallet Payments Integrate Apple Pay™ and Google Pay™ via Web and Mobile. For more information, see [Wallet Payments](docId\:xUgwB4y6tqksmz-qUYCCZ). *** ## Web Payments A minimal integration is all that is required to enable you to take a payment. Generate hosted payment page links using Judopay’s Transaction API and redirect the consumer back to your own website, using configured redirect URLs. This helps minimise your PCI scope by providing consumers with a secure way to pay online via their browser, optimised for any device. For more information, see [Web Payments](docId\:GloRwwwFKFqp34FyKCXe8). *** ## SDKs Judopay’s SDKs enables merchants to easily integrate and customise a seamless consumer checkout experience, for Mobile, Web and Server integrations. All of our SDKs come built-in with the following features: - Secure Customer Authentication (SCA) compliance: 3D Secure. - Fraud Prevention Tools - Supports Alternative Payment Methods - You will not take on additional PCI scope, as sensitive card information is submitted by consumers into fields hosted by Judopay, encrypted and transmitted on behalf of the merchant, meaning it does not touch the merchant’s server. If you prefer to use your own UI for the consumer’s checkout journey, you can still easily integrate with Judopay using only a few lines of code to begin accepting payments. For more information, see: - [Mobile SDKs](docId\:FYeF-N37tnL1c5dssCmL3) - [Web SDK](docId:40dWE6LBub7vdKza1QYDC) - [Server SDK Integration](docId\:mZCNx_MB0NESPjB4MjpZ4)