DocsDocumentation

⌘K

Suggested Guides

Sign in Get started

Common workflows

Book Transfers and Holds Overdrafts Two Legged Transactions Going live

Technical guides

Getting Started Sandbox and Testing Reporting KYC/KYB Verifications

Use cases

Payment Origination Bank Accounts Card Programs Loan Origination

Informational guides

Intro to Card Issuing Roles & Permissions API Key Security Bank Statements

Working with the API

Authentication Pagination Idempotency Errors Events and Webhooks

Platform Entity Bank Account Account Number Counterparty Transfer Events and Webhooks

Overview Managing Entities Documentary Evidence

Overview Types Timing Notifications and States Returns Reversals International ACH Transfers

Overview Notifications and States Reversals Return Requests Wire Drawdown Requests

International Wires

Overview Outgoing Transfers Incoming Transfers Notifications and States Transfer Fees Returns Cancellations Tracking Supported Currencies Country-Specific Details Sandbox Simulations

Realtime Payments

Overview Outgoing Transfers Incoming Transfers Returns Notifications and States Request For Payment (RFP)

Overview Issuing, Printing, and Mailing Deposits Lockboxes Notifications and States Returns

Overview Disbursements Payments Sales and Reports

Overview Card Programs Card Accounts Cards Card Authorization Policies Card Transactions Card Fees Real-time Decisioning Card Tokens Card Reveal Card Reveal SDK Versions Card Reveal SDK Changelog Card Disputes Card Sandbox Simulation

Person

Person entity object Create a person entity Update a person entity

Business

Business entity object Create a business entity Update a business entity

General

List all entities Get an entity by ID Delete an entity Get entity compliance Get entity evidence Create entity evidence Get additional requirements Submit additional requirements List associated persons Link an associated person Update associated persons Create evidence with file upload

Narratives

Create an entity narrative List entity narratives Delete an entity narrative

Overview Bank account object Create a new bank account List all bank accounts Get a bank account by ID Update a bank account Add a bank account owner Delete a bank account Bank account overdraft alert object

Summary

Bank account summary object Get bank account summary history

Activities

Activity line item object List bank account activities

Overview Account number object Create a new account number List all account numbers from a bank account Get an account number Update an account number

Overview Loan object Create a new loan List all loans Get a loan by ID Update a loan

Loan Programs

Loan program object List loan programs Get a loan program Update loan program

Loan Summary

Loan summary object Get loan summary history

Disbursements

Loan disbursement object Create a disbursement List all disbursements Get a disbursement Update a disbursement hold Cancel a disbursement hold Clear a disbursement hold

Payments

Loan payment object Create a payment List all payments Get a payment Return a payment Apply collateral

Loan Sales

Loan sale object Create a loan sale List all loan sales Get a loan sale Loan sale summary object Get loan sale summaries for loans available for sale Get loan sale summaries for loans already sold

Overview Counterparty object Create a counterparty List all counterparties Get a counterparty by ID Delete a counterparty IBAN validation object Validate an IBAN

Financial Institutions

Financial institution object List financial institutions Get a financial institution

Overview ACH transfer object IAT transfer sub-object Create an ACH transfer List all ACH transfers Get an ACH transfer Cancel an ACH transfer Clear a held ACH transfer Reverse an ACH transfer

Returns

ACH return object Create an ACH return List all ACH returns Get an ACH return

ACH Positive Pay

Overview ACH positive pay rule object Create an ACH positive pay rule List ACH positive pay rules Get an ACH positive pay rule Delete an ACH positive pay rule

Overview Book transfer object Create a book transfer List all book transfers Get a book transfer Update a book transfer Cancel a book transfer Clear a book transfer

Overview Wire transfer object Create a wire transfer List all wire transfers Get wire transfer Cancel a held outgoing wire transfer Clear a held wire transfer Reverse an incoming wire transfer

Drawdowns

Wire drawdown request object Create a wire drawdown request List all wire drawdown requests Get a wire drawdown request Approve a wire drawdown request

Returns

Wire return request object Create a wire return request List all wire return requests Get a wire return request Approve a wire return request Reject a wire return request

International Wire

Overview International wire transfer object International wire tracking object Create an international wire transfer List all international wire transfers Get international wire transfer Track an international wire transfer Return an incoming international wire Cancel an outgoing international wire Cancel a held international wire transfer Clear a held international wire transfer Create international wire amendment

FX Rate Sheet

FX rate sheet object Get FX rate sheet

FX Quotes

FX quote object Request a foreign exchange quote Get a foreign exchange quote Book a foreign exchange quote Cancel a foreign exchange quote

Realtime Transfer

Overview Realtime transfer object Create a realtime transfer List all realtime transfers Get a realtime transfer Cancel a held realtime transfer Clear a held realtime transfer

RFP

Realtime RFP object Create a realtime RFP List all realtime RFPs Get a realtime RFP Accept a realtime RFP Reject a realtime RFP

Return Requests

Realtime return request object Create a realtime return request List all realtime return requests Get a realtime return request by ID Accept a realtime return request Reject a realtime return request Return a realtime transfer

Overview Check transfer object Issue a check Deposit a check Capture front of check Capture back of check List all check transfers Get a check transfer Get a check preview PDF for an issued transfer Stop a check transfer

Returns

Check return object Create a check return Get check transfer returns List all check returns

Lockboxes

Check lockbox object Create a check lockbox List all check lockboxes Get a check lockbox Delete a check lockbox

Overview List all transfers

ACH

Receive an ACH Credit Receive an ACH Debit Settle ACH transfer

Wires

Receive a wire transfer Receive a wire drawdown request Receive a wire return request Settle wire transfer

International Wires

Receive an international wire

Local Transfers

Realtime

Receive a realtime transfer Receive a realtime RFP (Request for Payment)

Checks

Deposit an issued check Settle check deposit

Card Programs

Create sandbox card program Close sandbox card program

Card Transactions

Simulate card authorization Simulate incremental authorization Simulate capture Simulate full financial transaction Simulate refund Simulate reversal

3DS Authentication

Simulate 3DS authentication Complete simulated 3DS challenge

Card Tokens

Simulate token eligibility check Simulate approve provisioning Simulate device binding Simulate step-up retrieve methods Simulate step-up send passcode Simulate step-up complete Simulate token suspend Simulate token resume Simulate token deactivate

Overview Event object List all events List all webhook events Get an event

Overview Settlement report object Schedule a settlement report List all settlement reports Get a settlement report by ID Get a customized bank account statement

Overview Webhook object Create a webhook endpoint List all webhook endpoints Get a webhook endpoint Update a webhook endpoint Delete a webhook endpoint Verify a webhook endpoint List all webhook deliveries List webhook deliveries by event

Overview Document object Upload a document List all documents Get a document

Overview Admin transfer object Get an admin transfer Reclaimed lost wires Check adjustments

Overview Card object Manufacturing details sub-object Shipping details sub-object Create card List cards Get card Update card Activate card Deactivate card Pause card Renew card Replace card Update card PIN Delete card PIN Unblock card PIN Create card reveal token

Overview Card account object Create card account List card accounts Get card account by ID Update card account Close card account Suspend card account Reinstate card account

Card Authorization Policy

Overview Card authorization policy summary object Card authorization policy version object Card authorization policy config sub-object Card spend policy sub-object List card authorization policies Create card authorization policy

Versions

List card authorization policy versions Create card authorization policy version Get card authorization policy version Update card authorization policy version Delete card authorization policy version

Overview Card dispute object Card dispute webhook payload object Check card dispute eligibility Create card dispute List card disputes Get card dispute by ID Submit card dispute Respond to card dispute Add card dispute evidence Close card dispute Issue card dispute provisional credit Remove card dispute provisional credit

Documents

Upload card dispute document Get card dispute document

Overview Card program object List card programs Get card program by ID Update card program

Card Templates

Card template object List card templates

Card Fees

Card program fee object List card program fees Set card program fee Delete card program fee

Card Real-Time Decisioning

Overview Real-time decision request object Real-time decision response object

3DS Authentication

3DS authentication decision request object 3DS authentication decision response object

3DS Webhooks

3DS attempt object 3DS OTP generated webhook payload object 3DS data-only authentication object

Overview Card token object Provisioning decisioning details sub-object Send passcode webhook payload object List card tokens Get card token by ID Activate card token Deactivate card token Pause card token

Card Transaction

Overview Card transaction object Card transaction event object Card transaction webhook payload object List card transactions Get card transaction by ID

Menu

Common workflows

Book Transfers and Holds Overdrafts Two Legged Transactions Going live

Technical guides

Getting Started Sandbox and Testing Reporting KYC/KYB Verifications

Use cases

Payment Origination Bank Accounts Card Programs Loan Origination

Informational guides

Intro to Card Issuing Roles & Permissions API Key Security Bank Statements

Working with the API

Authentication Pagination Idempotency Errors Events and Webhooks

Platform Entity Bank Account Account Number Counterparty Transfer Events and Webhooks

Overview Managing Entities Documentary Evidence

Overview Types Timing Notifications and States Returns Reversals International ACH Transfers

Overview Notifications and States Reversals Return Requests Wire Drawdown Requests

International Wires

Overview Outgoing Transfers Incoming Transfers Notifications and States Transfer Fees Returns Cancellations Tracking Supported Currencies Country-Specific Details Sandbox Simulations

Realtime Payments

Overview Outgoing Transfers Incoming Transfers Returns Notifications and States Request For Payment (RFP)

Overview Issuing, Printing, and Mailing Deposits Lockboxes Notifications and States Returns

Overview Disbursements Payments Sales and Reports

Overview Card Programs Card Accounts Cards Card Authorization Policies Card Transactions Card Fees Real-time Decisioning Card Tokens Card Reveal Card Reveal SDK Versions Card Reveal SDK Changelog Card Disputes Card Sandbox Simulation

Person

Person entity object Create a person entity Update a person entity

Business

Business entity object Create a business entity Update a business entity

General

List all entities Get an entity by ID Delete an entity Get entity compliance Get entity evidence Create entity evidence Get additional requirements Submit additional requirements List associated persons Link an associated person Update associated persons Create evidence with file upload

Narratives

Create an entity narrative List entity narratives Delete an entity narrative

Overview Bank account object Create a new bank account List all bank accounts Get a bank account by ID Update a bank account Add a bank account owner Delete a bank account Bank account overdraft alert object

Summary

Bank account summary object Get bank account summary history

Activities

Activity line item object List bank account activities

Overview Account number object Create a new account number List all account numbers from a bank account Get an account number Update an account number

Overview Loan object Create a new loan List all loans Get a loan by ID Update a loan

Loan Programs

Loan program object List loan programs Get a loan program Update loan program

Loan Summary

Loan summary object Get loan summary history

Disbursements

Loan disbursement object Create a disbursement List all disbursements Get a disbursement Update a disbursement hold Cancel a disbursement hold Clear a disbursement hold

Payments

Loan payment object Create a payment List all payments Get a payment Return a payment Apply collateral

Loan Sales

Loan sale object Create a loan sale List all loan sales Get a loan sale Loan sale summary object Get loan sale summaries for loans available for sale Get loan sale summaries for loans already sold

Overview Counterparty object Create a counterparty List all counterparties Get a counterparty by ID Delete a counterparty IBAN validation object Validate an IBAN

Financial Institutions

Financial institution object List financial institutions Get a financial institution

Overview ACH transfer object IAT transfer sub-object Create an ACH transfer List all ACH transfers Get an ACH transfer Cancel an ACH transfer Clear a held ACH transfer Reverse an ACH transfer

Returns

ACH return object Create an ACH return List all ACH returns Get an ACH return

ACH Positive Pay

Overview ACH positive pay rule object Create an ACH positive pay rule List ACH positive pay rules Get an ACH positive pay rule Delete an ACH positive pay rule

Overview Book transfer object Create a book transfer List all book transfers Get a book transfer Update a book transfer Cancel a book transfer Clear a book transfer

Overview Wire transfer object Create a wire transfer List all wire transfers Get wire transfer Cancel a held outgoing wire transfer Clear a held wire transfer Reverse an incoming wire transfer

Drawdowns

Wire drawdown request object Create a wire drawdown request List all wire drawdown requests Get a wire drawdown request Approve a wire drawdown request

Returns

Wire return request object Create a wire return request List all wire return requests Get a wire return request Approve a wire return request Reject a wire return request

International Wire

Overview International wire transfer object International wire tracking object Create an international wire transfer List all international wire transfers Get international wire transfer Track an international wire transfer Return an incoming international wire Cancel an outgoing international wire Cancel a held international wire transfer Clear a held international wire transfer Create international wire amendment

FX Rate Sheet

FX rate sheet object Get FX rate sheet

FX Quotes

FX quote object Request a foreign exchange quote Get a foreign exchange quote Book a foreign exchange quote Cancel a foreign exchange quote

Realtime Transfer

Overview Realtime transfer object Create a realtime transfer List all realtime transfers Get a realtime transfer Cancel a held realtime transfer Clear a held realtime transfer

RFP

Realtime RFP object Create a realtime RFP List all realtime RFPs Get a realtime RFP Accept a realtime RFP Reject a realtime RFP

Return Requests

Realtime return request object Create a realtime return request List all realtime return requests Get a realtime return request by ID Accept a realtime return request Reject a realtime return request Return a realtime transfer

Overview Check transfer object Issue a check Deposit a check Capture front of check Capture back of check List all check transfers Get a check transfer Get a check preview PDF for an issued transfer Stop a check transfer

Returns

Check return object Create a check return Get check transfer returns List all check returns

Lockboxes

Check lockbox object Create a check lockbox List all check lockboxes Get a check lockbox Delete a check lockbox

Overview List all transfers

ACH

Receive an ACH Credit Receive an ACH Debit Settle ACH transfer

Wires

Receive a wire transfer Receive a wire drawdown request Receive a wire return request Settle wire transfer

International Wires

Receive an international wire

Local Transfers

Realtime

Receive a realtime transfer Receive a realtime RFP (Request for Payment)

Checks

Deposit an issued check Settle check deposit

Card Programs

Create sandbox card program Close sandbox card program

Card Transactions

Simulate card authorization Simulate incremental authorization Simulate capture Simulate full financial transaction Simulate refund Simulate reversal

3DS Authentication

Simulate 3DS authentication Complete simulated 3DS challenge

Card Tokens

Simulate token eligibility check Simulate approve provisioning Simulate device binding Simulate step-up retrieve methods Simulate step-up send passcode Simulate step-up complete Simulate token suspend Simulate token resume Simulate token deactivate

Overview Event object List all events List all webhook events Get an event

Overview Settlement report object Schedule a settlement report List all settlement reports Get a settlement report by ID Get a customized bank account statement

Overview Webhook object Create a webhook endpoint List all webhook endpoints Get a webhook endpoint Update a webhook endpoint Delete a webhook endpoint Verify a webhook endpoint List all webhook deliveries List webhook deliveries by event

Overview Document object Upload a document List all documents Get a document

Overview Admin transfer object Get an admin transfer Reclaimed lost wires Check adjustments

Overview Card object Manufacturing details sub-object Shipping details sub-object Create card List cards Get card Update card Activate card Deactivate card Pause card Renew card Replace card Update card PIN Delete card PIN Unblock card PIN Create card reveal token

Overview Card account object Create card account List card accounts Get card account by ID Update card account Close card account Suspend card account Reinstate card account

Card Authorization Policy

Overview Card authorization policy summary object Card authorization policy version object Card authorization policy config sub-object Card spend policy sub-object List card authorization policies Create card authorization policy

Versions

List card authorization policy versions Create card authorization policy version Get card authorization policy version Update card authorization policy version Delete card authorization policy version

Overview Card dispute object Card dispute webhook payload object Check card dispute eligibility Create card dispute List card disputes Get card dispute by ID Submit card dispute Respond to card dispute Add card dispute evidence Close card dispute Issue card dispute provisional credit Remove card dispute provisional credit

Documents

Upload card dispute document Get card dispute document

Overview Card program object List card programs Get card program by ID Update card program

Card Templates

Card template object List card templates

Card Fees

Card program fee object List card program fees Set card program fee Delete card program fee

Card Real-Time Decisioning

Overview Real-time decision request object Real-time decision response object

3DS Authentication

3DS authentication decision request object 3DS authentication decision response object

3DS Webhooks

3DS attempt object 3DS OTP generated webhook payload object 3DS data-only authentication object

Overview Card token object Provisioning decisioning details sub-object Send passcode webhook payload object List card tokens Get card token by ID Activate card token Deactivate card token Pause card token

Card Transaction

Overview Card transaction object Card transaction event object Card transaction webhook payload object List card transactions Get card transaction by ID

Extended API Access

Enter your password to unlock additional API documentation.

Password

Back to API Reference