Payment recalls

Occasionally, you might make a payment and then realise the payment information is wrong. For example, you might have paid the wrong person, or entered the wrong amount.

If the payment has already been processed, it is still possible in some cases to recall it and get your money back. We support recalling payment via the API and via the Client Portal.

This page describe how recalls work generally, and how to initiate a recall via the API. For further details about each endpoint, refer to the API reference.

Before you recall a payment

There are few things to be aware of before recalling a payment:

• It is often faster to contact the recipient and ask them to return the payment directly
• A fee will be charged for each recall request, which will be included in the operational fee line in your invoice
• The returned amount might be less than the original amount. This is because the beneficiary bank might take a fee to process the recall
• To make a recall via the Client Portal, ensure that the user initiating the recall has the 'Initiate recalls' permission (see the guide on permission for more information

How recalls work

To recall a payment, your payment must meet certain conditions:

• The payment must be less than 6 months old
• The payment status must be processed (if your payment hasn't yet been processed, you should be able to cancel it instead)
• The payment must not be through the Faster Payments or SEPA Instant schemes (the GBP and EUR instant payment schemes). If you attempt to initiate a recall on payments through these schemes, you will still be allowed to initiate a recall, but the recall status will go directly from Received to Unsuccessful
• You cannot request a recall of a payment, for which there is an active recall request, or if the payment has already been successfully recalled
• You must provide a valid reason for recalling the payment. We allow recalls for the following reasons:
  • Invalid creditor account number (code: AC03)
  • Wrong amount (code: AM09)
  • Requested by customer (code: CUST)

You can follow the progress of the recall request via the Client Portal or by using one of the GET recalls endpoints. The progress of a recall request, after you have made a valid request, is as follows:

We will make up to three attempts to recall the payment. This includes the initial recall and then two additional chasers (five working days apart), if we have not received a response. If the third attempt is unsuccessful, we advise you to contact your client and/or the counterparty's bank directly.

📘

Cancelling a recall

It is not currently possible to cancel a recall via the UI or the API. To cancel a recall, contact Client Services.

Making a recall request

To initiate a recall, a POST request should be sent to the api/v1/recalls endpoint, described in detail here Initiate a recall for a payment.

Content specifications body

Request

POST /api/v1/recalls

{  
  "paymentId": "3f811c2c-b36a-44ec-9476-33a6584174c5",  
  "recallReasonCode": "AC03"  
}

Response

{  
  "id": "6846031b-c870-47a6-a4b3-ff151b21164d",  
  "paymentId": "d58e4f68-32fc-4771-bf72-96d727be14c2",  
  "incomingPaymentId": null,  
  "status": "Processing",  
  "statusReason": "Recall request sent",  
  "statusCode": null,  
  "createdAt": "2023-11-06T09:08:57.9077833+00:00",  
  "modifiedAt": "2023-11-06T09:08:57.9077836+00:00",  
  "recallReason": {  
    "code": "AC03",  
    "description": "Invalid Creditor Account Number"  
  }  
}

Get details of a recall request

To retrieve the details of a single recall request up to 6 months old, use the endpoint api/v1/recalls/{recall-id}, where {recall-id} refers to the Id of the recall, received in the response to your recall request. Here is the link to the technical reference of the endpoint: Get a specific recall by Id.

Content specifications header

Request

GET/api/v1/recalls/6198eb60-d1dd-4aad-9bbd-b01a49214e62

Response

{  
  "id": "8c91e01c-5723-40a5-8ba8-ade9e6897fad",  
  "paymentId": "df5ccf4e-243d-4959-84ad-1f3e16151af8",  
  "incomingPaymentId": null,  
  "status": "Processing",  
  "statusReason": "Recall request sent",  
  "statusCode": null,  
  "createdAt": "2023-11-06T09:08:57.9329992+00:00",  
  "modifiedAt": "2023-11-06T09:08:57.9329994+00:00",  
  "recallReason": {  
    "code": "AC03",  
    "description": "Invalid Creditor Account Number"  
  }  
}

Get details of all recalls

To retrieve the details of all recalls up to 6 months old, use the endpoint api/v1/recalls endpoint. Here is the link to the technical reference of the endpoint: Get a collection of recalls.

Content specifications header

Request

GET/api/v1/recalls?PageNumber=1&PageSize=2

Response

{  
  "result": [  
    {  
      "id": "b87f3b4b-7865-495d-8672-1a8f813a24b3",  
      "paymentId": "54aa6750-1ca8-4924-b707-2f5287afa35d",  
      "incomingPaymentId": null,  
      "status": "Processing",  
      "statusReason": "Recall request sent",  
      "statusCode": null,  
      "createdAt": "2023-11-06T12:31:18.2488209+00:00",  
      "modifiedAt": "2023-11-06T12:31:18.248821+00:00",  
      "recallReason": {  
        "code": "AC03",  
        "description": "Invalid Creditor Account Number"  
      }  
    },  
    {  
      "id": "c62511ff-2d18-4566-a6b5-e62ad4002739",  
      "paymentId": "bf8c64de-3774-4f6c-aefb-1e1ba0c16836",  
      "incomingPaymentId": null,  
      "status": "Unsuccessful",  
      "statusReason": "The request was rejected by the counterparty (Closed Account)",  
      "statusCode": "AC04",  
      "createdAt": "2023-11-06T12:31:18.248823+00:00",  
      "modifiedAt": "2023-11-06T12:31:18.2488231+00:00",  
      "recallReason": {  
        "code": "AM09",  
        "description": "Wrong Amount"  
      },   
],  
  "pageInfo": {  
    "currentPage": 1,  
    "pageSize": 50,  
    "rowCount": 2  
  }  
}

Status of a recall request

To only get the status of a specific recall request up to 6 months old, use the endpoint /api/v1/recalls/{recall-id}/status, where {recall-id} refers to the ID of the recall, received in the response to your recall request. Here is the link to the technical reference of the endpoint: Get status of recall.

Content specification header

Request

GET/api/v1/recalls/6198eb60-d1dd-4aad-9bbd-b01a49214e62/status

Response

{  
  "status": "Successful"  
}