POST/cards/{cardId}/atm

Enable or Disable ATM

Enables or disables ATM usage for an Active card. Independent of suspend. Idempotent.

bash

curl -X POST "{{baseUrl}}/cards/{{cardId}}/atm" \
  -H "session-token: {{sessionToken}}" \
  -H "Content-Type: application/json" \
  -d "{\"AtmEnabled\": false}"

Path variables

Field	Type	Required	Possible values	Description
`cardId`	string	Required	55d0c52f-79ee-4d38-acf4-a16c07957898	Card reference ID from list cards.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`AtmEnabled`	boolean	Required	true \| false	`true` = enable ATM; `false` = disable.

Example request

{
  "AtmEnabled": false
}

{
  "AtmEnabled": false
}

Only Active cards. Independent of suspend. Idempotent. Request body must use PascalCase (`AtmEnabled`); camelCase is not accepted.

Additional info

Field	Type	Required	Possible values	Description
`Request — enable ATM`	object	Optional	—	Body to enable ATM usage.
`200 — Enable success`	object	Optional	—	Successful enable response.
`400 — Card not Active`	object	Optional	—	ATM usage can only be changed for Active cards.

Example— Request — enable ATM

{
  "AtmEnabled": true
}

{
  "AtmEnabled": true
}

Example— 200 — Enable success

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CardId": "55d0c52f-79ee-4d38-acf4-a16c07957898",
    "AtmEnabled": true,
    "Message": "ATM usage enabled successfully"
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CardId": "55d0c52f-79ee-4d38-acf4-a16c07957898",
    "AtmEnabled": true,
    "Message": "ATM usage enabled successfully"
  }
}

Example— 400 — Card not Active

{
  "ResponseCode": 400,
  "ResponseMessage": "ATM usage can only be changed for Active cards",
  "ResponseData": null
}

{
  "ResponseCode": 400,
  "ResponseMessage": "ATM usage can only be changed for Active cards",
  "ResponseData": null
}

Path param stays camelCase (`cardId`). Body field is PascalCase (`AtmEnabled`).

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	Updated ATM state.
`ResponseData.CardId`	string	—	Card reference id.
`ResponseData.AtmEnabled`	boolean	—	Resulting ATM state.
`ResponseData.Message`	string	—	Enable / disable / already-* message.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CardId": "55d0c52f-79ee-4d38-acf4-a16c07957898",
    "AtmEnabled": false,
    "Message": "ATM usage disabled successfully"
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CardId": "55d0c52f-79ee-4d38-acf4-a16c07957898",
    "AtmEnabled": false,
    "Message": "ATM usage disabled successfully"
  }
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.