OpenAPI specification
Release: ActiveSingle operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
Loading, please wait…
Retrieve bank accounts.
/v1/funds/{partyId}/baas/bank-accounts/inquiryUse this endpoint to retrieve the direct deposit information associated with the cardholder. ❗️ Requirement A successful response will only be returned if at least one payout has been completed for this user. This rule was put in place by banking service to prevent bad actors from signing up as gig workers with our partners as a means of obtaining a banking service account to leverage the direct deposit functionality in order to receive large 3rd party deposits. 📘 Recommendation To avoid a frictional experience for the user, we recommend the integrating partner to hide the option of viewing the Direct Deposit Information until at least one "Instant Pay" has been completed.
Showing 6 of 6 top-level parameters (6 total fields) for Bank Accounts Inquiry
partyIdRequiredstringpathThe UUID of the Payfare (banking service) user.
Api-KeyRequiredstringheaderCommerceHub API key. Use the same value as the first part of the HMAC signing input.
Auth-Token-TypeRequiredstringheaderIdentifies the CommerceHub HMAC authentication scheme.
Available enum values
Selecting a value updates the request header.
Client-Request-IdRequiredstringheaderFresh client request identifier included in the HMAC signing input. Generate a new identifier for every request, for example using String(Date.now()). Use exactly the same value in the header and signature; this does not establish an idempotency or retry guarantee.
TimestampRequiredstringheaderRequest time as a 13-digit Unix timestamp in milliseconds, generated using String(Date.now()). Use exactly this value in the HMAC signing input. Accepted clock skew awaits confirmation.
AuthorizationRequiredstringheaderBase64(HMAC-SHA-256(apiSecret, apiKey + clientRequestId + timestamp)), without a prefix. Use exactly the values sent in the corresponding headers.
Request
Bank Accounts InquiryResponse
Top-level fields returned in a successful (200) response.
statusstringThe status field.
messagestringThe message field.
dataobjectThe data field.
curl --request GET 'https://cert.api.fiservapps.com/ch/v1/funds/{partyId}/baas/bank-accounts/inquiry' \
--header 'Api-Key: YOUR_API_KEY' \
--header 'Auth-Token-Type: HMAC' \
--header 'Client-Request-Id: YOUR_CLIENT_REQUEST_ID' \
--header 'Timestamp: YOUR_TIMESTAMP' \
--header 'Authorization: YOUR_BASE64_SIGNATURE' \
--header 'Accept: application/json'Standard HTTP error reference. Not every status applies to every operation.
| HTTP | Meaning | Guidance |
|---|---|---|
| 400 | Bad Request | Check the URL parameters, headers, and request payload. |
| 401 | Unauthorized | Verify the API key, HMAC signature, request ID, and timestamp. |
| 403 | Forbidden | Verify access to the requested service and resource. |
| 404 | Not Found | Check the endpoint and resource identifiers. |
| 409 | Conflict | Check the current resource state before repeating the operation. |
| 422 | Unprocessable Content | Review the returned validation details and correct the request. |
| 429 | Too Many Requests | Respect Retry-After when present; confirm retry safety before resending mutations. |
| 500 | Internal Server Error | Record the response and request identifier; confirm the outcome before retrying a mutation. |
| 502 | Bad Gateway | An upstream response failed. Confirm the outcome before retrying a mutation. |
| 503 | Service Unavailable | Respect Retry-After when present and confirm the outcome before retrying a mutation. |
| 504 | Gateway Timeout | The upstream response timed out. Check the operation outcome before resending. |
Single operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
No Postman workflow is mapped to this operation. No product-wide collection is substituted.
QA collections: Configure your environment and credentials before running. Some requests create resources or move funds.