SchemaPaymentsCards

Verify a card

Verify that a card is valid. For banks that do not support verification, we charge a micro deposit that we void immediately.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request

This endpoint expects an object.
processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
cardobjectRequired
Object that contains information about the card.
operatorstringOptional>=0 characters<=50 characters
Operator who requested to verify the card.
customerobjectOptional
Customer contact and address details.

Response

Successful request. Returns the verification status of the card details.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
verifiedboolean

Indicates if we have verified the card details.

  • true - The card details are valid.
  • false - The card details are not valid.
operatorstringOptional>=0 characters<=50 characters
Operator who requested to verify the card.
dateTimestringOptionalformat: "date-time"

Date and time that we processed the request. This format follows the ISO 8601 standard, for example, 2024-07-02T15:02:07+00:00.

responseCodeenumOptional

Response from the processor.

  • A - The processor approved the transaction.
  • D - The processor declined the transaction.
  • E - The processor received the transaction but will process the transaction later.
  • P - The processor authorized a portion of the original amount of the transaction.
  • R - The issuer declined the transaction and indicated that the customer should contact their bank.
  • C - The issuer declined the transaction and indicated that the merchant should keep the card as it was reported lost or stolen.
responseMessagestringOptional>=1 character<=48 characters
Response description from the payment processor. For example, "Refer to Card Issuer".
processorResponseCodestringOptional

Response code from payment processor. This code is then mapped onto a responseCode enum.

Errors