A entidade Pix representa o método utilizado na execução da ordem. Contém todas as informações necessárias para a emissão de um pix.
Objeto
{
"id": "jpxyxa42fvfg416vgzvraydn3",
"orderId": "jpxyxa42fvfg416vgzvraydn3",
"status": "Created",
"provider": "StoneOpenbank",
"providerId": "ec363b21-113f-44e9-8cc3-dfcdb3cc2dc3",
"invoiceType": "InvoiceWithDueDate",
"amount": 20.0,
"dueDate": "2020-12-04",
"dueDateInDays": 3,
"limitDate": "2020-12-04",
"LimitDateInDays": 3,
"issuanceDate": "2020-12-04",
"transactionId": "",
"key": "48545115484525",
"qRCode": {
"content": "00020101021226890014br.gov.bcb.pix2567pix-h.stone.com.br/pix/v2/cobv/e1e80eed-d0cc-4ba1-a87c-2526f5e61cec5204000053039865406100.005802BR5923Nome do CPF 502021060986014RIO DE JANEIRO622905256df486abbb294668817b903ad6304D69E"
},
"createdBy": "application:credit-credit",
"createdAt": "2020-12-04T13:35:47.792Z",
"settledAt": "2020-12-04T13:35:47.792Z",
"expiredAt": "2020-12-04T13:35:47.792Z",
"lastUpdateAt": "2020-12-04T13:35:47.792Z"
}
Campos
| Campo | Descrição | Tipo de Dados | Validações |
|---|---|---|---|
id | Identificador único do pix | string | |
orderId | Identificador da ordem | string | |
status | Status atual do pix | string | |
provider | Provedor para a emissão do pix | string | |
providerId | Identificador do pix no provedor | string | |
invoiceType | Tipo de pix | string | |
amount | Valor a pagar | decimal | |
dueDate | Data de vencimento do pix. | date ("YYYY-MM-DD") | Precisa ser igual ou maior que o dia atual e igual ou menor do que a limitdate. Caso seja um dia não útil o pagamento poderá ser feito até o próximo dia útil. _Mesmo depois dessa data expirar o pagamento ainda pode ser feito. |
dueDateInDays | Data de vencimento expressa em número absoluto de dias | integer | Precisa ser maior ou igual a zero e menor ou igual a 365 dias. |
limitDate | Data limite para pagamento | date ("YYYY-MM-DD") | Deve ser igual ou maior a data de vencimento e menor que 365 dias. Caso não seja informada será configurada automaticamente a data de vencimento. |
limitDateInDays | Data limite de pagamento expressa em número absoluto de dias | integer | Deve ser menor ou igual ao valor contido em DueDateInDays e maior ou igual a zero. |
issuanceDate | Data da emissão do pix | date ("YYYY-MM-DD") | |
transactionId | Identificador da transação | string | |
key | Chave pix | string | |
qrCode.content | Conteúdo do pix | string | |
createdBy | Identificador do usuário que solicitou a criação do pix | string | |
settledAt | Data e hora em que o dinheiro do pagamento do pix é depositado na conta do beneficiário | date ("YYYY-MM-DDThh:mm:ssZ") | |
expiredAt | Data e hora em que o pix expirou OBS. O pagamento pode ocorrer mesmo após essa data | date ("YYYY-MM-DDThh:mm:ssZ") | |
createdAt | Data e hora em que o pix foi gerado | date ("YYYY-MM-DDThh:mm:ssZ") | |
lastUpdateAt | Data e hora da última atualização dos dados | date ("YYYY-MM-DDThh:mm:ssZ") |
Estados
| Status | Descrição |
|---|---|
Initial | Criação do Pix solicitada |
Created | Pix criado |
Settled | Pix pago |
Expired | Pix expirado |
Cancelled | Pix Cancelado |
Provedores
| Provider | Descrição |
|---|---|
StoneOpenbank | Utilização da Stone Openbank API |
Tipos de Invoice
| Tipo | Descrição |
|---|---|
InvoiceWithDueDate | Pix com data de vencimento |
Stream de Dados
Contrato de Streaming dos Dados do Pix
Veja Streaming de dados
{
"Stream": {
"Content": [
{
"Data": [
{
"Id": "jq6yw5d4fk39gg4u1yv713wyy",
"OrderId": "jq6yw5d2e2p7858yw3t9dy36k",
"Amount": 20.0,
"Provider": "StoneOpenbank",
"ProviderId": "xpto",
"TransactionId": "xpto",
"DueDate": "2022-01-01T00:00:00",
"DueDateInDays": 0,
"LimitDate": "2022-01-01T00:00:00",
"LimitDateInDays": 0,
"InvoiceType": "InvoiceWithDueDate",
"IssuanceDate": "2022-01-01T00:00:00",
"SettledAt": "2022-01-01T00:00:00",
"CreatedAt": "2022-01-01T00:00:00",
"CreatedBy": "xpto",
"QRCodeContent": "xpto",
"QRCodeImage": "xpto",
"Key": "xpto",
"Status": "Created",
"GeneratedAt": "2021-01-22T14:22:07.817272Z",
"GeneratedBy": "xpto",
"LastUpdatedAt": "2021-01-22T14:22:07.817272Z",
"Version": -1,
"StreamDate": "2021-01-22T14:22:22.2480082Z"
}
],
"SchemaName": "order-pix",
"SchemaVersion": 1
}
]
},
"Timestamp": "2021-01-22T14:22:22.3106853Z",
"CommandKey": "jq6yw5j3qksxeff8sy2j8gad1",
"SessionKey": "jq6yw5d2e2p7858yw3t9dy36k",
"ChannelKey": "DefaultNotificationsChannel",
"IdempotencyKey": "jq6yw5j3qks54faxbt3u5h1mk",
"SagaProcessKey": "jq6yw5cus5skevp76rm24ns3q",
"BatchProcessKey": null,
"Result": {},
"Id": "jq6yw5d2e2p7858yw3t9dy36k",
"ApplicationKey": "runscope",
"UserEmail": null,
"ValidationResult": null
}
Contrato de Streaming dos Dados - Evento
Veja Streaming de Dados - Evento na Visão Geral da Ordem de Pagamento
Tipos de Eventos e Ações
| Tipo de evento | Ação |
|---|---|
Pix | Created |
Pix | Expired |
Pix | Settled |
Pix | Cancelled |