Wallet Updated Webhook

The EWALLET_UPDATED webhook notifies the client when a wallet is updated.

Webhook Trigger Mechanism

The webhook follows the logic below:

Triggered when any of the following fields are updated or cleared:
- category
- cnls_partner_query_reference
- ewallet_reference_id
- first_name
- last_name
- metadata
- parent_ewallet
- type
Triggered regardless of whether the update is made via the API or the Client Portal.
Sent only for wallets with an ACT (active) status; not sent for DIS (disabled) or CLO (closed) wallets.
Not triggered by updates to the following fields: phone_number, email, is_lob, or status.
Not triggered when adding contacts or funds to the wallet.

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

- accounts
- An array of objects with the following fields:
  alias
  Alternate text description of the currency.
  balance
  Available funds in the account.
  currency
  Three-letter ISO 4217 code for the currency used in the balance field.
  id
  ID of the account. UUID.
  limit
  Reserved.
  limits
  Reserved.
  on_hold_balance
  Amount in the on-hold balance of the account.
  received_balance
  Amount of escrow funds in the account.
  reserve_balance
  Amount in the reserve balance of the account.
- category
- Indicates the type of client wallet. One of the following:
  - collect
  - disburse
  - card_authorization
  - general
- cnls_partner_query_reference
- Value of the partner_query_reference parameter used as the query request ID in the Card Network Lookup Service (CNLS). See Retrieve Query Results. Relevant to Payment Facilitator (PayFac). Parameter is not displayed when it is not relevant.
- contacts
- Contains the following fields:
  - data
    An array of 'contact' objects. For details about the fields of the 'contact' object, see Add Contact to Wallet.
  - has_more
    Indicates whether there are more contacts than appear in the data array.
  - total_count
    The total number of contacts in the wallet.
  - url
    URL to retrieve all contacts in the wallet. Use HTTP get.
- email
- Email address of the wallet owner. Deprecated. The email address belongs to the contact.
- ewallet_reference_id
- Wallet ID defined by the customer or end user.
- first_name
- First name of the wallet owner.
- id
- Unique identifier of the wallet object. String starting with ewallet_.
- last_name
- Family name of the wallet owner.
- metadata
- A JSON object defined by the client. See Metadata.
- parent_ewallet
- ID of the parent wallet. String starting with ewallet_.
- phone_number
- Phone number of the wallet owner in E.164 format. Deprecated. The phone number belongs to the contact.
- status
- Status of the wallet. One of the following:
  - ACT - Enabled and active.
  - CLO - Permanently closed.
  - DIS - Disabled.
  - DEL - Deleted.
- system_initiated
- Indicates which organization initiated the change in the wallet's status. One of the following:
  - true - Initiated by Rapyd.
  - false - Initiated by the client.
- type
- Type of wallet. One of the following:
  - company - A business wallet.
  - person - The wallet of an individual consumer.
  - client - A wallet for the Rapyd client. To create additional wallets of this type, contact Client Support.
- verification_status
- Result of the verification check. One of the following:
  - not verified - The contact has not been submitted for the Know Your Customer checks.
  - KYCd - The user has passed the Know Your Customer checks.

EWALLET_UPDATED Webhook

{
    "id": "wh_a1b2c3d4e5f67890123456789abcdef01",
    "type": "EWALLET_UPDATED",
    "data": {
        "id": "ewallet_b5320c566cc4aa01fe77440ad08693f7",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example12345.com",
        "phone_number": "+555555555555",
        "status": "ACT",
        "accounts": [
            {
                "id": "ff97f975-5e85-4df0-8f01-9b1b051d3e390",
                "currency": "EUR",
                "alias": "EUR",
                "balance": 10000,
                "received_balance": 0,
                "on_hold_balance": 0,
                "reserve_balance": 0,
                "limits": null,
                "limit": null
            },
            {
                "id": "4a659c50-3f2d-487a-b062-30459e00c4370",
                "currency": "EUR",
                "alias": "EUR",
                "balance": 9798,
                "received_balance": 0,
                "on_hold_balance": 0,
                "reserve_balance": 0,
                "limits": null,
                "limit": null
            }
        ],
        "verification_status": "not verified",
        "type": "company",
        "metadata": {
            "merchant_defined": true
        },
        "ewallet_reference_id": "erd-2025-08-10ab",
        "category": null,
        "contacts": {
            "data": [
                {
                    "id": "cont_18c0d881a3d0d2e9e54d4664c6b0022d",
                    "first_name": "John",
                    "last_name": "Doe",
                    "middle_name": "",
                    "second_last_name": "",
                    "gender": "not_applicable",
                    "marital_status": "not_applicable",
                    "house_type": "",
                    "contact_type": "business",
                    "phone_number": "+14155551234",
                    "email": "john.doe.162417@example12345.com",
                    "identification_type": "",
                    "identification_number": "",
                    "issued_card_data": {
                        "preferred_name": "",
                        "transaction_permissions": "",
                        "role_in_company": ""
                    },
                    "date_of_birth": null,
                    "country": "US",
                    "nationality": null,
                    "address": null,
                    "ewallet": "ewallet_b5320c566cc4aa01fe77440ad08693f7",
                    "created_at": 1753881858,
                    "metadata": {},
                    "business_details": {
                        "id": "busi_aba4330005786f053d25c46168d21fc4",
                        "name": "",
                        "registration_number": "",
                        "entity_type": "null",
                        "industry_category": "null",
                        "industry_sub_category": "null",
                        "address": {
                            "id": "address_3c15646a8e2011f884c92eb416f52a02",
                            "name": "John Doe",
                            "line_1": "789 Main Street",
                            "line_2": "Apt 4E",
                            "line_3": "",
                            "city": "Anytown",
                            "state": "",
                            "country": "US",
                            "zip": "54321",
                            "phone_number": "+14155555555",
                            "metadata": {},
                            "canton": "",
                            "district": "",
                            "created_at": 1755781052
                        },
                        "created_at": 1753881858,
                        "annual_revenue": 0,
                        "establishment_date": null,
                        "legal_entity_type": null,
                        "cnae_code": null,
                        "statement_descriptor": null,
                        "mcc": null,
                        "website_url": null,
                        "customer_service_phone_number": null
                    },
                    "compliance_profile": 0,
                    "verification_status": "not verified",
                    "send_notifications": false,
                    "mothers_name": "",
                    "contact_reference_id": null
                }
            ],
            "has_more": true,
            "total_count": 6,
            "url": "/v1/ewallets/ewallet_b5320c566cc4aa01fe77440ad08693f7/contacts"
        },
        "parent_ewallet": null,
        "cnls_partner_query_reference": null
    },
    "trigger_operation_id": "f9a3368f-3dbf-49c6-a81a-a17f5150612c0",
    "status": "NEW",
    "created_at": 1754572956,
    "extended_timestamp": 1754572956000
}

In this section:

Documentation

Wallet Updated Webhook

Webhook Trigger Mechanism

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results