Card Controls
Action | Description | Endpoint | Conditions | Post performing action |
|---|---|---|---|---|
Create Card | Create card for customer | POST/v0/cards/create | Not restricted by any conditions such as card status. | Will provide card details |
Re-issue Card | Functionality to create a new card for the customer account. | POST/v0/cards/{cardId}/re-issue | Not restricted by any conditions such as card status. If Damaged = False. The request is for a new card, a new card with new details will be issued. The old card will automatically be cancelled. | Card details including card ID will be updated. Card status will be moved to Awaiting_Activiation. It will also show the old card in an Inactive status. |
Activate Card | Move the card into a status that allows the customer to start carrying out transactions. | POST/v0/cards/{cardId}/activate | This action is only valid for cards with a status of AWAITING_ACTIVATION. | It will move card status to Active |
Block Card | Stops the use of the card for any type of payment. The customer must get in touch with the relevant support. Used in instances that require investigation into the use of the card. | POST/v0/cards/{cardId}/block | Not restricted Not restricted by any conditions such as card status. | It will move card status to Blocked |
Cancel Card | Will put card into a state that means it cannot be used for transactions. | POST/v0/cards/{cardId}/cancel | Not restricted by any conditions such as card status. | It will move card status to Inactive |
Freeze Card | Stops transactions being setup using the card, the account is still active and the customer can control this. | PATCH/v0/cards/{cardId}/payment-preferences | Not restricted by any conditions such as card status. | The cardEnabled status would update to True if enabled or False if disabled. It does not update card status. |
Online Transaction Payments (Card not present) | When enabled it means the customer can use card details to make online payments. | PATCH/v0/cards/{cardId}/payment-preferences | Not restricted by any conditions such as card status. | The cardNotPresentEnabled status would update to True if enabled or False if disabled. It does not update card status. |
Contactless Payments | Allows for payments to be made through contactless devices. | PATCH/v0/cards/{cardId}/payment-preferences | Not restricted by any conditions such as card status. | The ContactlessEnabled status would update to True if enabled or False if disabled. It does not update card status. |
ATM Withdrawals | When disabled it will stops the card being used to withdraw cash from ATM. | PATCH/v0/cards/{cardId}/payment-preferences <CashWithdrawalEnabled = ATM> | Not restricted by any conditions such as card status. | The CashWithdrawalEnabled status would update to True if enabled or False if disabled. It does not update card status. |
Magnetic Stripe Payments | Controls the functionality of whether the card will be accepted when swiped through POS machine. | PATCH/v0/cards/{cardId}/payment-preferences | Not restricted by any conditions such as card status. | The MagneticStripePayment status would update to True if enabled or False if disabled. It does not update card status. |
Digital Wallet Payments (Apple / Google Pay) | Allows for payments using the digital wallet such as Apple Pay on IOS and Google Pay on Android devices. | PATCH/v0/cards/{cardId}/payment-preferences | Not restricted by any conditions such as card status. | The MobileWalletPaymentEnabled status would update to True if enabled or False if disabled. It does not update card status. |
Unlock Card PIN | Action providing the capability to unblock a card PIN so that the cardholder is able to attempt to enter their PIN again. Blocking of a card’s PIN occurs after the cardholder has incorrectly entered their card PIN 3 times. | POST/v0/cards/{cardId}/pin/unblock | Not restricted by any conditions such as card status. | N/A |