Skip to main content

Repasse de pagamento em lote

Esta API tem como objetivo fornecer uma estrutura padronizada para recebimento de ordens de repasse de pagamentos, as ordens passarão pela realização de validações desde a etapa inicial da criação do pedido até sua aprovação final, onde será gerado um arquivo contendo a conclusão sobre todas as ordens contidas no pedido

Arquivo de Remessa​

As ordens de repasse de pagamentos devem estar sempre contidas em um arquivo no formato .csv e padronizado conforme o modelo disponibilizado. Este é o arquivo que será enviado para a api de conciliação de crédito, validado, processado e só então, gerado o arquivo de retorno.

Arquivo de Retorno​

É o arquivo que será disponibilizado ao parceiro no final de todo o processamento de um arquivo de remessa válido, conterá todas as ordens de repasse de pagamentos que foram aprovadas e rejeitadas.

Upload do Arquivo de Remessa​

Para realização do upload do arquivo de remessa é necessário, primeiramente, a geração de um link pré-assinado temporário do S3 (AWS) que serve para fazer o upload de qualquer arquivo para a plataforma do BTG Empresas.

// exemplo de resposta:
{
  "upload_url": "https://btg-file-uploads.s3.amazonaws.com/user_28771ABC/8bce6cfc-dcd4-473b-9fae-60ef3f60ec11?AWSAccessKeyId=JAIAIR3IFH6UCHKS&SB\\u0026Expires=1447353431\\u0026Signature=abK2ncbdlAIl2hk2921AKHQ%",
  "file_url": "https://s3-sa-east-1.amazonaws.com/btg-file-uploads/8bce6cfc-dcd4-473b-9fae-60ef3f60ec11"
}

O campo upload_url informa o endereço da rota que deverá ser utilizada para efetuar o upload do arquivo, já o campo file_url informa o endereço do arquivo que deverá ser utilizado para geração do pedido na API de Conciliação de Crédito.

Após o upload do arquivo, o mesmo ficará disponível na nossa plataforma por até 3 dias corridos, até que seja vinculado a uma operação. Caso o prazo de expiração do arquivo seja atingido e o vínculo não tenha sido feito, será necessário gerar um novo link de upload e enviar o arquivo novamente.

Criar Pedido​

Nesta etapa de criação do pedido de Conciliação de Crédito é onde, de fato, será inicializada a validação e processamento do arquivo, possibilitando posteriormente, seja via requisição REST, seja via Webhook, a consulta do status desse pedido.

  • Criar Pedido de Conciliação de Crédito
// exemplo de resposta:
{
    "id": "0524b1ed-6a78-4f00-8394-543ffcd188f0",
    "status": "QUEUED"
}

Callback de status do pedido​

É uma rota que deve ser disponibilizada pelo parceiro para receber informações referente ao andamento de um pedido e também o recebimento do arquivo de retorno.

// exemplo de requisição:
{
    "id": "bb9d844c-8041-464c-b160-471d437231d6",
    "status": "QUEUED",
    "conciliatedFileS3Url": ""
}

Consultar status do pedido​

Alternativa ao uso do webhook para consulta de status do pedido.

  • Consultar status do pedido ref:get_v1-credit-conciliation-agreementid-creditconciliationorderid
// exemplo de resposta:
{
    "id": "bb9d844c-8041-464c-b160-471d437231d6",
    "status": "QUEUED",
    "conciliatedFileS3Url": ""
}

Recursos Disponíveis​

Os recursos da API de Repasse de pagamento em lote estão disponíveis no API Reference.

📘 API Reference

Repasse de pagamento em lote