Os convênios representam o vínculo contratual entre um estabelecimento e uma instituição bancária, definindo como operações financeiras (Boleto, Pix, HybridPayment/BolePix) devem ser processadas.
Cada convênio encapsula:
Identificação bancária
Dados operacionais (conta, agência, sistema)
Regras de prioridade
Habilitação por tipo de pagamento
Essa entidade é central para o fluxo de pagamentos de boletos, pix e bolepix.
URL:
/v2/BankAgreements?{parameters}
Os parâmetros são:
Response body:
{
"page": 0,
"pageSize": 0,
"totalCount": 0,
"totalPages": 0,
"items": [
{
"bankAgreementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accessKey": "string",
"alias": "string",
"system": "string",
"cobrancaEletronica": {
"bank": 2147483647,
"branch": "123",
"accountNumber": "4456",
"boleto": {
"hash": "string",
"pkce": "string",
"socialNumber": "string",
"isMain": true
},
"pix": {
"pixCode": "string",
"hash": "string",
"pkce": "string",
"socialNumber": "string",
"isMain": true
}
},
"bancoNix": {
"boleto": {
"bank": 2147483647,
"branch": "123",
"accountNumber": "cupwo6NLD1tB3",
"socialNumber": "string",
"accountId": "string",
"isMain": true
},
"pix": {
"socialNumber": "string",
"pixType": 0,
"pixCode": "string",
"accountId": "string",
"isMain": true
}
},
"active": true,
"isMainPix": true,
"isMainBillet": true,
"origin": "string"
}
]
}