Temporarily suspends a payment card to prevent unauthorized transactions.
Suspend Payment Card
This endpoint temporarily suspends a specified payment card, immediately blocking all transactions and access. The suspension is reversible and is intended for situations where potential unauthorized activity is detected or the cardholder needs to pause card usage. The card can be reactivated through a separate API call once the suspension is no longer needed.
Endpoint
POST /netevia/paymentCard/suspendPaymentCard
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint when a cardholder reports suspicious activity or a lost card and you need to immediately stop further transactions without permanently closing the card. It is also useful when a cardholder wants a temporary pause, such as during travel or while investigating a disputed charge. The card can be unsuspended later, making this a more flexible option than full card termination.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| paymentCardId | string | Yes | Unique identifier of the payment card to suspend. Minimum length: 1 character. |
| notes | string | No | Optional notes describing the reason for suspension. Maximum length: 600 characters. |
| last4 | string | No | Last 4 digits of the card number, used as an additional verification check. |
{
"paymentCardId": "card_a1b2c3d4e5f6",
"notes": "Cardholder reported potential unauthorized activity on account.",
"last4": "4321"
}Response
200 OK
| Field | Type | Description |
|---|---|---|
| profileId | integer (int32) | The profile ID associated with the card owner. |
| success | boolean | Indicates whether the suspension was completed successfully. |
| errors | string / null | Error message if the operation failed; null on success. |
| changeLog | array / null | Array of change log entries recording the actions performed during this request. |
| changeLog[].requestType | integer (int32) | Numeric code representing the type of banking request performed. |
| changeLog[].changes | string / null | Description of the specific changes made during the request. |
{
"profileId": 100234,
"success": true,
"errors": null,
"changeLog": [
{
"requestType": 7,
"changes": "Payment card suspended successfully."
}
]
}Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required paymentCardId field, or field fails validation (e.g., empty string or notes exceeding 600 characters) |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions to suspend the specified card |
| 404 | The specified paymentCardId does not exist or does not belong to the authenticated user's profile |
| 500 | Internal server error |
Common Mistakes
- Omitting the required
paymentCardIdfield — this will result in a 400 validation error. - Passing an empty string for
paymentCardId— it must have a minimum length of 1 character. - Exceeding the 600-character limit for the
notesfield, which causes a validation failure. - Attempting to suspend a card that is already suspended — verify card status before calling this endpoint.
- Using a stale Bearer token — tokens expire after 10 minutes; refresh via
POST /api/auth/refreshbefore making this call.
Related Endpoints
POST /netevia/paymentCard/activatePaymentCard— Reactivates a previously suspended payment cardPOST /netevia/paymentCard/terminatePaymentCard— Permanently terminates a payment cardPOST /netevia/paymentCard/getPaymentCard— Retrieves the current status and details of a payment card
Example
curl -X POST https://api.banking.netevia.dev/netevia/paymentCard/suspendPaymentCard \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"paymentCardId": "card_a1b2c3d4e5f6",
"notes": "Cardholder reported potential unauthorized activity on account.",
"last4": "4321"
}'