Skip to main content

3DS transaction setup

POST 
/charge/3ds/setup

Endpoint responsible for performing the setup of a 3DS transaction

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.

Body

required

    paymentSource stringrequired

    Possible values: [CHECKOUT, GATEWAY]

    Enum [ CHECKOUT(Transactions made from the standard checkout and lightBox), GATEWAY(Transactions carried out using the api directly)]

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

    Unique external identifier for the charge, defined by the merchant's system. This field must be unique for each charge, as it is used to individually track and identify transactions in the system. If not provided, it will be generated internally. Caution: reusing a merchantChargeId for multiple charges will result in failures when creating new charges.

    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.\/\_\+-]*$

    One time token generated by our SDK on seller's front-end to be used in the transaction. It's useful to avoid sending card data to the seller's backend. When using this field, the card data is not necessary.

    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​

OK

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

  • ]

Loading...