integrations.sh
← all integrations

adyen.com – PayoutService

OpenAPI apis-guru payment

A set of API endpoints that allow you to store payout details, confirm, or decline a payout.

For more information, refer to .

Authentication

To use the Payout API, you need to have : one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our .

Both of these API credentials must be authenticated with .The following example shows how to authenticate your request when submitting a payout:

curl-U "storePayout@Company.YOUR_COMPANY_ACCOUNT":"YOUR_BASIC_AUTHENTICATION_PASSWORD" \-H "Content-Type: application/json" \...

Versioning

Payments API supports using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://pal-test.adyen.com/pal/servlet/Payout/v30/payout

Going live

To authenticate to the live endpoints, you need from your live Customer Area.

The live endpoint URLs contain a prefix which is unique to your company account:


https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v30/payout

Get your {PREFIX} from your live Customer Area under Developers > API URLs > Prefix.

Homepage
https://api.apis.guru/v2/specs/adyen.com:PayoutService/30.json
Provider
adyen.com:PayoutService / PayoutService
OpenAPI version
3.1.0
Spec (JSON)
https://api.apis.guru/v2/specs/adyen.com/PayoutService/30/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/adyen.com/PayoutService/30/openapi.yaml

Tools (8)

Extracted live via the executor SDK.

  • initialization.postStoreDetail

    Stores payment details under the PAYOUT recurring contract. These payment details can be used later to submit a payout via the /submitThirdParty call.

  • initialization.postStoreDetailAndSubmitThirdParty

    Submits a payout and stores its details for subsequent payouts.

    The submitted payout must be confirmed or declined either by a reviewer or via /confirmThirdParty or /declineThirdParty calls.

  • initialization.postSubmitThirdParty

    Submits a payout using the previously stored payment details. To store payment details, use the /storeDetail API call.

    The submitted payout must be confirmed or declined either by a reviewer or via /confirmThirdParty or /declineThirdParty calls.

  • instantPayouts.postPayout

    With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.

  • reviewing.postConfirmThirdParty

    Confirms a previously submitted payout.

    To cancel a payout, use the /declineThirdParty endpoint.

  • reviewing.postDeclineThirdParty

    Cancels a previously submitted payout.

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

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools