Payments
Business Banking Payments APIs support ACH payments and collections, domestic and international wire payments, and retrieval of payment history and individual payments by identifier.
End-user benefits
- Create ACH Payments and ACH Collections.
- Create domestic wire payments and international wire payments.
- List ACH Payments and ACH Collections.
- List domestic wires and international wires.
- Retrieve a single payment by
paymentIdfor ACH or wire flows.
Integration capabilities
- Create ACH Payments and ACH Collections.
- Create domestic wire payments and international wire payments.
- List ACH Payments and ACH Collections.
- List domestic wires and international wires.
- Retrieve a single payment by
paymentIdfor ACH or wire flows.
Scopes
| Scope | Description |
|---|---|
ach-payments:read | Read ACH Payment details |
ach-payments:write | Create and update ACH Payment details |
wire-payments:read | Read wire payment details |
wire-payments:write | Create and update wire payment details |
Required headers
| Header | Description |
|---|---|
Authorization | Bearer token (V2 authentication) |
correlationId | Unique identifier for request tracking (UUID format) |
Error codes (BBP_*)
| Code | Message | HTTP Status Code |
|---|---|---|
| BBP-126 | Invalid institution Id | 400 |
| BBP-127 | Invalid business Id | 400 |
| BBP-128 | Invalid login Id | 400 |
| BBP-129 | Invalid SEC code | 400 |
| BBP-130 | Invalid transaction | 400 |
| BBP-131 | Invalid JWT | 401 |
| BBP-132 | Invalid role | 401 |
| BBP-133 | Bad request | 400 |
| BBP-133 | Query parameters (fromDate, toDate) are required | 400 |
| BBP-133 | Missing or invalid payment id | 400 |
| BBP-134 | No record exists for the id | 404 |
| BBP-135 | Invalid User. User not found in System | 400 |
| BBP-136 | Invalid payment type | 400 |
| BBP-137 | Invalid payment status | 400 |
| BBP-138 | Invalid payment | 400 |
| BBP-139 | Invalid ACH payment description | 400 |
| BBP-140 | Invalid payment amount | 400 |
| BBP-141 | Invalid ACH CompanyId | 400 |
| BBP-142 | Invalid currency code | 400 |
| BBP-143 | Invalid transaction type | 400 |
| BBP-144 | Invalid account type | 400 |
| BBP-145 | Invalid routing number | 400 |
| BBP-146 | Invalid contact name | 400 |
| BBP-147 | Invalid contact account number | 400 |
| BBP-148 | Invalid originator account number | 400 |
| BBP-149 | Invalid addenda | 400 |
| BBP-150 | Invalid contact identification number | 400 |
| BBP-151 | Invalid delivery date | 400 |
| BBP-152 | Invalid header value for request. | 400 |
| BBP-153 | Invalid contact bank name | 400 |
| BBP-154 | Invalid beneficiary details | 400 |
| BBP-155 | Invalid beneficiary name | 400 |
| BBP-156 | Invalid beneficiary address | 400 |
| BBP-157 | Invalid beneficiary address street | 400 |
| BBP-158 | Invalid beneficiary address city | 400 |
| BBP-159 | Invalid beneficiary address state | 400 |
| BBP-160 | Invalid beneficiary address zip code | 400 |
| BBP-161 | Invalid beneficiary address country | 400 |
| BBP-162 | Invalid purpose of wire | 400 |
| BBP-163 | Invalid beneficiary account number | 400 |
| BBP-164 | Invalid beneficiary instructions | 400 |
| BBP-165 | Invalid beneficiary bank details | 400 |
| BBP-166 | Invalid beneficiary bank name | 400 |
| BBP-167 | Invalid beneficiary routing number | 400 |
| BBP-168 | Invalid beneficiary SWIFT number | 400 |
| BBP-169 | Invalid beneficiary account number | 400 |
| BBP-170 | Invalid beneficiary bank instructions | 400 |
| BBP-171 | Invalid beneficiary bank address 1 | 400 |
| BBP-172 | Invalid beneficiary bank address 2 | 400 |
| BBP-173 | Invalid beneficiary bank address city | 400 |
| BBP-174 | Invalid beneficiary bank address state | 400 |
| BBP-175 | Invalid beneficiary bank address zip code | 400 |
| BBP-176 | Invalid beneficiary bank address country | 400 |
| BBP-177 | Invalid intermediary bank details | 400 |
| BBP-178 | Invalid intermediary bank type | 400 |
| BBP-179 | Invalid intermediary bank account number | 400 |
| BBP-180 | Invalid intermediary bank name | 400 |
| BBP-181 | Invalid intermediary routing number | 400 |
| BBP-182 | Invalid intermediary bank SWIFT number | 400 |
| BBP-183 | Invalid foreign currency amount | 400 |
| BBP-184 | Invalid send in foreign currency | 400 |
| BBP-185 | Invalid payment name | 400 |
Endpoints
Create a Wire Payment
Creates a new domestic or international Wire Payment. **Examples** illustrate requests by payment type (WIRE_DOMESTIC or WIRE_INTERNATIONAL).
Create an ACH Payment
Creates a new ACH Payment or ACH collection. **Examples** illustrate requests by payment type (ACH_COLLECTION or ACH_PAYMENT) and sub-field (SEC code). ACH_PAYMENT uses DEBIT; ACH_COLLECTION uses CREDIT.
Get ACH Payment by Payment ID
Retrieves a single ACH Payment (ACH_PAYMENT or ACH_COLLECTION) by its payment ID.
Get List of ACH Payments
Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to ACH_PAYMENT and/or ACH_COLLECTION; defaults to both when omitted. To get a single payment by ID, use GET /db-bb-payments/bbpayments/v1/ach-payments/{paymentId}.
Get List of Wire Payments
Provide fromDate and toDate (YYYY-MM-DD). Date range may not exceed 30 days. Optional paymentStatus and paymentType (comma-separated) filters. Use paymentType to restrict to WIRE_DOMESTIC and/or WIRE_INTERNATIONAL; defaults to both when omitted. To get a single payment by ID, use GET /db-bb-payments/bbpayments/v1/wire-payments/{paymentId}.
Get Wire Payment by Payment ID
Retrieves a single Wire Payment (WIRE_DOMESTIC or WIRE_INTERNATIONAL) by its payment ID.