Skip to content

Entities

FinancialInstrumentId module-attribute 

FinancialInstrumentId = NewType(
    "FinancialInstrumentId", UUID
)

Unique identifier for a financial instrument.

Financial instruments are opaque from outside the Payment Gateway. This guarantees that the internal representation of a financial instrument is not exposed to the outside world for security and privacy reasons. All operations on a financial instrument should be done using its unique identifier.

LegalEntityId module-attribute 

LegalEntityId = NewType('LegalEntityId', UUID)

Unique identifier for a legal entity.

Legal entities are opaque from outside the Payment Gateway. This guarantees that the internal representation of a legal entity is not exposed to the outside world for security and privacy reasons. All operations on a legal entity should be done using its unique identifier.

CALocalAccountDetails dataclass 

CALocalAccountDetails(
    *,
    institution_number,
    transit_number,
    account_number,
    display_value
)

Bases: DataClassJsonMixin

Full Canadian local account details returned by a reveal operation.

account_number instance-attribute 

account_number

Up to 12-digit account number.

display_value instance-attribute 

display_value

Full account number formatted for display (e.g. "003-12345-9876543210").

institution_number instance-attribute 

institution_number

3-digit financial institution code.

transit_number instance-attribute 

transit_number

5-digit branch transit code.

FinancialInstrument dataclass 

FinancialInstrument(
    *,
    id,
    legal_entity_id,
    instrument_type,
    display_value,
    description,
    reference
)

Public read-only representation of a financial instrument.

description instance-attribute 

description

Human-readable description.

display_value instance-attribute 

display_value

Obfuscated identifier safe for display and logging.

id instance-attribute 

id

Unique identifier.

instrument_type instance-attribute 

instrument_type

Type of instrument (IBAN account, CA local account, etc.).

legal_entity_id instance-attribute 

legal_entity_id

ID of the owning legal entity.

reference instance-attribute 

reference

Machine-readable reference.

FinancialInstrumentProviderMapping dataclass 

FinancialInstrumentProviderMapping(
    *,
    financial_instrument_id,
    workspace_key,
    external_id,
    mapping_metadata
)

Public read-only representation of a financial instrument provider mapping.

external_id instance-attribute 

external_id

External ID used by the payment service provider.

financial_instrument_id instance-attribute 

financial_instrument_id

ID of the associated financial instrument.

mapping_metadata instance-attribute 

mapping_metadata

Provider-specific metadata.

workspace_key instance-attribute 

workspace_key

Provider workspace key.

IBANAccountDetails dataclass 

IBANAccountDetails(
    *, iban, bank_country_code, bic, display_value
)

Bases: DataClassJsonMixin

Full IBAN account details returned by a reveal operation.

bank_country_code instance-attribute 

bank_country_code

Country code of the bank in ISO 3166-1 alpha-2 format.

bic instance-attribute 

bic

BIC/SWIFT code of the bank.

display_value instance-attribute 

display_value

Full IBAN formatted for display (e.g. "FR76 1234 5678 9012 3456 7890 123").

iban instance-attribute 

iban

IBAN of the bank account.

LegalEntityProviderMapping dataclass 

LegalEntityProviderMapping(
    *,
    legal_entity_id,
    workspace_key,
    external_id,
    mapping_metadata
)

Public read-only representation of a legal entity provider mapping.

external_id instance-attribute 

external_id

External ID used by the payment service provider.

legal_entity_id instance-attribute 

legal_entity_id

ID of the associated legal entity.

mapping_metadata instance-attribute 

mapping_metadata

Provider-specific metadata.

workspace_key instance-attribute 

workspace_key

Provider workspace key.