Payment Channels

🏦 Payment Channels

Payment Channels act as intermediaries facilitating transactions between entities, such as Payers and Payees. They represent the medium through which funds are transferred, like bank accounts. Each Payment Channel is linked to specific entities, ensuring accurate tracking and management of transactions.

🔗 Relationship with Entities

Payment Channels are directly associated with entities within the system. This linkage allows for:

  • Transaction Routing: Determining the path funds take between entities
  • Risk Detection: By having visibility into the origin of deposits (e.g., when an End User deposits from multiple different accounts), you can define rules that flag such behavior for investigation as a potential risk

📘 Field Descriptions

FieldTypeDescription
typestringGeneral type of payment channel (e.g., BANK_ACCOUNT).
idstringUnique identifier for the payment channel in Fiat Republic's system.
externalIdstringMember's identifier for the payment channel (e.g., virtual account ID).
externalStatusstringStatus of the payment channel in the Member's system (e.g., ACTIVE).
externalUpdatedAtinteger (timestamp)Timestamp of last update in the Member’s system (in milliseconds).
externalCreatedAtinteger (timestamp)Timestamp of creation in the Member’s system (in milliseconds).
channelTypestringSpecific type of the channel (usually same as type, e.g., BANK_ACCOUNT).
createdAtinteger (timestamp)Timestamp of when the channel was created in Fiat Republic (in milliseconds).
updatedAtinteger (timestamp)Timestamp of the last update in Fiat Republic (in milliseconds).
metadataobject / nullOptional metadata for custom use (currently null in examples).
bankAccountobject
bankAccount.bankNamestringName of the bank providing the account.
bankAccount.accountHolderNamestringName of the account holder.
bankAccount.countrystringCountry of the bank (ISO 3166-1 alpha-2 code).
bankAccount.ibanstringInternational Bank Account Number (IBAN).
bankAccount.bicstringBank Identifier Code (BIC/SWIFT).
bankAccount.accountNumberstring / nullLocal account number, if available.
bankAccount.routingCodesarrayList of routing codes associated with the account.
bankAccount.routingCodes.valuestringValue of the routing code (e.g., 8900).
bankAccount.routingCodes.typestringType of routing code (e.g., NCC).