Request for authorization in the 3DS flow

POST 
/charge/3ds/authorization

Performs the authorization of a charge in the 3DS flow

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 String (string)required
smartCheckoutId uuid

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

capture booleanrequired

transactions

object[]

required

Array [

chargeId String (string)

installmentNumber integerrequired

installmentType stringrequired

Possible values: [NONE, MERCHANT]

Default value: NONE

Enum [ NONE(Spot transaction), MERCHANT(Transaction in installments by the merchant, i.e. without interest)]

softDescriptor String (string)

card

object

required

cvv String (string)required

cardholderAuthenticationId String (string)required

subMerchant

object

id stringrequired

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

The ID of merchant responsible for the transaction

document stringrequired

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

SubMerchant Document

mcc stringrequired

Possible values: >= 4 characters and <= 4 characters

MCC of the SubMerchant

address

object

required

street stringrequired

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

number stringrequired

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

neighborhood stringrequired

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

city stringrequired

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

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

]

Responses

200

OK

application/json

Schema

Schema

charge

object

required

id stringrequired

nsu stringrequired

customerId stringrequired

chargeStatus stringrequired

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

transactions

object[]

required

Array [

isApproved boolean

card

object

required

number stringrequired

brand stringrequired

paymentType string

installmentType string

installmentNumber integer

softDescriptor string

amount integerrequired

isCapture boolean

isRecurrency boolean

transactionId string

transactionStatus stringrequired

acquirer string

creationDateTime string

captureDateTime string

]

Example (from schema)

{
  "charge": {
    "id": "string",
    "nsu": "string",
    "customerId": "string",
    "chargeStatus": "NotAuthorized",
    "transactions": [
      {
        "isApproved": true,
        "card": {
          "number": "string",
          "brand": "string"
        },
        "paymentType": "string",
        "installmentType": "string",
        "installmentNumber": 0,
        "softDescriptor": "string",
        "amount": 0,
        "isCapture": true,
        "isRecurrency": true,
        "transactionId": "string",
        "transactionStatus": "string",
        "acquirer": "string",
        "creationDateTime": "string",
        "captureDateTime": "string"
      }
    ]
  }
}

400

Bad Request

application/json

Schema

Schema

message stringrequired
success booleanrequired
businessCode string

errors

object[]

Array [

message string

field string

]

Example (from schema)

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

401

Unauthorized

application/json

Schema

Schema

message stringrequired
success booleanrequired
businessCode string

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "businessCode": "string",
  "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
businessCode string

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "businessCode": "string",
  "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...