Cancel physical card order status

Cancel Physical Card Order

The Cancel Physical Card Order endpoint allows partners to halt the processing of a physical payment card order that is still in progress. Once cancelled, the card will not be issued or shipped, and the order status is updated to reflect the cancellation. This endpoint is useful for managing card inventory and preventing unwanted card issuance.

Endpoint

POST /api/paymentCards/cancelPhysicalPaymentCardOrder

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 customer requests cancellation of a physical card order before it has been fulfilled. This is applicable when a card order was submitted in error, the customer no longer needs the card, or the order details need to be changed and the existing order must be voided before a new one is placed.

Request Body

{
  "paymentCardId": "pci_a1b2c3d4e5f6g7h8i9j0",
  "orderId": "ord_z9y8x7w6v5u4t3s2r1q0"
}

Response

200 OK

A successful response confirms that the physical card order has been cancelled and no further processing will occur on the order.

{
  "success": true,
  "message": "Physical card order has been successfully cancelled.",
  "orderId": "ord_z9y8x7w6v5u4t3s2r1q0",
  "status": "canceled"
}

Error Codes

Common Mistakes

• Providing an orderId for an order that has already been fulfilled or shipped — only active/pending orders can be cancelled.
• Omitting paymentCardId — both the card ID and order ID are required to identify and cancel the correct order.
• Passing empty strings for paymentCardId or orderId — both fields enforce a minimum length of 1 character.
• Attempting to cancel a virtual or burner card order using this endpoint — this endpoint is specific to physical card orders.

Related Endpoints

• POST /api/paymentCards/createPhysicalPaymentCardOrder — Create a new physical payment card order
• GET /api/paymentCards/getPhysicalPaymentCardOrder — Retrieve the status and details of a physical card order
• POST /api/paymentCards/createVirtualPaymentCard — Create a virtual payment card
• POST /api/paymentCards/createBurnerPaymentCard — Create a temporary burner payment card

Example

curl -X POST https://api.banking.netevia.dev/api/paymentCards/cancelPhysicalPaymentCardOrder \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentCardId": "pci_a1b2c3d4e5f6g7h8i9j0",
    "orderId": "ord_z9y8x7w6v5u4t3s2r1q0"
  }'