ADadyen
Reviewing

Cancel a payout

Changed on

This endpoint is deprecated and no longer supports new integrations. Do one of the following:

  • If you are building a new integration, use the Transfers API instead.
  • If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.

With the Transfers API, you can:

  • Handle multiple payout use cases with a single API.
  • Use new payout functionalities, such as instant payouts to bank accounts.
  • Receive webhooks with more details and defined transfer states.

For more information about the payout features of the Transfers API, see our Payouts documentation.

Cancels a previously submitted payout.

To confirm and send a payout, use the /confirmThirdParty endpoint.

post/declineThirdParty

Request

  • Base URL
    https://pal-test.adyen.com/pal/servlet/Payout/v67
  • URL
    https://pal-test.adyen.com/pal/servlet/Payout/v67/declineThirdParty
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

additionalDataobject

This field contains additional data, which may be required for a particular payout request.

merchantAccountstring required

The merchant account identifier, with which you want to process the transaction.

originalReferencestring required

The PSP reference received in the /submitThirdParty response.

Response

OK - the request has succeeded.

additionalDataobject

This field contains additional data, which may be returned in a particular response.

pspReferencestring required

Adyen's 16-character string reference associated with the transaction. This value is globally unique; quote it when communicating with us about this response.

responsestring required

The response:

  • In case of success, it is either payout-confirm-received or payout-decline-received.
  • In case of an error, an informational message is returned.

Changes

  • v67e98fc0eb0b48Revision changes
    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status