Skip to main content
POST
C#
This endpoint requires the transactions.write scope.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

prefer
string[] | null

The preferred resource type in the response.

Example:

"resource=transaction"

x-gr4vy-merchant-account-id
string

The ID of the merchant account to use for this request.

Example:

"default"

idempotency-key
string | null

A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions.

Example:

"request-12345"

Path Parameters

transaction_id
string<uuid>
required

The ID of the transaction

Example:

"7099948d-7286-47e4-aad8-b68f7eb44591"

Body

application/json

Request body for capturing an authorized transaction.

amount
integer | null

The amount to capture, in the smallest currency unit (e.g., cents). This must be less than or equal to the authorized amount, unless over-capture is available.

Required range: 0 <= x <= 99999999
Example:

1299

airline
Airline · object | null

The airline data to submit to the payment service during the capture call.

cart_items
CartItem · object[] | null

An array of cart items that represents the line items of this capture.

tracking
Tracking · object[] | null

An array of shipment tracking details for this capture.

Maximum array length: 5
final
boolean
default:true

Whether this is marked as the final capture for the associated transaction. Must be true or omitted when multi-capture is not enabled; a value of false is only valid when multi-capture is available on the connection.

Example:

true

external_identifier
string | null

An external identifier that can be used to match the capture against your own records.

Required string length: 1 - 300
Example:

"capture-12345"

reauthorize_if_authorization_expired
boolean
default:false

Whether this capture request should re-authorize the transaction if it has expired.

Examples:

true

false

Response

Successful Response

A full transaction resource.

id
string<uuid>
required

The ID for the transaction.

Example:

"7099948d-7286-47e4-aad8-b68f7eb44591"

reconciliation_id
string
required

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.

Example:

"default"

merchant_account_id
string
required

The ID of the merchant account this transaction belongs to.

Example:

"default"

currency
string
required

The currency code for this transaction.

Pattern: ^[A-Z]{3}$
Examples:

"EUR"

"GBP"

"USD"

amount
integer
required

The total amount for this transaction across all funding sources including gift cards.

Example:

1299

status
string
required

The status of the transaction for the payment_method. The status may change over time as asynchronous processing events occur.

Example:

"authorization_succeeded"

authorized_amount
integer
required

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.

Example:

1299

captured_amount
integer
required

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.

Example:

1299

refunded_amount
integer
required

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.

Example:

1299

settled_amount
integer
required

The net amount settled for this transaction, in the smallest currency unit (for example, cents or pence).

Example:

1100

settled
boolean
required

Indicates whether this transaction has been settled.

Example:

true

intent
string
required

The original intent used when the transaction was created.

Example:

"capture"

gift_card_redemptions
GiftCardRedemption · object[]
required

The gift cards redeemed for this transaction.

created_at
string<date-time>
required

The date and time when the transaction was created, in ISO 8601 format.

Example:

"2013-07-16T19:23:00.000+00:00"

updated_at
string<date-time>
required

The date and time when the transaction was last updated, in ISO 8601 format.

Example:

"2013-07-16T19:23:00.000+00:00"

disputed
boolean
required

Indicates whether this transaction has been disputed.

Example:

true

payment_source
string
required

The source of the transaction.

Example:

"ecommerce"

merchant_initiated
boolean
required

Indicates whether the transaction was initiated by the merchant or the customer.

Example:

true

is_subsequent_payment
boolean
required

Indicates whether the transaction represents a subsequent payment or an initial one.

Example:

false

intent_outcome
string
required

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.

Example:

"succeeded"

multi_tender
boolean
required

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.

Example:

true

account_funding_transaction
boolean
required

Marks the transaction as an AFT. Requires the payment service to support this feature, and might recipient and buyer data

Example:

true

type
string
default:transaction

Always transaction.

Allowed value: "transaction"
Example:

"transaction"

settled_currency
string | null

The ISO 4217 currency code of this transaction's settlement.

Pattern: ^[A-Z]{3}$
Example:

"USD"

country
string | null

The 2-letter ISO 3166-1 alpha-2 country code for the transaction. Used to filter payment services for processing.

Pattern: ^[A-Z]{2}$
Example:

"US"

external_identifier
string | null

An external identifier that can be used to match the transaction against your own records.

Required string length: 1 - 200
Example:

"transaction-12345"

payment_method
TransactionPaymentMethod · object | null

The payment method used for this transaction.

method
string | null

The method used for the transaction.

Example:

"card"

instrument_type
string | null

The name of the instrument used to process the transaction.

Example:

"pan"

error_code
string | null

The standardized error code set by Gr4vy.

Example:

"missing_redirect_url"

payment_service
TransactionPaymentService · object | null

The payment service used for this transaction.

pending_review
boolean
default:false

Whether a manual anti fraud review is pending with an anti fraud service.

Example:

false

buyer
TransactionBuyer · object | null

The buyer used for this transaction.

raw_response_code
string | null

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.

Example:

"E104"

raw_response_description
string | null

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.

Example:

"Missing redirect URL"

shipping_details
ShippingDetails · object | null

The shipping details associated with the transaction.

checkout_session_id
string<uuid> | null

The identifier for the checkout session this transaction is associated with.

Example:

"4137b1cf-39ac-42a8-bad6-1c680d5dab6b"

gift_card_service
GiftCardService · object | null

The gift card service used for this transaction.

reauthorized_from_transaction_id
string<uuid> | null

The identifier of the transaction from which this transaction was reauthorized.

Example:

"4137b1cf-39ac-42a8-bad6-1c680d5dab6b"

airline
Airline · object | null

Contains information about an airline travel, if applicable.

auth_response_code
string | null

This is the response description received from the processor.

Example:

"00"

avs_response_code
string | null

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.

Example:

"match"

cvv_response_code
string | null

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.

Example:

"match"

anti_fraud_decision
string | null

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.

Example:

"accept"

cart_items
CartItem · object[] | null

An array of cart items that represents the line items of a transaction.

statement_descriptor
StatementDescriptor · object | null

The statement descriptor is the text to be shown on the buyer's statements.

scheme_transaction_id
string | null

An identifier for the transaction used by the scheme itself, when available.

Example:

"123456789012345"

transaction_link_id
string | null

A transaction link identifier for the transaction used by the scheme itself, when available.

Example:

"123456789012345"

three_d_secure
TransactionThreeDSecureSummary · object | null

The 3-D Secure data that was sent to the payment service for the transaction.

payment_service_transaction_id
string | null

The payment service's unique ID for the transaction.

Example:

"tx-12345"

additional_identifiers
Additional Identifiers · object

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.

Example:
metadata
Metadata · object | null

Additional information about the transaction stored as key-value pairs.

Example:
authorized_at
string<date-time> | null

The date this transaction was authorized at.

Example:

"2013-07-16T19:23:00.000+00:00"

captured_at
string<date-time> | null

The date this transaction was captured at.

Example:

"2013-07-16T19:23:00.000+00:00"

voided_at
string<date-time> | null

The date this transaction was voided at.

Example:

"2013-07-16T19:23:00.000+00:00"

canceled_at
string<date-time> | null

The date this transaction was canceled at.

Example:

"2013-07-16T19:23:00.000+00:00"

approval_expires_at
string<date-time> | null

The date this transaction's approval URL will expire at.

Example:

"2013-07-16T19:23:00.000+00:00"

buyer_approval_timedout_at
string<date-time> | null

The date this transaction's approval timed out at.

Example:

"2013-07-16T19:23:00.000+00:00"

recipient
Recipient · object | null

The recipient of any account to account funding. For use with AFTs.

merchant_advice_code
string | null

An optional merchant advice code which provides insight into the type of transaction or reason why the payment failed.

Example:

"02"

installment_count
integer | null

The number of installments for this transaction, if applicable.

Example:

3

session_token
string | null

A session token that can be used to fetch session data for direct client integrations.

Example:

"j3CZf9Eg6nUygMAVA6PXsVWGHiccj"

tax_amount
integer | null

The sales tax amount for this transaction, represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99

Required range: 0 <= x <= 99999999
Example:

1299

merchant_tax_id
string | null

Merchant tax ID (for example, EIN or VAT number).

Required string length: 1 - 100
purchase_order_number
string | null

Invoice number or Purchase Order number.

Required string length: 1 - 100
customer_reference_number
string | null

Customer code or reference.

Required string length: 1 - 100
amount_includes_tax
boolean | null

Whether the tax is included in the amount.

Example:

false

supplier_order_number
string | null

The merchant's unique identifier for the sales order or invoice.

Required string length: 1 - 100
duty_amount
integer | null

Total charges for import/export duties.

Required range: 0 <= x <= 99999999
Example:

1299

shipping_amount
integer | null

Total shipping amount.

Required range: 0 <= x <= 99999999
Example:

1299

iso_response_code
string | null

This is the ISO8583 response code code received from the payment service.

Example:

"0110"