Payouts

The payout functionality is set up as a 2-step process, with the first user initiating the action, and the second user confirming it before executing it. There are two additional web service user accounts for the payout process:

  • storePayout@Company.[Company Account Code] – To store payout details on a separate call via the payout service, and to initiate a payout.
  • reviewPayout@Company.[Company Account Code] – To confirm/decline a payout on a separate call via the payout service.

You can submit a payout in two ways using the API calls below:

The administrator should assign permissions to users to store and review payouts. If you don't have access to assign permissions, contact Adyen Support Team.

Submit a payout

You can submit a payout using a specific recurring details contract. You can use the latest created recurring contract for the shopper reference by using the LATEST values in the request.

Request:

{
    "amount" : {
        "currency" : "EUR",
        "value" : "1000"
    },

    "merchantAccount" : "TestMerchant",
    
    "recurring" : {
        "contract" : "PAYOUT"
    },
    
    "reference" : "PayoutPayment-0001",
    "shopperEmail" : "shopper@email.com",    
    "shopperReference" : "TheShopperReference",
    "shopperName" : {
        "firstName" : "Adyen",
        "gender" : "MALE",
        "lastName" : "Test"
    },
    "dateOfBirth" : "1990-01-01",
    "entityType" : "Company",
    "nationality" : "NL",
    "selectedRecurringDetailReference" : "LATEST"
}

Response:

{
    "pspReference" : "9913140798220028",
    "resultCode" : "[payout-submit-received]"
}

Request:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <submit xmlns="http://payout.services.adyen.com"> 
      <request> 
        <amount> 
          <currency xmlns="http://common.services.adyen.com">EUR</currency> 
          <value xmlns="http://common.services.adyen.com">1000</value> 
        </amount> 
        <merchantAccount>TestMerchant</merchantAccount> 
        <recurring> 
            <contract xmlns="http://payment.services.adyen.com">PAYOUT</contract> 
        </recurring> 
        <reference>PayoutPayment-0001</reference> 
        <shopperEmail>email@shopper.com</shopperEmail> 
        <shopperReference>TheShopperReference</shopperReference>
        <shopperName>
          <firstName xmlns="http://common.services.adyen.com">Adyen</firstName>
          <gender xmlns="http://common.services.adyen.com">MALE</gender>
          <lastName xmlns="http://common.services.adyen.com">Test</lastName>
        </shopperName>
        <dateOfBirth>1990-01-01</dateOfBirth>
        <entityType>Company</entityType>
        <nationality>NL</nationality>
        <selectedRecurringDetailReference>LATEST</selectedRecurringDetailReference> 
      </request> 
    </submit> 
  </soap:Body> 
</soap:Envelope>

Response:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:submitResponse xmlns:ns1="http://payout.services.adyen.com">
      <ns1:response> 
        <pspReference xmlns="http://payout.services.adyen.com">9913140798220028</pspReference> 
        <refusalReason xmlns="http://payout.services.adyen.com" xsi:nil="true"/>
        <resultCode xmlns="http://payout.services.adyen.com">[payout-submit-received]</resultCode> 
      </ns1:response> 
    </ns1:submitResponse> 
  </soap:Body> 
</soap:Envelope>

Request:

amount.currency=EUR&amount.value=1000&merchantAccount=TestMerchant&recurring.contract=PAYOUT&reference=TheMerchantReference&shopperEmail=shopper%40email.com&shopperReference=TheShopperReference&shopperName.firstName=Adyen&shopperName.gender=MALE&shopperName.lastName=Test&dateOfBirth=1990-01-01&entityType=Company&nationality=NL&selectedRecurringDetailReference=LATEST

Response:

pspReference=9914352319170967&resultCode=%5Bpayout-submit-received%5D

Store detail and submit a payout

You can store the payouts details and make a payout request in a single API call by calling the storeDetailAndSubmit method. 

Request:

{
    "amount" : {
        "currency" : "EUR",
        "value" : "1000"
    },
  
    "merchantAccount" : "TestMerchant",
    
    "recurring" : {
        "contract" : "PAYOUT"
    },
                  
    "bank": {
        "bankName": "AbnAmro",
        "bic": "ABNANL2A",
        "countryCode": "NL",
        "iban": "NL32ABNA0515071439",
        "ownerName": "Adyen",
        "bankCity": "Amsterdam",
        "taxId":"bankTaxId"
    },
 
    "reference" : "TheMerchantReference",
    "shopperEmail" : "shopper@email.com",    
    "shopperReference" : "TheShopperReference",
    "shopperName" : {
        "firstName" : "Adyen",
        "gender" : "MALE",
        "lastName" : "Test"
    },
    "dateOfBirth" : "1990-01-01",
    "entityType" : "Company",
    "nationality" : "NL",
                  
    "billingAddress": {
        "houseNumberOrName":"17",
        "street":"Teststreet 1",
        "city":"Amsterdam",
        "stateOrProvince":"NY",
        "country" : "US",
        "postalCode":"12345"
    }
}

Response:

{
    "pspReference" : "9913134956610005",
    "resultCode" : "[payout-submit-received]"
}

Request:

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <storeDetailAndSubmit xmlns="http://payout.services.adyen.com"> 
      <request> 
        <amount> 
          <currency xmlns="http://common.services.adyen.com">EUR</currency> 
          <value xmlns="http://common.services.adyen.com">1000</value> 
        </amount> 
        <bank>
          <bankName xmlns="http://payment.services.adyen.com">AbnAmro</bankName>
          <bic xmlns="http://payment.services.adyen.com">ABNANL2A</bic>
          <countryCode xmlns="http://payment.services.adyen.com">NL</countryCode>
          <iban xmlns="http://payment.services.adyen.com">NL32ABNA0515071439</iban>
          <ownerName xmlns="http://payment.services.adyen.com">Adyen</ownerName> 
          <bankCity xmlns="http://payment.services.adyen.com">Amsterdam</bankCity>
          <taxId xmlns="http://payment.services.adyen.com">bankTaxId</taxId> 
        </bank>
        <merchantAccount>TestMerchant</merchantAccount> 
        <recurring> 
          <contract xmlns="http://payment.services.adyen.com">PAYOUT</contract> 
        </recurring> 
        <reference>TheMerchantReference</reference>
        <shopperEmail>shopper@email.com</shopperEmail> 
        <shopperReference>TheShopperReference</shopperReference>
        <shopperName>
          <firstName xmlns="http://common.services.adyen.com">Adyen</firstName>
          <gender xmlns="http://common.services.adyen.com">MALE</gender>
          <lastName xmlns="http://common.services.adyen.com">Test</lastName>
        </shopperName>
        <dateOfBirth>1990-01-01</dateOfBirth>
        <entityType>Company</entityType>
        <nationality>NL</nationality>
        <billingAddress>
          <houseNumberOrName xmlns="http://common.services.adyen.com">17</houseNumberOrName>
          <street xmlns="http://common.services.adyen.com">Teststreet 1</street>
          <city xmlns="http://common.services.adyen.com">Amsterdam</city>
          <stateOrProvince xmlns="http://common.services.adyen.com">NY</stateOrProvince>
          <country xmlns="http://common.services.adyen.com">US</country> 
          <postalCode xmlns="http://common.services.adyen.com">12345</postalCode>
        </billingAddress>
      </request> 
    </storeDetailAndSubmit> 
  </soap:Body> 
</soap:Envelope>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns2="http://payout.services.adyen.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body>
      <ns2:storeDetailAndSubmitResponse>
         <ns2:response>
            <ns2:pspReference>8514514822637867</ns2:pspReference>
            <ns2:resultCode>[payout-submit-received]</ns2:resultCode>
         </ns2:response>
      </ns2:storeDetailAndSubmitResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request:

amount.currency=EUR&amount.value=1000&bank.iban=DE87123456781234567890&bank.bankName=Wirecard&bank.countryCode=DE&bank.ownerName=Test+Shopper&bank.bankCity=Amsterdam&bank.taxId=bankTaxId&merchantAccount=TestMerchant&recurring.contract=PAYOUT&reference=TheMerchantReference&shopperEmail=shopper%40email.com&shopperReference=TheShopperReference&shopperName.firstName=Adyen&shopperName.gender=MALE&shopperName.lastName=Test&dateOfBirth=1990-01-01&entityType=Company&nationality=NL&billingAddress.houseNumberOrName=17&billingAddress.street=Teststreet&billingAddress.city=Amsterdam&billingAddress.stateOrProvince=NY&billingAddress.country=US&billingAddress.postalCode=12345

Response:

pspReference=9914352309510016&resultCode=%5Bpayout-submit-received%5D

You can decide over a period of seven days to proceed or cancel a payout, after which the payout expires automatically. Confirming and declining the payout can be done using:

  • Confirm or decline API calls to the payout service.
  • Manually via the Adyen Customer Area (CA). If a user has the permission to view and/or modify payouts, an additional Payouts option from the menu in the Adyen Customer Area (CA) is visible.

Confirm a payout

Request:

{
    "merchantAccount" : "TestMerchant",
    "originalReference" : "9913140798220028"
}

Response:

{
    "pspReference" : "9913140798220028",
    "response" : "[payout-confirm-received]"
}

Request:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <confirm xmlns="http://payout.services.adyen.com"> 
      <request> 
        <additionalData xsi:nil="true"/>
        <merchantAccount>TestMerchant</merchantAccount> 
        <originalReference>9913140798220028</originalReference> 
      </request> 
    </confirm> 
  </soap:Body> 
</soap:Envelope>

Response:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:confirmResponse xmlns="http://payout.services.adyen.com"> 
      <ns1:response> 
        <pspReference xmlns="http://payout.services.adyen.com">9913140808680104</pspReference> 
        <response xmlns="http://payout.services.adyen.com">[payout-confirm-received]</response>
      </ns1:response> 
    </ns1:confirmResponse> 
  </soap:Body> 
</soap:Envelope>

Request:

merchantAccount=TestMerchant&originalReference=9913140798220028

Response:

pspReference=9914352327811826&response=%5Bpayout-confirm-received%5D

Decline a payout

Request:

{
    "merchantAccount" : "TestMerchant",
    "originalReference" : "9913140798220028"
}

Response:

{
    "pspReference" : "9913140798220028",
    "response" : "[payout-decline-received]"
}

Request:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <decline xmlns="http://payout.services.adyen.com"> 
      <request> 
        <additionalData xsi:nil="true"/>
        <merchantAccount>TestMerchant</merchantAccount> 
        <originalReference>9913140798220028</originalReference> 
      </request> 
    </decline> 
  </soap:Body> 
</soap:Envelope>

Response:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns1:declineResponse xmlns="http://payout.services.adyen.com"> 
      <ns1:response> 
        <pspReference xmlns="http://payout.services.adyen.com">9913140808680104</pspReference> 
        <response xmlns="http://payout.services.adyen.com">[payout-decline-received]</response>
      </ns1:response> 
    </ns1:declineResponse> 
  </soap:Body> 
</soap:Envelope>

Request:

merchantAccount=TestMerchant&originalReference=9913140798220028

Response:

pspReference=9914352333652404&response=%5Bpayout-decline-received%5D

Questions

Can't find something you are looking for? Look at our FAQ for answers or send an email to support.