Configuração de transação 3DS

POST 
/charge/3ds/setup

Endpoint responsável por realizar a configuração de uma transação 3DS

Request

Header Parameters

caller-origin string

Inclua a propriedade 'caller-origin' como uma string no header das requisições REST somente se a aplicação for uma plataforma de e-commerce, caso contrário, não inclua.

application/json

Body

required

paymentSource stringrequired

Possible values: [CHECKOUT, GATEWAY]

Enum [ CHECKOUT(Transações realizadas a partir do checkout padrão e lightBox), GATEWAY(Transações realizadas utilizando diretamente a api)]

smartCheckoutId String

SmartCheckout ID defined by the system (Required to default or lightBox checkout)

merchantChargeId String

Possible values: >= 6 characters and <= 36 characters, Value must match regular expression ^([a-zA-Z0-9-]+$)$

Identificador externo único da cobrança, definido pelo sistema do comerciante. Este campo deve ser exclusivo para cada cobrança, pois é utilizado para rastrear e identificar individualmente as transações no sistema. Caso não seja passado, será gerado internamente. Atenção: a reutilização de um merchantChargeId para múltiplas cobranças resultará em falhas na criação de novas cobranças.

transactions

object[]

required

Possible values: >= 1, <= 1

One transactions to be performed within the charge.

Array [

card

object

cardId uuid

temporaryCardToken string

Possible values: Value must match regular expression ^[a-zA-Z0-9.\/\_\+-]*$

Token de uso único gerado pelo nosso SDK no front-end do seller para ser utilizado na transação. É útil para evitar o envio de dados do cartão para o backend do seller. Ao usar este campo, os dados do cartão não são necessários.

cardNumber string

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

cvv string

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

brand string

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

cardholderName String

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

cardholderDocument String

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

billingAddress

object

required

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 .-]+$

expirationMonth int32

Possible values: >= 1 and <= 12

expirationYear int32

Possible values: >= 2000 and <= 9999

paymentType stringrequired

Possible values: [CREDIT]

Enum [ CREDIT(Cartão de credito)]

amount int32required

Possible values: >= 1

Payment amount in cents

]

Responses

200

OK

application/json

Schema

Schema

chargeId String

Charge ID defined by system

transactions

object[]

Possible values: >= 1, <= 1

Array [

accessToken string

deviceDataCollectionUrl string

cardholderAuthenticationId string

cardholderAuthenticationReferenceId string

pan string

]

Example (from schema)

{
  "chargeId": "string",
  "transactions": [
    {
      "accessToken": "string",
      "deviceDataCollectionUrl": "string",
      "cardholderAuthenticationId": "string",
      "cardholderAuthenticationReferenceId": "string",
      "pan": "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"
  }
}

415

Unsupported Media Type

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": "Request object is invalid or incorrectly formatted",
  "success": false,
  "errors": null
}

500

Internal Server Error

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": "Internal Server Error",
  "success": false,
  "errors": null
}

Loading...