paymentRoute.created

initial release

paymentRoute.created

Added the paymentRoute webhook with action created. Rain sends this webhook when a payment route becomes active and is ready to receive deposits, for example after a Partner-Managed customer completes KYC and Rain provisions the route’s virtual account. The body is the full payment route, matching the GET /v1/payment-routes response.

Payload Fields

Field	Type	Description
`id`	`string`	The payment route ID
`userId`	`string` (optional)	The user ID for consumer accounts
`companyId`	`string` (optional)	The company ID for corporate accounts
`status`	`string`	Route status (`active`, `pending`, `frozen`, or `deleted`). This webhook fires when the route reaches `active`
`source.currency`	`string`	Source currency code (e.g., `usd`, `usdc`, `mxn`)
`source.rail`	`string`	Source rail (e.g., `ach`, `wire`, `base`, `mx_spei`)
`destination.currency`	`string`	Destination currency code
`destination.rail`	`string`	Destination rail
`destination.address`	`object`	Destination address (see address types below)
`destination.referenceId`	`string` (optional)	Destination reference / memo. Only relevant for fiat destinations
`depositAddress`	`object` (optional)	Where the customer funds the route (see deposit address types below). Omitted while a route is `pending`
`refundAddress`	`string` (optional)	Refund wallet address, for onchain-source (offramp) routes
`senderFees`	`array` (optional)	Sender fees applied to the route
`developerFees`	`array` (optional)	Deprecated: use `senderFees` instead. Returns the same values for backward compatibility
`createdAt`	`string`	ISO 8601 timestamp of creation
`updatedAt`	`string`	ISO 8601 timestamp of last update

Address Types

The destination address can be one of:Onchain address:

Field	Type	Description
`type`	`string`	Always `onchain`
`address`	`string`	Wallet address

Payment account address:

Field	Type	Description
`type`	`string`	Always `paymentAccount`
`id`	`string`	Payment account ID

Deposit Address Types

The deposit address can be one of:Fiat deposit address:

Field	Type	Description
`type`	`string`	Always `fiat`
`beneficiaryName`	`string` (optional)	Beneficiary name
`beneficiaryAddress`	`string` (optional)	Beneficiary address
`beneficiaryBankName`	`string` (optional)	Bank name
`beneficiaryBankAddress`	`string` (optional)	Bank address
`accountNumber`	`string` (optional)	Account number (US bank deposits)
`routingNumber`	`string` (optional)	Routing number (US bank deposits)
`clabeNumber`	`string` (optional)	CLABE (Clave Bancaria Estandarizada) for MXN SPEI deposits
`transferMessage`	`string` (optional)	Transfer message / memo to include with the deposit

Onchain deposit address:

Field	Type	Description
`type`	`string`	Always `onchain`
`address`	`string`	Wallet address

Example Payload

{
    "resource": "paymentRoute",
    "action": "created",
    "version": "1.0.0",
    "body": {
        "id": "a1b2c3d4-5e6f-7081-9234-56789abcdef0",
        "userId": "11111111-1111-1111-1111-111111111111",
        "status": "active",
        "source": {
            "currency": "usd",
            "rail": "ach"
        },
        "destination": {
            "currency": "usdc",
            "rail": "base",
            "address": {
                "type": "onchain",
                "address": "0x1234567890abcdef1234567890abcdef12345678"
            }
        },
        "depositAddress": {
            "type": "fiat",
            "beneficiaryBankName": "SSB BANK",
            "accountNumber": "1234567890",
            "routingNumber": "043087080"
        },
        "createdAt": "2026-06-11T15:30:00.000Z",
        "updatedAt": "2026-06-11T15:30:00.000Z"
    }
}