Objeto Settlements

Ao buscar os objetos de pagamentos de cartão (settlements) de um recebedor, as seguintes informações compõem o objeto retornado:

AtributoTipoDescrição
idStringIdentificador da Settlement
amountIntValor da Settlement
productStringProduto referente à liquidação. Possíveis valores: credit, debit ou anticipation
card_brandStringBandeira do cartão
payment_dateStringData de pagamento da Settlement (Data no padrão ISO 8601)
recipient_idStringID do Recebedor
document_typeStringTipo de documento. Possíveis valores: individual(CPF) ou company(CNPJ)
contract_obligation_idStringID da obrigação de contrato da registradora (campo legado. valor default null)
liquidation_arrangement_idStringID da LiquidationArrangement
liquidation_typeStringTipo da liquidação, interna ou externa
contract_keyStringChave do contrato na registradora

Caso não seja nulo, a Settlement teve seu valor liquidado em um efeito de contrato da registradora
liquidation_engineStringMotor de liquidação interno
external_engine_payment_idStringRepresenta o ID do motor de liquidação utilizado internamente.
funding_account_idStringIdentificador da conta fonte pagadora
statusStringStatus da Settlement. Possíveis valores: failed, success, pending
ispbStringISPB da conta destino da Settlement. Para ISPBs mais populares é retornado o nome da instituição bancária, para os menos utilizados é retornado o código

Este campo só é retornado caso get_ispb seja passado na QueryString da request
target_account.ispbStringCódigo ISPB da conta destino da Settlement

Este campo só é retornado caso get_ispb seja passado na QueryString da request