Deposit Completed Webhook

The Deposit Completed webhook is sent when a deposit to a virtual account is completed by the action of a third party.

In the sandbox, Simulate a Bank Transfer to a Virtual Account simulates the third-party action and triggers this webhook.

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.
- 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

- amount
- The amount credited to the virtual account, in units of the currency defined in currency.
- bank_account
- Details about the bank account, including the following fields:
  account_no
  The actual account number that was assigned to the virtual account when it was created.
  address
  Street address of the bank branch.
  beneficiary_name
  Name of the Rapyd Wallet owner of the virtual account to which the money was deposited.
  bic
  BIC (Bank Identifier Code) of the virtual account.
  branch_code
  The bank's branch number.
  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.
  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
  sort_code
  A six-digit bank identification number. Relevant to certain country-currency combinations.
- 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.
- ewallet
- ID of the Rapyd Wallet that the virtual account is attached to. String starting with ewallet_.
- fx_rate
- Currency conversion rate for the transaction.
- issued_account_id
- ID of the virtual account. String starting with issuing_.
- issuing_transaction_id
- ID of the virtual account transaction. String starting with isutran_.
- 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.
- remitter_information
- Details about the remitter of a transfer to a virtual bank account, including the following fields:
  account_id
  The remitter's bank account identifier.
  bank_code
  Bank identifier code, such as SWIFT, BIC, ABA, or other local identifier.
  name
  The name of the remitter.
  remitter_reference
  Information that the remitter adds to the transaction, intended for the beneficiary. Supported by some payment methods.

ISSUING_DEPOSIT_COMPLETED Webhook

{
    "id": "",
    "token": "",
    "organization_id": "2d87743e-93c8-11e7-9273-0ef1982c1e4a",
    "type": "ISSUING_DEPOSIT_COMPLETED",
    "data": {
        "bank_account": {
            "bic": "DHBKHKHH",
            "bank": "DBS Bank (Hong Kong) Limited",
            "address": "G/F, The Center, 99 Queen''s Road Central, Central, Hong Kong",
            "country": "Hong Kong",
            "bank_code": "016",
            "branch_code": "478",
            "country_iso": "HK",
            "account_number": "7981378115932954",
            "beneficiary_name": "John Doe",
            "requested_currency": null
        },
        "ewallet": "ewallet_5c148fcf040282f80907026f6030cce9",
        "amount": 101,
        "currency": "HKD",
        "issued_account_id": "issuing_1a70c234e6ba03fc01af430d9f4151a3",
        "issuing_transaction_id": "isutran_a540bbda57fdfe15c6d78807054e80d6",
        "remitter_information": {
            "name": "DBS TEST CHATS",
            "account_id": "123456789",
            "bank_code": "",
            "remitter_reference": "ICC202209091827"
        },
        "original_amount": 101,
        "original_currency": "HKD",
        "fx_rate": 1
    },
    "trigger_operation_id": "ceb8b0a0-afda-4ed9-928f-af294447c24a",
    "first_attempt_at": 0,
    "last_attempt_at": 0,
    "status": "",
    "created_at": 0,
    "uri": ""
}

In this section:

Documentation

Deposit Completed Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results