Skip to main content

OWT Create and Execute

Works In Progress

This feature will be made available in Sandbox, as from Wednesday 18th September 2024 for UK-based programmes only.

Outgoing Wire Transfers (OWT) Creation and Execution Flow​

  1. To create an Outgoing Wire Transfer, use the existing endpoint POST /outgoing_wire_transfers. This endpoint supports both SEPA (Euro) and FPS (GBP) transfers.

    • You can initiate the transfer using a Linked Account ID, Beneficiary ID, or by providing bank account details for a one-time payment.

  2. After the OWT is created, Weavr will automatically perform a Confirmation of Payee (CoP) check to verify the bank account details.

Faster Payment only

The CoP check will only impact GBP OWTs sent via Faster Payments (within the UK) and will not impact the SEPA OWTs.

  1. Weavr will return the CoP result, including reason codes and additional information, and the OWT state will be updated to PENDING_CONFIRMATION.

  2. In response to the POST /outgoing_wire_transfers request, you will receive an object called validationOutcomes containing the results of the CoP check.

  3. Taking the CoP result into account, you (as the Embedder) can decide whether to allow your end user to proceed with the execution of the OWT.

  4. Display the CoP result to the end user and give them the option to:

    • Edit the payee details, or
    • Proceed with the OWT, or
    • Cancel the OWT.

  5. To confirm and proceed with the OWT, use POST /outgoing_wire_transfers/{id}/confirm. The OWT state will then change from PENDING_CONFIRMATION to PENDING_CHALLENGE.

  6. Complete SCA challenge and the OWT will be sent for execution. After that OWT state will be changed from PENDING_CHALLENGE to SUBMITTED.

  7. If the end user wants to cancel or abandon the process, use POST /outgoing_wire_transfers/{id}/cancel

tip

When creating an Outgoing Wire Transfer using a Linked Account ID, a Confirmation of Payee result is not returned, and the additional step to Confirm the OWT is not required.

OWT API Endpoints​

In the HTTP 200 response of the endpoints:

  • POST /outgoing_wire_transfers/
  • GET /outgoing_wire_transfers/
  • GET /outgoing_wire_transfers/{id}

The following fields are provided in the response payload:

  1. A state PENDING_CONFIRMATION. Outgoing wire transfers created via BeneficiaryId or bankAccountDetails → FasterPaymentBankDetails executed over Faster Payments (Payments in GBP) will be automatically set in the state PENDING_CONFIRMATION.

  2. A new array of objects validationOutcomes . The validationOutcomes array will include the following objects:

    • category: value ConfirmationOfPayeeResult.
    • categoryResult:
      • match - one of Enum: Match, Close_Match, No_Match.
      • code - one of Enum: ANNM, MBAM, BANM, PANM, BAMM, PAMM, AC01, IVCR, ACNS, OPTO, CASS, SCNS. Check CoP Reason codes for more details.
      • accountName - string.

  3. A new object destinationInstrument with a value linkedAccount.

Confirm or Cancel OWTs​

To confirm an outgoing wire transfer over Faster Payment call

POST/outgoing_wire_transfers/{id}/confirmTry it

To cancel an outgoing wire transfer call

POST/outgoing_wire_transfers/{id}/cancelTry it

OWT Webhook Event​

The outgoing wire transfer webhook includes the eventType PENDING_CONFIRMATION in its payload.