Schema

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	{}
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
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	[email protected]
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
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
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

Webhook Payload for Wallet

Parameter	Type	Example
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'
suspended	Boolean	false
updated_date	DateTime	2024-08-12T00:06:00Z

GraphQL Schema

enum SubscriptionType {
  entity
  transfer
  incoming_transfer
  wallet
}

type Mutation {
  createWebhookSubscription(
    subscription_type: SubscriptionType!
    url: String!
    header_key: String
    header_value: String
  ): String

  disableWebhookSubscription(
    subscription_id: UUID!
  ): String
}