v5
latestOpenAPI 3.1.02026-07-262421791.5 MBbank-account-details
Create payment return
Creates a return for a payment received to bank account details.
When you create a return, you must provide the ID of the payment you wish to return as well as the ID of the profile that received the payment. In addition, you can provide a reason for the return in the request body. When returning SWIFT payments, reason is a required field.
post/v1/profiles/{profileId}/account-details/payments/{paymentId}/returns
Path parameters
profileIdinteger required
Example:12345678
The ID of the profile that received the payment.
paymentIdinteger required
Example:987654321
The ID of the payment to return.
Headers
X-External-Correlation-Idstring uuid
Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.
Request body
Example request
{
"reason": "CLOSED_ACCOUNT"
}Response
Payment return created.
Example response
{
"id": "4cc39f2b-3513-453d-8792-9ccc22e513c3"
}