Inbound Payments API Overview

The current version of the Open API is geared towards applications receiving payments. Depending on the industry of the integrator, these platforms could range from POS systems that want to allow a store's customers to pay with banq mobile application to a rent collection application that wants to automatically collect recurring rent payments through the banq platform.

Types of Payments

The Open API supports a flexible set payments including:

  • One time real-time payments
  • Recurring payments
  • Scheduled payments

Requesting Payments

Depending on the use case, payments can be requested and interacted with in a variety of ways. POS systems for example may chose to use QR codes for in-person payments and include a payment link on invoices for on online purchases.

Payment requests can be sent via:

  • QR Code
  • Payment Link which can be shared via email, SMS, messaging app, etc
  • In-app request

Payment Sources

End users can make payments from their:

  • banq balance
  • checking account
  • debit card (depending on the merchants industry)

Transaction Fail Reasons

#ErrorError Message
1General ErrorWe're sorry, there's been an error. Please check your network connection and try again. If it continues, please reach out to [email protected]
2PlaidBalanceCheckFailedThere is an insufficient balance in source account.
3InsufficientBalanceThere is an insufficient balance in source banq account.
4TierPlanLimitsWe're sorry, the payment exceeds the amount limit for your account
5BlacklistedFingerprintError processing this payment. Please reach out to [email protected]
6IsaBalanceIsInsufficientWe're sorry, we are not able to settle this balance. Please try again later
7PlaidRequiresReAuthenticationPlaid requires that you re-link your bank credentials. Please update your Payment Method from the Account Space Manager and try this payment again
8CustodialAccountContactIsNotApprovedYour account has not yet been approved for withdrawals. It can take up to 1-3 business days for your account to be approved. Try again soon
9AccountIsFrozenYou must verify your ID to move money out of this account. Please note it can take 1-3 business days for your account to be approved or for your ID to be verified. If you have any questions, reach out to [email protected]
10PaymentMethodWasRemovedPayment method was removed
11TransferReversedTransfer Reversed
12ContributionFrozenWe're sorry, this recipient is currently unable to receive payments. Please try again later or contact [email protected]
13FailedPreviousDepositOperation failed due to failed deposit
14FailedAssetOperationDueToPrimeTrustErrorsCouldn't process transaction
15DisbursementCancelledWithdrawal failed, contact [email protected]

What’s Next

Review the integration flow