Transfer Funds Webhook

The Transfer Funds webhook notifies a Rapyd partner that a transfer was completed within a Rapyd wallet from one balance to another.

The data array contains two objects, one representing the source of the funds and one representing the destination.

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

- amount
- Amount of the transfer.
  - A positive number indicates that the amount was transferred to the indicated balance.
  - A negative number indicates that the amount was transferred from the indicated balance.
- balance
- Amount in the indicated balance after the transfer.
- balance_type
- Balance type where the funds are transferred to or from. One of the following:
  - available_balance
  - on_hold_balance
  - received_balance
  - reserve_balance
- created_at
- Time of the transfer, in Unix time.
- currency
- Currency of the account within the Rapyd wallet. Three-letter alphabetic ISO 4217 code.
- destination_balance_type
- Balance type where the funds are transferred to. One of the following:
  - available_balance
  - on_hold_balance
  - received_balance
  - reserve_balance
- destination_ewallet_id
- ID of the wallet. String starting with ewallet_.
- id
- ID of the transaction. UUID.
- metadata
- A JSON object defined by the client. See Metadata.
- type
- Indicates the type of transaction. The value is balance_transfer.
- source_balance_type
- Balance type where the funds are transferred from. One of the following:
  - available_balance
  - on_hold_balance
  - received_balance
  - reserve_balance
- source_ewallet_id
- ID of the wallet. String starting with ewallet_.
- ID of the transaction with regard to the source. UUID
- status
- Status of the transfer.
  - CLOSED - The transfer is complete.

Transfer Funds Webhook

{
    id: 'wh_a0a073591bc931bf92cf81dc67262570',
    type: 'TRANSFER_FUNDS',
    data: [
		{
            id: 'wt_05e14c2bbc27cc69230198bdc75c2369',
            type: 'balance_transfer',
            amount: -100,
            reason: '',
            status: 'CLOSED',
            balance: 900,
            currency: 'USD',
            metadata: {},
            created_at: 1688673865,
            ewallet_id: 'ewallet_cdeb8a21aa1ea5b84cfae582b693aac5',
            balance_type: 'received_balance',
            destination_ewallet_id: 'ewallet_cdeb8a21aa1ea5b84cfae582b693aac5',
            destination_balance_type: 'available_balance'
        }, {
            id: 'wt_60524f12b1b68a3367fca422c2434ccd',
            type: 'balance_transfer',
            amount: 100,
            reason: '',
            status: 'CLOSED',
            balance: 25208.69,
            currency: 'USD',
            metadata: {},
            created_at: 1688673865,
            ewallet_id: 'ewallet_cdeb8a21aa1ea5b84cfae582b693aac5',
            balance_type: 'available_balance',
            source_ewallet_id: 'ewallet_cdeb8a21aa1ea5b84cfae582b693aac5',
            source_balance_type: 'received_balance'
        }
    ],
    trigger_operation_id: '5b0aaa1b-1541-4196-a688-002cc0cd2d4a',
    status: 'NEW',
    created_at: 1688673865,
    "extended_timestamp": 1688673865394
}

In this section:

Documentation

Transfer Funds Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results