Search

Are you looking for test card numbers?

Would you like to contact support?

Default icon

Get payout status

Get the actual payout state at merchant level.

If there are any pending changes for the specified payout, the /getPayoutStatus response returns the following:

  • The original status of the payout. For example, the previous status before the payout was set to pending. 
  • The new status requested for the payout. This is the status that is waiting for approval or rejection.

Request parameters

To obtain payout status information for a merchant, make a POST /getPayoutStatus 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

The response contains the following information:

Name Type Returned by default Description
actualState String
-white_check_mark-

The actual status of the payout.
Allowed values:

  • Blocked
  • Unblocked
status String
-white_check_mark-

The original status of the payout, i.e. preceding the pending status.
Allowed values:

  • NonPayable (This is always the initial status)
  • Payable
  • Blocked
pendingNewStatus String
-x-

The payout status change that has been requested, and that is waiting for approval or rejection while the payout is pending.
Allowed values:

  • Payable
  • Blocked

When a payout is pending, it is considered blocked.

jaasUserKey String
-x-
String representation of the account user name used to modify the status.
note String
-x-
When a payout is set to Blocked, you can add an explanatory note.
If it is populated, the corresponding content is returned here. 
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>
    <getPayoutStatus xmlns="http://caaccount.services.adyen.com">
      <request>
        <merchantCode>TestMerchant</merchantCode>
      </request>
    </getPayoutStatus>
  </soap:Body>
</soap:Envelope>

Response

{  
   "pspReference":"9914321075110053",
   "actualState":"Unblocked",
   "jaasUserKey":"ws@Company.TestCompany",
   "note":"Updated via API",
   "status":"Payable"
}
<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:getPayoutStatusResponse>
      <ns0:response>
        <ns0:pspReference>9914321075110053</ns0:pspReference>
        <ns0:actualState>Unblocked</ns0:actualState>
        <ns0:jaasUserKey>ws@Company.TestCompany</ns0:jaasUserKey>
        <ns0:note>Updated via API</ns0:note>
        <ns0:status>Payable</ns0:status>
      </ns0:response>
    </ns0:getPayoutStatusResponse>
  </soap:Body>
</soap:Envelope>