Update Requested Currency

Define, change, or cancel the currency to which funds received by a virtual account are converted.

The status of the virtual account must be ACT (active) or PEN (pending).

To cancel a previously defined currency conversion, set requested_currency to null.

Note

This endpoint replaces the deprecated endpoint - POST v1/issuing/bankaccounts/:virtual_account

Rapyd will continue to support the deprecated endpoint until December 31, 2024.

Prerequisites

Parameters

Request Path Parameters

- virtual_account
- ID of the virtual account number object. String starting with issuing_.

Request Header Parameters

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

/v1/virtual_accounts/:virtual_account

Update Requested Currency

curl - X post
https: //sandboxapi.rapyd.net/v1/virtual_accounts/issuing_2392a9fc4ec990838da111bd8ce6c825
-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'
-d '{
"requested_currency": "USD"
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "d2150cbd-40ba-476e-8b1a-a8a2596f6e2e"
    },
    "data": {
        "id": "issuing_36feaa027745f08b4691636d8d3fd07e",
        "merchant_reference_id": "issuing_36feaa027745f08b4691636d8d3fd07e",
        "ewallet": "ewallet_5c148fcf040282f80907026f6030cce9",
        "bank_account": {
            "beneficiary_name": "Rapyd Holdings Pte Ltd",
            "address": "G/F, The Center, 99 Queen's Road Central, Central, Hong Kong",
            "country_iso": "HK",
            "bank": "DBS Bank (Hong Kong) Limited",
            "country": "Hong Kong",
            "bank_code": "016",
            "account_id": "7981397317776192",
            "account_id_type": "",
            "local_bank_code_type": "",
            "swift_bic": "DHBKHKHH",
            "branch_code": "478"
        },
        "metadata": {},
        "status": "ACT",
        "description": "K DBS HK",
        "funding_instructions": null,
        "currency": "HKD",
        "requested_currency": "USD",
        "transactions": []
    }
}

Cancel Requested Currency

curl - X post
https: //sandboxapi.rapyd.net/v1/virtual_accounts/issuing_2392a9fc4ec990838da111bd8ce6c825
-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'
-d '{
"requested_currency": null
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "5b105124-30e8-440e-a5b9-01d01fcbf67e"
    },
    "data": {
        "id": "issuing_2392a9fc4ec990838da111bd8ce6c825",
        "merchant_reference_id": "5rtfgk897ter0df0m",
        "ewallet": "ewallet_f95ed68265974e0af57675a5c2f24fcc",
        "bank_account": {
            "beneficiary_name": "John Doe",
            "address": "99 Queen's Road Central, Central, Hong Kong",
            "country_iso": "HK",
            "bank": "DBS Bank (Hong Kong) Limited",
            "country": "Hong Kong",
            "bank_code": "016",
            "account_number": "7981304591201301",
            "bic": "DHBKHKHH"
        },
        "metadata": {
            "merchant_defined": true
        },
        "status": "ACT",
        "description": "Issue virtual account to wallet with receiving currency",
        "funding_instructions": null,
        "currency": "HKD",
        "requested_currency": null,
        "transactions": []
    }
}

In this section:

Documentation