Card
Add and remove cards to be used for Payments with Zapper.
postRegister 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
Request
Response
Request
Headers
Authorization
required
Bearer <Identity Token>
The identity token received from the service account login
x-api-key
required
string
Authentication key
Body Parameters
cardNumber
required
string
Number on the front of the card.
holderName
required
string
Name on the card.
expiryMonth
required
number
Month that the card expires (1-12).
expiryYear
required
number
Year that the card expires (CCYY).
Response
201: Created
Successfully stored and tokenised card information.
{"token": "00000000-0000-0000-0000-000000000000","cardMask": "400000xxx0002","holderName": "Card Holder","expiryMonth": 9,"expiryYear": 2030}
{"cardNumber": "4000000000000002","holderName": "Card Holder","expiryMonth": 9,"expiryYear": 2030}
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 |
deleteRemove Card
delete
https://api.zapper.com/v1/cards/{token}
Remove the card matching the provided token. This action is irreversible.
Request
Response
Request
Path Parameters
token
required
string
Token for the payment method to be removed.
Headers
Authorization
required
Bearer <Identity Token>
The identity token received from the service account login
x-api-key
required
string
Authentication key
Response
200: OK
Card successfully removed from the Zapper platform.
Last updated 7 months ago