transactions.write
scope.Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The preferred resource type in the response.
"resource=transaction"
"resource=transaction-void"
The ID of the merchant account to use for this request.
"default"
Path Parameters
The ID of the transaction
"7099948d-7286-47e4-aad8-b68f7eb44591"
Response
Successful Response
A full transaction resource.
The ID for the transaction.
"7099948d-7286-47e4-aad8-b68f7eb44591"
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.
"default"
The ID of the merchant account this transaction belongs to.
"default"
The currency code for this transaction.
"EUR"
"GBP"
"USD"
The total amount for this transaction across all funding sources including gift cards.
1299
The status of the transaction for the payment_method
. The status may change over time as asynchronous processing events occur.
processing
, authorization_succeeded
, authorization_declined
, authorization_failed
, authorization_voided
, authorization_void_pending
, capture_succeeded
, capture_pending
, buyer_approval_pending
"authorization_succeeded"
The amount for this transaction that has been authorized for the payment_method
. This can be less than the amount
if gift cards were used.
1299
The total amount captured for this transaction, in the smallest currency unit (for example, cents or pence). This can be the full value of the authorized_amount
or less.
1299
The total amount refunded for this transaction, in the smallest currency unit (for example, cents or pence). This can be the full value of the captured_amount
or less.
1299
The net amount settled for this transaction, in the smallest currency unit (for example, cents or pence).
1100
Indicates whether this transaction has been settled.
true
The original intent
used when the transaction was created.
authorize
, capture
"capture"
The gift cards redeemed for this transaction.
The date and time when the transaction was created, in ISO 8601 format.
"2013-07-16T19:23:00.000+00:00"
The date and time when the transaction was last updated, in ISO 8601 format.
"2013-07-16T19:23:00.000+00:00"
The way payment method information made it to this transaction.
ecommerce
, moto
, recurring
, installment
, card_on_file
"ecommerce"
Indicates whether the transaction was initiated by the merchant or the customer.
true
Indicates whether the transaction represents a subsequent payment or an initial one.
false
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.
pending
, succeeded
, failed
"succeeded"
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.
true
Marks the transaction as an AFT. Requires the payment service to support this feature, and might recipient
and buyer
data
true
Always transaction
.
"transaction"
"transaction"
The ISO 4217 currency code of this transaction's settlement.
"EUR"
"GBP"
"USD"
The 2-letter ISO 3166-1 alpha-2 country code for the transaction. Used to filter payment services for processing.
"DE"
"GB"
"US"
An external identifier that can be used to match the transaction against your own records.
1 - 200
"transaction-12345"
The payment method used for this transaction.
The method used for the transaction.
abitab
, affirm
, afterpay
, alipay
, alipayhk
, applepay
, arcuspaynetwork
, bacs
, bancontact
, banked
, bcp
, becs
, bitpay
, blik
, boleto
, boost
, card
, cashapp
, chaseorbital
, clearpay
, click-to-pay
, dana
, dcb
, dlocal
, ebanx
, efecty
, eps
, everydaypay
, gcash
, gem
, gemds
, gift-card
, giropay
, givingblock
, gocardless
, googlepay
, googlepay_pan_only
, gopay
, grabpay
, ideal
, kakaopay
, kcp
, khipu
, klarna
, latitude
, latitudeds
, laybuy
, linepay
, linkaja
, maybankqrpay
, mercadopago
, multibanco
, multipago
, nequi
, netbanking
, network-token
, nupay
, oney_10x
, oney_12x
, oney_3x
, oney_4x
, oney_6x
, ovo
, oxxo
, p24
, pagoefectivo
, payid
, paymaya
, paypal
, paypalpaylater
, payto
, payvalida
, picpay
, pix
, pse
, rabbitlinepay
, razorpay
, rapipago
, redpagos
, scalapay
, sepa
, servipag
, shopeepay
, singteldash
, smartpay
, sofort
, spei
, stitch
, stripedd
, stripetoken
, tapi
, tapifintechs
, thaiqr
, touchngo
, truemoney
, trustly
, trustlyeurope
, upi
, venmo
, vipps
, waave
, webpay
, wechat
, yape
, zippay
"card"
The name of the instrument used to process the transaction.
pan
, card_token
, redirect
, redirect_token
, googlepay
, applepay
, network_token
"pan"
The standardized error code set by Gr4vy.
"missing_redirect_url"
The payment service used for this transaction.
Whether a manual anti fraud review is pending with an anti fraud service.
false
The buyer used for this transaction.
This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.
"E104"
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.
"Missing redirect URL"
The shipping details associated with the transaction.
The identifier for the checkout session this transaction is associated with.
"4137b1cf-39ac-42a8-bad6-1c680d5dab6b"
The gift card service used for this transaction.
Contains information about an airline travel, if applicable. Information about an airline travel.
This is the response description received from the processor.
"00"
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.
match
, no_match
, partial_match_address
, partial_match_postcode
, partial_match_name
, unavailable
"match"
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.
match
, no_match
, unavailable
, not_provided
"match"
The mapped decision received from the anti-fraud service. In case of a review decision this field is not updated once the review is resolved.
accept
, error
, exception
, reject
, review
, skipped
"accept"
An array of cart items that represents the line items of a transaction.
The statement descriptor is the text to be shown on the buyer's statements. Information to show the user on their payments statement
An identifier for the transaction used by the scheme itself, when available.
"123456789012345"
The 3-D Secure data that was sent to the payment service for the transaction.
The payment service's unique ID for the transaction.
"tx-12345"
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.
{
"payment_service_authorization_id": "auth-12345",
"payment_service_capture_id": "capture-12345"
}
Additional information about the transaction stored as key-value pairs.
{
"cohort": "cohort-12345",
"order": "order-12345"
}
The date this transaction was authorized at.
"2013-07-16T19:23:00.000+00:00"
The date this transaction was captured at.
"2013-07-16T19:23:00.000+00:00"
The date this transaction was voided at.
"2013-07-16T19:23:00.000+00:00"
The date this transaction was canceled at.
"2013-07-16T19:23:00.000+00:00"
The date this transaction's approval URL will expire at.
"2013-07-16T19:23:00.000+00:00"
The date this transaction's approval timed out at.
"2013-07-16T19:23:00.000+00:00"
The recipient of any account to account funding. For use with AFTs. Recipient of an account funding transaction
An optional merchant advice code which provides insight into the type of transaction or reason why the payment failed.
"02"
"21"
The number of installments for this transaction, if applicable.
3