Change Wallet Status

Disable, enable, or close a Rapyd Wallet.

This method triggers the Wallet Status Changed Webhook.

In addition, disabling a wallet triggers the Wallet Disabled Webhook, enabling a wallet triggers the Wallet Enabled Webhook, and closing a wallet triggers the Wallet Closed Webhook.

The webhooks contain the same information as the response.

Disable a wallet to prevent the following actions:

Moving money into or out of the wallet.
Issuing a bank account number or card to the wallet.

Disable a wallet when the customer requests it, or while you conduct an investigation.

Disabling a wallet changes the status of the wallet to DIS (disabled).

Enable a wallet to reverse the process.

Enabling a wallet changes the status of the wallet to ACT (enabled and active).

Close a wallet to permanently disable it. The wallet must have no balances, no pending transactions, and no open virtual accounts.

Closing a wallet changes the status of the wallet to CLO (permanently closed). You cannot change the status of a closed wallet.

Parameters

Request Path Parameters

- ewallet
- ID of the Rapyd Wallet. String starting with ewallet_.
- status
- The change to make in the wallet status. One of the following:
  - close - Change the status from enabled and active (ACT) or disabled (DIS) to permanently closed (CLO).
  - disable - Change the status from enabled and active (ACT) to disabled (DIS).
  - enable - Change the status from disabled (DIS) to enabled and active (ACT).

Request Header Parameters

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

/v1/user/ewallets/:ewallet/statuses/:status

Disable Wallet

curl -X post
https://sandboxapi.rapyd.net/v1/ewallets/ewallet_67b83dcb34c274156da8607ab2abca4b/statuses/disable
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "c2330ab6-4e49-4995-a854-34a832aa0661"
    },
    "data": {
        "id": "ewallet_67b83dcb34c274156da8607ab2abca4b",
        "phone_number": "+6305551212",
        "email": null,
        "first_name": "John",
        "last_name": "Doe",
        "status": "DIS",
        "accounts": [],
        "verification_status": "not verified",
        "type": "company",
        "metadata": {},
        "ewallet_reference_id": "2023-01-30b15716",
        "category": null,
        "contacts": null,
        "parent_ewallet": null
    }
}

Enable Wallet

curl -X post
https://sandboxapi.rapyd.net/v1/ewallets/ewallet_67b83dcb34c274156da8607ab2abca4b/statuses/enable
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "015f6b52-fc60-4fb1-8d63-670340a736a8"
    },
    "data": {
        "id": "ewallet_67b83dcb34c274156da8607ab2abca4b",
        "phone_number": "+6305551212",
        "email": null,
        "first_name": "John",
        "last_name": "Doe",
        "status": "ACT",
        "accounts": [],
        "verification_status": "not verified",
        "type": "company",
        "metadata": {},
        "ewallet_reference_id": "2023-01-30b15716",
        "category": null,
        "contacts": null,
        "parent_ewallet": null
    }
}

Close Wallet

curl -X post
https://sandboxapi.rapyd.net/v1/ewallets/ewallet_67b83dcb34c274156da8607ab2abca4b/statuses/close
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "2a325899-f00a-45b1-9eec-ec35ef7b5966"
    },
    "data": {
        "id": "ewallet_67b83dcb34c274156da8607ab2abca4b",
        "phone_number": "+6305551212",
        "email": null,
        "first_name": "John",
        "last_name": "Doe",
        "status": "CLO",
        "accounts": [],
        "verification_status": "not verified",
        "type": "company",
        "metadata": {},
        "ewallet_reference_id": "2023-01-30b15716",
        "category": null,
        "contacts": null,
        "parent_ewallet": null
    }
}

In this section:

Documentation

Change Wallet Status

Parameters

Request Path Parameters

Request Header Parameters

Response Parameters

Search results