Recipient

Webhook events will be triggered whenever a transfer recipient is created or its KYC status is updated.

Event Category:

MULTI_CURRENCY_ACCOUNT

Event Type:

MULTI_CURRENCY_ACCOUNT.TRANSFER.RECIPIENT.CREATE
MULTI_CURRENCY_ACCOUNT.TRANSFER.RECIPIENT.UPDATE

Example webhook event

The data object is expected to have the same structure as the response from the Retrieve a recipient endpoint.

{
  eventId: 'evt_1957160c5745959da2',
  eventCategory: 'MULTI_CURRENCY_ACCOUNT',
  eventType: 'MULTI_CURRENCY_ACCOUNT.TRANSFER.RECIPIENT.UPDATE',
  eventAction: 'UPDATE',
  data: {
    id: '9fe80b3f-b7d4-4ea9-a3c3-745808e332e6',
    type: 'individual',
    status: 'AVAILABLE',
    userId: '42c784f4-eb84-4e87-b0de-8c2183aed67c',
    createdAt: '2025-03-07T16:11:05.02801+00:00',
    bank: {
      iban: null,
      address: {
        city: "New York",
        country: "USA",
        postalCode: "10003",
        addressLine1: "Example St 1.",
        stateProvinceRegion: "NY"
      },
      bankCode: null,
      bankName: 'Bank of America',
      currency: 'USD',
      ifscCode: null,
      sortCode: null,
      swiftCode: 'BOFAUS6NXXX',
      branchCode: null,
      branchName: null,
      accountName: 'Sam Yoon',
      accountType: 'CHECKING',
      accountHolder: {
        address: null,
        phone: null,
        govIdType: null,
        govIdNumber: null
      },
      accountNumber: '1091222221',
      routingNumber: '026009593',
      accountPurpose: null
    },
    recipient: {
      name: 'Sam Yoon',
      type: '10',
      email: '[email protected]',
      phone: '+18571223434',
      address: {
        addressLine1: "Example St 1.",
        city: "New York",
        stateProvinceRegion: "NY",
        postalCode: "10003",
        country: "USA"
      },
      occupation: null,
      nationality: null,
      certificationType: null,
      certificationNumber: null,
      certificationBackUrl: null,
      certificationFrontUrl: null,
      certificationIssuanceAuth: null,
      certificationIssuanceDate: '2024-12-01T00:00:00.000Z',
      certificationExpirationDate: null
    },
    updatedAt: '2025-03-07T16:12:01.191+00:00',
    failedReason: null,
    rejectionReasons: null
  },
  createdAt: '2025-03-07T16:12:02.550Z',
  timestamp: '2025-03-07T16:12:20.210Z',
  version: 'v2'
}