Correspondent bank transfers

Cancel a correspondent bank transfer

Cancel the correspondent bank transfer identified by the id path parameter.

post/correspondent_bank_transfers/{id}/cancel

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/correspondent_bank_transfers/{id}/cancel
  • Auth: HTTP bearer and API key in header api-key

Path parameters

idstring required
Example:123456789

The unique identifier of the correspondent bank transfer.

Request body

cancellationReasonstring

The reason the scheduled transaction was canceled.

Example request

{
  "cancellationReason": "Payment no longer required"
}

Response

Success

idstring required

The unique identifier of the Correspondent Banking OWT.

profileIdstring required

The profile Id which a specific identity, instrument, or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring

The tag field is a custom field that can be used to search and filter.

purposestring required

The purpose of the payment.

descriptionstring

These details are passed to the beneficiary as the reference. This field is mandatory for wire transfers executed over SEPA. The allowed length is dependent on the payment type:

SEPA <= 35 characters. An extended character set is accepted to cater for all European languages. If SEPA does not support a particular character, it is automatically converted to an acceptable alternative, in line with SEPA scheme guidance.

Faster Payments <= 18 characters

state'INVALID' | 'PENDING_CHALLENGE' | 'SUBMITTED' | 'REJECTED' | 'APPROVED' | 'FAILED' | 'COMPLETED' | 'RETURNED' | 'SCHEDULED' | 'CANCELLED' | 'PENDING_CONFIRMATION' required

The state of the correspondent bank transfer transaction, as follows:

  • INVALID: The transfer has failed initial validation checks.
  • PENDING_CHALLENGE: The transfer requires the completion of a transaction confirmation challenge before it can be submitted.
  • SUBMITTED: The transfer has been submitted to the sending financial institution for processing.
  • REJECTED: The transfer that was submitted was rejected.
  • APPROVED: The transfer that was submitted has been approved and is being processed by the sending financial institution.
  • FAILED: There was an issue with the transfer, and the transaction has failed.
  • COMPLETED: The requested funds have been sent from the source instrument.
  • RETURNED: The transfer has been returned to the sender.
  • SCHEDULED: The transfer will be executed at the scheduled time.
  • CANCELLED: The scheduled transfer has been canceled.
  • PENDING_CONFIRMATION: The transfer requires a manual confirmation by the user before proceeding.
creationTimestampinteger required

The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.

scheduledTimestampstring

The epoch timestamp at which the transaction is scheduled to be executed.

cancellationReasonstring

The reason the scheduled transaction was canceled.

Example response

{
  "id": "123456789",
  "profileId": "10001",
  "tag": "customer-123",
  "sourceInstrument": {
    "id": "123456789"
  },
  "amount": {
    "currency": "GBP",
    "amount": 1250
  },
  "originator": {
    "tag": "customer-123",
    "name": "Alex Smith",
    "address": "1 High Street, London W1A 1AA",
    "country": "GB",
    "bankAccountDetails": {
      "account": "GB29NWBK60161331926819",
      "financialInstitution": "NWBKGB2L"
    },
    "supplementaryInformation": {
      "documentNumber": "123456789"
    }
  },
  "beneficiary": {
    "name": "Alex Smith",
    "iban": "GB29NWBK60161331926819",
    "bankIdentifierCode": "NWBKGB2L",
    "address": "1 High Street, London W1A 1AA",
    "bankName": "National Westminster Bank PLC",
    "bankAddress": "250 Bishopsgate, London EC2M 4AA",
    "bankCountry": "GB",
    "nationality": "GB",
    "dateOfBirth": "1990-01-01"
  },
  "purpose": "Invoice payment",
  "description": "Invoice 1042",
  "externalData": [
    {
      "name": "invoiceNumber",
      "value": "INV-1042"
    }
  ],
  "creationTimestamp": 1786118400000,
  "scheduledTimestamp": "1786118400000",
  "cancellationReason": "Payment no longer required",
  "validationOutcomes": [
    {
      "categoryResult": {
        "accountName": "Alex Smith"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.