Card Suspend / Close
Suspend a Card
You can suspend a card at anytime. Card will be set in aSUSPENDED
status. Card might be suspended for different reasons : Lost, Stolen, Damaged, Other. This is a reversible status, a card can be activate again and again. See Active a Card.
Suspending a card will prevent any further authorization to be accepted. It doesn't change the status of already accepted authorizations.
Clearing transactions based on a previous Authorization will be accepted, even if card is Suspended.
In order to help us to prevent frauds, we want to be able to identify who asked the card suspension.
Your Enduser can ask it for exemple if he is looking for his card and has a doubt about a possible a steal or, as a Partner, you want to be able to desactivate a card for exemple if your Enduser has not paid his subscription.
AnOperator
has to be provided : END_USER
if the suspend request is initiated by the Enduser. The Enduser and the Partner will be able to re-activate the card.PARTNER
if the suspend request is initiated by the Partner. In this case, the Enduser won't be able to re-activate the card, only the Partner could do this.
Request Body schema: application/json
operator required | string (Operator) Default: "END_USER" The entity initiating this operation. |
reason | string Optional reason of the card suspension. |
otherReason | string [ 0 .. 511 ] characters Description of reason if 'OTHER' was chosen. |
{- "operator": "END_USER",
- "reason": "STOLEN",
- "otherReason": "string"
}
Close a Card
Closing a card is not reversible
CLOSED
status. Card might be closed for different reasons : Lost, Stolen, Damaged, Other. This is NOT a reversible status. Closing a card will prevent any further authorization to be accepted. It doesn't change the status of already accepted authorizations.
Clearing transactions based on a previous Authorization will be accepted, even if card is Closed.
Operator
has to be provided : END_USER
if the close request is initiated by the Enduser.PARTNER
if the close request is initiated by the Partner.
POST /api/partner/cards/{cardId}/close
Request Body schema: application/json
operator required | string (Operator) Default: "END_USER" The entity initiating this operation. |
reason required | string Enum: "STOLEN" "LOST" "DAMAGED" "OTHER" |
otherReason | string [ 0 .. 511 ] characters Description of reason if 'OTHER' was chosen. |
{- "operator": "END_USER",
- "reason": "STOLEN",
- "otherReason": "string"
}