Pular para o conteúdo principal
GET
Read one settlement by NULiquid

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

nuLiquid
string
obrigatório

The Núclea settlement number (NULiquid).

Required string length: 21
Exemplo:

"202605280000000000001"

Resposta

OK

acquirerCnpj
string
obrigatório

CNPJCreddr.

acquirerCnpjBase
string
obrigatório

CNPJBaseCreddr.

acquirerName
string
obrigatório

NomCreddr.

administeredParticipant
string
obrigatório

IdentdPartAdmtd.

amount
string
obrigatório

VlrPgto, verbatim, as a decimal string.

amountType
string
obrigatório

TpVlrPgto.

arrangementCode
string
obrigatório

CodInstitdrArrajPgto.

centralizerCode
string
obrigatório

CodCentrlz.

centralizerDocument
string
obrigatório

CNPJ_CPFCentrlz.

centralizerPersonType
string
obrigatório

TpPessoaCentrlz.

currency
string
obrigatório

CodMoeda.

fileControlNumber
string
obrigatório

NumCtrlEmis of the file.

fileName
string
obrigatório

NomArq of the file.

ispbIfCreditor
string
obrigatório

ISPBIFCredr.

ispbIfDebtor
string
obrigatório

ISPBIFDevdr.

ispbIfSettlement
string
obrigatório

ISPBIFLiquidPontoVenda.

maintainedAt
string
obrigatório

DtHrManut, verbatim.

nuLiquid
string
obrigatório

NULiquid, the Núclea settlement number.

paymentDate
string
obrigatório

DtPgto (YYYY-MM-DD).

posCode
string
obrigatório

CodPontoVenda.

posDocument
string
obrigatório

CNPJ_CPFPontoVenda.

posName
string
obrigatório

NomePontoVenda.

posPersonType
string
obrigatório

TpPessoaPontoVenda.

posType
string
obrigatório

TpPontoVenda.

principalParticipant
string
obrigatório

IdentdPartPrincipal.

productType
string
obrigatório

TpProdLiquidCred, TpProdLiquidDeb or TpProdLiquidCarts, by type.

receivedAt
string
obrigatório

When this rail stored the settlement (RFC3339).

referenceDate
string
obrigatório

DtRef of the file (YYYY-MM-DD).

responses
object[]
obrigatório

The answers given to this settlement, oldest first; empty until one is given.

strProofs
object[]
obrigatório

The STR's proof that an LBTR paid this ASLC032 settlement's file, from the SLC0005 and LTR0005R2 this rail stored; empty until both arrive and agree, and always empty for CREDIT and DEBIT.

transferForm
string
obrigatório

IndrFormaTransf.

type
enum<string>
obrigatório

The notice that carried it: CREDIT (ASLC022), DEBIT (ASLC024), ANTICIPATION (ASLC032).

Opções disponíveis:
CREDIT,
DEBIT,
ANTICIPATION
acquirerAccount
string

CtCreddr; absent when the file omits it.

acquirerBranch
string

AgCreddr; absent when the file omits it.

cancelled
object

The ASLC061/065 that cancelled the settlement: the domicile must not credit it. Absent while it stands.

centralizerAccount
string

CtCentrlz; absent when the file omits it.

centralizerAccountType
string

TpCt; absent when the file omits it.

centralizerBranch
string

AgCentrlz; absent when the file omits it.

centralizerPaymentAccount
string

CtPgtoCentrlz; absent when the file omits it.

settled
object

Núclea's ASLC929 report that read the settlement Liquidado; absent while open.