Rotina responsável por efetuar a emissão de um Pix cobrança com vencimento.
Disponível para os bancos:
341
: Itaú748
: Sicredi756
: Sicoob999
: TecnoPay
POST
Sandbox:
https://pix.tecnospeed.com.br/sandbox/pix/charge
Produção:
https://pix.tecnospeed.com.br/api/v1/pix/charge
Headers
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
Authorization | Bearer | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJ1c2VyIjp7ImVtYWlsIjoicGVkc... |
Geração do PIX
É possível realizar a inclusão dos seguintes campos:
accountIdrequired | Você pode verificar também através do portal do cedente |
description |
string<= 140
Breve descrição da cobrança, será apresentado ao cliente no pagamento do PIX |
tags |
Array ofstrings<= 5 items
Lista de tags para vincular ao pagamento |
calendarrequired |
object
Informações a respeito de controle de tempo da cobrança |
payerrequired |
object
Informações sobre o pagador da cobrança |
valuerequired |
object
Valores referentes a cobrança |
aditionalInformation |
Array ofobjects<= 50 items
Informações adicionais que serão apresentadas ao pagador |
Segue abaixo Json de exemplo sobre a emissão de PIX de cobrança com vencimento:
{
"accountId": "0e001b8f-64a5-481a-a564-14b823bf836c",
"description": "Cobrança relativa a compra do dia 01-01-2021",
"tags": [
"compra",
"pix",
"2021"
],
"calendar": {
"dueDate": "2021-01-01",
"daysAfterDueDate": 10
},
"payer": {
"cpfCnpj": "01001001000113",
"name": "João da Silva",
"email": "email@email.com",
"street": "Av. Brasil, 100, Centro",
"city": "Maringá",
"state": "PR",
"zipcode": "87045170"
},
"value": {
"original": 132.9,
"fine": {},
"interest": {},
"reduction": {},
"discount": {}
},
"aditionalInformation": [
{
"name": "loja",
"value": "Loja de teste"
}
]
}
Response 201:
id |
string
|
surrogateKey
required
|
string
|
transactionId
required
|
string
|
description |
string
|
tags
required
|
Array ofstrings
|
kind
required
|
string
|
revision
required
|
number
|
status
required
|
string
Os possiveis status de retorno são:
|
errors
required
|
Array ofstrings
|
reason |
string
|
calendar |
object
|
payer |
object
|
value |
object
|
aditionalInformation
required
|
Array ofobjects
|
createdAt
required
|
string<date-time>
|
updatedAt
required
|
string<date-time>
|
E assim também temos o Json de retorno da API com a response 201
{
"id": "string",
"surrogateKey": "string",
"transactionId": "string",
"description": "string",
"tags": [
"string"
],
"kind": "string",
"revision": 0,
"status": "string",
"errors": [
"string"
],
"reason": "string",
"calendar": {
"dueDate": "string",
"daysAfterDueDate": 0
},
"payer": {
"cpfCnpj": "string",
"name": "string",
"email": "string",
"street": "string",
"city": "string",
"state": "string",
"zipcode": "string"
},
"value": {
"original": 0,
"fine": {
"modality": 0,
"valuePerc": 0
},
"interest": {
"modality": 0,
"valuePerc": 0
},
"reduction": {
"modality": 0,
"valuePerc": 0
},
"discount": {
"modality": 0,
"fixedDateDiscount": [
{
"date": "string",
"valuePerc": 0
}
],
"valuePerc": 0
}
},
"aditionalInformation": [
{
"name": "string",
"value": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
Response com erro ( 422 ):
code
required
|
number
Código HTTP |
errors
required
|
Array ofobjects(SubErrorsFormat)
Lista dos erros de validação |
Json com erro:
{
"code": 422,
"errors": [
{
"type": "business_logic",
"property": "dueDate",
"message": "email should not be empty"
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.