Skip to main content
GET
Read the inbound-portability lineage of a contract

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

numeroContrato
string
required

The rail contract number, byte-exact.

Required string length: 1 - 128

Response

OK

currency
string
required

ISO 4217 currency code.

effectiveAt
string
required

UTC instant the portability took effect at the ORIGIN (RFC3339, sub-second precision preserved to the microsecond the row stores). Not the instant we booked.

numeroContrato
string
required

The rail contract number.

origins
object[] | null
required

The contracts paid off, one per origin bank and contract, in the order the booking fact stated them.

transferredPrincipal
string
required

Total paid off at the origins, cent scale: their sum, at most the booked principal. The difference is the troco, new money to the worker.