Transactions

💸 Transactions

Transactions are a type of event (action) performed on a user account. They represent the movement of funds initiated by or affecting an entity.

🛠️ Creating a Transaction

To create a new transaction, send a POST request to the following endpoint: POST /api/v1/transactions

📝 Request Example

{
    "eventId": "5609c570-3b45-4bec-a326-9d50ee465156",
    "externalId": "pmt_eaxp4n74enj0l58vmy",
    "externalStatus": null,
    "reference": "Custom reference here",
    "amount": "2501.00",
    "currency": "EUR",
    "baseAmount": "2501.00",
    "paymentScheme": "SCT",
    "sender": {
        "externalEntityId": "pyr_xz3l6d7b4k631myjr5",
         "externalPaymentChannelId": "pyr_xz3l6d7b4k631myjr5",
         "countryCode": "BE"
    },
    "recipient": {
         "externalEntityId": "eus_v8jkx67no9g0dbglam",
         "externalPaymentChannelId": "vac_ong3zm73oela7b2jkr",
         "countryCode": "DK"
     },
     "externalCreatedAt": 1748432324513,
     "receivedAt": 1748432324728
}

📘 Field Descriptions

Field	Type	Description
`eventId`	`string`	Unique identifier for the transaction event.
`externalId`	`string`	Unique identifier for the transaction in the Member's system.
`externalStatus`	`string / null`	Optional external status provided by the Member system (can be `null`).
`reference`	`string`	Free-form reference for the transaction (e.g., invoice or customer note).
`amount`	`string`	Transaction amount in the original currency.
`currency`	`string`	ISO 4217 currency code (e.g., `EUR`, `USD`).
`baseAmount`	`string`	Normalized amount (e.g., after FX conversion, if applicable).
`paymentScheme`	`string`	Payment method/scheme used (e.g., `SCT`, `SEPA`, `FPS`).
`sender`	`object`	Details of the sending entity and payment channel.
`sender.externalEntityId`	`string`	ID of the sending entity.
`sender.externalPaymentChannelId`	`string`	ID of the sender’s payment channel.
`sender.countryCode`	`string`	ISO 3166-1 alpha-2 code of sender’s country.
`recipient`	`object`	Details of the receiving entity and payment channel.
`recipient.externalEntityId`	`string`	ID of the receiving entity.
`recipient.externalPaymentChannelId`	`string`	ID of the recipient’s payment channel.
`recipient.countryCode`	`string`	ISO 3166-1 alpha-2 code of recipient’s country.
`externalCreatedAt`	`integer` (timestamp)	Timestamp when the transaction was created in the Member's system (ms).
`receivedAt`	`integer` (timestamp)	Timestamp when the transaction was received by Fiat Republic (ms).