Start Credit Card Validation

Description

Starts the credit card validation process through a pre-authorization (authorization without capture) performed by the payment gateway.

During this process, EVO generates a random validation amount, registers the card with Pending status, and creates a validation process associated with the credit card. The validation must later be completed through the Confirm Credit Card Validation endpoint.

🚧 Notes
Available for use with both Branch Access Keys and General Admin Access Keys.
The validation flow is available only when the card validation feature is enabled for the branch and supported by the payment gateway.
This endpoint only starts the validation process. The validation must be completed later through the Confirm Credit Card Validation endpoint.

📨 Request Body

Parameter	Type	Required	Description
`idBranch`	int32	Yes	Identifier of the branch where the card validation will be performed.
`idProspect`	int32	Conditional	Identifier of the prospect associated with the card validation process. Required when validating a prospect's card.
`idMember`	int32	Conditional	Identifier of the member associated with the card validation process. Required when validating a member's card.
`cardData`	object	Yes	Object containing the tokenized credit card information (detailed below).

🧩 `cardData` Object Structure

Field	Type	Required	Description
`token`	string	No	Permanent card token generated by EVO and used to create the pre-authorization.
`temporaryToken`	string	No	Temporary token returned by the payment gateway during card registration.
`branchToken`	string	No	Branch token used by the payment gateway.
`totalInstallments`	int32	No	Number of installments configured for the card.
`truncatedCardNumber`	string	No	Masked credit card number.
`brand`	string	No	Credit card brand.
`cardHolderName`	string	No	Name printed on the credit card.
`cardExpirationYear`	int32	No	Credit card expiration year.
`cardExpirationMonth`	int32	No	Credit card expiration month.

📤 Response Structure

The response contains the result of the card validation request.

Field	Type	Description
`validationStatusSuccess`	boolean	Indicates whether the validation process was successfully started (`true` or `false`).
`idMember`	int32	Identifier of the member associated with the card, when applicable.
`idProspect`	int32	Identifier of the prospect associated with the card, when applicable.
`idCreditCard`	int32	Identifier of the credit card created in EVO and associated with the validation process.
`cardStatus`	string	Initial card status after the validation process is started. When successfully initiated, the card remains in Pending status until the validation is completed.
`attemptsRemaining`	int32	Number of remaining attempts available to confirm the validation.
`validationExpiration`	string (datetime)	Date and time when the validation process expires. After this deadline, a new validation process must be started.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params

application/json-patch+json

Example

{
    "idBranch": 0,
    "idProspect": 0,
    "idMember": 0,
    "cardData": {
        "token": "string",
        "temporaryToken": "string",
        "branchToken": "string",
        "totalInstallments": 0,
        "truncatedCardNumber": "string",
        "brand": "string",
        "cardHolderName": "string",
        "cardExpirationYear": 0,
        "cardExpirationMonth": 0
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Success

Body

Example

{
    "validationStatusSuccess": true,
    "idMember": 0,
    "idProspect": 0,
    "idCreditCard": 0,
    "cardStatus": "string",
    "attemptsRemaining": 0,
    "validationExpiration": "string"
}

Initiates credit card validation

Start Credit Card Validation

Description

📨 Request Body

🧩 `cardData` Object Structure

📤 Response Structure

Request

Request Code Samples

Responses

Initiates credit card validation

Start Credit Card Validation#

Description#

📨 Request Body#

🧩 cardData Object Structure#

📤 Response Structure#

Request

Request Code Samples

Responses

Start Credit Card Validation

Description

📨 Request Body

🧩 `cardData` Object Structure

📤 Response Structure