### Webhook Payload for Transfer
| Parameter | Type | Example |
|----------------------------|--------|------------------------------------------|
| subscription_type | String | transfer |
| id | UUID | 18ea46e5-2c36-4862-9eac-adc44364df7b |
| user_id | UUID | 18ea46e5-2c36-4862-9eac-adc44364df7b |
| entity_id | UUID | 18ea46e5-2c36-4862-9eac-adc44364df7b |
| beneficiary_id | UUID | 18ea46e5-2c36-4862-9eac-adc44364df7b |
| wallet_id | UUID | 18ea46e5-2c36-4862-9eac-adc44364df7b |
| state | String | processing |
| fee | String | 0.00 |
| fee_usd | String | 0.00 |
| source_amount | String | 15 |
| source_currency | String | MXN |
| destination_amount | String | 0.87 |
| destination_currency | String | USD |
| purpose_of_payment | String | Test |
| rate | String | 0.057817 |
| reference | String | Test |
| created_date | String | 2023-08-08T16:59:42.463Z |
| expected_delivery_date | String | 2023-08-09T17:00:06.375Z |
| funding_instructions | FundingInstructions | empty object |
| payment_method | String | local |
| scheduled_delivery_date | String | 2023-08-09T17:00:06.375Z |
| wire | String | false |
### Webhook Payload for Entity
| Parameter | Type | Example |
|----------------------------|--------|------------------------------------------|
| subscription_type | String | entity |
| id | UUID | 18ea46e5-2c36-4862-9eac-adc44364df7 |
| type | String | business or person |
| business_name | String | Routefusion, Inc |
| created_date | String | 2023-08-08T16:59:42.463Z |
| state | State | approved |
| first_name | String | John |
| last_name | String | Smith |
| email | String | [john.smith@routefusion.com](mailto:john.smith@routefusion.com) |
| phone | String | 555-555-5555 |
| phone_country | String | US |
| address1 | String | 123 S. Congress |
| address2 | String | Suite 3 |
| city | String | Austin |
| state_province_region | String | TX |
| postal_code | String | 78702 |
| country | String | US |
| user_id | UUID | 18ea46e5-2c36-4862-9eac-adc44364df7b |
| representatives | [UUID] | ['18ea46e5-2c36-4862-9eac-adc44364df7b'] |
### Webhook Payload for IncomingTransfer
| Parameter | Type | Example |
|----------------------------|--------|------------------------------------------|
| subscription_type | String | incoming_transfer |
| id | UUID | 27f96699-55a9-4c03-8b36-7627bc344751 |
| entity_id | UUID | 102eafea-957a-41fe-b0bd-6dc078021f16 |
| wallet_id | UUID | 202a9c54-e7fa-4ccb-8303-a9195f7593b2 |
| currency | String | USD |
| credit | Boolean| true |
| amount | String | '2500.00' |
| transaction_date | DateTime | 2024-02-06T23:16:54Z |
| reference | String | |
| counterparty_name | String | Bob's Burgers |
| account_number | String | '13254355' |
| name_on_bank_account | String | Frankie's Fries |
| nicename_on_bank_account | String | Fries Account #1 |
| state | IncomingTransferState | complete |
| payment_method | String | This is not guaranteed to be present. Consider this optional. It will have the value 'local' or 'wire'. |
| purpose_of_payment | String | Purchase of goods |
| updated_date | DateTime | 2024-02-07T00:05:00Z |
| created_date | DateTime | 2024-02-07T00:05:00Z |
| senders_bank | String | Bank of America |
| trace | String | 22ADF2345DB3455 |
| enriched_payment_data | PrimitiveMetadata | { ... } |
### Webhook Payload for Wallet
| Parameter | Type | Example |
|----------------------------|--------|------------------------------------------|
| subscription_type | String | wallet |
| available_balance | String | '10,000' |
| balance | String | '10,000' |
| country | ISO3166_1 | US |
| created_date | DateTime | 2024-08-12T00:05:00Z |
| currency | ISO4217 | USD |
| entity | UUID | 102eafea-957a-41fe-b0bd-6dc078021f16 |
| id | UUID | 202a9c54-e7fa-4ccb-8303-a9195f7593b2 |
| organization | UUID | 27f96699-55a9-4c03-8b36-7627bc344751 |
| representative_currency | ISO4217 | USD |
| state | String | one of: 'accepted', 'pending', 'verified', 'rejected', 'suspended', 'frozen' |
| suspended | Boolean| false |
| updated_date | DateTime | 2024-08-12T00:06:00Z |
### Webhook Payload for Beneficiary
| Attribute | Type | Definition | Example |
|----------------------------|--------|------------------------------------------|------------------------------------------|
| subscription_type | String | event resource category | beneficiary |
| id | UUID | the id of the beneficiary | a9d0164d-22df-46c6-a836-1a3da5a470d8 |
| entity | Entity | the entity object - NOT editable after creation| see entity schema |
| creator | UserAccount | the user object that created the beneficiary - NOT editable after creation| see UserAccount schema |
| type | String | the classification of the beneficiary, can either be 'personal' or 'business' - NOT editable after creation| personal |
| email | Email | email used for notification | [info@customer.com](mailto:info@customer.com) |
| phone | String | phone number of beneficiary | 9177234464 |
| phone_country | String | 2 letter ISO code of the country the phone number exists in| US |
| tax_number | TaxNumber | tax number of the beneficiary for the country provided| 121904576 |
| first_name | String | first name of the beneficiary | Thomas |
| last_name | String | last name of the beneficiary | Jones |
| address1 | String | address line 1 of beneficiary | 1305 E 6th St. |
| address2 | String | address line 2 of beneficiary | Unit 10 |
| city | String | city the beneficiary resides in | Austin |
| state | BeneficiaryState | state of the beneficiary | - accepted
- pending
- verified
- failed
- change_required |
| state_province_region | String | the state (US), province, or region the beneficiary resides in| Texas |
| postal_code | String | the postal code of the beneficiary | 78702 |
| country | String!| 2 letter ISO code of the country the beneficiary resides in| US |
| tax_number | String | the tax number of the beneficiary, this is only required for some countries| 111564839 |
| contact_first_name | String | first name of the contact of the beneficiary (business only)| George |
| contact_last_name | String | last name of the contact of the beneficiary (business only)| Castanza |
| business_name | String | name of business receiving payment | Routefusion |
| name_on_bank_account | String | legal owner of the bank account | Thomas Jones |
| swift_bic | String | SWIFT/BIC code of the bank; this can be an account number, CLABE or IBAN| CITIUS33XXX |
| account_type | AccountType | type of the beneficiaries account, can only be checking or saving| checking |
| account_number | String | the IBAN, CLABE, or account number of the bank account| 2345366452 |
| routing_code | String | routing code of the local financial system| A bank routing code |
| currency | String | the 3 character code of the currency - NOT editable after creation| USD |
| bank_name | String | the name of the banking institution | Citibank |
| branch_name | String | the name of the bank branch | LOS ANGELES-BRENTWOOD |
| bank_address1 | String | line 1 of the bank address | 11726 SAN VICENTE BLVD |
| bank_address2 | String | line 2 of the bank address | Unit 10 |
| bank_city | String | the city the bank is located | Los Angeles |
| bank_state_province_region | String | the state, region, or province the bank resides in| California |
| bank_postal_code | PostalCode | the postal code of the bank | 90049 |
| bank_country | ISO3166_1! | the 2 character country code the bank resides in - NOT editable after creation| US |
| changes_required | [String] | an array of beneficiary keys that need changes| ["account_number"] |
### Webhook Payload for RFI
| Parameter | Type | Example |
|----------------------------|--------|------------------------------------------|
| subscription_type | String | rfi |
| id | UUID | e376a833-02c7-494c-b5bb-54bf90764d01 |
| resource_type | String | entity |
| resource_id | UUID | 330a30ba-3537-4553-a6b7-ab254072320a |
| organization_id | UUID | 1252b4e7-32e2-4c13-8c9b-2cb85c9f40dd |
| status | String | open |
| responded_on | DateTime | null |
| created_date | DateTime | 2026-06-02T20:02:22.507Z |
| updated_date | DateTime | 2026-06-02T20:02:22.507Z |
| details | [RFIDetail] | See RFI Detail below |
#### RFI Detail
| Parameter | Type | Example |
|----------------------------|--------|------------------------------------------|
| rfi_case_detail_id | UUID | b1eaf262-694b-474d-bb67-b86ba6aec68a |
| subtype_name | String | TAX_ID |
| answer | String | null |
| file_answer | String | null |
| input_type | RFIInputType | {"required":["file"],"optional":["text"]} |
| label | String | EIN/Tax number letter issued by government |
#### RFI Input Type
| Parameter | Type | Example |
|----------------------------|--------|------------------------------------------|
| required | [String] | ["file"] |
| optional | [String] | ["text"] |
### GraphQL Schema
GraphQL
```graphql
enum SubscriptionType {
entity
beneficiary
transfer
incoming_transfer
wallet
rfi
}
type Mutation {
createWebhookSubscription(
subscription_type: SubscriptionType!
url: String!
header_key: String
header_value: String
): String
disableWebhookSubscription(
subscription_id: UUID!
): String
}
```