Outgoing wire transfers

Update the beneficiary name of an outgoing wire transfer

Updates the beneficiary name on the outgoing wire transfer identified by id and re-runs the payee check with the new name.

Use this when a transfer is in PENDING_CONFIRMATION and the Confirmation of Payee (CoP) or Verification of Payee (VoP) result shows a close but inexact match. The previous result is discarded and the check runs again. Once the result is acceptable, confirm the transfer.

patch/outgoing_wire_transfers/{id}

Request

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

Path parameters

idstring required
Example:123456789

The unique identifier of the outgoing wire transfer.

Request body

namestring

The new beneficiary name. Mutually exclusive with acceptVerifiedName. For FasterPayments/BACS: max 140 chars matching pattern ^[a-zA-Z0-9/-?:().,'+\s#=!"%&<>;{@\r\n]$. For IBAN: max 150 chars.

acceptVerifiedNameboolean

Set to true to accept the account name returned with a CLOSE_MATCH or EXACT_MATCH VoP/CoP result. Mutually exclusive with name.

Example request

{
  "name": "Alex Smith",
  "acceptVerifiedName": true
}

Response

Success

idstring required

The unique identifier of an Outgoing Wire Transfer transaction.

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

The purpose of the payment.

descriptionstring

Transaction description.

type'SEPA' | 'FASTER_PAYMENTS' | 'SWIFT' | 'RIX'

The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.

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

The state of the Outgoing wire transfer transaction, as follows:

  • INVALID: The wire transfer has failed initial validation checks.
  • PENDING_CHALLENGE: The wire transfer requires the completion of a transaction confirmation challenge before it can be submitted.
  • SUBMITTED: The wire transfer is being processed, including transaction monitoring, before it is sent to the sending financial institution.
  • REJECTED: The wire transfer that was submitted was rejected.
  • APPROVED: The wire transfer that was submitted has been approved and is being processed by the sending financial institution.
  • FAILED: There was an issue with the wire transfer, and the transaction has failed.
  • COMPLETED: The requested funds have been sent from the source instrument.
  • RETURNED: The wire transfer has been returned to the sender.
  • SCHEDULED: The wire transfer will be executed at the scheduled time.
  • CANCELLED: The wire transfer was canceled before completion.
  • PENDING_CONFIRMATION: The wire transfer requires manual confirmation by the user before proceeding. It may be canceled if confirmation is not completed in time.
rejectedInfo'SYSTEM' | 'USER'

Additional info when the outgoing wire transfer has been rejected, as follows:

  • SYSTEM: The wire transfer was rejected by the system.
  • USER: The wire transfer was rejected by the user.
challengeExemptionReason'LOW_VALUE' | 'TRUSTED_BENEFICIARY'

The Reason the transaction was exempted from SCA verification

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.

executionTimestampstring

The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.

cancellationReasonstring

The reason the scheduled transaction was canceled.

Example response

{
  "id": "123456789",
  "profileId": "10001",
  "tag": "customer-123",
  "sourceInstrument": {
    "id": "123456789"
  },
  "transferAmount": {
    "currency": "GBP",
    "amount": 1250
  },
  "fee": {
    "currency": "GBP",
    "amount": 1250
  },
  "purpose": "Invoice payment",
  "description": "Invoice 1042",
  "destination": {
    "name": "Alex Smith",
    "address": "1 High Street, London W1A 1AA",
    "bankName": "National Westminster Bank PLC",
    "bankAddress": "250 Bishopsgate, London EC2M 4AA",
    "bankCountry": "GB",
    "bankAccountDetails": {
      "iban": "GB29NWBK60161331926819",
      "bankIdentifierCode": "NWBKGB2L"
    },
    "nationality": "GB",
    "dateOfBirth": "1990-01-01"
  },
  "creationTimestamp": 1786118400000,
  "scheduledTimestamp": "1786118400000",
  "executionTimestamp": "1786118401250",
  "cancellationReason": "Payment no longer required",
  "validationOutcomes": [
    {
      "categoryResult": {
        "accountName": "Alex J Smith"
      }
    }
  ]
}

Changes

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