FoccoSMF - Administradora de Pagamentos (BLU)

Utilização de Serviços de Envio e Consulta de Dados para BLU

Para utilização dos serviços da BLU é utilizado o padrão REST, utilizando JSON para envio e recebimento das informações.

A URL base para utilização dos serviços é o http://<IP>:<PORTA>/service/<SERVIÇO> do FoccoSMF.

Exemplo: http://localhost:8878/service/AdministradorPagamentos/CheckInvoice

1 - Estrutura Base

1.1 - Request

1.1.1 - Campos

O corpo das demais requisições será enviado pelo atributo Requests.

Atributo	Tipo	Informação	Valor Padrão
ChaveAmbiente	string	Chave do Ambiente
Modelo	string	Modelo do Documento	"ADMINISTRADOR_PAGAMENTOS" (6)
Cnpj	string	CNPJ da Empresa
CodigoGenerico	string	Código Genérico da Plataforma	"BLU"
UrlBase	string	URL da API
Authentication	dynamic	Dados da Autenticação
Requests	object[]	Dados de Envio

1.2 - Response

1.2.1 - Campos

O corpo dos demais retornos será enviado pelo atributo Responses.

Atributo	Tipo	Informação
Responses	dynamic	Dados de Retorno

2 - Envio de Cobrança

2.1 - Request

2.1.1 - URL

<URL base para utilização dos serviços>/AdministradorPagamentos/SendInvoice

2.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
BuyerDocument	string	CNPJ/CPF do Cliente	Sim
Amount	double	Valor da Cobrança	Sim
ScheduledAt	DateTimeOffset?	Data Agendada para Pagamento	Não
BillingLater	bool	Indica se o pagamento será feito na aprovação ou no faturamento da cobrança.	Sim
IdType	string	Tipo do Identificador	Sim
Id	string	Identificador	Sim
Sequence	int	Sequência do Identificador	Sim
Billet	object	Informações de boleto.
Allowed	bool	Indica se permite boletos como forma de pagamento.	Sim
DueDate	DateTimeOffset	Data de Vencimento do Boleto	Sim

2.1.3 - Exemplo

{
    "BuyerDocument": "33916915000109",
    "Amount": 123.9,
    "ScheduledAt": null,
    "BillingLater": true,
    "Billet": {
        "Allowed": false,
        "DueDate": "2021-05-14T00:00:00-03:00"
    },
    "IdType": "PDV",
    "Id": "53225",
    "Sequence": 0
}

2.2 - Response

2.2.1 - Campos

Atributo	Tipo	Informação
BuyerDocument	string	CNPJ/CPF do Cliente
PaymentType	string	Tipo de Pagamento
Amount	double?	Valor da Cobrança
ScheduledAt	DateTimeOffset?	Data Agendada para Pagamento
BillingLater	bool?	Indica se o pagamento será feito na aprovação ou no faturamento da cobrança.
Status	string	Status da Cobrança
IncreaseOrDiscountRate	double?	Pagamento de Desconto/Acréscimo da Cobrança
IncreaseOrDiscount	double?	Valor de Desconto/Acréscimo da Cobrança
ChargerIncreaseOrDiscountRate	double?	Pagamento de Desconto/Acréscimo do Cobrador
ChargerIncreaseOrDiscount	double?	Valor de Desconto/Acréscimo do Cobrador
Kind	string	Tipo da Cobrança
ChargerKind	string	Momento da Cobrança
IssuerDocument	string	CNPJ da Empresa Emissora
Platform	string	Plataforma Resposável pelo Retorno
ExternalId	string	Identificador do Terceiro
IdType	string	Tipo do Identificador
Id	string	Identificador
RequestStatus	string	Status da Requisição Enviada
RequestMessage	string	Mensagem da Requisição Enviada
Installments	object	Conciliação financeira.
ExternalId	string	Identificador do Terceiro
ReleasedAt	DateTimeOffset?	Data do Pagamento
NetValue	double	Valor Líquido
GrossValue	double	Valor Bruto
RateValue	double	Valor da Taxa
TaxRate	double	Percentual da Taxa
AdvancesRateValue	double	Valor da Taxa de Imposto Antecipada
BillingExternalId	string	Identificador da Fatura do Terceiro

2.2.2 - Tipos de Pagamento

Mnemônico	Valor	Descrição
NAO_DEFINIDO	0	Não Definido
GARANTIDO	1	Garantido
ANTECIPADO	2	Antecipado
BOLETO	3	Boleto

2.2.3 - Status da Cobrança

Mnemônico	Valor	Descrição
AGUARDANDO_APROVACAO	1	Aguardando Aprovação
APROVADO	2	Aprovado
CANCELADO	3	Cancelado
REJEITADO	4	Rejeitado
DEVOLVIDO	999	Devolvido

2.2.4 - Exemplo

{
    "BuyerDocument": "33.916.915/0001-09",
    "PaymentType": "GARANTIDO",
    "Amount": 123.9,
    "ScheduledAt": null,
    "BillingLater": true,
    "Status": "APROVADO",
    "IncreaseOrDiscountRate": 0.0,
    "IncreaseOrDiscount": 0.0,
    "Kind": "payment_collection_optimized",
    "ChargerKind": "default",
    "Installments": [
        {
            "ExternalId": "d4f9967f-3f3f-4c68-aa83-82ebb7480f98",
            "ReleasedAt": "2021-05-14T00:00:00-03:00",
            "NetValue": 120.0,
            "GrossValue": 120.0,
            "RateValue": 3.9,
            "TaxRate": 0.31,
            "AdvancesRateValue": 0.0,
            "BillingExternalId": "7dfj9d89-9832034sd-ff44-84n2388a0duk"
        }
    ],
    "IssuerDocument": "73500480000204",
    "Platform": "BLU",
    "ExternalId": "d4f9967f-3f3f-4c68-aa83-82ebb7480f98",
    "IdType": "PDV",
    "Id": "53225",
    "RequestStatus": "OK",
    "RequestMessage": "Cobrança consultada na BLU com sucesso."
}

3 - Consulta de Cobrança

3.1 - Request

3.1.1 - URL

<URL base para utilização dos serviços>/AdministradorPagamentos/CheckInvoice

3.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
ExternalId	string	Identificador do Terceiro	Sim
IdType	string	Tipo do Identificador	Sim
Id	string	Identificador	Sim
Sequence	int	Sequência do Identificador	Sim

3.1.3 - Exemplo

{
    "ExternalId": "d4f9967f-3f3f-4c68-aa83-82ebb7480f98",
    "IdType": "PDV",
    "Id": "53225",
    "Sequence": 0
}

3.2 - Response

A Consulta de Cobrança possui exatamente o mesmo retorno do Envio de Cobranças.

4 - Cancelamento de Cobrança

4.1 - Request

4.1.1 - URL

<URL base para utilização dos serviços>/AdministradorPagamentos/CancelCharge

4.1.2 - Campos

O Cancelamento de Cobrança possui exatamente o mesmo envio do Envio de Cobranças.

4.2 - Response

O Cancelamento de Cobrança possui exatamente o mesmo retorno do Envio de Cobranças.

5 - Envio do Faturamento

5.1 - Request

5.1.1 - URL

<URL base para utilização dos serviços>/AdministradorPagamentos/SendBillingDetails

5.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
DocumentType	string	Tipo do Documento (Nota Fiscal, Título, Boleto)	Sim
Number	string	Número do Documento	Sim
Series	string	Série do Documento	Não
Date	DateTimeOffset	Data de Emissão do Documento	Sim
Key	string	Chave de Acesso do Documento	Sim
Amount	double	Valor do Documento	Sim
DocumentId	long	Identificador do Documento (Nota Fiscal, Título, Boleto)	Sim
ExternalId	string	Identificador do Terceiro	Sim
IdType	string	Tipo do Identificador	Sim
Id	string	Identificador	Sim
Sequence	int	Sequência do Identificador	Sim

5.1.3 - Exemplo

{
    "DocumentType": "Nota Fiscal",
    "Number": "288945",
    "Series": "1",
    "Date": "2021-07-16T00:00:00-03:00",
    "Key": "41210773500480000123550010002889451012670742",
    "Amount": 2423.75,
    "DocumentId": 201,
    "ExternalId": "4a548d9d-0810-4cd0-a05f-1cd2a31cf41b",
    "IdType": "PDV",
    "Id": "366672",
    "Sequence": 0
}

5.2 - Response

5.2.1 - Campos

Atributo	Tipo	Informação
DocumentId	long	Identificador do Documento (Nota Fiscal, Título, Boleto)
IssuerDocument	string	CNPJ da Empresa Emissora
Platform	string	Plataforma Resposável pelo Retorno
ExternalId	string	Identificador do Terceiro
IdType	string	Tipo do Identificador
Id	string	Identificador
RequestStatus	string	Status da Requisição Enviada
RequestMessage	string	Mensagem da Requisição Enviada

5.2.2 - Exemplo

{
    "DocumentId": 201,
    "IssuerDocument": "73500480000123",
    "Platform": "BLU",
    "ExternalId": "9ff72945-dfe9-4f28-a469-fcfb1cee4f9d",
    "IdType": "PDV",
    "Id": "366672",
    "RequestStatus": "OK",
    "RequestMessage": null
}

6 - Cancelamento do Faturamento

6.1 - Request

6.1.1 - URL

<URL base para utilização dos serviços>/AdministradorPagamentos/CancelBilling

6.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
BillingExternalId	string	Identificador de Faturamento no Terceiro	Sim
ExternalId	string	Identificador do Terceiro	Sim
IdType	string	Tipo do Identificador	Sim
Id	string	Identificador	Sim
Sequence	int	Sequência do Identificador	Sim

6.1.3 - Exemplo

{
    "BillingExternalId": "7dfj9d89-9832034sd-ff44-84n2388a0duk",
    "ExternalId": "5cfb5d56-4468-49da-aa12-90e2406f0dfd",
    "IdType": "PDV",
    "Id": "1301222",
    "Sequence": 0
}

6.2 - Response

O Cancelamento do Faturamento possui exatamente o mesmo retorno do Envio do Faturamento.

7 - Consulta de Conciliação Financeira

7.1 - Request

7.1.1 - URL

<URL base para utilização dos serviços>/AdministradorPagamentos/CheckPaymentReconciliation

7.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
ReconciliationDate	DateTimeOffset?	Data da Conciliação	Sim
IdType	string	Tipo do Identificador	Sim
Id	string	Identificador	Sim
Sequence	int	Sequência do Identificador	Sim

7.1.3 - Exemplo

{
    "ReconciliationDate": "2020-12-16T19:47:05.5268396-03:00",
    "IdType": null,
    "Id": null,
    "Sequence": 0
}

7.2 - Response

7.2.1 - Campos

Atributo	Tipo	Informação
IssuerDocument	string	CNPJ da Empresa Emissora
Platform	string	Plataforma Resposável pelo Retorno
ExternalId	string	Identificador do Terceiro
IdType	string	Tipo do Identificador
Id	string	Identificador
RequestStatus	string	Status da Requisição Enviada
RequestMessage	string	Mensagem da Requisição Enviada
Reconciliations	dynamic	Reconciliações
ReconciliationDate	DateTimeOffset?	Data da Conciliação
NetValue	double?	Valor Líquido
GrossValue	double?	Valor Bruto
RateValue	double?	Valor da Taxa
AdvancesRateValue	double?	Valor da Taxa de Imposto Antecipada
ReconciliationType	string	Tipo de Reconciliação
PaymentExternalId	string	Identificador do Pagamento
TransactionExternalId	string	Identificador da Transação

7.2.2 - Tipos de Reconciliação

Mnemônico	Valor	Descrição
PAGAMENTO	0	Pagamento

7.2.3 - Exemplo

{
    "Reconciliations": [
        {
            "ReconciliationDate": "2020-12-17T00:00:00-03:00",
            "NetValue": 607.53459,
            "GrossValue": 607.53459,
            "RateValue": 0.0,
            "AdvancesRateValue": 0.0,
            "ReconciliationType": "PAGAMENTO",
            "PaymentExternalId": "64990077",
            "TransactionExternalId": "19649"
        },
        {
            "ReconciliationDate": "2020-12-17T00:00:00-03:00",
            "NetValue": 573.59372,
            "GrossValue": 573.59372,
            "RateValue": 0.0,
            "AdvancesRateValue": 0.0,
            "ReconciliationType": "PAGAMENTO",
            "PaymentExternalId": "64990096",
            "TransactionExternalId": "19650"
        },
        {
            "ReconciliationDate": "2020-12-17T00:00:00-03:00",
            "NetValue": 425.93186,
            "GrossValue": 425.93186,
            "RateValue": 0.0,
            "AdvancesRateValue": 0.0,
            "ReconciliationType": "PAGAMENTO",
            "PaymentExternalId": "64990086",
            "TransactionExternalId": "19651"
        }
    ],
    "IssuerDocument": "73500480000123",
    "Platform": "BLU",
    "ExternalId": null,
    "IdType": null,
    "Id": null,
    "RequestStatus": "OK",
    "RequestMessage": "Conciliação financeira consultada na BLU com sucesso."
}