Adyen Decline Third Party API

openapi: 3.2.0
info:
  version: '68'
  x-publicVersion: true
  title: Adyen Payout Decline Third Party API
  description: A set of API endpoints that allow you to store payout details, confirm, or decline a payout.
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://pal-test.adyen.com/pal/servlet/Payout/v68
tags:
- name: declineThirdParty
paths:
  /declineThirdParty:
    post:
      tags:
      - declineThirdParty
      summary: Adyen Cancel a Payout
      description: 'Cancels a previously submitted payout.


        To confirm and send a payout, use the `/confirmThirdParty` endpoint.'
      x-addedInVersion: '10'
      operationId: post-declineThirdParty
      x-sortIndex: 2
      x-methodName: declineThirdParty
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              declineThirdParty:
                $ref: '#/components/examples/post-declineThirdParty-declineThirdParty'
            schema:
              $ref: '#/components/schemas/ModifyRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                declineThirdParty:
                  $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200'
              schema:
                $ref: '#/components/schemas/ModifyResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-declineThirdParty401Example:
                  summary: Default post-declineThirdParty 401 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-declineThirdParty403Example:
                  summary: Default post-declineThirdParty 403 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-declineThirdParty422Example:
                  summary: Default post-declineThirdParty 422 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-declineThirdParty500Example:
                  summary: Default post-declineThirdParty 500 response
                  x-microcks-default: true
                  value:
                    additionalData: {}
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ServiceError:
      properties:
        additionalData:
          x-addedInVersion: '46'
          additionalProperties:
            type: string
          description: Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.
          type: object
        errorCode:
          description: The error code mapped to the error message.
          type: string
        errorType:
          description: The category of the error.
          type: string
        message:
          description: A short explanation of the issue.
          type: string
        pspReference:
          description: The PSP reference of the payment.
          type: string
        status:
          description: The HTTP response status.
          format: int32
          type: integer
      type: object
    ModifyRequest:
      properties:
        additionalData:
          additionalProperties:
            type: string
          description: This field contains additional data, which may be required for a particular payout request.
          type: object
        merchantAccount:
          description: The merchant account identifier, with which you want to process the transaction.
          type: string
        originalReference:
          description: The PSP reference received in the `/submitThirdParty` response.
          type: string
      required:
      - merchantAccount
      - originalReference
      type: object
    ModifyResponse:
      properties:
        additionalData:
          additionalProperties:
            type: string
          description: This field contains additional data, which may be returned in a particular response.
          type: object
        pspReference:
          description: Adyen's 16-character string reference associated with the transaction. This value is globally unique; quote it when communicating with us about this response.
          type: string
        response:
          description: '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.'
          type: string
      required:
      - pspReference
      - response
      type: object
  examples:
    post-declineThirdParty-declineThirdParty-200:
      summary: Example response for request 'declineThirdParty'
      value:
        pspReference: 991617894325360J
        response: '[payout-decline-received]'
    generic-400:
      summary: Response code 400. Bad Request.
      value:
        status: 400
        errorCode: '702'
        message: 'Unexpected input: I'
        errorType: validation
    post-declineThirdParty-declineThirdParty:
      summary: Cancel a payout
      description: Cancel a previously submitted payout
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        originalReference: '9913140798220028'
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http