Correspondent bank transfers

List correspondent bank transfers

Returns a paginated list of correspondent bank transfers for the logged-in identity. Filter results by profile, source instrument, creation date, execution date, state, tag, or originator details.

Read the transaction activity overview for how correspondent bank transfers appear in the common transaction model.

get/correspondent_bank_transfers

Request

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

Query parameters

offsetinteger

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger
Example:25

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

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.

Example:10001

Filter by the managed account/card profile. Leave out to fetch all managed accounts/card.

sourceInstrument.idstring
Example:123456789

Filter by the source instrument id. Must be specified when source.type is provided.

sourceInstrument.type'managed_accounts'

Filter by the source instrument type. Must be specified when source.id is provided.

createdFrominteger

Filter for correspondent bank transfer transactions created after createdFrom timestamp, expressed in Epoch timestamp using millisecond precision.

createdTointeger

Filter for correspondent bank transfer transactions created before createdTo timestamp, expressed in Epoch timestamp using millisecond precision.

executedFrominteger

Filter for correspondent bank transfer transactions executed after executedFrom timestamp, expressed in Epoch timestamp using millisecond precision.

executedTointeger

Filter for correspondent bank transfer transactions executed before executedTo timestamp, expressed in Epoch timestamp using millisecond precision.

tagstring

Filter by the correspondent bank transfer tag. The exact tag must be provided, as wildcards are not supported.

stateCorrespondentBankingOwtState[]

Filter by the state of the correspondent bank transfer transaction.

originator.namestring

Filter by the originator name. Partial matches are supported.

originator.type'INDIVIDUAL' | 'BUSINESS'

Filter by the originator type.

originator.tagstring

Filter by the originator tag.

Response

Success

countinteger

Total number of records (excluding the paging limit)

responseCountinteger

Total number of records returned in this response (always capped at 100).

Example response

{
  "transfer": [
    {
      "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.