API Reference
Supported Operations
- Withdraw (push to customer US bank account via FedNow)
- Transaction status lookup
Endpoints
Withdraw
POST /api/v2/fednow/withdraw
Sends funds from your VoPay account to a customer's US bank account via the FedNow network.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Amount | decimal | Yes | Transaction amount in USD |
| RecipientName | string | Yes | Name of the recipient |
| ABARoutingNumber | string | Conditional | 9-digit ABA routing number. Required if not using a token |
| AccountNumber | string | Conditional | Recipient's bank account number. Required if not using a token |
| Token | string | Conditional | Tokenized bank account. Use instead of raw banking details |
| ClientAccountID | string | Optional | Link transaction to a sub-account |
| ContactID | string | Optional | Link transaction to a contact |
| ClientReferenceNumber | string | Optional | Your internal reference number |
| TransactionTypeCode | string | Optional | Transaction type code |
| GLCode | string | Optional | General ledger code |
| Notes | string | Optional | Internal notes |
| IdempotencyKey | string | Optional | Unique key to prevent duplicate transactions |
| ParentTransactionID | string | Optional | ID of a parent transaction to link this to |
Get Withdraw Transaction
GET /api/v2/fednow/withdraw/transaction
Returns details of a single FedNow withdraw transaction.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| TransactionID | string | Yes | The transaction ID returned from /fednow/withdraw |
Updated 2 days ago