Endpoint responsible for configuring the 3DS Enrollment stage

POST 
/charge/3ds/enrollment

Enrollment is the stage where the Gateway sends the cardholder's address information, device used, and card details to the 3DS Provider. The 3DS Provider will check with the Issuer whether a challenge is required or if the transaction will be authenticated without it.

Request

Header Parameters

caller-origin string

Include the 'caller-origin' property as a string in the header of REST requests only if the application is an e-commerce platform, otherwise, don't include it.

application/json

Body

required

chargeId Stringrequired

customer

object

Related customer (buyer).

name Stringrequired

Possible values: non-empty, Value must match regular expression ^[\p{L} ]+$

Customer's name.

email emailrequired

Possible values: Value must match regular expression ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Customer's e-mail.

documentType DocumentTypeEnumrequired

Possible values: [CPF, CNPJ, PASSPORT]

document Stringrequired

Possible values: Value must match regular expression ^\d{9}$|^\d{11}$|^[A-Z0-9]{9}$

Customer's CPF, CNPJ or PASSAPORT. Must match.

phone

object

Customer phone number.

countryCode stringrequired

Possible values: <= 3 characters, Value must match regular expression ^[0-9]+$

areaCode stringrequired

Possible values: <= 3 characters, Value must match regular expression ^[0-9]+$

number stringrequired

Possible values: Value must match regular expression ^[0-9]+$

type stringrequired

Possible values: [RESIDENTIAL, COMMERCIAL, TEMPORARY, MOBILE]

Enum [RESIDENTIAL(Telefone Residencial.), COMMERCIAL(Telefone Comercial.), TEMPORARY(Telefone Temporário.), MOBILE(Celular)]

customerId string

Possible values: Value must match regular expression ^(?!\s*$)[\p{L}\d .-]+$

threeDomainSecureSettings

object

isActive booleanrequired

acquirerBin string

acquirerMerchantId string

requestorId string

requestorName string

provider integer

providerMerchantId string

providerMerchantSecretKey string

providerMerchantKeyId string

byPassChallenge boolean

byPassElegibleBrands integer[]

acquirerBinByCardBrands

object[]

required

Array [

acquirerBin stringrequired

cardBrand int32required

]

browser

object

httpAcceptBrowserValue stringrequired

httpAcceptContent stringrequired

httpBrowserLanguage stringrequired

httpBrowserJavaEnabled booleanrequired

httpBrowserJavaScriptEnabled booleanrequired

httpBrowserColorDepth stringrequired

httpBrowserScreenHeight stringrequired

httpBrowserScreenWidth stringrequired

httpBrowserTimeDifference stringrequired

userAgentBrowserValue stringrequired

transactions

object[]

required

Array [

amount integerrequired

boarding

object

taxAmount integerrequired

entryAmount integerrequired

card

object

cardId string

Possible values: Value must match regular expression ^(?!\s*$)[\p{L}\d .-]+$

temporaryCardToken string

Possible values: Value must match regular expression ^(?!\s*$)[\p{L}\d .-]+$

expirationMonth integer

expirationYear integer

brand string

Possible values: [VISA, MASTERCARD, AMEX, ELO, HIPERCARD]

number string

cardholderName string

Possible values: non-empty, Value must match regular expression ^[\p{L} ]+$

cardholderDocument string

Possible values: Value must match regular expression ^\d{11}$|^\d{14}$|^[A-Z0-9]{8}$

cvv string

Possible values: >= 3 characters and <= 4 characters, Value must match regular expression ^\d+$

cardType integer

isPrivateLabel boolean

billingAddress

object

street stringrequired

Possible values: Value must match regular expression ^(?!\s*$)[\p{L}\d .-]+$

number string

Possible values: Value must match regular expression ^[0-9]+$

neighborhood string

Possible values: Value must match regular expression ^[\p{L} ]+$

city stringrequired

Possible values: Value must match regular expression ^[\p{L} ]+$

state stringrequired

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[\p{L} ]+$

country stringrequired

Possible values: Value must match regular expression ^[\p{L} ]+$

zipCode stringrequired

Possible values: Value must match regular expression ^[0-9]+$

complement string

Possible values: Value must match regular expression ^(?!\s*$)[\p{L}\d .-]+$

]

shipping

object

name stringrequired

Possible values: Value must match regular expression ^(?!\s*$)[\p{L}\d .-]+$

email emailrequired

Possible values: Value must match regular expression ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

shippingAddress

object

street stringrequired

Possible values: Value must match regular expression ^(?!\s*$)[\p{L}\d .-]+$

number string

Possible values: Value must match regular expression ^[0-9]+$

neighborhood string

Possible values: Value must match regular expression ^[\p{L} ]+$

city stringrequired

Possible values: Value must match regular expression ^[\p{L} ]+$

state stringrequired

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[\p{L} ]+$

country stringrequired

Possible values: Value must match regular expression ^[\p{L} ]+$

zipCode stringrequired

Possible values: Value must match regular expression ^[0-9]+$

complement string

Possible values: Value must match regular expression ^(?!\s*$)[\p{L}\d .-]+$

id string

isActive boolean

phone

object

Customer phone number.

countryCode stringrequired

Possible values: <= 3 characters, Value must match regular expression ^[0-9]+$

areaCode stringrequired

Possible values: <= 3 characters, Value must match regular expression ^[0-9]+$

number stringrequired

Possible values: Value must match regular expression ^[0-9]+$

type stringrequired

Possible values: [RESIDENTIAL, COMMERCIAL, TEMPORARY, MOBILE]

Enum [RESIDENTIAL(Telefone Residencial.), COMMERCIAL(Telefone Comercial.), TEMPORARY(Telefone Temporário.), MOBILE(Celular)]

Responses

200

OK

application/json

Schema

Schema

chargeId stringrequired

Charge ID defined by system

chargeStatus stringrequired

Possible values: [Undefined, Authorized, PreAuthorized, Canceled, Partial, NotAuthorized, PendingCancel, Expired, Timeout]

transactions

object[]

required

Array [

cardholderAuthenticationVersion string

cardholderAuthenticationStatus stringrequired

Possible values: [Approved, Rejected, Challenged]

stepUpUrl string

needRunAntifraud boolean

pan string

accessToken string

heightChallenge string

widthChallenge string

]

Example (from schema)

{
  "chargeId": "string",
  "chargeStatus": "NotAuthorized",
  "transactions": [
    {
      "cardholderAuthenticationVersion": "string",
      "cardholderAuthenticationStatus": "Challenged",
      "stepUpUrl": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp",
      "needRunAntifraud": true,
      "pan": "string",
      "accessToken": "string",
      "heightChallenge": "string",
      "widthChallenge": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Authorization token not found.",
  "success": false,
  "errors": {
    "message": "Authorization token not found",
    "field": "Authorization Token"
  }
}

502

Bad Gateway

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Error when making an external call, try again later.",
  "success": false,
  "errors": null
}

Loading...