Retrieve a single payment transaction by its identifier.
Responses
-
The payment transaction was retrieved successfully.
Hide response attribute Show response attribute object
- data
object Required The payment transaction for the given payment transaction ID. Its shape depends on
origin.One of: Hide attributes Show attributes
-
The type of the authorization for the transaction. Either PENDING if the authorized amount is a temporary hold on the user's funds, or FINAL if the authorized amount is the final amount that will be charged to the user.
Values are
PARTIALorFINAL. -
The amount that was authorized from the payment transaction. This is the amount that was requested to be charged to the user.
Minimum value is
0. -
The date and time when the payment transaction was authorized
-
The timestamp when the transaction was cancelled. This field is only set if the transaction was cancelled.
-
The amount that was captured from the payment transaction. This is the amount that was actually charged to the user.
Minimum value is
0. -
The date and time when the payment transaction was captured
-
The unique identifier of the cart associated with the payment transaction.
-
The identifier of the client that created the payment transaction: the one that authorized it for a platform transaction, the one that imported it for an imported one.
-
The date and time when the payment transaction was created
-
The currency of the transaction.
- deliveryNote
object Required The state of the transaction's delivery note, or
nullif none was ever wanted - its provider produces none, or none could be determined when the transaction was authorized. A delivery note is wanted from the authorization onwards but only produced once the capture starts, so PENDING is the ordinary state until then. It carries no deadline: a transaction that is cancelled or never captured leaves it pending, and the transaction's ownstatusis what says it is not coming. Narrow onstatus.One of: Hide attributes Show attributes
Hide attributes Show attributes
Hide attributes Show attributes
-
The date and time the generation last failed.
-
Why the generation failed.
Values are
FEATURE_NOT_SUPPORTED,PROVIDER_NOT_ACTIVE, orUNKNOWN. -
The unique identifier of the delivery note.
-
The state of the delivery note. FAILED: the last generation attempt failed.
Value is
FAILED.
Hide attributes Show attributes
-
The date and time the generation was cancelled.
-
The date and time the generation last failed before it was cancelled, or
nullif it never failed. -
Why the generation last failed before it was cancelled, or
nullif it never failed.Values are
FEATURE_NOT_SUPPORTED,PROVIDER_NOT_ACTIVE, orUNKNOWN. -
The unique identifier of the delivery note.
-
The state of the delivery note. CANCELLED: the generation was cancelled and will not be attempted again.
Value is
CANCELLED.
-
-
The timestamp when the transaction failed. This field is only set if the transaction failed.
-
The failure code of the transaction. This field is only set if the transaction failed.
Values are
PAYMENT_METHOD_EXPIRED,INVALID_CARD_NUMBER,INSUFFICIENT_FUNDS,FRAUD_DETECTED,RESTRICTED_CARD,WITHDRAWAL_LIMIT_EXCEEDED,WITHDRAWAL_FREQUENCY_LIMIT_EXCEEDED,DECLINED_BY_ISSUER,TERMINAL_NOT_AVAILABLE,PROVIDER_ERROR,INVALID_METADATA,PROVIDER_NOT_AVAILABLE,PROVIDER_NOT_ENABLED, orUNKNOWN. -
The unique identifier of the payment transaction
-
The kind of the payment method used for this transaction.
-
The origin of the transaction. PLATFORM: authorized and captured through this service.
Value is
PLATFORM. -
The unique identifier of the payment method used for the transaction
-
The point of interaction (POI) where the transaction took place.
Hide poi attributes Show poi attributes object
-
The address of the point of interest (POI) associated with the payment transaction.
Hide address attributes Show address attributes object
-
The unique identifier of the point of interest (POI) associated with the payment transaction.
-
The name of the point of interest (POI).
-
The IANA time zone of the point of interest (POI).
-
- products
object Required A list of products that are part of the transaction. Useful for reporting purposes like receipts.
One of: Hide attributes Show attributes
-
The unique identifier of the buyer the product is associated with.
- configurations
object Required A list of product configurations. More configuration types may be added in the future, so clients reading configurations should handle types they do not know.
One of: Hide attributes Show attributes
-
The localized label of the product configuration.
-
The latitude of the location
Minimum value is
-90, maximum value is90. -
The longitude of the location
Minimum value is
-180, maximum value is180. -
The unique identifier of the product configuration.
-
Value is
LOCATION.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- options
object Required The selected configuration options for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- periods
object Required The periods of the product configuration. More pricing values may be added in the future, so clients reading periods should handle values they do not know.
One of: Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
TOTAL. -
The date and time when the period started.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
The price per unit of the period excluding VAT.
Minimum value is
0. -
The price per unit of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
UNIT. -
The quantity of the period.
Minimum value is
0. -
The date and time when the period started.
-
The unit of measurement for the period's quantity.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
-
-
Value is
PERIODS.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- option
object Required The selected configuration option for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
SINGLE_SELECT.
-
-
The unique identifier of the contract the product is associated with.
-
The currency of the product.
-
The unique identifier of the product.
-
The localized label of the product.
-
The total price of this product excluding VAT.
Minimum value is
0. -
The total price of this product including VAT.
Minimum value is
0. -
The price per unit of the product excluding VAT.
Minimum value is
0. -
The price per unit of the product including VAT.
Minimum value is
0. -
The quantity of the product.
Minimum value is
0. -
Value is
CANCELLED. -
The unique identifier of the supplier the product is associated with.
-
The type of the product.
-
The unit of the product.
-
The VAT amount of the product.
Minimum value is
0. -
The VAT rate of the product from 0 (0%) to 1 (100%).
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The unique identifier of the buyer the product is associated with.
- configurations
object Required A list of product configurations. More configuration types may be added in the future, so clients reading configurations should handle types they do not know.
One of: Hide attributes Show attributes
-
The localized label of the product configuration.
-
The latitude of the location
Minimum value is
-90, maximum value is90. -
The longitude of the location
Minimum value is
-180, maximum value is180. -
The unique identifier of the product configuration.
-
Value is
LOCATION.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- options
object Required The selected configuration options for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- periods
object Required The periods of the product configuration. More pricing values may be added in the future, so clients reading periods should handle values they do not know.
One of: Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
TOTAL. -
The date and time when the period started.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
The price per unit of the period excluding VAT.
Minimum value is
0. -
The price per unit of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
UNIT. -
The quantity of the period.
Minimum value is
0. -
The date and time when the period started.
-
The unit of measurement for the period's quantity.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
-
-
Value is
PERIODS.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- option
object Required The selected configuration option for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
SINGLE_SELECT.
-
-
The unique identifier of the contract the product is associated with.
-
The currency of the product.
-
The unique identifier of the product.
-
The localized label of the product.
-
The total price of this product excluding VAT.
Minimum value is
0. -
The total price of this product including VAT.
Minimum value is
0. -
The price per unit of the product excluding VAT.
Minimum value is
0. -
The price per unit of the product including VAT.
Minimum value is
0. -
The quantity of the product.
Minimum value is
0. -
Value is
CONFIGURED. -
The unique identifier of the supplier the product is associated with.
-
The type of the product.
-
The unit of the product.
-
The VAT amount of the product.
Minimum value is
0. -
The VAT rate of the product from 0 (0%) to 1 (100%).
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The unique identifier of the buyer the product is associated with.
- configurations
object Required A list of product configurations. More configuration types may be added in the future, so clients reading configurations should handle types they do not know.
One of: Hide attributes Show attributes
-
The localized label of the product configuration.
-
The latitude of the location
Minimum value is
-90, maximum value is90. -
The longitude of the location
Minimum value is
-180, maximum value is180. -
The unique identifier of the product configuration.
-
Value is
LOCATION.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- options
object Required The selected configuration options for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- periods
object Required The periods of the product configuration. More pricing values may be added in the future, so clients reading periods should handle values they do not know.
One of: Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
TOTAL. -
The date and time when the period started.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
The price per unit of the period excluding VAT.
Minimum value is
0. -
The price per unit of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
UNIT. -
The quantity of the period.
Minimum value is
0. -
The date and time when the period started.
-
The unit of measurement for the period's quantity.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
-
-
Value is
PERIODS.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- option
object Required The selected configuration option for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
SINGLE_SELECT.
-
-
The unique identifier of the contract the product is associated with.
-
The unique identifier of the product.
-
The localized label of the product.
-
Value is
CONFIGURING. -
The unique identifier of the supplier the product is associated with.
-
The type of the product.
-
-
Determines whether the payment transaction is a proxy transaction.
- receipt
object Required The state of the transaction's receipt, or
nullif none was ever wanted - its provider produces none, or none could be determined when the transaction was authorized. A receipt is wanted from the authorization onwards, so PENDING is the ordinary state until the capture that produces it has run. It carries no deadline: a transaction that is cancelled or never captured leaves its receipt pending, and the transaction's ownstatusis what says it is not coming. Narrow onstatus.One of: Hide attributes Show attributes
Hide attributes Show attributes
-
The date and time the generation last failed.
-
Why the generation failed.
Values are
FEATURE_NOT_SUPPORTED,PROVIDER_NOT_ACTIVE, orUNKNOWN. -
The unique identifier of the receipt.
-
The state of the receipt. FAILED: the last generation attempt failed.
Value is
FAILED.
Hide attributes Show attributes
-
The date and time the generation was cancelled.
-
The date and time the generation last failed before it was cancelled, or
nullif it never failed. -
Why the generation last failed before it was cancelled, or
nullif it never failed.Values are
FEATURE_NOT_SUPPORTED,PROVIDER_NOT_ACTIVE, orUNKNOWN. -
The unique identifier of the receipt.
-
The state of the receipt. CANCELLED: the generation was cancelled and will not be attempted again.
Value is
CANCELLED.
-
-
The current status of the payment transaction. An IMPORTED transaction is always CAPTURED: it records money that already moved. A MIGRATED transaction is CAPTURED unless it is a proxy leg, which keeps the status the previous platform left it in.
Values are
AUTHORIZING,AUTHORIZING_ACTIONS_REQUIRED,AUTHORIZING_FAILED,AUTHORIZING_CANCELLED,AUTHORIZED,AUTHORIZED_CANCELLING,AUTHORIZED_CANCELLING_FAILED,AUTHORIZED_CANCELLED,CAPTURING,CAPTURING_FAILED,CAPTURING_CANCELLED, orCAPTURED. -
The summary of the transaction, including the total amounts from each product.
Hide summary attributes Show summary attributes object
-
The currency of the transaction. This value matches the currency of each product in the transaction.
-
The total transaction amount excluding VAT.
Minimum value is
0. -
The total transaction amount including VAT.
Minimum value is
0. -
The total VAT amount for the transaction.
Minimum value is
0.
-
-
The date and time when the payment transaction was last updated
-
The unique identifier of the user associated with the payment transaction.
Hide attributes Show attributes
-
Free-form additional data supplied by the importing system, returned exactly as imported. Not interpreted by this service.
Additional properties are allowed.
-
The amount that was authorized from the payment transaction. This is the amount that was requested to be charged to the user.
Minimum value is
0. -
The date and time when the payment transaction was authorized
-
The amount that was captured from the payment transaction. This is the amount that was actually charged to the user.
Minimum value is
0. -
The date and time when the payment transaction was captured
-
The identifier of the client that created the payment transaction: the one that authorized it for a platform transaction, the one that imported it for an imported one.
-
The date and time when the payment transaction was created
-
The currency of the transaction.
-
The identifier the importing system assigned to the transaction, as submitted to the import. Unique per importing client.
-
The unique identifier of the payment transaction
-
The unique identifier of the import that created the transaction.
-
The kind of the payment method used for this transaction.
-
The origin of the transaction. IMPORTED: settled outside the platform and imported; never authorized, captured, cancelled or documented by this service.
Value is
IMPORTED. -
The unique identifier of the payment method used for the transaction
-
The point of interaction (POI) where the transaction took place, or null if the importing system did not know it.
Hide poi attributes Show poi attributes object
-
The address of the point of interest (POI).
Hide address attributes Show address attributes object
-
The unique identifier of the point of interest (POI), or null if the importing system could not resolve the site to one.
-
The name of the point of interest (POI).
-
The IANA time zone of the point of interest (POI), or null if the importing system did not provide one.
-
-
The products that are part of the transaction. Empty if the importing system did not know them.
Hide products attributes Show products attributes object
- configurations
object Required A list of product configurations. More configuration types may be added in the future, so clients reading configurations should handle types they do not know.
One of: Hide attributes Show attributes
-
The localized label of the product configuration.
-
The latitude of the location
Minimum value is
-90, maximum value is90. -
The longitude of the location
Minimum value is
-180, maximum value is180. -
The unique identifier of the product configuration.
-
Value is
LOCATION.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- options
object Required The selected configuration options for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- periods
object Required The periods of the product configuration. More pricing values may be added in the future, so clients reading periods should handle values they do not know.
One of: Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
TOTAL. -
The date and time when the period started.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
The price per unit of the period excluding VAT.
Minimum value is
0. -
The price per unit of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
UNIT. -
The quantity of the period.
Minimum value is
0. -
The date and time when the period started.
-
The unit of measurement for the period's quantity.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
-
-
Value is
PERIODS.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- option
object Required The selected configuration option for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
SINGLE_SELECT.
-
-
The currency of the product.
-
The unique identifier of the product.
-
The localized label of the product.
-
The total price of this product excluding VAT.
Minimum value is
0. -
The total price of this product including VAT.
Minimum value is
0. -
The price per unit of the product excluding VAT.
Minimum value is
0. -
The price per unit of the product including VAT.
Minimum value is
0. -
The quantity of the product.
Minimum value is
0. -
The status of the product. An imported product is always CONFIGURED: it is priced and final.
Value is
CONFIGURED. -
The type of the product.
-
The unit of the product.
-
The VAT amount of the product.
Minimum value is
0. -
The VAT rate of the product from 0 (0%) to 1 (100%).
Minimum value is
0, maximum value is1.
-
The current status of the payment transaction. An IMPORTED transaction is always CAPTURED: it records money that already moved. A MIGRATED transaction is CAPTURED unless it is a proxy leg, which keeps the status the previous platform left it in.
Values are
AUTHORIZING,AUTHORIZING_ACTIONS_REQUIRED,AUTHORIZING_FAILED,AUTHORIZING_CANCELLED,AUTHORIZED,AUTHORIZED_CANCELLING,AUTHORIZED_CANCELLING_FAILED,AUTHORIZED_CANCELLED,CAPTURING,CAPTURING_FAILED,CAPTURING_CANCELLED, orCAPTURED. -
The summary of the transaction, including the total amounts from each product.
Hide summary attributes Show summary attributes object
-
The currency of the transaction. This value matches the currency of each product in the transaction.
-
The total transaction amount excluding VAT.
Minimum value is
0. -
The total transaction amount including VAT.
Minimum value is
0. -
The total VAT amount for the transaction.
Minimum value is
0.
-
-
The date and time when the payment transaction was last updated
-
The unique identifier of the user associated with the payment transaction.
Hide attributes Show attributes
-
The type of the authorization for the transaction, as the previous platform recorded it. Either PARTIAL if the authorized amount was a temporary hold on the user's funds, or FINAL if it was the final amount.
Values are
PARTIALorFINAL. -
The amount that was authorized from the payment transaction. This is the amount that was requested to be charged to the user.
Minimum value is
0. -
The date and time when the payment transaction was authorized
-
The timestamp when the transaction was cancelled. This field is only set if the transaction was cancelled, which on a migrated transaction only a proxy leg can be.
-
The amount that was captured from the payment transaction. This is the amount that was actually charged to the user.
Minimum value is
0. -
The date and time when the payment transaction was captured
-
The identifier of the client that created the payment transaction: the one that authorized it for a platform transaction, the one that imported it for an imported one.
-
The date and time when the payment transaction was created
-
The currency of the transaction.
-
The unique identifier of the transaction's delivery note, or null if there is none.
-
The timestamp when the transaction failed. This field is only set if the transaction failed, which on a migrated transaction only a proxy leg can have.
-
The unique identifier of the payment transaction
-
The kind of the payment method used for this transaction.
-
The origin of the transaction. MIGRATED: authorized and captured through the previous payment platform and imported from it; a completed record, not a transaction this service can act on.
Value is
MIGRATED. -
The unique identifier of the payment method used for the transaction
-
The point of interaction (POI) where the transaction took place.
Hide poi attributes Show poi attributes object
-
The address of the point of interest (POI).
Hide address attributes Show address attributes object
-
The unique identifier of the point of interest (POI) associated with the payment transaction.
-
The name of the point of interest (POI).
-
The IANA time zone of the point of interest (POI), derived from the coordinates the previous platform recorded for it. Null where it recorded no usable coordinates.
-
- products
object Required A list of products that are part of the transaction. Useful for reporting purposes like receipts.
One of: Hide attributes Show attributes
-
The unique identifier of the buyer the product is associated with.
- configurations
object Required A list of product configurations. More configuration types may be added in the future, so clients reading configurations should handle types they do not know.
One of: Hide attributes Show attributes
-
The localized label of the product configuration.
-
The latitude of the location
Minimum value is
-90, maximum value is90. -
The longitude of the location
Minimum value is
-180, maximum value is180. -
The unique identifier of the product configuration.
-
Value is
LOCATION.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- options
object Required The selected configuration options for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- periods
object Required The periods of the product configuration. More pricing values may be added in the future, so clients reading periods should handle values they do not know.
One of: Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
TOTAL. -
The date and time when the period started.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
The price per unit of the period excluding VAT.
Minimum value is
0. -
The price per unit of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
UNIT. -
The quantity of the period.
Minimum value is
0. -
The date and time when the period started.
-
The unit of measurement for the period's quantity.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
-
-
Value is
PERIODS.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- option
object Required The selected configuration option for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
SINGLE_SELECT.
-
-
The unique identifier of the contract the product is associated with.
-
The currency of the product.
-
The unique identifier of the product.
-
The localized label of the product.
-
The total price of this product excluding VAT.
Minimum value is
0. -
The total price of this product including VAT.
Minimum value is
0. -
The price per unit of the product excluding VAT.
Minimum value is
0. -
The price per unit of the product including VAT.
Minimum value is
0. -
The quantity of the product.
Minimum value is
0. -
Value is
CANCELLED. -
The unique identifier of the supplier the product is associated with.
-
The type of the product.
-
The unit of the product.
-
The VAT amount of the product.
Minimum value is
0. -
The VAT rate of the product from 0 (0%) to 1 (100%).
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The unique identifier of the buyer the product is associated with. The nil UUID where the previous platform recorded no contract to resolve a buyer from.
- configurations
object Required A list of product configurations. More configuration types may be added in the future, so clients reading configurations should handle types they do not know.
One of: Hide attributes Show attributes
-
The localized label of the product configuration.
-
The latitude of the location
Minimum value is
-90, maximum value is90. -
The longitude of the location
Minimum value is
-180, maximum value is180. -
The unique identifier of the product configuration.
-
Value is
LOCATION.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- options
object Required The selected configuration options for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- periods
object Required The periods of the product configuration. More pricing values may be added in the future, so clients reading periods should handle values they do not know.
One of: Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
TOTAL. -
The date and time when the period started.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
The price per unit of the period excluding VAT.
Minimum value is
0. -
The price per unit of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
UNIT. -
The quantity of the period.
Minimum value is
0. -
The date and time when the period started.
-
The unit of measurement for the period's quantity.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
-
-
Value is
PERIODS.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- option
object Required The selected configuration option for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
SINGLE_SELECT.
-
-
The unique identifier of the contract the product is associated with. The nil UUID where the previous platform recorded no contract, which is every transaction before August 2023.
-
The currency of the product.
-
The unique identifier of the product.
-
The localized label of the product.
-
The total price of this product excluding VAT, after any discount the previous platform applied.
Minimum value is
0. -
The total price of this product including VAT, after any discount the previous platform applied.
Minimum value is
0. -
What was paid per unit excluding VAT: the total price excluding VAT divided by the quantity, after any discount the previous platform applied, so it can be below the pump price. Informational:
0where the previous platform recorded no quantity, andnullonly where the value would not fit.Minimum value is
0. -
What was paid per unit including VAT: the total price including VAT divided by the quantity, after any discount the previous platform applied, so it can be below the pump price. Informational:
0where the previous platform recorded no quantity, andnullonly where the value would not fit.Minimum value is
0. -
The quantity of the product.
Minimum value is
0. -
The status of the product. A migrated product is always CONFIGURED: it is priced and final.
Value is
CONFIGURED. -
The unique identifier of the supplier the product is associated with. The nil UUID where the previous platform recorded no merchant.
-
The type of the product.
-
The unit of the product.
-
The VAT amount of the product, after any discount the previous platform applied.
Minimum value is
0. -
The VAT rate of the product from 0 (0%) to 1 (100%).
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The unique identifier of the buyer the product is associated with.
- configurations
object Required A list of product configurations. More configuration types may be added in the future, so clients reading configurations should handle types they do not know.
One of: Hide attributes Show attributes
-
The localized label of the product configuration.
-
The latitude of the location
Minimum value is
-90, maximum value is90. -
The longitude of the location
Minimum value is
-180, maximum value is180. -
The unique identifier of the product configuration.
-
Value is
LOCATION.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- options
object Required The selected configuration options for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- periods
object Required The periods of the product configuration. More pricing values may be added in the future, so clients reading periods should handle values they do not know.
One of: Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
TOTAL. -
The date and time when the period started.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
Hide attributes Show attributes
-
The currency in which the period is priced.
-
The date and time when the period ended.
-
The price of the period excluding VAT.
Minimum value is
0. -
The price of the period including VAT.
Minimum value is
0. -
The price per unit of the period excluding VAT.
Minimum value is
0. -
The price per unit of the period including VAT.
Minimum value is
0. -
How the period is priced.
Value is
UNIT. -
The quantity of the period.
Minimum value is
0. -
The date and time when the period started.
-
The unit of measurement for the period's quantity.
-
The VAT amount of the period.
Minimum value is
0. -
The VAT rate applied to the period.
Minimum value is
0, maximum value is1.
-
-
Value is
PERIODS.
Hide attributes Show attributes
-
The localized label of the product configuration.
-
The unique identifier of the product configuration.
- option
object Required The selected configuration option for the product.
One of: Hide attributes Show attributes
-
The currency in which the configuration option is priced.
-
The localized label of the product configuration selection.
-
The price per unit of the configuration option excluding VAT.
Minimum value is
0. -
The price per unit of the configuration option including VAT.
Minimum value is
0. -
The type of the product configuration select option.
Value is
PRICED. -
The unit of measurement for the configuration option.
-
The configuration selection value.
-
The VAT rate applied to the configuration option.
Minimum value is
0.
-
-
Value is
SINGLE_SELECT.
-
-
The unique identifier of the contract the product is associated with.
-
The unique identifier of the product.
-
The localized label of the product.
-
Value is
CONFIGURING. -
The unique identifier of the supplier the product is associated with.
-
The type of the product.
-
-
Determines whether the payment transaction is a proxy transaction.
-
The unique identifier of the transaction's receipt, or null if there is none.
-
The current status of the payment transaction. An IMPORTED transaction is always CAPTURED: it records money that already moved. A MIGRATED transaction is CAPTURED unless it is a proxy leg, which keeps the status the previous platform left it in.
Values are
AUTHORIZING,AUTHORIZING_ACTIONS_REQUIRED,AUTHORIZING_FAILED,AUTHORIZING_CANCELLED,AUTHORIZED,AUTHORIZED_CANCELLING,AUTHORIZED_CANCELLING_FAILED,AUTHORIZED_CANCELLED,CAPTURING,CAPTURING_FAILED,CAPTURING_CANCELLED, orCAPTURED. -
The summary of the transaction, including the total amounts from each product.
Hide summary attributes Show summary attributes object
-
The currency of the transaction. This value matches the currency of each product in the transaction.
-
The total transaction amount excluding VAT.
Minimum value is
0. -
The total transaction amount including VAT.
Minimum value is
0. -
The total VAT amount for the transaction.
Minimum value is
0.
-
-
The date and time when the payment transaction was last updated
-
The unique identifier of the user associated with the payment transaction.
-
-
The request parameters are invalid or missing.
-
Client authentication failed.
-
Missing one or more required scopes.
-
The payment transaction was not found.
-
An internal server error occurred.
curl \
--request GET 'https://api.pace.cloud/payment/2026-4/payment-transactions/6fc2acbd-3afd-4df3-9967-836a7929b13f' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"data": {
"authorizationType": "PARTIAL",
"authorizedAmount": "120.00",
"authorizedAt": "2023-10-01T12:00:00.000Z",
"cancelledAt": "2023-10-01T12:00:00.000Z",
"capturedAmount": "46.87",
"capturedAt": "2023-10-01T12:00:00.000Z",
"cartId": "317643aa-b684-44de-873c-a72d9ed766ee",
"clientId": "pace-drive-app",
"createdAt": "2023-10-01T12:00:00.000Z",
"currency": "EUR",
"deliveryNote": {
"id": "0f7c4b1e-2a3d-4c5e-8f60-71a2b3c4d5e6",
"status": "PENDING"
},
"failedAt": "2023-10-01T12:00:00.000Z",
"failureCode": "INSUFFICIENT_FUNDS",
"id": "6fc2acbd-3afd-4df3-9967-836a7929b13f",
"kind": "FUEL_CARD_PROVIDER",
"origin": "PLATFORM",
"paymentMethodId": "b4fd81c9-8969-4323-98b7-855a7d7f0d60",
"poi": {
"address": {
"city": "Karlsruhe",
"country": "DE",
"houseNumber": "18",
"postalCode": "76131",
"street": "Haid-und-Neu-Straße"
},
"id": "154e01ae-557a-48b3-a68a-609f1507db1d",
"name": "PACE Fuel Station",
"timeZone": "Europe/Berlin"
},
"products": {
"buyerId": "0151f0e1-f932-4d3a-9e2a-0f3818b8cb1c",
"configurations": {
"label": "Pump Number",
"name": "PUMP_NUMBER",
"type": "INPUT",
"value": "100.00"
},
"contractId": "3fc6db3b-615c-4db2-9d86-c37e9df8ae47",
"currency": "EUR",
"id": "8394e4df-95f6-4b9e-87da-4982c0aaec4b",
"label": "Fueling",
"priceExcludingVAT": "61.34",
"priceIncludingVAT": "72.99",
"pricePerUnitExcludingVAT": "1.596",
"pricePerUnitIncludingVAT": "1.899",
"quantity": "38.62",
"status": "CANCELLED",
"supplierId": "1dd3721c-7c7b-4acb-8adc-e027267f603c",
"type": "FUELING",
"unit": "LITER",
"vatAmount": "13.63",
"vatRate": "0.19"
},
"proxy": true,
"receipt": {
"id": "9b4d1a02-0f4c-4a0a-9e4d-2f8a3c6b1d55",
"status": "PENDING"
},
"status": "CAPTURED",
"summary": {
"currency": "EUR",
"totalAmountExcludingVAT": "88.90",
"totalAmountIncludingVAT": "104.84",
"vatAmount": "15.94"
},
"updatedAt": "2023-10-01T12:00:00.000Z",
"userId": "a1c782d9-7a6c-4e5a-b05b-1d11b93c510a"
}
}