Sync the transaction with the payment service to get the latest status,
amounts, and some of the identifiers. This is only available for some payment
service providers.
POST
/
transactions
/
{transaction_id}
/
sync
This endpoint requires the transactions.read scope. Please note that we
will only update the transaction if it represents a valid transition from
the current status to the new status.
A list of additional identifiers that we may keep track of to manage this transaction. This
may include the authorization ID, capture ID, and processor ID, as well as an undefined list of
additional identifiers.
The date and time when this transaction was authorized in the payment
service.
Don't use this field to determine whether the transaction was authorized.
A null value doesn't necessarily imply that the transaction wasn't
authorized, it can mean that the payment service doesn't provide this
value, that it didn't provide it at the time the transaction was
authorized or that the transaction was authorized before the introduction
of this field.
The response code received from the payment service for the Address
Verification Check (AVS). This code is mapped to a standardized Gr4vy
AVS response code.
no_match - neither address or postal code match
match - both address and postal code match
partial_match_address - address matches but postal code does not
partial_match_postcode - postal code matches but address does not
unavailable - AVS is unavailable for card/country
The value of this field can be null if the payment service did not
provide a response.
The date and time when this transaction was captured in the payment
service.
Don't use this field to determine whether the transaction was captured.
A null value doesn't necessarily imply that the transaction wasn't
captured, it can mean that the payment service doesn't provide this value,
that it didn't provide it at the time the transaction was captured or that
the transaction was captured before the introduction of this field.
The name of the cart item. The value you set for this property may
be truncated if the maximum length accepted by a payment service
provider is less than 255 characters.
The amount for an individual item represented as a monetary amount
in the smallest currency unit for the given currency, for example
1299 USD cents represents $12.99.
The amount sent through to the payment processor as unitary amount
will be calculated to include the discount and tax values sent
as part of this cart item.
The amount discounted for this item represented as a monetary amount
in the smallest currency unit for the given currency, for example 1299
USD cents represents $12.99.
Please note that this amount is for the total of the cart item and not
for an individual item. For example, if the quantity is 5, this value
should be the total discount amount for 5 of the cart item.
You might see unexpected failed transactions if the discount_amount can
not be equally divided by the quantity value. This is due to the fact
that some payment services require this amount to be specified per unit.
In this situation we recommend splitting this item into separate items,
each with their own specific discount.
The tax amount for this item represented as a monetary amount
in the smallest currency unit for the given currency, for example 1299
USD cents represents $12.99.
Please not that this amount is for the total of the cart item and not
for an individual item. For example, if the quantity is 5, this value
should be the total tax amount for 5 of the cart item.
You might see unexpected failed transactions if the tax_amount can
not be equally divided by the quantity value. This is due to the fact
that some payment services require this amount to be specified per unit.
In this situation we recommend splitting this item into separate items,
each with their own specific tax amount.
The response code received from the payment service for the Card
Verification Value (CVV). This code is mapped to a standardized Gr4vy
CVV response code.
no_match - the CVV does not match the expected value
match - the CVV matches the expected value
unavailable - CVV check unavailable for card our country
not_provided - CVV not provided
The value of this field can be null if the payment service did not
provide a response.
The outcome of the original intent of a transaction.
This allows you to understand if the intent of the transaction
(e.g. capture or authorize) has been achieved when dealing with multiple
payment instruments.
If all payment instruments (payment_method and/or gift_cards)
have succeeded to get an authorization or direct sale at any point
in time then this will return a succeeded value.
If any of the payment instruments fails or declines then this will
return a failed value.
If any payment instruments is still in a pending or processing state
then the result will be pending.
Please note that if any of the payment instruments are voided or refunded
after the result reaches a succeeded state then the result will remain
unchanged.
Indicates whether the transaction represents a subsequent payment
coming from a setup recurring payment.
Please note there are some restrictions on how this flag may be
used.
The flag can only be false (or not set) when the transaction meets
one of the following criteria:
It is not merchant_initiated.
payment_source is set to card_on_file.
The flag can only be set to true when the transaction meets one of the
following criteria:
It is not merchant_initiated.
payment_source is set to recurring or installment and
merchant_initiated is set to true.
Defines if this transaction has been split across multiple payment instruments
such as a payment_method and one or more gift_cards, or multiple gift_cards
without a payment_method.
The date and time when this card was last replaced.
When the Account Updater determines that new card details are available, existing details are not
changed immediately. There are three scenarios in which the actual replacement occurs:
When this card has expired.
When only the expiration date changed.
When a transaction using this card is declined with any of the following codes:
canceled_payment_method
expired_payment_method
unavailable_payment_method
unknown_payment_method
When the replacement is applied, this field is updated.
For non-card payment methods, the value of this field is always set to null.
The payment account reference (PAR) returned by the card scheme. This is a unique
reference to the underlying account that has been used to fund this payment method.
This value will be unique if the same underlying account was used, regardless of
the actual payment method used. For example, a network token or an Apple Pay device
token will return the same PAR when possible.
The uniqueness of this value will depend on the card scheme, please refer to their documentation
for further details. The availability of the PAR in our API depends on the availability
of its value in the API of the payment service used for the transaction.
An additional label used to differentiate different sub-types of a payment
method. Most notably this can include the type of card used in a
transaction. This field is null for the non-card payment methods.
This represents the card scheme sent to the connector and it could be different from the
actual card scheme that is being used by the PSP to process the transaction
in the following situations: 1. use_additional_scheme transformation is used
with the PAN instrument but we already have a PSP token for the card.
2. use_additional_scheme transformation is used but PSP has fallen back to the
main card scheme internally.
This is the response description received from the payment service. This
can be set to any value and is not standardized across different
payment services.
The base62 encoded transaction ID. This represents a shorter version
of this transaction's id which is sent to payment services, anti-fraud services,
and other connectors. You can use this ID to reconcile a payment service's
transaction against our system.
This ID is sent instead of the transaction ID because not all services
support 36 digit identifiers.
The statement descriptor is the text to be shown on the buyer's statements.
The specific usage of these fields will depend on the capabilities of
the underlying PSP and bank. As a typical example, 'name' and
'description' could be concatenated using '* ' as a separator, and
then the resulting descriptor would be truncated to 22 characters by
the issuing bank.
The status of the transaction for the payment_method. The status
may change over time as asynchronous processing events occur.
Please note that the possible statuses returned will depend on the
operation performed. For example, a captured transaction will never
move to a authorization_voided status.
The error data received from our 3DS server. This will not be
populated if the customer failed the authentication with a
status code of N, R, or U. To see full details about
the 3DS calls in those situations please use our transaction
events API.
The 3DS data sent to the payment service for this transaction.
This will only be populated if external 3DS data was passed in
directly as part of the transaction API call, or if our 3DS server
returned a status code of Y or A.
In case of a failure to authenticate (status N, R, or U) this
field will not be populated. To see full details about the 3DS calls
please use our transaction events API.
The date and time when this transaction was voided in the payment service.
Don't use this field to determine whether the transaction was voided.
A null value doesn't necessarily imply that the transaction wasn't
voided, it can mean that the payment service doesn't provide this value,
that it didn't provide it at the time the transaction was voided or that
the transaction was voided before the introduction of this field.
