Virtual Account Status Webhook

The VIRTUAL_ACCOUNT_STATUS webhook notifies the client that the status of a virtual account changed.

Parameters

Webhook Header Parameters

Webhook Root Parameters

- created_at
- Time that the webhook was created, in Unix time.
  Note
  Inside the data object, some webhooks have another created_at field that refers to a different event.
- data
- Contains the actual data of the webhook.
  For details, see below.
- extended_timestamp
- Time in milliseconds that the webhook was created, in Unix time.
- id
- ID of the webhook. String starting with wh_.
- status
- Status of the webhook. One of the following:
  - NEW
  - CLO - Closed.
  - ERR - Error.
  - RET - Re-sent.
  Note
  Inside the data object, some webhooks have another status field that refers to a different event.
- trigger_operation_id
- ID of the operation that triggered the webhook. UUID.
- type
- Name of the webhook type.
  Note
  The name in the Client Portal is different.

Webhook Data Parameters

- bank_account
- Details about the virtual account, including the following fields:
  aba
  9-digit ABA routing number of the virtual account.
  aba_routing_number
  9-digit ABA routing number of the virtual account.
  account_holder
  Name of the virtual account holder.
  account_no
  The actual account number that was assigned to the virtual account when it was created.
  account_number
  The actual account number that was assigned to the virtual account when it was created.
  address
  Street address of the branch of the bank that issued the virtual account number.
  beneficiary_name
  Name of the owner of the Rapyd Wallet that the virtual account number was issued to.
  bic
  Bank Identifier Code (BIC) of the virtual account.
  branch_code
  Number of the bank branch.
  city
  City of the branch of the bank that issued the virtual account number.
  country
  Two-letter ISO 3166-1 ALPHA-2 code of the country of the virtual account.
  country_iso
  Two-letter ISO 3166-1 ALPHA-2 code of the country of the virtual account.
  iban
  International bank account number (IBAN) of the virtual account.
  payment_type
  Method of transferring funds to and from the virtual account.
  sort_code
  A six-digit bank identification number. Relevant to certain country-currency combinations.
- currency
- Currency for the virtual account. Three-letter ISO 4217 code.
- description
- Description of the transaction, as defined by the client.
- ewallet
- ID of the Rapyd Wallet that the virtual account is attached to. String starting with ewallet_.
- funding_instructions
- Reserved.
- id
- ID of the virtual account number object. String starting with issuing_.
- merchant_reference_id
- Identifier defined by the client for reference purposes. Limit: 45 characters.
- metadata
- A JSON object defined by the client. See Metadata.
- requested_currency
- Currency received by the virtual account after conversion. One of the following:
  AUD - Australian Dollar
  EUR - Euro
  GBP - Pound Sterling
  HKD - Hong Kong Dollar
  SGD - Singapore Dollar
  USD - US Dollar
- status
- Indicates the status of the virtual account.
  ACT - Active.
  CLO - Closed.
  ERR - Error.
  PEN - Pending.
  REJ - Rejected.
- transactions
- List that describes individual transactions in the wallet that were done via the virtual account number. Each object has the following fields:
  id
  ID of the transaction. String starting with isutran_.
  amount
  The amount credited to the virtual account, in units of the currency defined in currency.
  created_at
  Timestamp for the transaction, in Unix time.
  currency
  The currency credited to the virtual account. Three-letter ISO 4217 code.
  Transactions without FX - The currency sent by the sender.
  FX transactions - Determined by requested_currency in the virtual account.
  fx_rate
  Currency conversion rate for the transaction.
  original_amount
  The amount sent by the sender to the virtual account, in units of the currency defined in original_currency.
  original_currency
  The currency sent by the sender to the virtual account. Three-letter ISO 4217 code.

VIRTUAL_ACCOUNT_STATUS Webhook

{
    "id": "wh_6482bedfb0f01915d5104b0057dda314",
    "data": {
        "id": "issuing_293e65543872d2a87057b48dd657dd06",
        "status": "ACT",
        "ewallet": "ewallet_eb221f9155cf0895c8a4e8b1ad6b844d",
        "currency": "EUR",
        "metadata": {
            "merchant_defined": true
        },
        "description": "Issue virtual account to wallet",
        "bank_account": {
            "beneficiary_name": "John Doe",
            "address": "Northwest House, 119 Marylebone Road NW1 5PU",
            "country_iso": "DE",
            "iban": "DE07202208000092780641",
            "bic": "SXPYDEHH"
        },
        "transactions": [],
        "funding_instructions": null,
        "merchant_reference_id": "5rtfgk897ter0df0m"
    },
    "type": "VIRTUAL_ACCOUNT_STATUS",
    "status": "NEW",
    "created_at": 1723707139,
    "extended_timestamp": 1723707139393,
    "trigger_operation_id": "376f6f78-fe99-42f7-b19d-84def749fd63"
}

In this section:

Documentation

Virtual Account Status Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results