Rotina responsável por efetuar a emissão de um Pix cobrança imediata.
001: Banco do Brasil033: Santander237: Bradesco341: Itaú364: GerenciaNet748: Sicredi756: Sicoob999: TecnoPay
POST
Sandbox:
https://pix.tecnospeed.com.br/sandbox/pix/dynamic
Produção:
https://pix.tecnospeed.com.br/api/v1/pix/dynamic
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:
| accountId
required
|
string
UUID da conta que será usado para emissão do PIX |
| 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 |
| amount
required
|
number
Valor da cobrança, o valor final apresentado ao pagador |
| duration |
number
Tempo de duração da cobrança do PIX, granularidade em segundos |
| payerName |
string[ 1 .. 255 ]
Nome do pagador do PIX, caso preenchido o campo "payerCpfCnpj" também deve ser preenchido. |
| payerCpfCnpj |
string<= 14
CPF ou CNPJ do pagador, caso preenchido o campo "payerName" também deve ser preenchido |
| 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 imediata:
{
"accountId": "0e001b8f-64a5-481a-a564-14b823bf836c",
"description": "Cobrança relativa a compra do dia 01-01-2021",
"tags": [
"compra",
"pix",
"2021"
],
"amount": 120,
"duration": 123123,
"payerName": "João da Silva",
"payerCpfCnpj": "01001001000113",
"aditionalInformation": [
{
"name": "loja",
"value": "Loja de teste"
}
]
}
Response 201:
| id |
string
|
| surrogateKey
required
|
string
|
| transactionId
required
|
string
|
| description |
string
|
| status
required
|
string
Os possiveis status de retorno são:
|
| amount
required
|
number
|
| duration
required
|
number
|
| kind
required
|
string
|
| reason |
string
|
| revision
required
|
number
|
| payerName
required
|
string
|
| payerCpfCnpj
required
|
string
|
| tags
required
|
Array ofstrings
|
| createdAt
required
|
string<date-time>
|
| updatedAt
required
|
string<date-time>
|
| aditionalInformation
required
|
Array ofobjects
|
| errors
required
|
Array ofarrays
|
E assim também temos o Json de retorno da API com a response 201
{
"id": "string",
"surrogateKey": "string",
"transactionId": "string",
"description": "string",
"status": "string",
"amount": 0,
"duration": 0,
"kind": "string",
"reason": "string",
"revision": 0,
"payerName": "string",
"payerCpfCnpj": "string",
"tags": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"aditionalInformation": [
{
"name": "string",
"value": "string"
}
],
"errors": []
}
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.