Sign in
Transfers

Return a transfer

Initiates the return of previously transferred funds without creating a new transferId.

post/transfers/{transferId}/returns

Path parameters

transferIdstring required

The unique identifier of the transfer to be returned.

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body

referencestring

Your internal reference for the return. If you don't provide this in the request, Adyen generates a unique reference. This reference is used in all communication with you about the instruction status.

We recommend using a unique value per instruction. If you need to provide multiple references for a transaction, separate them with hyphens ("-").

Response

OK - the request has succeeded.

idstring

The unique identifier of the return.

referencestring

Your internal reference for the return.

status'Authorised' | 'Declined'

The resulting status of the return.

Possible values: Authorised, Declined.

transferIdstring

The unique identifier of the original transfer.

Changes

Changed in 5 of the 51 revisions of this API.8

  • v32188d062ff1b1See the full diff
    • ○

      the / request property's minLength was decreased from 3 to 0

      request-property-min-length-decreased

  • v3b53fe3b6fff61See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

  • v369a555a91daf4See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v3ec02d539f7541See the full diff
    • ○

      the endpoint scheme security clientKey was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3073f244a02631See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog