redirect<\/strong>","pm_directory":"clearpay","contact":"false"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/clearpay\/api-only","title":"Clearpay for API only","content":"You can add Clearpay to your existing integration. The following instructions show only what you must add to your integration specifically for Clearpay.\nIf an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have an existing API-only integration.\n \n\n\nRedirect handling\nMake sure that your existing integration is set up to handle the redirect. action.type: redirect.\n\n\n\nSetup steps\n Before you begin, add Clearpay in your Customer Area. \n\n\n\nHow it works\n\nThe shopper selects Clearpay as the payment method.\nThe shopper enters their details in the payment form that you build.\nWhen you make the payment request, you include additional information about the items that the shopper intends to purchase.\nYour existing integration setup will handle the redirect.\nYou capture the payment.\nClearpay starts the repayment period for the shopper.\n\nBuild your payment form\nInclude Clearpay in the list of available payment methods.\nTo perform risk checks, Clearpay requires you to collect the following shopper details:\n\nFull name\nEmail address\nBilling address and delivery address\n\n\nYou can download the logo for Clearpay to use in your form.\n\nGet Clearpay as an available payment method\nWhen you make the \/paymentMethods to get available payment methods, specify the following so that Clearpay is included in the response.\n\n\n\nParameter\nValues\n\n\n\n\n countryCode\nGB\n\n\n amount.currency\nGBP\n\n\n\n\n \n\n\n \n\nAdd additional parameters to your \/payments request\nWhen you make a payment, add the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n shopperName\n\nThe shopper's full name.\n\n\n shopperEmail\n\nThe shopper's email address.\n\n\n shopperReference\n\nA unique reference to identify the shopper. Minimum length: three characters.\n\n\n countryCode\n\nThe shopper's country\/region.\n\n\n billingAddress\n\nThe postal address to be included on the invoice.\n\n\n deliveryAddress\n\nThe postal address where the goods will be shipped.\n\n\n lineItems\n\nPrice and product information about the purchased items.\n\n\n telephoneNumber\n\nThe shopper's telephone number, if provided.\n\n\n\n\n \n\nThe response includes the action.type: redirect.\n\n \n\nCapture the payment\nDepending on your merchant account configuration, Clearpay payments are captured automatically after authorisation, or manually captured. If you prefer to capture the payment after the goods have been sent, you need to set up a capture delay or use manual capture. To partially capture a payment, you also need to use manual capture.\nClearpay payments have to be captured within 13 days after authorisation.\nDuring authorisation, the shopper is charged for the first installment. If the payment is not captured within 13 days, before the second installment, Clearpay cancels the payment and refunds the first installment to the shopper.\n\nFor testing purposes, Clearpay authorisations expire in one day. When you use manual capture, you need to capture test Clearpay payments within one day after authorisation.\n\nFull or partial manual captures\nWhen you use manual capture, in your \/payments\/{paymentPspReference}\/captures request specify:\n\n amount.value: the full or partial amount that the shopper should pay.\n lineItems: (optional) price and product information for the items that the shopper should pay for.\n\nAny unclaimed amount that is left over after partially capturing a payment is automatically cancelled. When your account is enabled for multiple partial captures, the unclaimed amount after an initial capture is not automatically cancelled.\n\nTo set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture.\n\nRefunds and cancellations\nIf a payment has not yet been captured, you can cancel it. If a payment has already been captured and you want to return the funds to the shopper, you need to refund the payment.\nFull or partial refunds\nTo fully or partially refund a payment, in your \/payments\/{paymentPspReference}\/refunds request specify:\n\n amount.value: the full or partial amount to be refunded to the shopper.\n lineItems: (optional) price and product information about the refunded items.\n\nDiscounts\nTo offer discounts, your payment request must include the negative amount to be added to the original price. The following example shows how to specify a discount of 1 GBP on Item #2:\n{\n \"amount\":{\n \"value\":800,\n \"currency\":\"GBP\"\n },\n ...\n \"lineItems\":[\n\n {\n \"description\":\"Test Clearpay 1\",\n \"quantity\":\"1\",\n \"amountIncludingTax\":\"400\",\n \"id\":\"Item #1\"\n },\n {\n \"description\":\"Test Clearpay 2\",\n \"quantity\":\"2\",\n \"amountIncludingTax\":\"300\",\n \"id\":\"Item #2\"\n }\n\n {\n \"description\":\"Discount\",\n \"quantity\":\"2\",\n \"amountIncludingTax\":\"-100\",\n \"id\":\"Item #2 Discount\"\n }\n ]\n}\nTest and go live\nTo test Clearpay payments, you need to use the Clearpay sandbox environment and create a test Clearpay shopper account. Clearpay offers separate sandbox environments and test details based on country and region.\nFollow the links to the Clearpay developer documentation for more details.\n\n\n\nClearpay developer documentation\nDescription\n\n\n\n\nTest Environment (Sandbox)\nMore information about how to get access to the sandbox environment.\n\n\nCustomer Accounts\nLearn how to create a test Clearpay shopper account.\n\n\nTest cards\nList of available Clearpay test cards to test different payment flows.\n\n\n\n\nIn the Clearpay sandbox environment, you will see Adyen as the merchant name. When you go live, this will change to your own merchant name.\n\nWhen you have set up your sandbox environment, and created your Clearpay test shopper account, you can make a test payment. You can check the status of test payments in your\u00a0Customer Area\u00a0>\u00a0Transactions\u00a0>\u00a0Payments.\nBefore you can accept live Clearpay payments, you need to submit a request for Clearpay in your live Customer Area.\nSee also\n\n\n API-only integration guide\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Clearpay","lvl3":"Clearpay for API only"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/clearpay","lvl3":"\/pt\/payment-methods\/clearpay\/api-only"},"levels":4,"category":"Payment method","category_color":"green","tags":["Clearpay"]},"articleFiles":{"payment-methods-response.json":"payment-methods-response.json<\/p>","payments-response.json":"
payments-response.json<\/p>"}}
![\"-white_check_mark-\"](\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" "\\"-white_check_mark-\\"")
<\/td>\n