API Reference

Overview

Accounts

Overview

The Account object

List Accounts

Create an Account

Retrieve an Account

Update an Account

Retrieve an Account Balance

Close an Account

Sandbox: Create an account revenue payment

Sandbox: Create an interest payment

Account Numbers

Overview

The Account Number object

List Account Numbers

Create an Account Number

Retrieve an Account Number

Update an Account Number

Account Transfers

Overview

The Account Transfer object

List Account Transfers

Create an Account Transfer

Retrieve an Account Transfer

Approve an Account Transfer

Cancel an Account Transfer

Transactions

Overview

The Transaction object

List Transactions

Retrieve a Transaction

Pending Transactions

Overview

The Pending Transaction object

List Pending Transactions

Create a Pending Transaction

Retrieve a Pending Transaction

Release a user-initiated Pending Transaction

Sandbox: Release an Inbound Funds Hold

Declined Transactions

Overview

The Declined Transaction object

List Declined Transactions

Retrieve a Declined Transaction

ACH Transfers

Overview

The ACH Transfer object

List ACH Transfers

Create an ACH Transfer

Retrieve an ACH Transfer

Approve an ACH Transfer

Cancel a pending ACH Transfer

Sandbox: Acknowledge an ACH Transfer

Sandbox: Create a Notification of Change for an ACH Transfer

Sandbox: Return an ACH Transfer

Sandbox: Settle an ACH Transfer

Sandbox: Submit an ACH Transfer

Inbound ACH Transfers

Overview

The Inbound ACH Transfer object

List Inbound ACH Transfers

Retrieve an Inbound ACH Transfer

Create a notification of change for an Inbound ACH Transfer

Decline an Inbound ACH Transfer

Return an Inbound ACH Transfer

Sandbox: Create an Inbound ACH Transfer

ACH Prenotifications

Overview

The ACH Prenotification object

List ACH Prenotifications

Create an ACH Prenotification

Retrieve an ACH Prenotification

Check Transfers

Overview

The Check Transfer object

List Check Transfers

Create a Check Transfer

Retrieve a Check Transfer

Approve a Check Transfer

Cancel a pending Check Transfer

Stop payment on a Check Transfer

Sandbox: Mail a Check Transfer

Inbound Check Deposits

Overview

The Inbound Check Deposit object

List Inbound Check Deposits

Retrieve an Inbound Check Deposit

Decline an Inbound Check Deposit

Return an Inbound Check Deposit

Sandbox: Create an Inbound Check Deposit

Sandbox: Accept an Inbound Check Deposit

Sandbox: Create an Inbound Check Deposit Adjustment

Physical Check Batches

Overview

The Physical Check Batch object

Create a Physical Check Batch

Cancel a Physical Check Batch

Complete a Physical Check Batch

Real-Time Payments Transfers

Overview

The Real-Time Payments Transfer object

List Real-Time Payments Transfers

Create a Real-Time Payments Transfer

Retrieve a Real-Time Payments Transfer

Approve a Real-Time Payments Transfer

Cancel a pending Real-Time Payments Transfer

Sandbox: Complete a Real-Time Payments Transfer

Inbound Real-Time Payments Transfers

Overview

The Inbound Real-Time Payments Transfer object

List Inbound Real-Time Payments Transfers

Retrieve an Inbound Real-Time Payments Transfer

Sandbox: Create an Inbound Real-Time Payments Transfer

Real-Time Payments Requests for Payment

Overview

The Real-Time Payments Request for Payment object

List Real-Time Payments Requests for Payment

Create a Real-Time Payments Request for Payment

Retrieve a Real-Time Payments Request for Payment

Inbound Real-Time Payments Requests for Payment

Overview

The Inbound Real-Time Payments Request for Payment object

List Inbound Real-Time Payments Requests for Payment

Retrieve an Inbound Real-Time Payments Request for Payment

FedNow Transfers

Overview

The FedNow Transfer object

List FedNow Transfers

Create a FedNow Transfer

Retrieve a FedNow Transfer

Approve a FedNow Transfer

Cancel a pending FedNow Transfer

Sandbox: Complete a FedNow Transfer

Inbound FedNow Transfers

Overview

The Inbound FedNow Transfer object

List Inbound FedNow Transfers

Retrieve an Inbound FedNow Transfer

Sandbox: Create an Inbound FedNow Transfer

Swift Transfers

Overview

The Swift Transfer object

List Swift Transfers

Create a Swift Transfer

Retrieve a Swift Transfer

Approve a Swift Transfer

Cancel a pending Swift Transfer

Wire Transfers

Overview

The Wire Transfer object

List Wire Transfers

Create a Wire Transfer

Retrieve a Wire Transfer

Approve a Wire Transfer

Cancel a pending Wire Transfer

Sandbox: Reverse a Wire Transfer

Sandbox: Submit a Wire Transfer

Inbound Wire Transfers

Overview

The Inbound Wire Transfer object

List Inbound Wire Transfers

Retrieve an Inbound Wire Transfer

Reverse an Inbound Wire Transfer

Sandbox: Create an Inbound Wire Transfer

Wire Drawdown Requests

Overview

The Wire Drawdown Request object

List Wire Drawdown Requests

Create a Wire Drawdown Request

Retrieve a Wire Drawdown Request

Sandbox: Refuse a Wire Drawdown Request

Sandbox: Submit a Wire Drawdown Request

Inbound Wire Drawdown Requests

Overview

The Inbound Wire Drawdown Request object

List Inbound Wire Drawdown Requests

Retrieve an Inbound Wire Drawdown Request

Sandbox: Create an Inbound Wire Drawdown request

Card Transfers

Card Tokens

Overview

The Card Token object

List Card Tokens

Retrieve a Card Token

Retrieve the capabilities of a Card Token

Sandbox: Create a Card Token

Card Push Transfers

Overview

The Card Push Transfer object

List Card Push Transfers

Create a Card Push Transfer

Retrieve a Card Push Transfer

Approve a Card Push Transfer

Cancel a pending Card Push Transfer

Card Validations

Overview

The Card Validation object

List Card Validations

Create a Card Validation

Retrieve a Card Validation

Check Deposits

Overview

The Check Deposit object

List Check Deposits

Create a Check Deposit

Retrieve a Check Deposit

Sandbox: Adjust a Check Deposit

Sandbox: Reject a Check Deposit

Sandbox: Return a Check Deposit

Sandbox: Submit a Check Deposit

Lockbox Addresses

Overview

The Lockbox Address object

List Lockbox Addresses

Create a Lockbox Address

Retrieve a Lockbox Address

Update a Lockbox Address

Lockbox Recipients

Overview

The Lockbox Recipient object

List Lockbox Recipients

Create a Lockbox Recipient

Retrieve a Lockbox Recipient

Update a Lockbox Recipient

Inbound Mail Items

Overview

The Inbound Mail Item object

List Inbound Mail Items

Retrieve an Inbound Mail Item

Action an Inbound Mail Item

Sandbox: Create an Inbound Mail Item

Cards

Overview

The Card object

List Cards

Create a Card

Retrieve a Card

Update a Card

Create a Card details iframe

Retrieve sensitive details for a Card

Update a Card's PIN

Card Payments

Overview

The Card Payment object

List Card Payments

Retrieve a Card Payment

Sandbox: Create a Card Authentication attempt

Sandbox: Create a Card Authentication Challenge attempt

Sandbox: Create an initial Card Authentication Challenge

Sandbox: Expire a Card Authorization

Sandbox: Create a Card Authorization

Sandbox: Create a Card Balance Inquiry

Sandbox: Confirm the fuel pump amount for a Card Authorization

Sandbox: Increment a Card Authorization

Sandbox: Refund a card transaction

Sandbox: Reverse a Card Authorization

Sandbox: Settle a Card Authorization

Card Purchase Supplements

Overview

The Card Purchase Supplement object

List Card Purchase Supplements

Retrieve a Card Purchase Supplement

Sandbox: Create a Card Purchase Supplement

Card Disputes

Overview

The Card Dispute object

List Card Disputes

Create a Card Dispute

Retrieve a Card Dispute

Submit a User Submission for a Card Dispute

Withdraw a Card Dispute

Sandbox: Advance the state of a Card Dispute

Physical Cards

Overview

The Physical Card object

List Physical Cards

Create a Physical Card

Retrieve a Physical Card

Update a Physical Card

Sandbox: Advance the shipment status of a Physical Card

Sandbox: Create a Physical Card Shipment Tracking Update

Digital Card Profiles

Overview

The Digital Card Profile object

List Card Profiles

Create a Digital Card Profile

Retrieve a Digital Card Profile

Archive a Digital Card Profile

Clones a Digital Card Profile

Physical Card Profiles

Overview

The Physical Card Profile object

List Physical Card Profiles

Create a Physical Card Profile

Retrieve a Card Profile

Archive a Physical Card Profile

Clone a Physical Card Profile

Digital Wallet Tokens

Overview

The Digital Wallet Token object

List Digital Wallet Tokens

Retrieve a Digital Wallet Token

Sandbox: Create a digital wallet token request

Compliance

Entities

Overview

The Entity object

List Entities

Create an Entity

Retrieve an Entity

Update an Entity

Archive an Entity

Sandbox: Simulate validation of an Entity

Beneficial Owners

Overview

The Beneficial Owner object

List Beneficial Owners

Create a Beneficial Owner

Retrieve a Beneficial Owner

Update a Beneficial Owner

Archive a Beneficial Owner

Supplemental Documents

Overview

The Supplemental Document object

List Entity Supplemental Document Submissions

Create a supplemental document for an Entity

Entity Onboarding Sessions

Overview

The Entity Onboarding Session object

List Entity Onboarding Session

Create an Entity Onboarding Session

Retrieve an Entity Onboarding Session

Expire an Entity Onboarding Session

Sandbox: Submit an Entity Onboarding Session

Programs

Overview

The Program object

List Programs

Retrieve a Program

Sandbox: Create a Program

Events and Webhooks

Events

Overview

The Event object

List Events

Retrieve an Event

Event Subscriptions

Overview

The Event Subscription object

List Event Subscriptions

Create an Event Subscription

Retrieve an Event Subscription

Update an Event Subscription

Real-Time Decisions

Overview

The Real-Time Decision object

Retrieve a Real-Time Decision

Action a Real-Time Decision

External Accounts

Routing Numbers

Overview

The Routing Number object

List Routing Numbers

External Accounts

Overview

The External Account object

List External Accounts

Create an External Account

Retrieve an External Account

Update an External Account

Files and Exports

Account Statements

Overview

The Account Statement object

List Account Statements

Retrieve an Account Statement

Sandbox: Create an Account Statement

Files

Overview

The File object

List Files

Create a File

Retrieve a File

Get File Contents

File Links

Overview

The File Link object

Create a File Link

Exports

Overview

The Export object

List Exports

Create an Export

Retrieve an Export

Sandbox: Generate a Tax Form Export

OAuth

Groups

Overview

The Group object

Retrieve Group details

OAuth Applications

Overview

The OAuth Application object

List OAuth Applications

Retrieve an OAuth Application

OAuth Connections

Overview

The OAuth Connection object

List OAuth Connections

Retrieve an OAuth Connection

OAuth Tokens

Overview

The OAuth Token object

Create an OAuth Token

Intrafi

IntraFi Account Enrollments

Overview

The IntraFi Account Enrollment object

List IntraFi Account Enrollments

Enroll an account in the IntraFi deposit sweep network

Get an IntraFi Account Enrollment

Unenroll an account from IntraFi

IntraFi Balances

Overview

The IntraFi Balance object

Get IntraFi balance

IntraFi Exclusions

Overview

The IntraFi Exclusion object

List IntraFi Exclusions

Create an IntraFi Exclusion

Get an IntraFi Exclusion

Archive an IntraFi Exclusion