Getbankverificationpdf 1 endpoints

GET /statements/{accountId}/bank/pdf Get Bank verification PDF

Get Get Bank verification PDF from API

operationId: GetBankVerificationPdf_fromApi

Parameters

Name	In	Required	Type	Description
accountId	path	required	string	ID of the account to get

Responses

200

Successful Response

GET /statements/{accountId}/bank/pdf

Getcard 1 endpoints

GET /cards/{cardId} Get Card by Id

Get a Card from API

operationId: GetCard_byId

Parameters

Name	In	Required	Type	Description
cardId	path	required	string	ID of the card to get
included	query	optional	string	—

Responses

200

Successful Response

GET /cards/{cardId}

Getcardlimits 1 endpoints

GET /cards/{cardId}/limits Get Card Limit by Id

Get a Card Limits from API

operationId: GetCardLimits_byId

Parameters

Name	In	Required	Type	Description
cardId	path	required	string	ID of the card to get

Responses

200

Successful Response

GET /cards/{cardId}/limits

Getcardpinstatus 1 endpoints

GET /cards/{cardId}/secure-data/pin/status Get Card PIN Status

Get Card PIN Status via API

operationId: GetCardPinStatus_pinStatus

Parameters

Name	In	Required	Type	Description
cardId	path	required	string	ID of the card to get PIN status

Responses

200

Successful Response

GET /cards/{cardId}/secure-data/pin/status

Getcheckdeposit 1 endpoints

GET /check-deposits/{checkDepositId} Get Check Deposit by Id

Get a Check Deposit from API

operationId: GetCheckDeposit_byId

Parameters

Name	In	Required	Type	Description
checkDepositId	path	required	string	ID of the check deposit to get

Responses

200

Successful Response

GET /check-deposits/{checkDepositId}

Getcheckdepositbackimage 1 endpoints

GET /check-deposits/{checkDepositId}/back Get Back Check Deposit Image by Id

Get Back Check Deposit Image from API

operationId: GetCheckDepositBackImage_byId

Parameters

Name	In	Required	Type	Description
checkDepositId	path	required	string	ID of the check deposit to get

Responses

200

Successful Response

GET /check-deposits/{checkDepositId}/back

Getcheckdepositfrontimage 1 endpoints

GET /check-deposits/{checkDepositId}/front Get Front Check Deposit Image by Id

Get Front Check Deposit Image from API

operationId: GetCheckDepositFrontImage_byId

Parameters

Name	In	Required	Type	Description
checkDepositId	path	required	string	ID of the check deposit to get

Responses

200

Successful Response

GET /check-deposits/{checkDepositId}/front

Getcheckpayment 1 endpoints

GET /check-payments/{checkPaymentId} Get Check Payment by Id

Get a Check Payment from API

operationId: GetCheckPayment_byId

Parameters

Name	In	Required	Type	Description
checkPaymentId	path	required	string	ID of the check payment to get

Responses

200

Successful Response

GET /check-payments/{checkPaymentId}

Getcounterparty 1 endpoints

GET /counterparties/{counterpartyId} Get Counterparty by Id

Get a Counterparty from API

operationId: GetCounterparty_byId

Parameters

Name	In	Required	Type	Description
counterpartyId	path	required	string	ID of the counterparty to get
included	query	optional	string	—

Responses

200

Successful Response

GET /counterparties/{counterpartyId}

Getcounterpartybalance 1 endpoints

GET /counterparties/{counterpartyId}/balance Get Counterparty Balance

Get Recurring Payment from API

operationId: GetCounterpartyBalance_recurringPaymentFromApi

Parameters

Name	In	Required	Type	Description
counterpartyId	path	required	string	ID of the counterparty to get

Responses

200

Successful Response

GET /counterparties/{counterpartyId}/balance

Getcustomer 1 endpoints

GET /customers/{customerId} Get Customer by Id

Get a Customer from API

operationId: GetCustomer_byId

Parameters

Name	In	Required	Type	Description
customerId	path	required	string	ID of the customer to get

Responses

200

Successful Response

GET /customers/{customerId}

Getdispute 1 endpoints

GET /disputes/{disputeId} Get Dispute by Id

Get a Dispute from API

operationId: GetDispute_byId

Parameters

Name	In	Required	Type	Description
disputeId	path	required	string	ID of the dispute to get

Responses

200

Successful Response

GET /disputes/{disputeId}

Getevent 1 endpoints

GET /events/{eventId} Get Event by Id

Get an Event from API

operationId: GetEvent_byId

Parameters

Name	In	Required	Type	Description
eventId	path	required	string	ID of the event to get

Responses

200

Successful Response

GET /events/{eventId}

Getinstitution 1 endpoints

GET /institutions/{routingNumber} Get Institution by Routing Number

Get an Institution from API

operationId: GetInstitution_byRoutingNumber

Parameters

Name	In	Required	Type	Description
routingNumber	path	required	string	routingNumber of the institution to get

Responses

200

Successful Response

GET /institutions/{routingNumber}

Getlistaccountendofdaybalanceshistory 1 endpoints

GET /account-end-of-day Get AccountEndOfDay List

Get AccountEndOfDay List from API

operationId: GetListAccountEndofdayBalancesHistory_fromApi

Responses

default —

200

Successful Response

GET /account-end-of-day

Getlistaccounts 1 endpoints

GET /accounts Get List Accounts

Get List Accounts from API

operationId: GetListAccounts_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
include	query	optional	string	—

Responses

200

Successful Response

401

UnitError

GET /accounts

Getlistapplicationforms 1 endpoints

GET /application-forms Get List Application Forms

Get List Application Forms from API

operationId: GetListApplicationForms_viaApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /application-forms

Getlistapplications 1 endpoints

GET /applications Get List Application

Get List Applications from API

operationId: GetListApplications_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—

Responses

default

Unexpected error

200

Successful Response

GET /applications

Getlistauthorizationrequests 1 endpoints

GET /authorization-requests Get List Authorization Requests

Get List Authorization Requests from API

operationId: GetListAuthorizationRequests_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—

Responses

200

Successful Response

GET /authorization-requests

Getlistauthorizations 1 endpoints

GET /authorizations Get List authorizations

Get List Authorizations from API

operationId: GetListAuthorizations_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /authorizations

Getlistcheckdeposits 1 endpoints

GET /check-deposits Get List Check Deposits

Get List Check Deposits from API

operationId: GetListCheckDeposits_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—
include	query	optional	string	—

Responses

200

Successful Response

GET /check-deposits

Getlistcheckpayments 1 endpoints

GET /check-payments Get List Check Payments

Get List Check Payments from API

operationId: GetListCheckPayments_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—
include	query	optional	string	—

Responses

200

Successful Response

GET /check-payments

Getlistcounterparties 1 endpoints

GET /counterparties Get Counterparties List

Get Counterparties List from API

operationId: GetListCounterparties_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /counterparties

Getlistcustomers 1 endpoints

GET /customers Get Customers List

Get Customers List from API

operationId: GetListCustomers_apiList

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /customers

Getlistdisputes 1 endpoints

GET /disputes Get List Disputes

Get List Disputes from API

operationId: GetListDisputes_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—

Responses

200

Successful Response

GET /disputes

Getlistevents 1 endpoints

GET /events Get Events List

Get Events List from API

operationId: GetListEvents_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—

Responses

200

Successful Response

GET /events

Getlistofcards 1 endpoints

GET /cards Get List of Cards

Get List of Cards from API

operationId: GetListOfCards_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional	object	—
filter	query	optional	object	—
include	query	optional	string	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /cards

Getlistofdocuments 1 endpoints

GET /applications/{applicationId}/documents Get List of Documents

Get List of Documents via API

operationId: GetListOfDocuments_viaApi

Parameters

Name	In	Required	Type	Description
applicationId	path	required	string	ID of the application to get documents for

Responses

200

Successful Response

GET /applications/{applicationId}/documents

Getlistorgapitokens 1 endpoints

GET /users/{userId}/api-tokens Get List Org API Tokens

Get List Org API Tokens from API

operationId: GetListOrgApiTokens_fromApi

Parameters

Name	In	Required	Type	Description
userId	path	required	string	ID of the user to revoke token

Responses

200

Successful Response

GET /users/{userId}/api-tokens

Getlistpayments 1 endpoints

GET /payments Get List Payments

Get List Payments from API

operationId: GetListPayments_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
include	query	optional	string	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /payments

Getlistrecurringpayments 1 endpoints

GET /recurring-payments Get Recurring Payments List

Get Recurring Payments List from API

operationId: GetListRecurringPayments_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /recurring-payments

Getlistrepayments 1 endpoints

GET /repayments Get List Repayments

Get List Repayments from API

operationId: GetListRepayments_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—

Responses

200

Successful Response

401 —

GET /repayments

Getlistrewards 1 endpoints

GET /rewards Get Rewards List

Get Rewards List from API

operationId: GetListRewards_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—
include	query	optional	string	—

Responses

200

Successful Response

GET /rewards

Getliststatements 1 endpoints

GET /statements Get List Statements

Get List Statements from API

operationId: GetListStatements_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /statements

Getlisttransactions 1 endpoints

GET /transactions Get List Transactions

Get List Transactions from API

operationId: GetListTransactions_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—
include	query	optional	string	—

Responses

200

Successful Response

GET /transactions

Getlistwebhooks 1 endpoints

GET /webhooks Get List Webhooks

Get List Webhooks from API

operationId: GetListWebhooks_fromApi

Parameters

Name	In	Required	Type	Description
page	query	optional		—
filter	query	optional	object	—
sort	query	optional	string	—

Responses

200

Successful Response

GET /webhooks

Getpayment 1 endpoints

GET /payments/{paymentId} Get Payment by Id

Get a Payment from API

operationId: GetPayment_byId

Parameters

Name	In	Required	Type	Description
paymentId	path	required	string	ID of the payment to get
included	query	optional	string	—

Responses

200

Successful Response

GET /payments/{paymentId}

Getreceivedpayment 1 endpoints

GET /received-payments/{paymentId} Get Received Payment by Id

Get a Received Payment from API

operationId: GetReceivedPayment_byId

Parameters

Name	In	Required	Type	Description
paymentId	path	required	string	ID of the payment to get
included	query	optional	string	—

Responses

200

Successful Response

GET /received-payments/{paymentId}

Getreceivedpaymentslist 1 endpoints

GET /received-payments Get Received Payments List

Get Received Payments from API

operationId: GetReceivedPaymentsList_fromApi

Parameters

Name	In	Required	Type	Description
included	query	optional	string	—

Responses

200

Successful Response

GET /received-payments

Getrecurringpayment 1 endpoints

GET /recurring-payments/{paymentId} Get Recurring Payment

Get Recurring Payment from API

operationId: GetRecurringPayment_byId

Parameters

Name	In	Required	Type	Description
paymentId	path	required	string	ID of the payment to get

Responses

200

Successful Response

GET /recurring-payments/{paymentId}

Getrepayment 1 endpoints

GET /repayments/{repaymentId} Get Repayment by Id

Get an Repayment from API

operationId: GetRepayment_byId

Parameters

Name	In	Required	Type	Description
repaymentId	path	required	string	ID of the repayment to get
include	query	optional	string	—

Responses

200

Successful Response

GET /repayments/{repaymentId}

Getreward 1 endpoints

GET /rewards/{rewardId} Get Reward by Id

Get a Reward from API

operationId: GetReward_byId

Parameters

Name	In	Required	Type	Description
rewardId	path	required	string	ID of the reward to get

Responses

200

Successful Response

GET /rewards/{rewardId}

Getstatementhtml 1 endpoints

GET /statements/{statementId}/html Get HTML Statement by Id

Get a HTML Statement from API

operationId: GetStatementHtml_byId

Parameters

Name	In	Required	Type	Description
statementId	path	required	string	ID of the statement to get

Responses

200

Successful Response

GET /statements/{statementId}/html

Getstatementpdf 1 endpoints

GET /statements/{statementId}/pdf Get PDF Statement by Id

Get a PDF Statement from API

operationId: GetStatementPdf_byId

Parameters

Name	In	Required	Type	Description
statementId	path	required	string	ID of the statement to get

Responses

200

Successful Response

GET /statements/{statementId}/pdf

Gettransaction 1 endpoints

GET /accounts/{accountId}/transactions/{transactionId} Get Transaction by Id

Get a Transaction from API

operationId: GetTransaction_byId

Parameters

Name	In	Required	Type	Description
accountId	path	required	string	ID of the account to get transaction from
transactionId	path	required	string	ID of the transaction

Responses

200

Successful Response

GET /accounts/{accountId}/transactions/{transactionId}

Getwebhook 1 endpoints

GET /webhooks/{webhookId} Get Webhook Id

Get a Webhook from API

operationId: GetWebhook_byId

Parameters

Name	In	Required	Type	Description
webhookId	path	required	string	ID of the webhook to get

Responses

200

Successful Response

GET /webhooks/{webhookId}

Reopenanaccount 1 endpoints

POST /accounts/{accountId}/reopen Reopen an Account by Id

Reopen an Account via API

operationId: ReopenAnAccount_byId

Parameters

Name	In	Required	Type	Description
accountId	path	required	string	ID of the account to close

Responses

default —

200

Successful Response

POST /accounts/{accountId}/reopen

Reportcardaslost 1 endpoints

POST /cards/{cardId}/report-lost Report lost as stolen

Report lost as stolen via API

operationId: ReportCardAsLost_viaApi

Parameters

Name	In	Required	Type	Description
cardId	path	required	string	ID of the card

Responses

200

Successful Response

POST /cards/{cardId}/report-lost

Reportcardasstolen 1 endpoints

POST /cards/{cardId}/report-stolen Report card as stolen

Report card as stolen via API

operationId: ReportCardAsStolen_viaApi

Parameters

Name	In	Required	Type	Description
cardId	path	required	string	ID of the card

Responses

200

Successful Response

POST /cards/{cardId}/report-stolen

Returncheckpayment 1 endpoints

POST /check-payments/{checkPaymentId}/return Return Check Payment by Id

Return a Check Payment via API

operationId: ReturnCheckPayment_byId

Parameters

Name	In	Required	Type	Description
checkPaymentId	path	required	string	ID of the check payment to return

Request Body

required

Return Check Payment Request

application/vnd.api+json

schema ReturnCheckPaymentByIdRequest

Property	Type	Required
data	object	optional
└ type	string	optional
└ attributes	object	optional
└ reason	string	optional

Responses

200

Successful Response

POST /check-payments/{checkPaymentId}/return