Request standard/lightbox checkout generation

POST 
/checkout

Request standard/lightbox checkout generation

Request

application/json

Body

required

amount int32required

Possible values: >= 1

description string
maxInstallmentNumber int32

Possible values: >= 1 and <= 12

customer

object

required

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

planId uuid
shippingAmount int32

Possible values: >= 1

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

receivers

object[]

Possible values: >= 1

Array [

merchantCode stringrequired

Possible values: >= 15 characters, Value must match regular expression ^\d+$

mdrDiscount boolean

chargeRemainder boolean

fixedAmount int32

Possible values: >= 1

Amount that seller has transacted based on fixed calculation.

percentageAmount double

Possible values: >= 1 and <= 100

Amount that seller has transacted based on percentage calculation.

commissionFixedAmount int32

Possible values: >= 1

Value to override the register of fixed commission settings.

commissionPercentageAmount double

Possible values: >= 1 and <= 100

Value to override the register of percentage commission settings.

]

threeDomainSecurePolicy string

Possible values: [INACTIVE, ACTIVE, EXCLUSIVE]

Default value: INACTIVE

Responses

200

OK

application/json

Schema

Schema

id string
checkoutUrl string

Example (from schema)

{
  "id": "string",
  "checkoutUrl": "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...