Request This endpoint expects an object.
amount integer Required
The transaction amount in minor units . Positive values for in-flow, negative values for out-flow.
currency enum Required
ISO currency code.
merchant_amount integer Required
Original merchant transaction amount in minor units.
merchant_currency enum Required
ISO currency code for the merchant_amount.
merchant_location string Required <=128 characters
The merchant location.
merchant_name string Required <=128 characters
The merchant name.
payment_method object Required
type enum Required
The nature of the transaction.
description string Optional <=255 characters
A human-readable description of the transaction.
entity_user_id string Optional format: "uuid"
ID of the entity user who made the transaction, if applicable.
external_id string Optional <=128 characters
External identifier for idempotency, if provided by the source system.
partner_metadata map from strings to strings Optional
Extensible key-value pairs for storing additional custom information for partner needs.
started_at datetime Optional
Date and time when the transaction was initiated.
status enum Optional
The current processing status of the transaction.
Response Successful Response
id string format: "uuid"
A unique Monite-generated ID assigned to this transaction.
amount integer
The transaction amount in minor units . Positive values for in-flow, negative values for out-flow.
currency enum
ISO currency code.
entity_id string format: "uuid"
ID of the entity that owns this resource.
merchant_amount integer
Original merchant transaction amount in minor units.
merchant_currency enum
ISO currency code for the merchant_amount.
merchant_location string <=128 characters
The merchant location.
merchant_name string <=128 characters
The merchant name.
started_at datetime
Date and time when the transaction was initiated.
type enum
The nature of the transaction.
description string <=255 characters
A human-readable description of the transaction.
entity_user_id string format: "uuid"
ID of the entity user who made the transaction, if applicable.
external_id string <=128 characters
External identifier for idempotency, if provided by the source system.
partner_metadata map from strings to strings
Extensible key-value pairs for storing additional custom information for partner needs.
receipt_id string
ID of the related receipt from payables service, if any. This field is read-only and system-managed.
status enum
The current processing status of the transaction.
