Refund a funds transfer

post/refundFundsTransfer

Refunds funds transferred from one account to another. Both accounts must be in the same platform, but can have different account holders.

Endpoint destination URL

https://cal-test.adyen.com/cal/services/Fund/v6/refundFundsTransfer

Request Parameters

Required

Optional

The amount to be transferred.

Show children

A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.

A PSP reference of the original fund transfer.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
Show more Show less
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
Show children Hide children
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
Show children Hide children
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
merchantReferencestring
The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.
messagestring
The message of the response.
originalReferencestring
A PSP reference of the original fund transfer.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
202 - Accepted
The request has been accepted for processing, but the processing has not been completed.
Show more Show less
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
Show children Hide children
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
Show children Hide children
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
merchantReferencestring
The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.
messagestring
The message of the response.
originalReferencestring
A PSP reference of the original fund transfer.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Refund a funds transfer

Request Parameters

Response parameters

HTTP Responses

200 - OK

202 - Accepted

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error