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

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"

X-Forwarded-For
string

The IP address to forward from the customer. Use this when calling our API from the server side to ensure the customer's address is passed to downstream services, rather than your server IP.

Example:

"192.168.0.2"

Body

application/json
amount
integer
required

The monetary amount for this transaction, in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99. If the intent is set to capture, an amount greater than zero must be supplied. All gift card amounts are subtracted from this amount before the remainder is charged to the provided payment_method.

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

1299

currency
string
required

A supported ISO 4217 currency code. For redirect requests, this value must match the one specified for currency in payment_method.

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

"EUR"

"GBP"

"USD"

country
string | null

The 2-letter ISO code of the country where the transaction is processed. This is also used to filter the payment services that can process the transaction. If this value is provided for redirect requests and it's not null, it must match the one specified for country in payment_method. Otherwise, the value specified for country in payment_method will be assumed implicitly.

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

"US"

payment_method
CardWithUrlPaymentMethodCreate · object

Create a transaction with raw card details

buyer
GuestBuyer · object | null

Guest buyer details provided inline rather than creating a buyer resource beforehand and using the buyer_id or buyer_external_identifier keys. No buyer resource will be created on Gr4vy when used.

buyer_id
string<uuid> | null

The ID of the buyer to associate this payment method to. If this field is provided then the buyer_external_identifier field needs to be unset. If a stored payment method or gift card is provided, then the buyer for that payment method needs to match the buyer for this field.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

buyer_external_identifier
string | null

The external_identifier of the buyer to associate this payment method to. If this field is provided then the buyer_id field needs to be unset. If a stored payment method or gift card is provided, then the buyer for that payment method needs to match the buyer for this field.

Required string length: 1 - 200
Example:

"buyer-12345"

gift_cards
(GiftCardTransactionCreate · object | GiftCardTokenTransactionCreate · object)[] | null

The optional gift card(s) to use for this transaction. At least one gift card is required if no other payment_method has been added. By default, only a maximum limit of 10 gift cards may be used in a single transaction. Please contact our team to change this limit.

Create a charge against a gift card

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"

intent
string
default:authorize

Defines the intent of this API call. This determines the desired initial state of the transaction.

  • authorize - (Default) Optionally approves and then authorizes a transaction but does not capture the funds.
  • capture - Optionally approves and then authorizes and captures the funds of the transaction.
Example:

"authorize"

store
boolean
default:false

Whether or not to also try and store the payment method with us so that it can be used again for future use. This is only supported for payment methods that support this feature. There are also a few restrictions on how the flag may be set:

  • The flag has to be set to true when the payment_source is set to recurring or installment, and merchant_initiated is set to false.
  • The flag has to be set to false (or not set) when using a previously vaulted payment method.
Example:

true

three_d_secure_data
ThreeDSecureDataV1 · object

Pass through 3-D Secure data to support external 3-D Secure authorisation. If using an external 3-D Secure provider, you should not pass a redirect_url in the payment_method object for a transaction.

three_d_secure
ThreeDSecure · object | null

Optional 3-D Secure values to use during the authentication flow.

metadata
Metadata · object | null

Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.

Example:
is_subsequent_payment
boolean
default:false

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.
  • payment_source is set to card_on_file.
Example:

true

merchant_initiated
boolean
default:false

Indicates whether the transaction was initiated by the merchant (true) or customer (false).

Example:

true

payment_source
string
default:ecommerce

The use-case for the the transaction.

Example:

"ecommerce"

airline
Airline · object | null

The airline addendum data which describes the airline booking associated with this transaction.

description
string | null

An optional description for the transaction. Forwarded to the payment processor where supported. Unlike statement_descriptor, this field has no character limit and does not appear on the buyer's bank statement.

Example:

"subscription-abc-123"

cart_items
CartItem · object[] | null

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

statement_descriptor
StatementDescriptor · object | null

Details about the payment and the merchant which may end up on the (bank) statement for the payment.

previous_scheme_transaction_id
string | null

A scheme's transaction identifier to use in connecting a merchant initiated transaction to a previous customer initiated transaction. If not provided, and a qualifying customer initiated transaction has been previously made with the stored payment method, then Gr4vy will populate this value with the identifier returned for that transaction. This field is also know as the Visa Transaction Identifier, or Mastercard Trace ID.

Required string length: 1 - 100
Example:

"123456789012345"

previous_transaction_link_id
string | null

A scheme's transaction link identifier to use in connecting a merchant initiated transaction to a previous customer initiated transaction. If not provided, and a qualifying customer initiated transaction has been previously made with the stored payment method, then Gr4vy will populate this value with the identifier returned for that transaction. This field is also know as the Mastercard Transaction Link ID (TLID).

Required string length: 1 - 100
Example:

"123456789012345"

browser_info
BrowserInfo · object | null

Information about the browser used by the buyer. This can be used by anti-fraud services.

shipping_details_id
string<uuid> | null

The unique identifier of a set of shipping details stored for the buyer. If provided, the created transaction will include a copy of the details at the point of transaction creation; i.e. it will not be affected by later changes to the detail in the database.

Example:

"bf8c36ad-02d9-4904-b0f9-a230b149e341"

connection_options
TransactionConnectionOptions · object | null

Allows for passing optional configuration per connection to take advantage of connection specific features. When provided, the data is only passed to the target connection type to prevent sharing configuration across connections. Please note that each of the keys this object are in kebab-case, for example cybersource-anti-fraud as they represent the ID of the connector. All the other keys will be snake case, for example merchant_defined_data or camel case to match an external API that the connector uses.

anti_fraud_fingerprint
string | null

This field represents the fingerprint data to be passed to the active anti-fraud service.

Example:

"yGeBAFYgFmM="

payment_service_id
string<uuid> | null

The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped.

Example:

"fffd152a-9532-4087-9a4f-de58754210f0"

account_funding_transaction
boolean
default:false

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

Example:

true

allow_partial_authorization
boolean
default:false

Defines if the transaction will allow for a partial authorization.

recipient
Recipient · object | null

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

installment_count
integer | null

The number of installments a buyer is required to make.

Required range: 1 <= x <= 100
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

integration_client
string | null

Defines the client where the session for this transaction is going to be used. Please refer to the connections documentation for more guidance.

Example:

"web"

approval_expires_at
string<date-time> | null

The date and time when the buyer's approval window for this transaction expires. If not provided, this is automatically computed from the connector's default expiration time. The value cannot exceed the connector's maximum approval window.

Example:

"2026-04-01T12:00:00+00:00"

is_amount_estimated
boolean | null
default:false

Whether the authorization amount is expected to be modified in the future or not.

Example:

true

Response

Returns the created transaction.

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"