Card Authentication

The Card authentication method supports a zero-dollar authorization. This way you can check that the credit card is valid, and if needed that the card has enough funds on it for the transaction. This type of authorization does not hold any funds on the cardholder account.

A zero dollar authorization cannot be submitted for settlement or for return.

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the payment record	Integer	Yes	No	Yes
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No
amount	Amount of the payment	Number	No	Yes	No
source	Where the card details come from `Internet` or `MOTO`	ENUM	Yes	Yes	No
card	Card details	Object	No	Yes	No
card.name	Cardholder name	String	No	Yes	No
card.number	Card number	Integer	No	Yes	No
card.exp	Card expiration date `mm/yy`	String	No	Yes	No
card.save	Save the card details for future use `Yes` or `No`	ENUM	No	Yes	No
card.verification	Verification object	Object	No	No	Yes
card.verification.cvv	Returns the verification cvv code	String	No	No	Yes
card.verification.address	Returns the verification address code	String	No	No	Yes
card.address	Card billing address details	Object	No	Yes	No
card.address.country	Card billing country	String	No	Yes	No
card.address.state	Card billing state	String	No	No	No
card.address.city	Card billing city	String	No	Yes	No
card.address.street	Card billing street	String	No	Yes	No
card.address.zip	Card billing zip	String	No	Yes	No

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "terminal": {
        "id": 24
    },
    "amount": "0.00",
    "source": "Internet",
    "level": 1,
    "card": {
        "name": "John Wick",
        "number": 5146312200000035,
        "exp": "12/30",
        "cvv": "998",
        "address": {
            "country": "United State of America",
            "state": "CA",
            "city": "Calabasas",
            "street": "8320",
            "zip": "85284"
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request Code Samples

Responses