SLC
Os eventos relacionados a SLC (Sistema de Liquidação de Cartões) disparam mensagens sempre que ocorrem atualizações na conciliação e liquidação de transações relacionadas aos recebíveis de cartões nas contas dos clientes de nossos parceiros.
Para mais informações sobre quando estes eventos são disparados e sobre o seu conteúdo, consulte a página:
Pré-requisitos
Para receber esses eventos, o parceiro deverá:
- Configurar previamente o recebedor de eventos do webhook.
- Conhecer a estrutura básica dos eventos que acompanha o objeto
data.
Informações sobre os eventos
Contexto e nome do evento
Os campos context e name poderão variar de acordo com a tabela a seguir:
context | name | Descrição |
|---|---|---|
SLC | SLC_CASH_IN_WAS_RECEIVED | O valor foi recebido no core bancário Bankly. |
SLC | SLC_CASH_IN_WAS_CLEARED | O valor foi liberado na conta destino do cliente. |
Nota
No contexto do SLC, não há um endpoint disponível para simular o recebimento dos eventos "SLC_CASH_IN_WAS_RECEIVED" e "SLC_CASH_IN_WAS_CLEARED" no ambiente de sandbox. Para realizar os testes, o parceiro deve entrar em contato com o seu Technical Account Manager (TAM).
Fluxo dos eventos
O fluxograma a seguir descreve a sequência em que os eventos ocorrem. Clique na imagem para ampliá-la:
Identificador (entityId)
entityId)O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.
No contexto de SLC, o entityId é o identificador da transação (authenticationCode).
Dados dos eventos
SLC_CASH_IN_WAS_RECEIVED
Esse evento sinaliza que o valor foi recebido no core bancário Bankly.
Descrição do objeto data do evento
data do eventoO objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
authenticationCode | string | Identificador da transação. | — |
amount | object | Objeto que contém informações sobre o valor a ser transferido. | — |
amount.value | number | Valor a ser transferido. | — |
amount.currency | string | Código da moeda de acordo com a ISO - 4217. | — |
recipient | object | Objeto que contém informações sobre o recebedor. | — |
recipient.document | object | Objeto que contém informações sobre o documento do recebedor. | — |
recipient.document.value | string | Número do documento. | — |
recipient.document.type | string | Tipo do documento, o qual pode ser “CPF” ou “CNPJ”. | — |
recipient.name | string | Nome completo do recebedor. | — |
recipient.type | string | Tipo do recebedor, o qual pode ser “CUSTOMER” ou “BUSINESS”. | — |
recipient.account | object | Objeto que contém informações sobre a conta bancária do recebedor. | — |
recipient.account.branch | string | Número da agência. | — |
recipient.account.number | string | Número da conta. | — |
recipient.account.bank | object | Objeto que contém informações sobre o banco ao qual a conta pertence. | — |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. | — |
recipient.account.bank.code | string | Código do banco. | — |
recipient.account.bank.name | string | Nome do banco. | — |
merchant | object | Objeto que contém informações sobre o comerciante. | — |
merchant.pointOfSaleCode | number | Código do ponto de venda. | — |
merchant.name | string | Nome do comerciante. | — |
merchant.document | object | Objeto que contém informações sobre o documento do comerciante. | — |
merchant.document.value | string | Número do documento. | — |
merchant.document.type | string | Tipo do documento, o qual pode ser “CPF” ou “CNPJ”. | — |
acquirer | object | Objeto que contém informações sobre o adquirente. | — |
acquirer.name | string | Nome do adquirente. | — |
acquirer.document | object | Objeto que contém informações sobre o documento do adquirente. | — |
acquirer.document.value | string | Número do documento. | — |
acquirer.document.type | string | Tipo do documento, o qual pode ser “CPF” ou “CNPJ”. | — |
transaction | object | Objeto que contém informações sobre a transação. | — |
transaction.uniqueClearingNumber | string | Código da transação no mercado. Esse número exclusivo identifica e rastreia as atividades de negociação das organizações. | — |
transaction.brand | string | Bandeira da transação. | — |
transaction.type | string | Indica a operação da transação, a qual pode ser “Credit” (crédito), “Debit” (débito) ou “Advancement” (antecipação). | — |
channel | object | Objeto que contém informações sobre o canal de transferência. | — |
channel.name | string | Nome do tipo de canal de transferência bancária, o qual sempre será “SLC”. | — |
createdAt | string | Data em que o evento de conciliação ocorreu, no formato ISO 8601 - UTC. | — |
Payload do evento
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId":"c443b2be-5d11-400e-ba43-ad5f6115cb95",
"companyKey":"STG_LUFFY",
"idempotencyKey":"06650f6e-f696-4fe1-92b6-fe0e9c00030e",
"context":"Slc",
"name":"SLC_CASH_IN_WAS_RECEIVED",
"timestamp":"2024-06-20T07:01:39.5700851Z",
"correlationId":"1e3530e9-bdf5-4319-b0e5-4ae479844953",
"data":{
"authenticationCode":"c443b2be-5d11-400e-ba43-ad5f6115cb95",
"amount":{
"value":61.86,
"currency":"BRL"
},
"recipient":{
"document":{
"value":"34183937000161",
"type":"CNPJ"
},
"type":"Business",
"name":"BANCO BV SA",
"account":{
"branch":"0001",
"number":"1104019636",
"bank":{
"code":"332",
"ispb":"13140088",
"name":"Acesso Soluções de Pagamento S.A."
}
}
},
"merchant":{
"pointOfSaleCode":"88000391",
"name":"Editora Nísia Floresta",
"document":{
"value":"01858774000110",
"type":"CNPJ"
}
},
"acquirer":{
"name":"Cielo S.A",
"document":{
"value":"34183937000161",
"type":"CNPJ"
}
},
"transaction":{
"uniqueClearingNumber":"202405271000392204283",
"brand":"ELO",
"type":"Debit"
},
"channel":{
"name":"SLC"
},
"createdAt":"2024-06-20T07:01:39.5700768Z"
},
"version":"1.0"
}
SLC_CASH_IN_WAS_CLEARED
Esse evento sinaliza que o valor foi liberado na conta destino do cliente.
Descrição do objeto data do evento
data do eventoO objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
authenticationCode | string | Identificador da transação. | — |
amount | object | Objeto que contém informações sobre o valor a ser transferido. | — |
amount.value | number | Valor a ser transferido. | — |
amount.currency | string | Código da moeda de acordo com a ISO - 4217. | — |
recipient | object | Objeto que contém informações sobre o recebedor. | — |
recipient.document | object | Objeto que contém informações sobre o documento do recebedor. | — |
recipient.document.value | string | Número do documento. | — |
recipient.document.type | string | Tipo do documento, o qual pode ser “CPF” ou “CNPJ”. | — |
recipient.name | string | Nome completo do recebedor. | — |
recipient.type | string | Tipo do recebedor, o qual pode ser “CUSTOMER” ou “BUSINESS”. | — |
recipient.account | object | Objeto que contém informações sobre a conta bancária do recebedor. | — |
recipient.account.branch | string | Número da agência. | — |
recipient.account.number | string | Número da conta. | — |
recipient.account.bank | object | Objeto que contém informações sobre o banco ao qual a conta pertence. | — |
recipient.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. | — |
recipient.account.bank.code | string | Código do banco. | — |
recipient.account.bank.name | string | Nome do banco. | — |
merchant | object | Objeto que contém informações sobre o comerciante. | — |
merchant.pointOfSaleCode | number | Código do ponto de venda. | — |
merchant.name | string | Nome do comerciante. | — |
merchant.document | object | Objeto que contém informações sobre o documento do comerciante. | — |
merchant.document.value | string | Número do documento. | — |
merchant.document.type | string | Tipo do documento, o qual pode ser “CPF” ou “CNPJ”. | — |
acquirer | object | Objeto que contém informações sobre o adquirente. | — |
acquirer.name | string | Nome do adquirente. | — |
acquirer.document | object | Objeto que contém informações sobre o documento do adquirente. | — |
acquirer.document.value | string | Número do documento. | — |
acquirer.document.type | string | Tipo do documento, o qual pode ser “CPF” ou “CNPJ”. | — |
transaction | object | Objeto que contém informações sobre a transação. | — |
transaction.uniqueClearingNumber | string | Código da transação no mercado. Esse número exclusivo identifica e rastreia as atividades de negociação das organizações. | — |
transaction.brand | string | Bandeira da transação. | — |
transaction.type | string | Indica a operação da transação, a qual pode ser “Credit” (crédito), “Debit” (débito) ou “Advancement” (antecipação). | — |
channel | object | Objeto que contém informações sobre o canal de transferência. | — |
channel.name | string | Nome do tipo de canal de transferência bancária, o qual sempre será “SLC”. | — |
createdAt | string | Data em que o evento de liquidação ocorreu, no formato ISO 8601 - UTC. | — |
Payload do evento
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId":"c443b2be-5d11-400e-ba43-ad5f6115cb95",
"companyKey":"STG_LUFFY",
"idempotencyKey":"06650f6e-f696-4fe1-92b6-fe0e9c00030e",
"context":"Slc",
"name":"SLC_CASH_IN_WAS_CLEARED",
"timestamp":"2024-06-20T07:01:39.5700851Z",
"correlationId":"1e3530e9-bdf5-4319-b0e5-4ae479844953",
"data":{
"authenticationCode":"c443b2be-5d11-400e-ba43-ad5f6115cb95",
"amount":{
"value":61.86,
"currency":"BRL"
},
"recipient":{
"document":{
"value":"34183937000161",
"type":"CNPJ"
},
"type":"Business",
"name":"BANCO BV SA",
"account":{
"branch":"0001",
"number":"1104019636",
"bank":{
"code":"332",
"ispb":"13140088",
"name":"Acesso Soluções de Pagamento S.A."
}
}
},
"merchant":{
"pointOfSaleCode":"88000391",
"name":"Editora Nísia Floresta",
"document":{
"value":"34183937000161",
"type":"CNPJ"
}
},
"acquirer":{
"name":"Cielo S.A",
"document":{
"value":"82723835000134",
"type":"CNPJ"
}
},
"transaction":{
"uniqueClearingNumber":"202405271000392204283",
"brand":"ELO",
"type":"Debit"
},
"channel":{
"name":"SLC"
},
"createdAt":"2024-06-20T07:01:39.5700768Z"
},
"version":"1.0"
}
Updated 22 days ago