DocsDocumentation
⌘K

Suggested Guides

GuidesAPI Reference
Home
Guides
Overview
Common workflows
Book Transfers and HoldsOverdraftsTwo Legged TransactionsGoing live
Technical guides
Getting StartedSandbox and TestingReportingKYC/KYB Verifications
Use cases
Payment OriginationBank AccountsLoan Origination
Informational guides
Roles & PermissionsBank Statements
Working with the API
AuthenticationPaginationIdempotencyErrorsEvents and Webhooks
Data Models
PlatformEntityBank AccountAccount NumberCounterpartyTransferEvents and Webhooks
Entities
OverviewManaging EntitiesDocumentary Evidence
ACH
OverviewTypesTimingNotifications and StatesReturnsReversalsInternational ACH Transfers
Domestic Wire
OverviewNotifications and StatesReversalsReturn RequestsWire Drawdown Requests
International Wires
OverviewOutgoing TransfersIncoming TransfersNotifications and StatesTransfer FeesReturnsCancellationsTrackingSupported CurrenciesCountry-Specific DetailsSandbox Simulations
Realtime Payments
OverviewOutgoing TransfersIncoming TransfersReturnsNotifications and StatesRequest For Payment (RFP)
Checks
OverviewIssuing, Printing, and MailingDepositsNotifications and StatesReturns
Loans
OverviewDisbursementsPaymentsSales and Reports
API Reference
Entity
Overview
Person
Person entity objectCreate a person entityUpdate a person entity
Business
Business entity objectCreate a business entityUpdate a business entity
General
List all entitiesGet an entity by IDDelete an entityGet entity complianceGet entity evidenceCreate third party evidenceGet additional requirementsSubmit additional requirementsList associated personsLink an associated personUpdate associated personsCreate evidence with file upload
Bank Account
OverviewBank account objectCreate a new bank accountList all bank accountsGet a bank account by IDUpdate a bank accountAdd a bank account ownerDelete a bank accountBank account overdraft alert object
Summary
Bank account summary objectGet bank account summary history
Account Number
OverviewAccount number objectCreate a new account numberList all account numbers from a bank accountGet an account numberUpdate an account number
Loans
OverviewLoan objectCreate a new loanList all loansGet a loan by IDUpdate a loan
Loan Programs
Loan program objectList loan programsGet a loan programUpdate loan program
Loan Summary
Loan summary objectGet loan summary history
Disbursements
Loan disbursement objectCreate a disbursementList all disbursementsGet a disbursementUpdate a disbursement holdCancel a disbursement holdClear a disbursement hold
Payments
Loan payment objectCreate a paymentList all paymentsGet a paymentReturn a payment
Loan Sales
Loan sale objectCreate a loan saleList all loan salesGet a loan saleLoan sale summary objectGet loan sale summaries for loans available for saleGet loan sale summaries for loans already sold
Counterparty
OverviewCounterparty objectCreate a counterpartyList all counterpartiesGet a counterparty by IDDelete a counterpartyIBAN validation objectValidate an IBAN
Financial Institutions
Financial institution objectList financial institutionsGet a financial institution
ACH Transfer
OverviewACH transfer objectIAT transfer sub-objectCreate an ACH transferList all ACH transfersGet an ACH transferCancel an ACH transferReverse an ACH transfer
Returns
ACH return objectCreate an ACH returnList all ACH returnsGet an ACH return
ACH Positive Pay
OverviewACH positive pay rule objectCreate an ACH positive pay ruleList ACH positive pay rulesGet an ACH positive pay ruleDelete an ACH positive pay rule
Book Transfer
OverviewBook transfer objectCreate a book transferList all book transfersGet a book transferUpdate a book transferCancel a book transferClear a book transfer
Wire Transfer
OverviewWire transfer objectCreate a wire transferList all wire transfersGet wire transferReverse an incoming wire transfer
Drawdowns
Wire drawdown request objectCreate a wire drawdown requestList all wire drawdown requestsGet a wire drawdown requestApprove a wire drawdown request
Returns
Wire return request objectCreate a wire return requestList all wire return requestsGet a wire return requestApprove a wire return requestReject a wire return request
International Wire
OverviewInternational wire transfer objectInternational wire tracking objectCreate an international wire transferList all international wire transfersGet international wire transferTrack an international wire transferReturn an incoming international wireCancel an outgoing international wireCreate international wire amendment
FX Rate Sheet
FX rate sheet objectGet FX rate sheet
FX Quotes
FX quote objectRequest a foreign exchange quoteGet a foreign exchange quoteBook a foreign exchange quoteCancel a foreign exchange quote
Realtime Transfer
OverviewRealtime transfer objectCreate a realtime transferList all realtime transfersGet a realtime transfer
RFP
Realtime RFP objectCreate a realtime RFPList all realtime RFPsGet a realtime RFPAccept a realtime RFPReject a realtime RFP
Return Requests
Realtime return request objectCreate a realtime return requestList all realtime return requestsGet a realtime return request by IDAccept a realtime return requestReject a realtime return requestReturn a realtime transfer
Check Transfer
OverviewCheck transfer objectIssue a checkDeposit a checkCapture front of checkCapture back of checkList all check transfersGet a check transferGet a check preview PDF for an issued transferStop a check transfer
Returns
Check return objectCreate a check returnGet check transfer returnsList all check returns
Transfer
OverviewList all transfers
Simulation
Overview
ACH
Receive an ACH CreditReceive an ACH DebitSettle ACH transfer
Wires
Receive a wire transferReceive a wire drawdown requestReceive a wire return requestSettle wire transfer
International Wires
Receive an international wire
Realtime
Receive a realtime transferReceive a realtime RFP (Request for Payment)
Checks
Deposit an issued checkSettle check deposit
Events
OverviewEvent objectList all eventsList all webhook eventsGet an event
Reporting
OverviewSettlement report objectSchedule a settlement reportList all settlement reportsGet a settlement report by IDGet a customized bank account statement
Webhooks
OverviewWebhook objectCreate a webhook endpointList all webhook endpointsGet a webhook endpointUpdate a webhook endpointDelete a webhook endpointVerify a webhook endpointList all webhook deliveriesList webhook deliveries by event
Documents
OverviewDocument objectUpload a documentList all documentsGet a document
Menu
Home
Guides
Overview
Common workflows
Book Transfers and HoldsOverdraftsTwo Legged TransactionsGoing live
Technical guides
Getting StartedSandbox and TestingReportingKYC/KYB Verifications
Use cases
Payment OriginationBank AccountsLoan Origination
Informational guides
Roles & PermissionsBank Statements
Working with the API
AuthenticationPaginationIdempotencyErrorsEvents and Webhooks
Data Models
PlatformEntityBank AccountAccount NumberCounterpartyTransferEvents and Webhooks
Entities
OverviewManaging EntitiesDocumentary Evidence
ACH
OverviewTypesTimingNotifications and StatesReturnsReversalsInternational ACH Transfers
Domestic Wire
OverviewNotifications and StatesReversalsReturn RequestsWire Drawdown Requests
International Wires
OverviewOutgoing TransfersIncoming TransfersNotifications and StatesTransfer FeesReturnsCancellationsTrackingSupported CurrenciesCountry-Specific DetailsSandbox Simulations
Realtime Payments
OverviewOutgoing TransfersIncoming TransfersReturnsNotifications and StatesRequest For Payment (RFP)
Checks
OverviewIssuing, Printing, and MailingDepositsNotifications and StatesReturns
Loans
OverviewDisbursementsPaymentsSales and Reports
API Reference
Entity
Overview
Person
Person entity objectCreate a person entityUpdate a person entity
Business
Business entity objectCreate a business entityUpdate a business entity
General
List all entitiesGet an entity by IDDelete an entityGet entity complianceGet entity evidenceCreate third party evidenceGet additional requirementsSubmit additional requirementsList associated personsLink an associated personUpdate associated personsCreate evidence with file upload
Bank Account
OverviewBank account objectCreate a new bank accountList all bank accountsGet a bank account by IDUpdate a bank accountAdd a bank account ownerDelete a bank accountBank account overdraft alert object
Summary
Bank account summary objectGet bank account summary history
Account Number
OverviewAccount number objectCreate a new account numberList all account numbers from a bank accountGet an account numberUpdate an account number
Loans
OverviewLoan objectCreate a new loanList all loansGet a loan by IDUpdate a loan
Loan Programs
Loan program objectList loan programsGet a loan programUpdate loan program
Loan Summary
Loan summary objectGet loan summary history
Disbursements
Loan disbursement objectCreate a disbursementList all disbursementsGet a disbursementUpdate a disbursement holdCancel a disbursement holdClear a disbursement hold
Payments
Loan payment objectCreate a paymentList all paymentsGet a paymentReturn a payment
Loan Sales
Loan sale objectCreate a loan saleList all loan salesGet a loan saleLoan sale summary objectGet loan sale summaries for loans available for saleGet loan sale summaries for loans already sold
Counterparty
OverviewCounterparty objectCreate a counterpartyList all counterpartiesGet a counterparty by IDDelete a counterpartyIBAN validation objectValidate an IBAN
Financial Institutions
Financial institution objectList financial institutionsGet a financial institution
ACH Transfer
OverviewACH transfer objectIAT transfer sub-objectCreate an ACH transferList all ACH transfersGet an ACH transferCancel an ACH transferReverse an ACH transfer
Returns
ACH return objectCreate an ACH returnList all ACH returnsGet an ACH return
ACH Positive Pay
OverviewACH positive pay rule objectCreate an ACH positive pay ruleList ACH positive pay rulesGet an ACH positive pay ruleDelete an ACH positive pay rule
Book Transfer
OverviewBook transfer objectCreate a book transferList all book transfersGet a book transferUpdate a book transferCancel a book transferClear a book transfer
Wire Transfer
OverviewWire transfer objectCreate a wire transferList all wire transfersGet wire transferReverse an incoming wire transfer
Drawdowns
Wire drawdown request objectCreate a wire drawdown requestList all wire drawdown requestsGet a wire drawdown requestApprove a wire drawdown request
Returns
Wire return request objectCreate a wire return requestList all wire return requestsGet a wire return requestApprove a wire return requestReject a wire return request
International Wire
OverviewInternational wire transfer objectInternational wire tracking objectCreate an international wire transferList all international wire transfersGet international wire transferTrack an international wire transferReturn an incoming international wireCancel an outgoing international wireCreate international wire amendment
FX Rate Sheet
FX rate sheet objectGet FX rate sheet
FX Quotes
FX quote objectRequest a foreign exchange quoteGet a foreign exchange quoteBook a foreign exchange quoteCancel a foreign exchange quote
Realtime Transfer
OverviewRealtime transfer objectCreate a realtime transferList all realtime transfersGet a realtime transfer
RFP
Realtime RFP objectCreate a realtime RFPList all realtime RFPsGet a realtime RFPAccept a realtime RFPReject a realtime RFP
Return Requests
Realtime return request objectCreate a realtime return requestList all realtime return requestsGet a realtime return request by IDAccept a realtime return requestReject a realtime return requestReturn a realtime transfer
Check Transfer
OverviewCheck transfer objectIssue a checkDeposit a checkCapture front of checkCapture back of checkList all check transfersGet a check transferGet a check preview PDF for an issued transferStop a check transfer
Returns
Check return objectCreate a check returnGet check transfer returnsList all check returns
Transfer
OverviewList all transfers
Simulation
Overview
ACH
Receive an ACH CreditReceive an ACH DebitSettle ACH transfer
Wires
Receive a wire transferReceive a wire drawdown requestReceive a wire return requestSettle wire transfer
International Wires
Receive an international wire
Realtime
Receive a realtime transferReceive a realtime RFP (Request for Payment)
Checks
Deposit an issued checkSettle check deposit
Events
OverviewEvent objectList all eventsList all webhook eventsGet an event
Reporting
OverviewSettlement report objectSchedule a settlement reportList all settlement reportsGet a settlement report by IDGet a customized bank account statement
Webhooks
OverviewWebhook objectCreate a webhook endpointList all webhook endpointsGet a webhook endpointUpdate a webhook endpointDelete a webhook endpointVerify a webhook endpointList all webhook deliveriesList webhook deliveries by event
Documents
OverviewDocument objectUpload a documentList all documentsGet a document

Loans

Get a loan program

GET/loans/programs/{loan_program_id}

Retrieve a single loan program by its ID.

Path Parameters

loan_program_id

stringRequired

Unique identifier for the loan program.

Previous
List loan programs
Next
Update loan program