updateCardsList

updateCardsList

Overview

This method updates a list of existing cards in a single request. Each card in the list is identified by its card_id.

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 https://api.{{environment}}.catch-e.com/fm/cards https://api.test.catch-e.com/fm/cards

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

Input Fields (JSON)

Send an array of cards. card_id is mandatory for each card; include only the other fields you want to update.

Key

Format

Notes

Mandatory

card_id

string

Yes

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

[ { "card_id": "1234", "expiry_date": "2028-01-31", "status_flag": "active" } ]

Response Details

Success

204 - No Content

The cards were updated successfully. No response body is returned.

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

One or more of the cards do 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" }