Temporarily suspend a payment card to prevent unauthorized transactions while preserving card data for future reactivation.
Temporary Lock the Card
The Suspend Payment Card endpoint allows you to temporarily lock a payment card, immediately blocking all transactions on that card. The card's information is preserved so it can be reactivated at any time. This provides an instant security response for lost, misplaced, or potentially compromised cards.
Endpoint
POST /api/paymentCards/suspendPaymentCard
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2
Include 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 a card as lost, misplaced, or suspects unauthorized activity and wants to block transactions immediately without closing the card permanently. Because suspension is reversible, it is the preferred first response before escalating to card cancellation or reissuance. This is applicable to Physical, Virtual, and Burner card types for both business and personal customers.
Request Body
The request body accepts a paymentCardId as the minimum required field. All request variants extend the base paymentcardrequest schema.
Base request (minimum required)
| Field | Type | Required | Description |
|---|---|---|---|
paymentCardId | string | Yes | Unique identifier of the payment card to suspend |
Extended variant: with order reference
| Field | Type | Required | Description |
|---|---|---|---|
paymentCardId | string | Yes | Unique identifier of the payment card to suspend |
orderId | string | Yes | Order identifier associated with the card |
Extended variant: with nickname
| Field | Type | Required | Description |
|---|---|---|---|
paymentCardId | string | Yes | Unique identifier of the payment card to suspend |
nickName | string | No | Display name for the card (max 18 characters) |
Extended variant: with date period
| Field | Type | Required | Description |
|---|---|---|---|
paymentCardId | string | Yes | Unique identifier of the payment card to suspend |
dateFrom | string (date-time) | Yes | Start of the suspension period (ISO 8601) |
dateTo | string (date-time) | Yes | End of the suspension period (ISO 8601) |
Extended variant: reissue (legacy)
| Field | Type | Required | Description |
|---|---|---|---|
paymentCardId | string | Yes | Unique identifier of the payment card to suspend |
expirationDate | string (date-time) | Yes | Expiration date/time for the card |
activateOnCreate | boolean | No | Whether to activate the card upon creation |
copyNumber | boolean | No | Whether to copy the existing card number |
copyPin | boolean | No | Whether to copy the existing card PIN |
Extended variant: reissue (current)
| Field | Type | Required | Description |
|---|---|---|---|
paymentCardId | string | Yes | Unique identifier of the payment card to suspend |
reason | string (enum) | No | Reason for reissue: NeedNewCard, LostOrStolen, Fraud, Damaged, Expired |
subProfileId | integer | No | ID of the authorized user (subProfile) on the card |
paymentCardName | string | No | Display name for the reissued card |
orderPhysicalPaymentCard | object | No | Physical card delivery details (see below) |
orderPhysicalPaymentCard object
| Field | Type | Required | Description |
|---|---|---|---|
deliveryDetails | object | Yes | Recipient name, company, and address |
deliveryDetails.name.givenName | string | Yes | Recipient first name |
deliveryDetails.name.familyName | string | Yes | Recipient last name |
deliveryDetails.companyName | string | Yes | Company name for delivery |
deliveryDetails.address.streetAddress | string | Yes | Street address |
deliveryDetails.address.extendedAddress | string | No | Apartment, suite, unit, etc. |
deliveryDetails.address.locality | string | Yes | City |
deliveryDetails.address.region | string | Yes | Two-letter state code (e.g., FL) |
deliveryDetails.address.postalCode | string | Yes | Five-digit ZIP code |
deliveryDetails.address.countryCodeAlpha3 | string | Yes | Three-letter country code (e.g., USA) |
courier.method | string (enum) | No | Shipping method: USPS_GROUND, USPS_PRIORITY, USPS_EXPRESS, UPS_GROUND, UPS_SECOND_DAY, UPS_NEXT_DAY |
Minimum request example
{
"paymentCardId": "card_abc123def456"
}Request with suspension period
{
"paymentCardId": "card_abc123def456",
"dateFrom": "2026-06-08T00:00:00Z",
"dateTo": "2026-06-15T23:59:59Z"
}Response
200 OK
A successful response confirms the payment card has been suspended. The response body returns a success status.
| Field | Type | Description |
|---|---|---|
| (confirmation) | — | HTTP 200 indicates the card has been successfully suspended |
{}Note: A 200 status code confirms the suspension was applied. No additional payload fields are returned beyond the success indication.
Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields, invalid paymentCardId format, or validation error on request body |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions to suspend the specified card |
| 404 | Payment card not found for the provided paymentCardId |
| 500 | Internal server error |
Common Mistakes
- Providing a
paymentCardIdthat belongs to a card already permanently closed — suspension only applies to active or previously active cards - Omitting
paymentCardIdentirely, which is always required regardless of which request variant is used - Sending an already-suspended card ID — check current card status before calling this endpoint to avoid redundant requests
- Using an expired Bearer token; tokens have a 10-minute lifetime and must be refreshed via
POST /api/auth/refreshbefore they expire - Setting
dateFromafterdateToin the date period variant, which will cause a validation error
Related Endpoints
POST /api/paymentCards/activatePaymentCard— Reactivate a previously suspended payment cardPOST /api/paymentCards/cancelPaymentCard— Permanently cancel a payment card (irreversible)POST /api/paymentCards/reissuePaymentCard— Reissue a replacement payment cardGET /api/paymentCards/getPaymentCard— Retrieve current status and details for a payment card
Example
curl -X POST https://api.banking.netevia.dev/api/paymentCards/suspendPaymentCard \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"paymentCardId": "card_abc123def456"
}' 200Success
