Incoming wire transfers

Get an incoming wire transfer

Returns the incoming wire transfer identified by id, including its originator, destination account, amount, and current state.

Read the incoming wire transfers overview for transfer requirements, states, and webhook events.

get/incoming_wire_transfers/{id}

Request

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

Path parameters

idstring required
Example:123456789

The unique identifier of the incoming wire transfer.

Response

Success

idstring required

The unique identifier of the incoming wire transfer.

profileIdstring

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.

state'PENDING' | 'COMPLETED' | 'REJECTED' required

The state of an incoming wire transfer:

  • PENDING: The transfer has been received and is being processed. Funds have not yet been credited to the destination account.
  • COMPLETED: Funds have been credited to the destination account.
  • REJECTED: The transfer was not accepted; funds were not credited.
paymentNetwork'SEPA' | 'FASTER_PAYMENTS' | 'SWIFT' | 'RIX' | 'BACS' | 'CHAPS' | 'TARGET'

The payment network over which the transfer was received.

senderNamestring

The name of the sender.

senderIbanstring

The IBAN of the sender.

senderReferencestring

The payment reference provided by the sender.

isInstantboolean

Whether this was an instant payment.

createdAtinteger required

When the IWT was received, expressed in Epoch timestamp using millisecond precision.

executedAtinteger

When the IWT was settled, expressed in Epoch timestamp using millisecond precision.

Example response

{
  "id": "123456789",
  "profileId": "10001",
  "amount": {
    "currency": "GBP",
    "amount": 1250
  },
  "fee": {
    "currency": "GBP",
    "amount": 1250
  },
  "destinationInstrument": {
    "id": "123456789",
    "type": "managed_accounts"
  },
  "senderName": "Alex Smith",
  "senderIban": "GB29NWBK60161331926819",
  "senderReference": "Invoice 1042",
  "forex": {
    "originalAmount": {
      "currency": "GBP",
      "amount": 1250
    },
    "exchangeRate": {
      "value": 1250,
      "scale": 2
    },
    "paddingAmount": {
      "currency": "GBP",
      "amount": 1250
    },
    "feeAmount": {
      "currency": "GBP",
      "amount": 1250
    }
  },
  "isInstant": true,
  "createdAt": 1786118400000,
  "executedAt": 1786118401250
}

Changes

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