Autorização de cobrança com Cartão de Credito

POST 
/charge/authorization

Realiza a autorização de uma charge. Tipos disponíveis:

• Autorização com captura tardia (lateCapture = true);
• Autorização com captura automática (lateCapture = false);
• Autorização com split de pagamento (com inclusão de Receivers)
• Autorização com COF (entryMode = Credential_on_file)

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 uuid

SmartCheckoutID definido pelo sistema (obrigatório para checkout padrão ou lightBox)

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.

customer

object

required

Informações do cliente/comprador.

name Stringrequired

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

Nome do cliente.

email emailrequired

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

E-mail do cliente.

documentType DocumentTypeEnumrequired

Possible values: [CPF, CNPJ, PASSPORT]

document Stringrequired

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

CPF, CNPJ ou PASSAPORT do cliente.

phone

object

numero de telefone.

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

transactions

object[]

required

Possible values: >= 1, <= 1

Uma transação a ser realizada dentro da cobrança.

Array [

paymentType stringrequired

Possible values: [CREDIT, WALLET, PIX]

Enum [ CREDIT(Cartão de credito), WALLET(QRCode PicPay), PIX (Pix)]

amount int32required

Possible values: >= 1

Payment amount in cents

softDescriptor string

transactionId string

entryMode string

Possible values: [CREDENTIAL_ON_FILE]

Modo de entrada da transação.

issuerTransactionId string

Possible values: Value must match regular expression ^[a-zA-Z0-9]*$

Código referente ao issuerTransactionId gerado em uma transação.

credit

object

required

cardId uuid

Pode conter apenas este ID se o cartão for cadastrado anteriormente. Caso contrário, as outras informações do cartão tornam-se obrigatórias

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

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

installmentNumber int32

Default value: 1

installmentType string

Possible values: [NONE, MERCHANT]

Default value: NONE

Enum [ NONE(Transação a vista), MERCHANT(Transação parcelada pelo lojista, ou seja, sem juros)]

sdwo

object

address

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

documentType DocumentTypeEnumrequired

Possible values: [CPF, CNPJ, PASSPORT]

document stringrequired

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

mcc stringrequired

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

merchantCode stringrequired

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

name stringrequired

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

operationType stringrequired

Possible values: [CASH_IN, BACK_TO_BACK]

phone

object

required

numero de telefone.

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

]

deviceInformation

object

Contém informações do dispositivo (obrigatório para análise antifraude)

ip IP

O IP do dispositivo usado para realizar a transação.

id IDnullable

ID exclusivo do dispositivo do cliente.

ipCountryCode IPCountryCodenullable

O código do país do endereço do cliente final. (Ex.: BRA)

ipCity IPCitynullable

A cidade estimada do endereço IP.

ipRegion IPRegionnullable

O endereço IP da região estimado.

sessionId SessionIDnullable

Um identificador da sessão no dispositivo a partir do qual este evento foi gerado.

sourceId String

Use este campo para declarar a origem de uma cobrança

lateCapture boolean

Default value: false

Informe true para realizar uma autorização com captura tardia. Valor padrão: falso.

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

Quantia que o vendedor transacionou com base no cálculo fixo.

percentageAmount double

Possible values: >= 1 and <= 100

Quantia que o vendedor transacionou com base no cálculo percentual.

commissionFixedAmount int32

Possible values: >= 1

Valor para substituir o registro das configurações de comissão fixa.

commissionPercentageAmount double

Possible values: >= 1 and <= 100

Valor para substituir o registro das configurações de comissão percentual.

]

Responses

200

OK

application/json

Schema

Schema

merchantChargeId string
id string
chargeStatus string

Possible values: [CANCELED, DENIED, ERROR, PAID, PARTIAL, PRE_AUTHORIZED, REFUNDED, CHARGEBACK]

amount int32
originalAmount int32
refundedAmount int32

transactions

object[]

Array [

paymentType string

Possible values: [CREDIT, WALLET, PIX]

Enum [ CREDIT(Cartão de credito), WALLET(QRCode PicPay), PIX (Pix)]

amount int32

originalAmount int32

refundedAmount int32

transactionStatus string

Possible values: [CANCELED, CHARGEBACK, DENIED, ERROR, EXPIRED, PAID, PARTIALLY_REFUNDED, PENDING, PRE_AUTHORIZED, REFUNDED]

createdAt date-time

Formato ISO 8601. Exemplo: 2022-05-01T16:00:00-03:00 (significa que foi criado em 01/05/2022 às 16h no fuso horário -03:00)

updatedAt date-time

Formato ISO 8601. Exemplo: 2022-05-01T16:00:00-03:00 (significa que foi atualizado em 01/05/2022 às 16h no fuso horário -03:00)

transactionId string

softDescriptor string

errorMessage string

credit

object

nsu string

cardNumber string

authorizationCode string

authorizationResponseCode string

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}$

expirationMonth int32

expirationYear int32

installmentNumber int32

installmentType string

Possible values: [NONE, MERCHANT]

Default value: NONE

Enum [ NONE(Transação a vista), MERCHANT(Transação parcelada pelo lojista, ou seja, sem juros)]

wallet

object

Wallet response

qrCode string

qrCodeBase64 string

expiresAt date-time

Formato ISO 8601. Exemplo: 2022-05-01T16:00:00-03:00 (significa que expirará em 01/05/2022 às 16h no fuso horário -03:00)

]

Example (from schema)

{
  "merchantChargeId": "string",
  "id": "string",
  "chargeStatus": "PRE_AUTHORIZED",
  "amount": 0,
  "originalAmount": 0,
  "refundedAmount": 0,
  "transactions": [
    {
      "paymentType": "CREDIT",
      "amount": 0,
      "originalAmount": 0,
      "refundedAmount": 0,
      "transactionStatus": "PRE_AUTHORIZED",
      "createdAt": "2022-05-01T16:00:00-03:00",
      "updatedAt": "2022-05-01T16:00:00-03:00",
      "transactionId": "string",
      "softDescriptor": "string",
      "errorMessage": "string",
      "credit": {
        "nsu": "string",
        "cardNumber": "string",
        "authorizationCode": "string",
        "authorizationResponseCode": "string",
        "brand": "VISA",
        "cardholderName": "string",
        "cardholderDocument": "string",
        "expirationMonth": 0,
        "expirationYear": 0,
        "installmentNumber": 0,
        "installmentType": "NONE"
      },
      "wallet": {
        "qrCode": "string",
        "qrCodeBase64": "string",
        "expiresAt": "2022-05-01T16:00:00-03:00"
      }
    }
  ]
}

Resposta de autorização com lateCapture false

{
  "merchantChargeId": "8086bfd7-6241-4f76-81d8-70460533ce74",
  "id": "ed50d469-ae7d-4a3d-a946-6e399cb981bb",
  "chargeStatus": "PAID",
  "amount": 1000,
  "originalAmount": 1000,
  "refundedAmount": 0,
  "transactions": [
    {
      "paymentType": "CREDIT",
      "amount": 1000,
      "originalAmount": 1000,
      "refundedAmount": 0,
      "transactionStatus": "PAID",
      "createdAt": "2023-11-08T10:42:36-03:00",
      "updatedAt": "2023-11-08T10:42:36-03:00",
      "transactionId": "1100000000000000000",
      "softDescriptor": "teste softDescriptor",
      "errorMessage": null,
      "credit": {
        "nsu": "000000002",
        "cardNumber": null,
        "authorizationCode": "000000",
        "authorizationResponseCode": "000000",
        "brand": "ELO",
        "cardholderName": "Pessoa da Silva",
        "cardholderDocument": "35213198066",
        "expirationMonth": null,
        "expirationYear": null,
        "installmentNumber": 0,
        "installmentType": "NONE"
      },
      "wallet": null
    }
  ]
}

Resposta de autorização com lateCapture true

{
  "merchantChargeId": "8086bfd7-6241-4f76-81d8-70460533ce74",
  "id": "ed50d469-ae7d-4a3d-a946-6e399cb981bb",
  "chargeStatus": "PRE_AUTHORIZED",
  "amount": 1000,
  "originalAmount": 1000,
  "refundedAmount": 0,
  "transactions": [
    {
      "paymentType": "CREDIT",
      "amount": 1000,
      "originalAmount": 1000,
      "refundedAmount": 0,
      "transactionStatus": "PRE_AUTHORIZED",
      "createdAt": "2023-11-08T10:42:36-03:00",
      "updatedAt": "2023-11-08T10:42:36-03:00",
      "transactionId": "1100000000000000000",
      "softDescriptor": "teste softDescriptor",
      "errorMessage": null,
      "credit": {
        "nsu": "000000002",
        "cardNumber": null,
        "authorizationCode": "000000",
        "authorizationResponseCode": "000000",
        "brand": "ELO",
        "cardholderName": "Pessoa da Silva",
        "cardholderDocument": "35213198066",
        "expirationMonth": null,
        "expirationYear": null,
        "installmentNumber": 0,
        "installmentType": "NONE"
      },
      "wallet": null
    }
  ]
}

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...