Replace the servicing account for card credit contracts

This endpoint updates the servicing account associated with a specified credit contract and is typically used in scenarios such as repayment account re-linking or correcting an incorrectly assigned servicing account. Here, you will learn how to replace (change) the servicing account for card credit contracts.

Use case

In this example, we will demonstrate how to replace the servicing account using the following data.

Use case data	API parameters with values
The headerId is the ID of the contract that will be updated.	...contracts/C001718023916/change-servicing-account
The sourceName indicates the source system, e.g., ACCOUNT.ACCOUNT for account-api.	"SourceName": "ACCOUNT.ACCOUNT"
The sourceRef is the ID of the account in the source system.	"SourceRef": "ID-1026"

Sample API call

To replace the servicing account for card credit contracts, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v1/contracts/C001718023916/change-servicing-account

Learn more about the change servicing account endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

JSON

{
  "servicingAccountSource": {
    "sourceName": "ACCOUNT.ACCOUNT",
    "sourceRef": "ID-1026"
  }
}

cURL

curl -L 'https://card-api.sandbox.tuumplatform.com/api/v1/contracts/C001718023916/change-servicing-account' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiT2ZmaWNlciBUZXN0IiwiZW1wbG95ZWVJZCI6IklELTEyMzgiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHBpcnlEVGltZSI6IjIwMjUtMDctMDJUMTA6NDk6MDkiLCJleHAiOjE3NTE0NTMzNDksInJvbGVzIjpbIkFETUlOIiwiU1lTVEVNIl19.JUBRg2ollm9cC_fzaEidrItMBQVK3tY_KtxUF09L5Ik' \
-H 'Content-Type: application/json' \
-d '{
  "servicingAccountSource": {
    "sourceName": "ACCOUNT.ACCOUNT",
    "sourceRef": "ID-1026"
  }
}'

Sample response

Below you will find the response to the API request:

Response

{
    "errors": null,
    "validationErrors": null,
    "data": null
}

Result

The API call's outcome is that the previous servicing account was replaced with currency account ID-1026 in the Tuum account API.

Troubleshooting

Here are some tips to help you address the most common errors.

Error message	Possible resolution
Contract header was not found.	Please ensure you are using a valid contract ID.
Contract in wrong status. Servicing account cannot be updated.	Please ensure the contract status is ACTIVE, BLOCKED, or DEFAULT.
Current servicing account has active event requests.	Please wait until the current servicing account has no active event requests.
Servicing account change is not allowed.	Please ensure that the service_account_rule_code for the new servicing account is set to CURRENT_ACCOUNT.
The source name/reference cannot be empty.	Please ensure that the parameters sourceName and sourceRef have assigned values.