OpenAPI specification
Release: ActiveSingle operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
Loading, please wait…
Manage party payout tender.
/ch/v1/party/tenderUse this API to facilitate processing parties boarding configuration.
Showing 8 of 8 top-level parameters (17 total fields) for Add payout tender
Client-Request-IdRequiredstringheaderUnique request correlation identifier used in HMAC signing.
TimestampRequiredstringheaderUnix epoch timestamp in milliseconds used in HMAC signing.
Auth-Token-TypeRequiredstringheaderAuthentication mechanism used by the request.
Available enum values
Selecting a value updates the request header.
AuthorizationRequiredstringheaderBase64 HMAC-SHA-256 signature; no prefix.
partyIdRequiredstringThe party ID for which the payout product is to be added or updated
operationTypeRequiredstringThe operationType field.
Available enum values
Selecting a value updates the request body.
partyTenderobjectRequired fields vary by operationType: - VERIFY: product, account - CREATE: product, token (with tokenData, tokenSource, sourceType) except EMFIWALLET, which may omit token and token child fields - UPDATE: tenderId only - REPLACE: tenderId only - DELETE: tenderId only Country is supplied via the address.country field (ISO 3166-1 alpha-3).
transactionDetailsobjectThe transactionDetails field.
Request
Add payout tenderResponse
Top-level fields returned in a successful (201) response.
gatewayResponseobjectGateway response and transaction state. Use transactionId or apiTraceId to track asynchronous completion.
partyTenderobjectRequired fields vary by operationType: - VERIFY: product, account - CREATE: product, token (with tokenData, tokenSource, sourceType) except EMFIWALLET, which may omit token and token child fields - UPDATE: tenderId only - REPLACE: tenderId only - DELETE: tenderId only Country is supplied via the address.country field (ISO 3166-1 alpha-3).
partyIdstringThe party ID for which the payout product was added or updated.
curl --request POST 'https://connect-cert.fiservapis.net/ch/v1/party/tender' \
--header 'Client-Request-Id: <Client-Request-Id>' \
--header 'Timestamp: <Timestamp>' \
--header 'Auth-Token-Type: HMAC' \
--header 'Authorization: YOUR_BASE64_HMAC_SIGNATURE' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"partyId": "100000000010001",
"operationType": "CREATE",
"partyTender": {
"product": "POACH",
"nickName": "My Checking",
"currency": "USD",
"isDefault": true,
"token": {
"tokenData": "<vault-token>",
"tokenSource": "FISERV_SECURE_VAULT",
"sourceType": "PaymentToken"
}
},
"transactionDetails": {
"merchantTransactionId": "TXN-1790790104668"
}
}'| HTTP | Description |
|---|---|
| 400 | The request is invalid. |
| 401 | Authentication failed or credentials are missing. |
| 404 | The requested resource was not found. |
| 408 | The request timed out. |
| 415 | The request media type is unsupported. |
| 425 | The request was sent too early. |
| 429 | The request rate limit was exceeded. |
| 500 | An unexpected server error occurred. |
| 503 | The service is temporarily unavailable. |
| 504 | The upstream service timed out. |
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.