{"title":"Payouts to cards","category":"Classic Platforms","creationDate":1776961628,"content":"<div class=\"sc-notice info\"><div>\n<p>This page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our <a href=\"\/pt\/adyen-for-platforms-model\">new integration guide<\/a> instead.<\/p>\n<\/div><\/div>\n<p>Aside from paying out to bank accounts, you also have the option to send payouts to eligible Mastercard and Visa debit cards. This feature is available in <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Fund\/v6\/overview\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Fund API<\/a> version 5 and later.<\/p>\n<p>When paying out to cards, the funds arrive to the cardholder within 30 minutes and there is no dependency on bank cutoffs.<\/p>\n<h2>Requirements<\/h2>\n<p>Contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> to enable card payouts for your platform.<\/p>\n<h2 id=\"check-and-store\">Step 1: Check if the card is eligible for payouts and save the card details<\/h2>\n<ol>\n<li>\n<p>Submit a POST  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> request with your account holder's card details and the following parameters:<\/p>\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-merchantAccount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">merchantAccount<\/a>&#58; Your merchant account.<\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Payment\/latest\/post\/authorise#request-shopperReference\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperReference<\/a>&#58; Your unique account holder reference (minimum length three characters).<\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-enablePayOut\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">enablePayOut<\/a>&#58; Indicates if the card details should be stored for payouts. Set this to <span translate=\"no\"><strong>true<\/strong><\/span>.<\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-paymentMethod\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">paymentMethod<\/a>&#58; Object containing your account holder's card details.<\/li>\n<\/ul>\n<div class=\"sc-notice note\"><div>\n<p>You can only pass raw card data if you are\u00a0<a href=\"\/pt\/get-started-with-adyen\/adyen-glossary\/#pci-compliance\">fully PCI compliant<\/a>. Otherwise, use our <a href=\"\/pt\/payment-methods\/cards\/custom-card-integration\">Card Component<\/a> to securely collect and encrypt your account holder's card details.<\/p>\n<\/div><\/div>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Submit a zero-value payment request'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;{\\n    \\&quot;{hint:Your account holder's card details}paymentMethod{\\\/hint}\\&quot;: {\\n      \\&quot;type\\&quot;: \\&quot;scheme\\&quot;,\\n      \\&quot;number\\&quot;: \\&quot;4111111111111111\\&quot;,\\n      \\&quot;expiryMonth\\&quot;: \\&quot;3\\&quot;,\\n      \\&quot;expiryYear\\&quot;: \\&quot;2030\\&quot;,\\n      \\&quot;cvc\\&quot;: \\&quot;737\\&quot;,\\n      \\&quot;holderName\\&quot;: \\&quot;John Smith\\&quot;\\n    },\\n    \\&quot;amount\\&quot;: {\\n      \\&quot;value\\&quot;: 0,\\n      \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;\\n    },\\n    \\&quot;{hint:Your unique reference for this account holder, minimum length 3}shopperReference{\\\/hint}\\&quot;: \\&quot;YOUR_UNIQUE_SUBMERCHANT_ID_IOfW3k9G2PvXFu2j\\&quot;,\\n    \\&quot;enablePayOut\\&quot;: true,\\n    \\&quot;reference\\&quot;: \\&quot;YOUR_TRANSACTION_REFERENCE\\&quot;,\\n    \\&quot;{hint:Your merchant account}merchantAccount{\\\/hint}\\&quot;: \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;\\n}&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"additionalData\\\": {\\n      \\\"{hint: Use this when creating a payout method in step 2}recurring.recurringDetailReference{\\\/hint}\\\": \\\"8315659584588245\\\",\\n      \\\"recurring.shopperReference\\\": \\\"YOUR_UNIQUE_SUBMERCHANT_ID_IOfW3k9G2PvXFu2j\\\",\\n      \\\"merchantReference\\\": \\\"YOUR_TRANSACTION_REFERENCE\\\",\\n      \\\"{hint: If value is I, this means that the card is eligible for instant payouts}fundsAvailability{\\\/hint}\\\": \\\"I\\\",\\n      \\\"{hint: Indicates if this card is eligible for payouts}payoutEligible{\\\/hint}\\\": \\\"Y\\\"\\n    },\\n    \\\"pspReference\\\": \\\"881566214605773J\\\",\\n    \\\"resultCode\\\": \\\"Authorised\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div class=\"sc-notice info\"><div>\n<p>If you are using the <a href=\"\/pt\/online-payments\/classic-integrations\/classic-api-integration#authorise-request\">classic integration<\/a>, include  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Payment\/latest\/post\/authorise#request-recurring-contract\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">recurring.contract<\/a> <span translate=\"no\"><strong>PAYOUT<\/strong><\/span> in your request.<\/p>\n<\/div><\/div>\n<\/li>\n<li>\n<p>Check the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#responses-200-additionalData-ResponseAdditionalDataCommon-payoutEligible\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">payoutEligible<\/a> parameter in the response. The value should be either:<\/p>\n<ul>\n<li><span translate=\"no\"><strong>Y<\/strong><\/span>: Eligible for payout. For Mastercard, this means that the card is eligible for both domestic and cross-border payouts.<\/li>\n<li><span translate=\"no\"><strong>D<\/strong><\/span>: Applies only to Mastercard. Card is eligible only for domestic payouts.<\/li>\n<\/ul>\n<p>If you receive an <span translate=\"no\"><strong>N<\/strong><\/span> or <span translate=\"no\"><strong>U<\/strong><\/span>, the card cannot be used for payouts.<\/p>\n<\/li>\n<li>\n<p>If the card is eligible for payouts, get the <code>recurring.recurringDetailReference<\/code> from the response. This is your account holder's tokenized card details. You will need this value when adding the new payout method and for submitting future payout requests.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"add-card-payout\">Step 2: Add card as a payout method<\/h2>\n<ol>\n<li>\n<p>Submit a POST <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Account\/updateAccountHolder\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/updateAccountHolder<\/a> request with the following parameters:<\/p>\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-shopperReference\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperReference<\/a>&#58; Your unique account holder reference. The minimum length is three characters.<\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#responses-200-additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">recurringDetailReference<\/a>&#58; This is the <code>recurring.recurringDetailReference<\/code> returned in the response in <a href=\"#check-and-store\">Step 1<\/a>.<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Update account holder request'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"accountHolderCode\\\" : \\\"4a55294d-7841-484d\\\",\\n    \\\"accountHolderDetails\\\" : {\\n    \\\"payoutMethods\\\" : [\\n       {\\n          \\\"merchantAccount\\\" : \\\"YOUR_MERCHANT_ACCOUNT\\\",\\n          \\\"recurringDetailReference\\\" : \\\"8315659584588245\\\",\\n          \\\"shopperReference\\\" : \\\"YOUR_UNIQUE_SELLER_ID_IOfW3k9G2PvXFu2j\\\"\\n       }\\n       ],\\n      ...\\n    }\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"invalidFields\\\" : [],\\n    \\\"pspReference\\\" : \\\"9915402175055353\\\",\\n    \\\"accountHolderCode\\\" : \\\"4a55294d-7841-484d\\\",\\n    \\\"accountHolderDetails\\\" : {\\n      ...\\n       \\\"payoutMethods\\\" : [\\n         {\\n            \\\"merchantAccount\\\" : \\\"YOUR_MERCHANT_ACCOUNT\\\",\\n            \\\"payoutMethodCode\\\": \\\"4a55294d-7841-484d-be06-2e6e9cac824f\\\",\\n            \\\"recurringDetailReference\\\" : \\\"9915402174902084\\\",\\n            \\\"shopperReference\\\" : \\\"YOUR_UNIQUE_SELLER_ID_IOfW3k9G2PvXFu2j\\\"\\n         }\\n       ],\\n       ...\\n    }\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<p>You receive a response that might contain any of the following status codes:<\/p>\n<ul>\n<li><span translate=\"no\"><strong>HTTP 200<\/strong><\/span>: You can use the information returned in API response, such as the <code>payoutMethodCode<\/code>, but wait for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Notification\/latest\/post\/ACCOUNT_HOLDER_UPDATED\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">ACCOUNT_HOLDER_UPDATED<\/a> notification before performing any business logic. The notification confirms when the new payout method has been added in our central database.<\/li>\n<li><span translate=\"no\"><strong>HTTP 202<\/strong><\/span>: The request has been acknowledged and added to the queue. Use the response to check and confirm the changes you made. Wait for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Notification\/latest\/post\/ACCOUNT_HOLDER_UPDATED\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">ACCOUNT_HOLDER_UPDATED<\/a> notification to confirm if the new payout method has been successfully added. Get the corresponding <code>payoutMethodCode<\/code> from the notification.<\/li>\n<\/ul>\n<h2 id=\"submit-card-payout\">Step 3: Submit a card payout<\/h2>\n<ol>\n<li>\n<p>Submit a POST  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/payoutAccountHolder\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payoutAccountHolder<\/a> using the <code>payoutMethodCode<\/code> returned in the response or notification in <a href=\"#add-card-payout\">Step 2<\/a>.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Submit a payout to the card'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"accountCode\\\" : \\\"9915402177165382\\\",\\n    \\\"accountHolderCode\\\" : \\\"4a55294d-7841-484d\\\",\\n    \\\"amount\\\" : {\\n      \\\"currency\\\" : \\\"USD\\\",\\n      \\\"value\\\" : 1000\\n    },\\n    \\\"description\\\" : \\\"YOUR_DESCRIPTION\\\",\\n    \\\"merchantReference\\\" : \\\"YOUR_PAYOUT_REFERENCE\\\",\\n    \\\"payoutMethodCode\\\" : \\\"4a55294d-7841-484d-be06-2e6e9cac824f\\\"\\n }\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n     \\\"invalidFields\\\" : [],\\n     \\\"merchantReference\\\": \\\"YOUR_PAYOUT_REFERENCE\\\",\\n     \\\"pspReference\\\" : \\\"9915402175055353\\\",\\n     \\\"resultCode\\\": \\\"Received\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>Wait for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Notification\/latest\/post\/ACCOUNT_HOLDER_PAYOUT\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">ACCOUNT_HOLDER_PAYOUT<\/a> notification to confirm the status of the payout.<br \/>\nFor more information, see <a href=\"\/pt\/classic-platforms\/payouts\/payout-notifications\">Payout notifications<\/a>.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/classic-platforms\/payouts\/scheduled-payout\"\n                        target=\"_self\"\n                        >\n                    Scheduled payouts\n                <\/a><\/li><li><a href=\"\/classic-platforms\/payouts\/manual-payout\"\n                        target=\"_self\"\n                        >\n                    Manual payouts\n                <\/a><\/li><li><a href=\"\/classic-platforms\/verification-process\"\n                        target=\"_self\"\n                        >\n                    Verification process\n                <\/a><\/li><li><a href=\"\/classic-platforms\/payouts\/payout-notifications\"\n                        target=\"_self\"\n                        >\n                    Payout notifications\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/payouts\/manual-payout\/payout-to-cards","articleFields":{"description":"Learn how to save your account holder's card details and make a payout.","search_category":"Classic Platforms","last_edit_on":"18-02-2021 15:12","parameters":{"directoryPath":"\/classic-platforms"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/payouts\/manual-payout\/payout-to-cards","title":"Payouts to cards","content":"\nThis page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our new integration guide instead.\n\nAside from paying out to bank accounts, you also have the option to send payouts to eligible Mastercard and Visa debit cards. This feature is available in Fund API version 5 and later.\nWhen paying out to cards, the funds arrive to the cardholder within 30 minutes and there is no dependency on bank cutoffs.\nRequirements\nContact our Support Team to enable card payouts for your platform.\nStep 1: Check if the card is eligible for payouts and save the card details\n\n\nSubmit a POST  \/payments request with your account holder's card details and the following parameters:\n\n merchantAccount&#58; Your merchant account.\n shopperReference&#58; Your unique account holder reference (minimum length three characters).\n enablePayOut&#58; Indicates if the card details should be stored for payouts. Set this to true.\n paymentMethod&#58; Object containing your account holder's card details.\n\n\nYou can only pass raw card data if you are\u00a0fully PCI compliant. Otherwise, use our Card Component to securely collect and encrypt your account holder's card details.\n\n\n\n\n\n\n\n\nIf you are using the classic integration, include  recurring.contract PAYOUT in your request.\n\n\n\nCheck the  payoutEligible parameter in the response. The value should be either:\n\nY: Eligible for payout. For Mastercard, this means that the card is eligible for both domestic and cross-border payouts.\nD: Applies only to Mastercard. Card is eligible only for domestic payouts.\n\nIf you receive an N or U, the card cannot be used for payouts.\n\n\nIf the card is eligible for payouts, get the recurring.recurringDetailReference from the response. This is your account holder's tokenized card details. You will need this value when adding the new payout method and for submitting future payout requests.\n\n\nStep 2: Add card as a payout method\n\n\nSubmit a POST \/updateAccountHolder request with the following parameters:\n\n shopperReference&#58; Your unique account holder reference. The minimum length is three characters.\n recurringDetailReference&#58; This is the recurring.recurringDetailReference returned in the response in Step 1.\n\n\n\n\n\n\n\n\n\nYou receive a response that might contain any of the following status codes:\n\nHTTP 200: You can use the information returned in API response, such as the payoutMethodCode, but wait for the  ACCOUNT_HOLDER_UPDATED notification before performing any business logic. The notification confirms when the new payout method has been added in our central database.\nHTTP 202: The request has been acknowledged and added to the queue. Use the response to check and confirm the changes you made. Wait for the  ACCOUNT_HOLDER_UPDATED notification to confirm if the new payout method has been successfully added. Get the corresponding payoutMethodCode from the notification.\n\nStep 3: Submit a card payout\n\n\nSubmit a POST  \/payoutAccountHolder using the payoutMethodCode returned in the response or notification in Step 2.\n\n\n\n\n\n\n\n\nWait for the  ACCOUNT_HOLDER_PAYOUT notification to confirm the status of the payout.\nFor more information, see Payout notifications.\n\n\nSee also\n\n\n                    Scheduled payouts\n                \n                    Manual payouts\n                \n                    Verification process\n                \n                    Payout notifications\n                \n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Classic integration","lvl2":"Payouts","lvl3":"Manual payouts","lvl4":"Payouts to cards"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/classic-platforms","lvl2":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/payouts","lvl3":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/payouts\/manual-payout","lvl4":"\/pt\/classic-platforms\/payouts\/manual-payout\/payout-to-cards"},"levels":5,"category":"Classic Platforms","category_color":"green","tags":["Payouts","cards"]}}
