Temporary Lock the Card

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)

FieldTypeRequiredDescription
paymentCardIdstringYesUnique identifier of the payment card to suspend

Extended variant: with order reference

FieldTypeRequiredDescription
paymentCardIdstringYesUnique identifier of the payment card to suspend
orderIdstringYesOrder identifier associated with the card

Extended variant: with nickname

FieldTypeRequiredDescription
paymentCardIdstringYesUnique identifier of the payment card to suspend
nickNamestringNoDisplay name for the card (max 18 characters)

Extended variant: with date period

FieldTypeRequiredDescription
paymentCardIdstringYesUnique identifier of the payment card to suspend
dateFromstring (date-time)YesStart of the suspension period (ISO 8601)
dateTostring (date-time)YesEnd of the suspension period (ISO 8601)

Extended variant: reissue (legacy)

FieldTypeRequiredDescription
paymentCardIdstringYesUnique identifier of the payment card to suspend
expirationDatestring (date-time)YesExpiration date/time for the card
activateOnCreatebooleanNoWhether to activate the card upon creation
copyNumberbooleanNoWhether to copy the existing card number
copyPinbooleanNoWhether to copy the existing card PIN

Extended variant: reissue (current)

FieldTypeRequiredDescription
paymentCardIdstringYesUnique identifier of the payment card to suspend
reasonstring (enum)NoReason for reissue: NeedNewCard, LostOrStolen, Fraud, Damaged, Expired
subProfileIdintegerNoID of the authorized user (subProfile) on the card
paymentCardNamestringNoDisplay name for the reissued card
orderPhysicalPaymentCardobjectNoPhysical card delivery details (see below)

orderPhysicalPaymentCard object

FieldTypeRequiredDescription
deliveryDetailsobjectYesRecipient name, company, and address
deliveryDetails.name.givenNamestringYesRecipient first name
deliveryDetails.name.familyNamestringYesRecipient last name
deliveryDetails.companyNamestringYesCompany name for delivery
deliveryDetails.address.streetAddressstringYesStreet address
deliveryDetails.address.extendedAddressstringNoApartment, suite, unit, etc.
deliveryDetails.address.localitystringYesCity
deliveryDetails.address.regionstringYesTwo-letter state code (e.g., FL)
deliveryDetails.address.postalCodestringYesFive-digit ZIP code
deliveryDetails.address.countryCodeAlpha3stringYesThree-letter country code (e.g., USA)
courier.methodstring (enum)NoShipping 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.

FieldTypeDescription
(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

CodeWhen it happens
400Missing required fields, invalid paymentCardId format, or validation error on request body
401Token missing, expired, or invalid
403Insufficient permissions to suspend the specified card
404Payment card not found for the provided paymentCardId
500Internal server error

Common Mistakes

  • Providing a paymentCardId that belongs to a card already permanently closed — suspension only applies to active or previously active cards
  • Omitting paymentCardId entirely, 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/refresh before they expire
  • Setting dateFrom after dateTo in the date period variant, which will cause a validation error

Related Endpoints

  • POST /api/paymentCards/activatePaymentCard — Reactivate a previously suspended payment card
  • POST /api/paymentCards/cancelPaymentCard — Permanently cancel a payment card (irreversible)
  • POST /api/paymentCards/reissuePaymentCard — Reissue a replacement payment card
  • GET /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"
  }'
Body Params
string
required
length ≥ 1
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!