cards

Cancel a card

Cancel a card and refund it in full: always possible while it is scheduled, and possible after dispatch only while the provider has not started on it; irreversible, and the card will not be mailed. Free. Sensitive write: it requires the human's approval to cancel. A card that can no longer be stopped returns 400 naming its status.

post/v1/cards/{card_id}/cancel

Request

  • Base URL: https://api.noerrands.com/c/cards
  • URL: https://api.noerrands.com/c/cards/v1/cards/{card_id}/cancel
  • Auth: HTTP bearer

Path parameters

card_idstring required

Request body

card_idstring required

Response

Success.

card_idstring required
status'cancelled' required
refunded_centsinteger required
balance_centsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.