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
# | Error | Error Message |
---|---|---|
1 | General Error | We're sorry, there's been an error. Please check your network connection and try again. If it continues, please reach out to [email protected] |
2 | PlaidBalanceCheckFailed | There is an insufficient balance in source account. |
3 | InsufficientBalance | There is an insufficient balance in source banq account. |
4 | TierPlanLimits | We're sorry, the payment exceeds the amount limit for your account |
5 | BlacklistedFingerprint | Error processing this payment. Please reach out to [email protected] |
6 | IsaBalanceIsInsufficient | We're sorry, we are not able to settle this balance. Please try again later |
7 | PlaidRequiresReAuthentication | Plaid requires that you re-link your bank credentials. Please update your Payment Method from the Account Space Manager and try this payment again |
8 | CustodialAccountContactIsNotApproved | Your 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 |
9 | AccountIsFrozen | You 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] |
10 | PaymentMethodWasRemoved | Payment method was removed |
11 | TransferReversed | Transfer Reversed |
12 | ContributionFrozen | We're sorry, this recipient is currently unable to receive payments. Please try again later or contact [email protected] |
13 | FailedPreviousDeposit | Operation failed due to failed deposit |
14 | FailedAssetOperationDueToPrimeTrustErrors | Couldn't process transaction |
15 | DisbursementCancelled | Withdrawal failed, contact [email protected] |
Updated over 3 years ago