updateCard

Overview

This method updates an existing card.

This method requires the Cards:Update permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Cards:Update'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'PUT' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/cards/{card_id} https://api.{{environment}}.catch-e.com/fm/cards/{card_id} https://api.test.catch-e.com/fm/cards/{card_id}

Input Fields (Header)

Key	Format	Notes	Mandatory
Delegated-Locking-Session-Id	string	(Optional) Locking responsibility will be delegated to the specified Session Id. The API will only verify that locks exist for this session id, and will not obtain them itself. Requires the DelegatedLocking permission.	No
Audit-User-Id	string	(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.	No

Path Parameters

Key	Format	Notes	Mandatory
card_id	string	The Card Id. A positive whole number, up to 10 digits, with no leading zeros.	Yes

Input Fields (JSON)

Key	Format	Notes	Mandatory
contract_id	string		No
card_number	string		No
account_number	string		No
supplier_id	string		No
posting_flag	string	Allowed values: `no`, `yes`. Default `yes`.	No
recharge_flag	string	Allowed values: `no`, `yes`. Default `no`.	No
client_id_recharge	string		No
history_only_flag	string	Allowed values: `no`, `yes`. Default `no`.	No
activated_date	string (date)		No
inactivated_date	string (date)		No
expiry_date	string (date)		No
card_sub_status_id	string		No
notes	string		No
status_flag	string	Allowed values: `active`, `inactive`. Default `active`.	No

Example

{ "expiry_date": "2028-01-31", "status_flag": "active", "notes": "string" }

Response Details

Success

200 - OK

Returns the updated card.

Field	Format	Notes
card_id	string
contract_id	string
card_number	string
account_number	string
supplier_id	string
posting_flag	string	Values: `no`, `yes`.
recharge_flag	string	Values: `no`, `yes`.
client_id_recharge	string
history_only_flag	string	Values: `no`, `yes`.
activated_date	string (date)
inactivated_date	string (date)
expiry_date	string (date)
card_sub_status_id	string
notes	string
status_flag	string	Values: `active`, `inactive`.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/cards/1234" } }, "card_id": "1234", "contract_id": "5678", "card_number": "[CARD-NUMBER]", "account_number": "[ACCOUNT-NUMBER]", "supplier_id": "91", "posting_flag": "yes", "recharge_flag": "no", "client_id_recharge": "", "history_only_flag": "no", "activated_date": "2026-01-15", "inactivated_date": "", "expiry_date": "2028-01-31", "card_sub_status_id": "", "notes": "string", "status_flag": "active" }

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
404 - Not Found	The card does not exist.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }