Card

Add and remove cards to be used for Payments with Zapper.

Register Card

POST https://api.zapper.com/v1/cards

Submit card information to be stored and receive a unique token to be used in future payments

Headers

Name	Type	Description
Authorization	String	Bearer <Identity Token> The identity token received from the service account login
x-api-key	string	Authentication key

Request Body

Name	Type	Description
cardNumber	string	Number on the front of the card.
holderName	string	Name on the card.
expiryMonth	number	Month that the card expires (1-12).
expiryYear	number	Year that the card expires (CCYY).

201 Successfully stored and tokenised card information.

{
    "token": "00000000-0000-0000-0000-000000000000",
    "cardMask": "400000xxx0002",
    "holderName": "Card Holder",
    "expiryMonth": 9,
    "expiryYear": 2030
}

Request Example

{
    "cardNumber": "4000000000000002",
    "holderName": "Card Holder",
    "expiryMonth": 9,
    "expiryYear": 2030
}

Response

Field	Type	Description
token	string	Unique representation of the card.
cardMask	string	User friendly string for the card.
holderName	string	Card holder name.
expiryMonth	number	The month the card expires.
expiryYear	number	The year the card expires. Format: CCYY
brand	string	The card issuer brand. eg. Mastercard, Visa

Remove Card

DELETE https://api.zapper.com/v1/cards/{token}

Remove the card matching the provided token. This action is irreversible.

Path Parameters

Name	Type	Description
token	string	Token for the payment method to be removed.

Headers

Name	Type	Description
Authorization	String	Bearer <Identity Token> The identity token received from the service account login
x-api-key	string	Authentication key

200 Card successfully removed from the Zapper platform.