Request to generate Charge with QRCode PIX

POST 
/charge/pix

Request to generate Charge with QRCode PIX

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

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 uuid

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.

lateCapture boolean

Default value: false

Inform true to perform an authorization with delayed capture. Default value: false.

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

transactions

object[]

required

Possible values: >= 1, <= 1

One transactions to be performed within the charge.

Array [

credit

object

cardId uuid

It may only contain this ID if the card was previously registered. Otherwise, the other card information becomes mandatory

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

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(Spot transaction), MERCHANT(Transaction in installments by the merchant, i.e. without interest)]

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

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

paymentType stringrequired

Possible values: [CREDIT, WALLET, PIX]

Enum [ CREDIT(Credit card), WALLET(QRCode PicPay), PIX(Pix)]

amount int32required

Possible values: >= 1

Payment amount in cents

softDescriptor string

transactionId string

pix

object

expiration int32

Possible values: >= 1

Expiration qrcode pix in seconds. Default = 600s

]

deviceInformation

object

Contains device information (mandatory to antifraud´s analisys)

ip IP

The IP of the device used to perform the transaction.

id IDnullable

Customer's device unique id

ipCountryCode IPCountryCodenullable

The country code of the address of the end customer. (Eg. BRA)

ipCity IPCitynullable

The estimated city of ip's address.

ipRegion IPRegionnullable

The estimated region ip's address.

sessionId SessionIDnullable

An identifier of the session in the device from which this event generated

sourceId String

Use this field to declare the source of a charge

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(Credit card), 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

ISO 8601 format. Example: 2022-05-01T16:00:00-03:00 (means it was created on 01/05/2022 at 16:00 in the -03:00 time zone)

updatedAt date-time

ISO 8601 format. Example: 2022-05-01T16:00:00-03:00 (means it was updated on 01/05/2022 at 16:00 in the -03:00 time zone)

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(Spot transaction), MERCHANT(Transaction in installments by the merchant, i.e. without interest)]

wallet

object

Wallet response

qrCode string

qrCodeBase64 string

expiresAt date-time

ISO 8601 format. Example: 2022-05-01T16:00:00-03:00 (means it will expire on 01/05/2022 at 16:00 in the -03:00 time zone)

]

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"
      }
    }
  ]
}

Example

{
  "merchantChargeId": "8086bfd7-6241-4f76-81d8-70460533ce74",
  "id": "ed50d469-ae7d-4a3d-a946-6e399cb981bb",
  "chargeStatus": "PRE_AUTHORIZED",
  "amount": 1000,
  "originalAmount": 1000,
  "refundedAmount": 0,
  "transactions": [
    {
      "paymentType": "PIX",
      "amount": 1000,
      "originalAmount": 1000,
      "refundedAmount": 0,
      "transactionStatus": "PENDING",
      "createdAt": "2023-11-08T11:50:21-03:00",
      "updatedAt": "2023-11-08T11:50:21-03:00",
      "transactionId": "2a50d469-ae7d-4a3d-a946-6e399cb981dh",
      "errorMessage": null,
      "credit": null,
      "wallet": null,
      "pix": {
        "qrCode": "00020101021226940014COM.PICPAY.P2B0172......",
        "qrCodeBase64": "data:image/png;base64......"
      }
    }
  ]
}

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