Search

Are you looking for test card numbers?

Would you like to contact support?

Default icon

Unblock a payout

Unblock a payout to the merchant's bank account.

This operation works at merchant level.

Unblocking payouts usually require a 4-eye policy through the Adyen Customer Area (CA)

The unblockPayout call allows unblocking payouts programmatically.

You can request to unblock a payout if the following criteria are satisfied:

  • The payout is in the Blocked state.
  • There are no pending changes for the specified payout.

This call does not support partial updates.

If an error occurs during an update:

  • No changes are applied.
  • Current data is kept.
  • The entire update fails.

Payout states

A payout can go through the following states:

Request parameters

To unblock payout, make a POST /unblockPayout request specifying:

Name Type Required Description
merchantCode String
-white_check_mark-
A merchant code string holds a value to identify a merchant. Format:
  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code

Response parameters

If there are no errors in the request, the call returns a pspReference.If any issues occur during the process, the call returns one or more warning or error messages.

Name Type Returned by default Description
pspReference String
-white_check_mark-
A reference to uniquely identify the request.
warnings String
-x-
List containing one or more warning messages.
Returned when the request is not correctly processed.
errors String
-x-
List containing one or more error messages.
Returned when the request fails.

Examples

Request

{  
   "merchantCode":"TestMerchant"
}
<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>
    <unblockPayout xmlns="http://caaccount.services.adyen.com">
      <request>
        <merchantCode>TestMerchant</merchantCode>
      </request>
    </unblockPayout>
  </soap:Body>
</soap:Envelope> 

Response

{  
   "pspReference":"9914526950210220"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://caaccount.services.adyen.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns0:unblockPayoutResponse>
      <ns0:response>
        <ns0:pspReference>9914321073950047</ns0:pspReference>
      </ns0:response>
    </ns0:unblockPayoutResponse>
  </soap:Body>
</soap:Envelope>