Skip to main content
GET
Read one settlement by NULiquid

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

nuLiquid
string
required

The Núclea settlement number (NULiquid).

Required string length: 21
Example:

"202605280000000000001"

Response

OK

acquirerCnpj
string
required

CNPJCreddr.

acquirerCnpjBase
string
required

CNPJBaseCreddr.

acquirerName
string
required

NomCreddr.

administeredParticipant
string
required

IdentdPartAdmtd.

amount
string
required

VlrPgto, verbatim, as a decimal string.

amountType
string
required

TpVlrPgto.

arrangementCode
string
required

CodInstitdrArrajPgto.

centralizerCode
string
required

CodCentrlz.

centralizerDocument
string
required

CNPJ_CPFCentrlz.

centralizerPersonType
string
required

TpPessoaCentrlz.

currency
string
required

CodMoeda.

fileControlNumber
string
required

NumCtrlEmis of the file.

fileName
string
required

NomArq of the file.

ispbIfCreditor
string
required

ISPBIFCredr.

ispbIfDebtor
string
required

ISPBIFDevdr.

ispbIfSettlement
string
required

ISPBIFLiquidPontoVenda.

maintainedAt
string
required

DtHrManut, verbatim.

nuLiquid
string
required

NULiquid, the Núclea settlement number.

paymentDate
string
required

DtPgto (YYYY-MM-DD).

posCode
string
required

CodPontoVenda.

posDocument
string
required

CNPJ_CPFPontoVenda.

posName
string
required

NomePontoVenda.

posPersonType
string
required

TpPessoaPontoVenda.

posType
string
required

TpPontoVenda.

principalParticipant
string
required

IdentdPartPrincipal.

productType
string
required

TpProdLiquidCred, TpProdLiquidDeb or TpProdLiquidCarts, by type.

receivedAt
string
required

When this rail stored the settlement (RFC3339).

referenceDate
string
required

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

responses
object[]
required

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

strProofs
object[]
required

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
required

IndrFormaTransf.

type
enum<string>
required

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

Available options:
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.