Update a transaction

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 | null

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

Example:

"default"

Path Parameters

transaction_id

string<uuid>

required

The ID of the transaction

Body

application/json

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"

metadata

Metadata · object

Additional information about the transaction stored as key-value pairs. If provided, the whole value will be overridden.

Show child attributes

metadata.{key}

string

Example:

{
  "cohort": "cohort-12345",
  "order": "order-12345"
}

connection_options

TransactionConnectionOptions · object

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. If provided, the whole value will be overridden.

Show child attributes

connection_options.account-updater

AccountUpdaterOptions · object

Custom options to be passed to the account-updater connector, allowing for simulating different account updater responses.

Show child attributes

connection_options.account-updater.response_code

string | null

The type of response to simulate.

Allowed value: "updated"

Example:

"updated"

connection_options.account-updater.account_number

string | null

When the response_code is set to updated, the payment method's account number will be updated to this value.

Required string length: 12 - 18

Example:

"4242424242424242"

connection_options.account-updater.expiration_month

string | null

When the response_code is set to updated, the payment method's expiration month will be updated to this value.

Required string length: 2

Example:

"12"

connection_options.account-updater.expiration_year

string | null

When the response_code is set to updated, the payment method's expiration year will be updated to this value.

Required string length: 4

Example:

"2030"

connection_options.account-updater.error_code

string | null

The type of error code to simulate.

Example:

"error"

connection_options.adyen-afterpay

AdyenOptions · object

Custom options to be passed to the adyen-afterpay connector.

Show child attributes

connection_options.adyen-afterpay.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-afterpay.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.adyen-alipay

AdyenOptions · object

Custom options to be passed to the adyen-alipay connector.

Show child attributes

connection_options.adyen-alipay.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-alipay.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.adyen-card

AdyenCardOptions · object

Custom options to be passed to the adyen-card connector.

Show child attributes

connection_options.adyen-card.autoRescue

boolean | null

Set to true to enable Auto Rescue for a transaction. Use the maxDaysToRescue to specify a rescue window.

Example:

true

connection_options.adyen-card.maxDaysToRescue

integer | null

The rescue window for a transaction, in days, when autoRescue is set to true. You can specify a value between 1 and 48. For cards, the default is one calendar month. For SEPA, the default is 42 days.

Example:

20

connection_options.adyen-card.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-card.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.adyen-card.autoRescueScenario

enum<string> | null

The rescue scenario to simulate for a transaction, when autoRescue is set to true.

Available options:

AutoRescueSuccessfulFirst,

AutoRescueSuccessfulSecond,

AutoRescueFailed,

AutoRescueFraud

Example:

"AutoRescueSuccessfulFirst"

connection_options.adyen-card.window_origin

string | null

The origin of the window where the payment is initiated, used for 3D Secure authentication.

Example:

"https://example.com"

connection_options.adyen-card.splits

AdyenSplitsOptions · object

Passes information of splitting payment amounts to the Adyen API.

Show child attributes

connection_options.adyen-card.splits.authorization

Authorization · object[] | null

Split payment values to pass to the Adyen API on payment authorization. See the Adyen docs for details on the format and contents of the list.

connection_options.adyen-card.splits.capture

Capture · object[] | null

Split payment values to pass to the Adyen API on payment capture. See the Adyen docs for details on the format and contents of the list.

connection_options.adyen-card.splits.refund

Refund · object[] | null

Split payment values to pass to the Adyen API on payment refund. See the Adyen docs for details on the format and contents of the list.

connection_options.adyen-cashapp

AdyenOptions · object

Custom options to be passed to the adyen-cashapp connector.

Show child attributes

connection_options.adyen-cashapp.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-cashapp.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.adyen-giropay

AdyenOptions · object

Custom options to be passed to the adyen-giropay connector.

Show child attributes

connection_options.adyen-giropay.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-giropay.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.adyen-ideal

AdyenOptions · object

Custom options to be passed to the adyen-ideal connector.

Show child attributes

connection_options.adyen-ideal.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-ideal.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.adyen-sepa

AdyenSepaOptions · object

Custom options to be passed to the adyen-sepa connector.

Show child attributes

connection_options.adyen-sepa.autoRescue

boolean | null

Set to true to enable Auto Rescue for a transaction. Use the maxDaysToRescue to specify a rescue window.

Example:

true

connection_options.adyen-sepa.maxDaysToRescue

integer | null

Example:

20

connection_options.adyen-sepa.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-sepa.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.adyen-sepa.autoRescueSepaScenario

enum<string> | null

The rescue scenario to simulate for a transaction, when autoRescue is set to true.

Available options:

AutoRescueSuccessfulFirst,

AutoRescueSuccessfulSecond,

AutoRescueFailed

Example:

"AutoRescueSuccessfulFirst"

connection_options.adyen-sepa.ownerName

string | null

The name on the SEPA bank account.

Example:

"A. Schneider"

connection_options.adyen-sofort

AdyenOptions · object

Custom options to be passed to the adyen-sofort connector.

Show child attributes

connection_options.adyen-sofort.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-sofort.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.adyen-vipps

AdyenOptions · object

Custom options to be passed to the adyen-vipps connector.

Show child attributes

connection_options.adyen-vipps.additionalData

Additionaldata · object

Passes additional data to the Adyen API when creating a transaction.

Show child attributes

connection_options.adyen-vipps.additionalData.{key}

string

Example:

{ "subMerchantID": "12345" }

connection_options.affirm-affirm

AffirmOptions · object

Custom options to be passed to the affirm-affirm connector.

Show child attributes

connection_options.affirm-affirm.discounts

Discounts · object

Passes additional discounts to the Affirm widget.

Show child attributes

connection_options.affirm-affirm.discounts.{key}

object

Example:

{
  "PRESDAY10": {
    "discount_amount": 1000,
    "discount_display_name": "President's Day 10% off"
  },
  "RETURN5": {
    "discount_amount": 500,
    "discount_display_name": "Returning customer 5% discount"
  }
}

connection_options.affirm-affirm.itinerary

AffirmItineraryOptions · object

Passes itinerary data to the Affirm API.

Show child attributes

connection_options.affirm-affirm.itinerary.type

string | null

The type of itinerary object.

Example:

"flight"

connection_options.affirm-affirm.itinerary.sku

string | null

The booking/itinerary number (if applicable).

Example:

"ABC123"

connection_options.affirm-affirm.itinerary.display_name

string | null

Readable description of the itinerary item.

Example:

"MIA-DCA-2019-12-11T12:07"

connection_options.affirm-affirm.itinerary.venue

string | null

The name of the venue where the event is hosted.

Example:

"Petco Park"

connection_options.affirm-affirm.itinerary.location

string | null

The address object that can be parsed.

Example:

"925 Collins Avenue, Miami Beach, FL, 33140, US"

connection_options.affirm-affirm.itinerary.date_start

string | null

The start date of this itinerary item.

Example:

"2019-12-05"

connection_options.affirm-affirm.itinerary.management

string | null

The corporation.

Example:

"Marriott"

connection_options.braintree-card

BraintreeOptions · object

Custom options to be passed to the braintree-card connector.

Show child attributes

connection_options.braintree-card.discount_amount

integer | null

Passes a discount amount to be applied to the transaction when using Braintree.

Example:

1000

connection_options.braintree-card.custom_fields

Custom Fields · object

Passes customFields to the Braintree API when creating a new payment. Custom fields allow you to customize your checkout experience by collecting specific information about your customers and their purchases.

Show child attributes

connection_options.braintree-card.custom_fields.{key}

string

Example:

{ "checkout": "primary" }

connection_options.braintree-card.dynamic_data_fields

BraintreeDynamicDataFieldsOptions · object

Additional dynamic fields to pass to the Braintree API

Show child attributes

connection_options.braintree-card.dynamic_data_fields.three_ds_auth_status

string | null

Passes the 3DS status to the Braintree API using customFields with the key set to the value of three_ds_auth_status

Example:

"threeDStatus"

connection_options.braintree-card.dynamic_data_fields.purchase_order_number

string | null

Passes the transaction.purchaseOrderNumber field when creating a new transaction.

Example:

"po-12345"

connection_options.braintree-card.dynamic_data_fields.vault_payment_method_criteria

enum<string> | null

Passes the vaultPaymentMethodCriteria field when creating a new transaction.

Available options:

ALWAYS,

ON_SUCCESSFUL_TRANSACTION

Example:

"ON_SUCCESSFUL_TRANSACTION"

connection_options.cybersource-anti-fraud

CybersourceAntiFraudOptions · object

Custom options to be passed to the cybersource-anti-fraud connector.

Show child attributes

connection_options.cybersource-anti-fraud.merchant_defined_data

Merchant Defined Data · object

A list of merchant defined data to be passed to the Cybersource Decision Manager API. Each key needs to be a numeric string.

Show child attributes

connection_options.cybersource-anti-fraud.merchant_defined_data.{key}

string

Maximum string length: 5000

Example:

{ "1": "data" }

connection_options.cybersource-anti-fraud.meta_key_merchant_id

string | null

The merchant ID to use for this transaction. This requires a meta key to be set up for use with Cybersource Decision Manager, and this overrides the connector configuration.

Example:

"merchant-1234"

connection_options.cybersource-anti-fraud.shipping_method

string | null

The shipping method for this transaction.

Example:

"sameday"

connection_options.cybersource-card

CybersourceOptions · object

Custom options to be passed to the cybersource-card connector.

Show child attributes

connection_options.cybersource-card.meta_key_merchant_id

string | null

The merchant ID to use for this transaction. This requires a meta key to be set up for use with Cybersource, and this overrides the connector configuration.

Example:

"merchant-1234"

connection_options.cybersource-card.merchant_defined_information

Merchant Defined Information · object

A list of merchant defined data to be passed to the Cybersource. Each key needs to be a numeric string.

Show child attributes

connection_options.cybersource-card.merchant_defined_information.{key}

string

Example:

{ "1": "data" }

connection_options.cybersource-card.ship_to_method

string | null

The shipping method for this transaction.

Example:

"sameday"

connection_options.cybersource-card.comments

string | null

Brief description of the order or any comment you wish to add to the order.

Example:

"This order is for a new customer"

connection_options.cybersource-ideal

CybersourceOptions · object

Custom options to be passed to the cybersource-ideal connector.

Show child attributes

connection_options.cybersource-ideal.meta_key_merchant_id

string | null

The merchant ID to use for this transaction. This requires a meta key to be set up for use with Cybersource, and this overrides the connector configuration.

Example:

"merchant-1234"

connection_options.cybersource-ideal.merchant_defined_information

Merchant Defined Information · object

A list of merchant defined data to be passed to the Cybersource. Each key needs to be a numeric string.

Show child attributes

connection_options.cybersource-ideal.merchant_defined_information.{key}

string

Example:

{ "1": "data" }

connection_options.cybersource-ideal.ship_to_method

string | null

The shipping method for this transaction.

Example:

"sameday"

connection_options.cybersource-ideal.comments

string | null

Brief description of the order or any comment you wish to add to the order.

Example:

"This order is for a new customer"

connection_options.cybersource-kcp

CybersourceOptions · object

Custom options to be passed to the cybersource-kcp connector.

Show child attributes

connection_options.cybersource-kcp.meta_key_merchant_id

string | null

The merchant ID to use for this transaction. This requires a meta key to be set up for use with Cybersource, and this overrides the connector configuration.

Example:

"merchant-1234"

connection_options.cybersource-kcp.merchant_defined_information

Merchant Defined Information · object

A list of merchant defined data to be passed to the Cybersource. Each key needs to be a numeric string.

Show child attributes

connection_options.cybersource-kcp.merchant_defined_information.{key}

string

Example:

{ "1": "data" }

connection_options.cybersource-kcp.ship_to_method

string | null

The shipping method for this transaction.

Example:

"sameday"

connection_options.cybersource-kcp.comments

string | null

Brief description of the order or any comment you wish to add to the order.

Example:

"This order is for a new customer"

connection_options.dlocal-nequi

DlocalOptions · object

Custom options to be passed to the dlocal-nequi connector.

Show child attributes

connection_options.dlocal-nequi.wallet

DlocalWalletOptions · object

Passes wallet data to the dLocal API for those connectors that need it.

Show child attributes

connection_options.dlocal-nequi.wallet.name

string | null

Passes wallet.name to the dLocal API for those connectors that need it.

Example:

"John Doe"

connection_options.dlocal-nequi.wallet.email

string | null

Passes wallet.email to the dLocal API for those connectors that need it.

Example:

"[email protected]"

connection_options.dlocal-nequi.wallet.token

string | null

Passes wallet.token to the dLocal API for those connectors that need it.

Example:

"123456"

connection_options.dlocal-nequi.wallet.username

string | null

Passes wallet.username to the dLocal API for those connectors that need it.

Example:

"johnd"

connection_options.dlocal-nequi.wallet.verify

boolean | null

Passes wallet.verify to the dLocal API for those connectors that need it.

Example:

true

connection_options.dlocal-upi

DlocalUPIOptions · object

Custom options to be passed to the dlocal-upi connector.

Show child attributes

connection_options.dlocal-upi.wallet

DlocalUPIWalletOptions · object

Passes wallet data to the dLocal API for those connectors that need it.

Show child attributes

connection_options.dlocal-upi.wallet.name

string | null

Passes wallet.name to the dLocal API for those connectors that need it.

Example:

"John Doe"

connection_options.dlocal-upi.wallet.email

string | null

Passes wallet.email to the dLocal API for those connectors that need it.

Example:

"[email protected]"

connection_options.dlocal-upi.wallet.token

string | null

Passes wallet.token to the dLocal API for those connectors that need it.

Example:

"123456"

connection_options.dlocal-upi.wallet.username

string | null

Passes wallet.username to the dLocal API for those connectors that need it.

Example:

"johnd"

connection_options.dlocal-upi.wallet.verify

boolean | null

Passes wallet.verify to the dLocal API for those connectors that need it.

Example:

true

connection_options.dlocal-upi.wallet.recurring_info

DlocalUPIRecurringInfoOptions · object

Passes wallet.recurring_info to the dLocal API for those connectors that need it.

Show child attributes

connection_options.dlocal-upi.wallet.recurring_info.subscription_frequency_unit

enum<string>

required

Indicates the frequency unit for the subscription. Allowed values are: DAY, WEEK, MONTH, BI_MONTHLY, QUARTER, SEMI_ANNUALLY, YEAR, ONDEMAND.

Available options:

MONTH,

WEEK,

BI_MONTHLY,

ONDEMAND,

QUARTER,

YEAR,

SEMI_ANNUALLY,

DAY

connection_options.dlocal-upi.wallet.recurring_info.subscription_frequency

integer

required

Indicates the frequency for the subscription.

connection_options.dlocal-upi.wallet.recurring_info.subscription_start_at

string

required

Indicates the start date for the subscription in format YYYYMMDD.

connection_options.dlocal-upi.wallet.recurring_info.subscription_end_at

string

required

Indicates the end date for the subscription in format YYYYMMDD.

Example:

{
  "subscription_end_at": "20241201",
  "subscription_frequency": 1,
  "subscription_frequency_unit": "MONTH",
  "subscription_start_at": "20231201"
}

connection_options.fiserv-card

FiservOptions · object

Custom options to be passed to the fiserv-card connector.

Show child attributes

connection_options.fiserv-card.installmentOptions

FiservInstallmentOptions · object

Passes installment data to the Fiserv API. This is now also a dedicated feature on the Gr4vy API.

Show child attributes

connection_options.fiserv-card.installmentOptions.numberOfInstallments

integer | null

Passes the order.installmentOptions.numberOfInstallments field to the Fiserv API.

Example:

6

connection_options.fiserv-card.installmentOptions.installmentsInterest

boolean | null

Passes the order.installmentOptions.installmentsInterest field to the Fiserv API.

Example:

true

connection_options.fiserv-card.installmentOptions.installmentDelayMonths

integer | null

Passes the order.installmentOptions.installmentDelayMonths field to the Fiserv API.

Example:

1

connection_options.fiserv-card.installmentOptions.merchantAdviceCodeSupported

boolean | null

Passes the order.installmentOptions.merchantAdviceCodeSupported field to the Fiserv API.

Example:

true

connection_options.forter-anti-fraud

ForterAntiFraudOptions · object

Custom options to be passed to the forter-anti-fraud connector.

Show child attributes

connection_options.forter-anti-fraud.delivery_type

enum<string> | null

The delivery type

Available options:

DIGITAL,

PHYSICAL,

HYBRID

Example:

"DIGITAL"

connection_options.forter-anti-fraud.delivery_method

string | null

The delivery method

Required string length: 1 - 50

connection_options.forter-anti-fraud.is_guest_buyer

boolean | null

Defines if this payment is made using guest checkout.

Example:

true

connection_options.forter-anti-fraud.cart_items

ForterAntiFraudOptionsCartItem · object[] | null

A list of cart items details to pass to the Forter API.

Show child attributes

connection_options.forter-anti-fraud.cart_items.basic_item_data

ForterAntiFraudOptionsCartItemBasicItemData · object

Basic information about the cart item.

Show child attributes

connection_options.forter-anti-fraud.cart_items.basic_item_data.type

enum<string> | null

Indicates whether the item is a physical good or a service/digital item.

Available options:

TANGIBLE,

NON_TANGIBLE

connection_options.forter-anti-fraud.cart_items.delivery_details

ForterAntiFraudOptionsCartItemDeliveryDetails · object

Details about how the item will be delivered.

Show child attributes

connection_options.forter-anti-fraud.cart_items.delivery_details.delivery_type

enum<string> | null

The type of delivery for this cart item.

Available options:

DIGITAL,

PHYSICAL,

HYBRID

connection_options.forter-anti-fraud.cart_items.delivery_details.delivery_method

string | null

The method of delivery for this cart item.

connection_options.forter-anti-fraud.cart_items.beneficiaries

ForterAntiFraudOptionsCartItemBeneficiary · object[] | null

List of beneficiaries who will receive this item.

Show child attributes

connection_options.forter-anti-fraud.cart_items.beneficiaries.personal_details

ForterAntiFraudOptionsCartItemBeneficiaryPersonalDetails · object

required

Personal details of the beneficiary.

Show child attributes

connection_options.forter-anti-fraud.cart_items.beneficiaries.personal_details.first_name

string | null

First name of the beneficiary.

connection_options.forter-anti-fraud.cart_items.beneficiaries.personal_details.last_name

string | null

Last name of the beneficiary.

connection_options.forter-anti-fraud.cart_items.beneficiaries.personal_details.email

string | null

Email address of the beneficiary.

connection_options.forter-anti-fraud.cart_items.beneficiaries.address

ForterAntiFraudOptionsCartItemBeneficiaryAddress · object

Address information of the beneficiary.

Show child attributes

connection_options.forter-anti-fraud.cart_items.beneficiaries.address.country

string

required

The country code of the beneficiary's address.

connection_options.forter-anti-fraud.cart_items.beneficiaries.address.address1

string | null

First line of the beneficiary's address.

connection_options.forter-anti-fraud.cart_items.beneficiaries.address.address2

string | null

Second line of the beneficiary's address.

connection_options.forter-anti-fraud.cart_items.beneficiaries.address.zip

string | null

Zip or postal code of the beneficiary's address.

connection_options.forter-anti-fraud.cart_items.beneficiaries.address.region

string | null

State or region of the beneficiary's address.

connection_options.forter-anti-fraud.cart_items.beneficiaries.address.company

string | null

Company name associated with the beneficiary's address.

connection_options.forter-anti-fraud.cart_items.beneficiaries.address.city

string | null

City of the beneficiary's address.

connection_options.forter-anti-fraud.cart_items.beneficiaries.phone

ForterAntiFraudOptionsCartItemBeneficiaryPhone · object[] | null

Phone numbers associated with the beneficiary.

Show child attributes

connection_options.forter-anti-fraud.cart_items.beneficiaries.phone.phone

string

required

The phone number of the beneficiary.

connection_options.forter-anti-fraud.cart_items.beneficiaries.comments

ForterAntiFraudOptionsCartItemBeneficiaryComments · object

Comments related to the beneficiary.

Show child attributes

connection_options.forter-anti-fraud.cart_items.beneficiaries.comments.user_comments_to_merchant

string | null

Comments from the user to the merchant.

connection_options.forter-anti-fraud.cart_items.beneficiaries.comments.message_to_beneficiary

string | null

Message intended for the beneficiary of the item.

connection_options.forter-anti-fraud.cart_items.beneficiaries.comments.merchant_comments

string | null

Comments from the merchant about this transaction.

connection_options.forter-anti-fraud.total_discount

ForterAntiFraudOptionsDiscount · object

Information about the discount applied to this order.

Show child attributes

connection_options.forter-anti-fraud.total_discount.coupon_code_used

string

required

The coupon code applied to the order.

connection_options.forter-anti-fraud.total_discount.discount_type

string

required

The type of discount applied to the order.

connection_options.forter-anti-fraud.total_discount.coupon_discount_amount

ForterAntiFraudOptionsDiscountCouponDiscountAmount · object

Monetary details of the discount amount.

Show child attributes

connection_options.forter-anti-fraud.total_discount.coupon_discount_amount.amount_usd

string | null

The discount amount in USD.

connection_options.forter-anti-fraud.total_discount.coupon_discount_amount.amount_local_currency

string | null

The discount amount in local currency.

connection_options.forter-anti-fraud.total_discount.coupon_discount_amount.currency

string | null

The currency code for the discount amount.

Example:

"EUR"

connection_options.forter-anti-fraud.total_discount.coupon_discount_percent

string | null

The percentage discount applied via the coupon.

connection_options.gem-gem

LatitudeOptions · object

Custom options to be passed to the gem-gem connector.

Show child attributes

connection_options.gem-gem.promotion_reference

string | null

The promotionReference field passed to the purchase API.

Maximum string length: 128

Example:

"promotion-123"

connection_options.gem-gemds

LatitudeOptions · object

Custom options to be passed to the gem-gemds connector.

Show child attributes

connection_options.gem-gemds.promotion_reference

string | null

The promotionReference field passed to the purchase API.

Maximum string length: 128

Example:

"promotion-123"

connection_options.givingblock-givingblock

GivingBlockOptions · object

Custom options to be passed to the givingblock-givingblock connector.

Show child attributes

connection_options.givingblock-givingblock.defaultCryptocurrency

string | null

The default cryptocurrency to present at checkout. This can be used to ensure the user is presented with the same currency in both your checkout and the Giving Block checkout.

Example:

"BTC"

connection_options.latitude-latitude

LatitudeOptions · object

Custom options to be passed to the latitude-latitude connector.

Show child attributes

connection_options.latitude-latitude.promotion_reference

string | null

The promotionReference field passed to the purchase API.

Maximum string length: 128

Example:

"promotion-123"

connection_options.latitude-latitudeds

LatitudeOptions · object

Custom options to be passed to the latitude-latitudeds connector.

Show child attributes

connection_options.latitude-latitudeds.promotion_reference

string | null

The promotionReference field passed to the purchase API.

Maximum string length: 128

Example:

"promotion-123"

connection_options.mattilda-tapi

MattildaTapiOptions · object

Custom options to be passed to the mattilda-tapi connector.

Show child attributes

connection_options.mattilda-tapi.payment_method_expires_at

string | null

Defines the date at which the payment will expire if not completed. Must be provided in ISO 8601 format (YYYY-MM-DD). If not specified, it defaults to 7 days in the future from the current date.

Example:

"2030-12-01"

connection_options.mattilda-tapifintechs

MattildaTapiOptions · object

Custom options to be passed to the mattilda-tapifintechs connector.

Show child attributes

connection_options.mattilda-tapifintechs.payment_method_expires_at

string | null

Defines the date at which the payment will expire if not completed. Must be provided in ISO 8601 format (YYYY-MM-DD). If not specified, it defaults to 7 days in the future from the current date.

Example:

"2030-12-01"

connection_options.monato-spei

MonatoSpeiOptions · object

Custom options to be passed to the monato-spei connector.

Show child attributes

connection_options.monato-spei.approval_url

string

required

Approval URL that will receive a charge payment method reference.

connection_options.mock-card

MockCardOptions · object

Custom options to be passed to the mock-card connector.

Show child attributes

connection_options.mock-card.merchant_advice_code

MockCardMerchantAdviceCodeOptions · object

Allows for mocking the merchant advice code.

Show child attributes

connection_options.mock-card.merchant_advice_code.account_number

string | null

required

When set, the MAC is only returned if the card number matches this account number.

connection_options.mock-card.merchant_advice_code.result

string | null

The MAC to return for this request.

connection_options.mock-card.skip_retry

boolean | null

When set to true, prevents retries on failed transactions.

connection_options.nuvei-card

NuveiOptions · object

Custom options to be passed to the nuvei-card connector.

Show child attributes

connection_options.nuvei-card.customData

string | null

General data about the customer provided by the merchant.

Maximum string length: 255

Example:

"user=123,trusted=false"

connection_options.nuvei-card.airlineData

NuveiAirlineDataOptions · object

Provides additional airline data for Nuvei payments.

Show child attributes

connection_options.nuvei-card.airlineData.seatClass

string | null

The seat class of the booking

Example:

"F"

connection_options.nuvei-card.airlineData.isCardholderTraveling

boolean | null

Indicates whether the cardholder is also a passenger.

Example:

true

connection_options.nuvei-ideal

NuveiIDealOptions · object

Custom options to be passed to the nuvei-ideal connector.

Show child attributes

connection_options.nuvei-ideal.customData

string | null

Additional data to be sent to Nuvei.

Maximum string length: 255

Example:

"user=123,trusted=false"

connection_options.nuvei-pse

NuveiPSEOptions · object

Custom options to be passed to the nuvei-pse connector.

Show child attributes

connection_options.nuvei-pse.userType

string | null

Customer type ("N" for persona natural, "J" for persona jurídica)

Example:

"N"

connection_options.nuvei-pse.userFisNumber

string | null

Customer’s document type

Example:

"CC"

connection_options.nuvei-pse.fiscalNumber

string | null

Customer’s document number

Example:

"CC"

connection_options.nuvei-pse.bankCode

string | null

The bank code of the selected bank

Example:

"5432"

connection_options.oxxo-oxxo

OxxoOptions · object

Custom options to be passed to the oxxo-oxxo connector.

Show child attributes

connection_options.oxxo-oxxo.payment_method_expires_at

integer | null

Defines a custom expiration time (unix time) after which Oxxo payment requests are cancelled

Example:

1750074293

connection_options.oxxo-oxxo.approval_url

string | null

Approval URL that will receive a charge payment method reference.

Example:

"https://example.com"

connection_options.paypal-paypal

PaypalOptions · object

Custom options to be passed to the paypal-paypal connector.

Show child attributes

connection_options.paypal-paypal.additional_data

Additional Data · object[] | null

Additional Set Transaction Context Values (STC) to be sent to PayPal as part of the transaction.

Show child attributes

connection_options.paypal-paypal.additional_data.{key}

string

Example:

{ "sender_account_id": "customer-1234" }

connection_options.paypal-paypal.shipping

PaypalShippingOptions · object

Shipping information to be passed to the PayPal API.

Show child attributes

connection_options.paypal-paypal.shipping.options

PaypalShippingOptionsItem · object[] | null

Shipping options that the payee or merchant offers to the payer to ship or pick up their items.

Maximum array length: 10

Show child attributes

connection_options.paypal-paypal.shipping.options.id

string

required

A unique ID that identifies a payer-selected shipping option.

Required string length: 1 - 127

connection_options.paypal-paypal.shipping.options.label

string

required

A description that the payer sees, which helps them choose an appropriate shipping option.

Required string length: 1 - 127

connection_options.paypal-paypal.shipping.options.selected

boolean

required

If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. Only one shipping.option can be set to selected=true.

connection_options.paypal-paypal.shipping.options.type

enum<string> | null

A classification for the method of purchase fulfillment.

Available options:

SHIPPING,

PICKUP,

PICKUP_IN_STORE,

PICKUP_FROM_PERSON

Example:

"SHIPPING"

connection_options.paypal-paypal.shipping.options.amount

PaypalShippingOptionsItemAmount · object

The shipping cost for the selected option.

Show child attributes

connection_options.paypal-paypal.shipping.options.amount.currency_code

string

required

The three-character ISO currency code.

connection_options.paypal-paypal.shipping.options.amount.value

string

required

The amount value, which might include a decimal portion.

Required string length: 1 - 32

Example:

{
  "options": [
    {
      "amount": { "currency_code": "USD", "value": "10.00" },
      "id": "ship_1234",
      "label": "Free Shipping",
      "selected": true,
      "type": "SHIPPING"
    }
  ]
}

connection_options.paypal-paypalpaylater

PaypalOptions · object

Custom options to be passed to the paypal-paypalpaylater connector.

Show child attributes

connection_options.paypal-paypalpaylater.additional_data

Additional Data · object[] | null

Additional Set Transaction Context Values (STC) to be sent to PayPal as part of the transaction.

Show child attributes

connection_options.paypal-paypalpaylater.additional_data.{key}

string

Example:

{ "sender_account_id": "customer-1234" }

connection_options.paypal-paypalpaylater.shipping

PaypalShippingOptions · object

Shipping information to be passed to the PayPal API.

Show child attributes

connection_options.paypal-paypalpaylater.shipping.options

PaypalShippingOptionsItem · object[] | null

Shipping options that the payee or merchant offers to the payer to ship or pick up their items.

Maximum array length: 10

Show child attributes

connection_options.paypal-paypalpaylater.shipping.options.id

string

required

A unique ID that identifies a payer-selected shipping option.

Required string length: 1 - 127

connection_options.paypal-paypalpaylater.shipping.options.label

string

required

A description that the payer sees, which helps them choose an appropriate shipping option.

Required string length: 1 - 127

connection_options.paypal-paypalpaylater.shipping.options.selected

boolean

required

connection_options.paypal-paypalpaylater.shipping.options.type

enum<string> | null

A classification for the method of purchase fulfillment.

Available options:

SHIPPING,

PICKUP,

PICKUP_IN_STORE,

PICKUP_FROM_PERSON

Example:

"SHIPPING"

connection_options.paypal-paypalpaylater.shipping.options.amount

PaypalShippingOptionsItemAmount · object

The shipping cost for the selected option.

Show child attributes

connection_options.paypal-paypalpaylater.shipping.options.amount.currency_code

string

required

The three-character ISO currency code.

connection_options.paypal-paypalpaylater.shipping.options.amount.value

string

required

The amount value, which might include a decimal portion.

Required string length: 1 - 32

Example:

{
  "options": [
    {
      "amount": { "currency_code": "USD", "value": "10.00" },
      "id": "ship_1234",
      "label": "Free Shipping",
      "selected": true,
      "type": "SHIPPING"
    }
  ]
}

connection_options.powertranz-card

PowertranzOptions · object

Custom options to be passed to the powertranz-card connector.

Show child attributes

connection_options.powertranz-card.skipThreeDSecure

boolean | null

default:false

Indicates to PowerTranz whether to skip the 3DS authentication for this transaction.

Example:

true

connection_options.stripe-card

StripeOptions · object

Custom options to be passed to the stripe-card connector.

Show child attributes

connection_options.stripe-card.error_on_requires_action

boolean | null

Passes the error_on_requires_action option to the Stripe API. Set to true to fail the payment attempt if it transitions into requires_action. Use this parameter for simpler integrations that don't handle customer actions, such as saving cards without authentication.

Example:

true

connection_options.stripe-card.stripe_connect

StripeConnectOptions · object

Stripe options to support Stripe Connect

Show child attributes

connection_options.stripe-card.stripe_connect.stripe_account

string | null

The Stripe Connect account to target using the Stripe-Account header.

Example:

"act_123456"

connection_options.stripe-card.stripe_connect.application_fee_amount

integer | null

The fee to charge the connected account.

Example:

"123"

connection_options.stripe-card.stripe_connect.on_behalf_of

string | null

The Stripe Connect account to target using the on_behalf_of request parameter.

Example:

"act_123456"

connection_options.stripe-card.stripe_connect.transfer_data_destination

string | null

The Stripe Connect account to target using the transfer_data.destination request parameter.

Example:

"act_123456"

connection_options.stripe-card.stripe_connect.transfer_group

string | null

A string that identifies the payment as part of a group.

Example:

"ORDER100"

connection_options.travelhub-card

TravelhubOptions · object

Custom options to be passed to the travelhub-card connector.

Show child attributes

connection_options.travelhub-card.customData

TravelHubCustomData · object[] | null

A list of customData to pass to the TravelHub API.

Show child attributes

connection_options.travelhub-card.customData.name

string

required

The key of the custom data field.

connection_options.travelhub-card.customData.value

string

required

The value of the custom data field.

connection_options.travelhub-card.customData.type

string | null

The type of the custom data field.

connection_options.travelhub-card.companyName

string | null

Customer company name to pass to the TravelHub API.

connection_options.trustly-trustly

TrustlyOptions · object

Custom options to be passed to the trustly-trustly connector.

Show child attributes

connection_options.trustly-trustly.refreshSplitToken

boolean | null

Indicates to Gr4vy whether or not the stored Trustly agreement needs refreshing.

Example:

true

connection_options.trustly-trustly.urlScheme

string | null

URL scheme for an app.

Example:

"APP://SOME_RESOURCE"

connection_options.wpay-everydaypay

WpayEverdaypayOptions · object

Custom options to be passed to the wpay-everydaypay connector.

Show child attributes

connection_options.wpay-everydaypay.merchant_defined_data

Merchant Defined Data · object

A dictionary of merchant defined data, to be passed to Wpay for anti-fraud control.

Show child attributes

connection_options.wpay-everydaypay.merchant_defined_data.{key}

string

connection_options.wpay-everydaypay.customerId

string | null

The customer ID for the Everyday Rewards account.

connection_options.wpay-everydaypay.rewardsAccessToken

string | null

The access token for the Everyday Rewards account.

connection_options.wpay-everydaypay.deviceId

string | null

The ID of the device on which the payment is occuring.

connection_options.wpay-everydaypay.postPaymentRedirect

boolean | null

Whether the transaction should redirect post-payment

Example:

true

connection_options.wpay-payto

WpayPaytoOptions · object

Custom options to be passed to the wpay-payto connector.

Show child attributes

connection_options.wpay-payto.instrument

WpayPaytoResourceOptions · object

Options to pass to the instrument resource in the Wpay PayTo API.

Show child attributes

connection_options.wpay-payto.instrument.simulation

WpayPaytoSimulationOptions · object

Simulate responses for this resource.

Show child attributes

connection_options.wpay-payto.instrument.simulation.simulate

string | null

The simulation being requested. Please refer to the developer guide for a list of all available simulations.

connection_options.wpay-payto.instrument.simulation.delay

integer | null

The delay in seconds before the requested simulation is executed.

Example:

5

connection_options.wpay-payto.payment

WpayPaytoResourceOptions · object

Options to pass to the payment resource in the Wpay PayTo API.

Show child attributes

connection_options.wpay-payto.payment.simulation

WpayPaytoSimulationOptions · object

Simulate responses for this resource.

Show child attributes

connection_options.wpay-payto.payment.simulation.simulate

string | null

The simulation being requested. Please refer to the developer guide for a list of all available simulations.

connection_options.wpay-payto.payment.simulation.delay

integer | null

The delay in seconds before the requested simulation is executed.

Example:

5

connection_options.wpay-payto.refund

WpayPaytoResourceOptions · object

Options to pass to the refund resource in the Wpay PayTo API.

Show child attributes

connection_options.wpay-payto.refund.simulation

WpayPaytoSimulationOptions · object

Simulate responses for this resource.

Show child attributes

connection_options.wpay-payto.refund.simulation.simulate

string | null

The simulation being requested. Please refer to the developer guide for a list of all available simulations.

connection_options.wpay-payto.refund.simulation.delay

integer | null

The delay in seconds before the requested simulation is executed.

Example:

5

Response

Successful Response

A full transaction resource.

string<uuid>

required

The ID for the transaction.

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.

merchant_account_id

string

required

The ID of the merchant account this transaction belongs to.

currency

string

required

The currency code for this transaction.

amount

integer

required

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

status

enum<string>

required

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

Available options:

processing,

authorization_succeeded,

authorization_declined,

authorization_failed,

authorization_voided,

authorization_void_pending,

capture_succeeded,

capture_pending,

buyer_approval_pending

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.

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.

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.

settled_amount

integer

required

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

settled

boolean

required

Indicates whether this transaction has been settled.

intent

enum<string>

required

The original intent used when the transaction was created.

Available options:

authorize,

capture

gift_card_redemptions

GiftCardRedemption · object[]

required

The gift cards redeemed for this transaction.

Show child attributes

gift_card_redemptions.id

string<uuid>

required

The ID for the gift card redemption.

gift_card_redemptions.status

enum<string>

required

The status of the gift card redemption for the payment_method.

Available options:

created,

succeeded,

failed,

skipped

gift_card_redemptions.amount

integer

required

The amount redeemed for this gift card.

gift_card_redemptions.refunded_amount

integer

required

The amount refunded for this gift card. This can not be larger than amount.

gift_card_redemptions.gift_card

TransactionGiftCard · object

required

The gift card used for this redemption

Show child attributes

gift_card_redemptions.gift_card.bin

string

required

The first 6 digits of the full gift card number.

gift_card_redemptions.gift_card.sub_bin

string

required

The 3 digits after the bin of the full gift card number.

gift_card_redemptions.gift_card.last4

string

required

The last 4 digits for the gift card.

gift_card_redemptions.gift_card.type

string

default:gift-card

Always gift-card.

Allowed value: "gift-card"

gift_card_redemptions.gift_card.id

string<uuid> | null

The ID for the gift card.

Example:

"356d56e5-fe16-42ae-97ee-8d55d846ae2e"

gift_card_redemptions.type

string

default:gift-card-redemption

Always gift-card-redemption.

Allowed value: "gift-card-redemption"

gift_card_redemptions.gift_card_service_redemption_id

string | null

The gift card service's unique ID for the redemption.

Example:

"xYqd43gySMtori"

gift_card_redemptions.error_code

enum<string> | null

If this gift card redemption resulted in an error, this will contain the internal code for the error.

Available options:

invalid_gift_card,

expired_card,

inactive_card,

invalid_service_credentials,

invalid_amount,

incorrect_currency,

insufficient_funds,

invalid_service_configuration,

operation_canceled,

service_error,

service_network_error,

unknown_error,

max_gift_cards_reached

Example:

"expired_card"

gift_card_redemptions.raw_error_code

string | null

If this gift card redemption resulted in an error, this will contain the raw error code received from the gift card provider.

Example:

"10001"

gift_card_redemptions.raw_error_message

string | null

If this gift card redemption resulted in an error, this will contain the raw error message received from the gift card provider.

Example:

"Card expired"

created_at

string<date-time>

required

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

updated_at

string<date-time>

required

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

disputed

boolean

required

Indicates whether this transaction has been disputed.

payment_source

enum<string>

required

The way payment method information made it to this transaction.

Available options:

ecommerce,

moto,

recurring,

installment,

card_on_file

merchant_initiated

boolean

required

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

is_subsequent_payment

boolean

required

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

intent_outcome

enum<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.

Available options:

pending,

succeeded,

failed

multi_tender

boolean

required

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

type

string

default:transaction

Always transaction.

Allowed value: "transaction"

settled_currency

string | null

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

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.

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

The payment method used for this transaction.

Show child attributes

payment_method.method

enum<string>

required

The type of this payment method.

Available options:

abitab,

affirm,

afterpay,

alipay,

alipayhk,

applepay,

arcuspaynetwork,

bacs,

bancontact,

bank,

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,

plaid,

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

payment_method.type

string

default:payment-method

Always payment-method.

Allowed value: "payment-method"

payment_method.approval_url

string | null

The optional URL that the buyer needs to be redirected to to further authorize their payment.

Example:

"https://gr4vy.app/redirect/12345"

payment_method.country

string | null

The 2-letter ISO code of the country this payment method can be used for. If this value is null the payment method may be used in multiple countries.

Example:

"US"

payment_method.currency

string | null

The ISO-4217 currency code that this payment method can be used for. If this value is null the payment method may be used for multiple currencies.

Example:

"USD"

payment_method.details

PaymentMethodDetailsCard · object

Details for credit or debit card payment method.

Show child attributes

payment_method.details.bin

string | null

Required string length: 6 - 8

payment_method.details.card_type

enum<string> | null

Available options:

credit,

debit,

prepaid

payment_method.details.card_issuer_name

string | null

payment_method.expiration_date

string | null

The expiration date for the payment method.

Required string length: 5

Example:

"12/30"

payment_method.fingerprint

string | null

The unique hash derived from the payment method identifier (e.g. card number).

Example:

"20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17"

payment_method.label

string | null

A label for the card or the account. For a paypal payment method this is the user's email address. For a card it is the last 4 digits of the card.

Maximum string length: 320

Example:

"1234"

payment_method.last_replaced_at

string<date-time> | null

The date and time when this card was last replaced by the account updater.

Example:

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

payment_method.mode

enum<string> | null

The mode to use with this payment method.

Available options:

card,

redirect,

applepay,

googlepay,

checkout-session,

click-to-pay,

gift-card,

bank

Example:

"card"

payment_method.scheme

enum<string> | null

The scheme of the card. Only applies to card payments.

Available options:

accel,

amex,

bancontact,

carte-bancaire,

cirrus,

culiance,

dankort,

diners-club,

discover,

eftpos-australia,

elo,

hipercard,

jcb,

maestro,

mastercard,

mir,

nyce,

other,

pulse,

rupay,

star,

uatp,

unionpay,

visa

Example:

"visa"

payment_method.id

string<uuid> | null

The ID of the payment method.

Example:

"852b951c-d7ea-4c98-b09e-4a1c9e97c077"

payment_method.approval_target

enum<string> | null

The browser target that an approval URL must be opened in. If any or null, then there is no specific requirement.

Available options:

new_window,

any

Example:

"any"

payment_method.external_identifier

string | null

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

Required string length: 1 - 200

Example:

"card-12345"

payment_method.payment_account_reference

string | 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.

Example:

"V0010014629724763377327521982"

method

enum<string> | null

The method used for the transaction.

Available options:

abitab,

affirm,

afterpay,

alipay,

alipayhk,

applepay,

arcuspaynetwork,

bacs,

bancontact,

bank,

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,

plaid,

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

Example:

"card"

instrument_type

enum<string> | null

The name of the instrument used to process the transaction.

Available options:

pan,

card_token,

redirect,

redirect_token,

googlepay,

applepay,

network_token,

plaid

Example:

"pan"

error_code

string | null

The standardized error code set by Gr4vy.

Example:

"missing_redirect_url"

payment_service

TransactionPaymentService · object

The payment service used for this transaction.

Show child attributes

payment_service.id

string<uuid>

required

The ID for the payment-service.

payment_service.payment_service_definition_id

string

required

The definition ID of the service used to process this payment.

Required string length: 1 - 50

payment_service.method

enum<string>

required

The payment method that this service handles.

Available options:

abitab,

affirm,

afterpay,

alipay,

alipayhk,

applepay,

arcuspaynetwork,

bacs,

bancontact,

bank,

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,

plaid,

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

payment_service.display_name

string

required

The display name for the payment service.

payment_service.type

string

default:payment-service

Always payment-service.

Allowed value: "payment-service"

pending_review

boolean

default:false

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

buyer

TransactionBuyer · object

The buyer used for this transaction.

Show child attributes

buyer.type

string

default:buyer

Always buyer.

Allowed value: "buyer"

buyer.id

string<uuid> | null

The ID for the buyer.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

buyer.display_name

string | null

The display name for the buyer.

Required string length: 1 - 200

Example:

"John Doe"

buyer.external_identifier

string | null

The merchant identifier for this buyer.

Required string length: 1 - 200

Example:

"buyer-12345"

buyer.billing_details

BillingDetails · object

The billing name, address, email, and other fields for this buyer.

Show child attributes

buyer.billing_details.first_name

string | null

The first name(s) or given name for the buyer.

Required string length: 1 - 255

Example:

"John"

buyer.billing_details.last_name

string | null

The last name, or family name, of the buyer.

Required string length: 1 - 255

Example:

"Doe"

buyer.billing_details.email_address

string | null

The email address for the buyer.

Required string length: 1 - 320

Example:

"[email protected]"

buyer.billing_details.phone_number

string | null

The phone number for the buyer which should be formatted according to the E164 number standard.

Example:

"+1234567890"

buyer.billing_details.address

Address · object

The billing address for the buyer.

Show child attributes

buyer.billing_details.address.city

string | null

The city for the address.

Required string length: 1 - 100

Example:

"San Jose"

buyer.billing_details.address.country

string | null

The country for the address in ISO 3166 format.

Example:

"US"

buyer.billing_details.address.postal_code

string | null

The postal code or zip code for the address.

Required string length: 1 - 50

Example:

"94560"

buyer.billing_details.address.state

string | null

The state, county, or province for the address.

Required string length: 1 - 255

Example:

"California"

buyer.billing_details.address.state_code

string | null

The code of state, county, or province for the address in ISO 3166-2 format.

Example:

"US-CA"

buyer.billing_details.address.house_number_or_name

string | null

The house number or name for the address. Not all payment services use this field but some do.

Required string length: 1 - 255

Example:

"10"

buyer.billing_details.address.line1

string | null

The first line of the address.

Required string length: 1 - 255

Example:

"Stafford Appartments"

buyer.billing_details.address.line2

string | null

The second line of the address.

Required string length: 1 - 255

Example:

"29th Street"

buyer.billing_details.address.organization

string | null

The optional name of the company or organisation to add to the address.

Required string length: 1 - 255

Example:

"Gr4vy"

buyer.billing_details.tax_id

TaxId · object

The tax ID information associated with the billing details.

Show child attributes

buyer.billing_details.tax_id.value

string

required

The tax ID for the buyer.

Required string length: 1 - 50

buyer.billing_details.tax_id.kind

enum<string>

required

The kind of tax ID

Available options:

ae.trn,

au.abn,

ar.dni,

ar.cuil,

ar.cuit,

br.cnpj,

br.cpf,

ca.bn,

ca.gst_hst,

ca.pst_bc,

ca.pst_mb,

ca.pst_sk,

ca.qst,

ch.vat,

cl.tin,

co.itin,

co.nit,

es.cif,

eu.vat,

gb.vat,

hk.br,

id.nik,

id.npwp,

in.gst,

in.pan,

jp.cn,

jp.rn,

kr.brn,

li.uid,

mx.curp,

mx.rfc,

my.frp,

my.itn,

my.nric,

my.sst,

no.vat,

nz.gst,

pe.ruc,

ph.tin,

ru.inn,

ru.kpp,

sa.vat,

sg.gst,

sg.uen,

th.id,

th.vat,

tw.vat,

us.ein,

za.vat,

bo.ci,

uy.rut,

uy.ci

buyer.account_number

string | null

The buyer account number.

Required string length: 1 - 200

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

The shipping details associated with the transaction.

Show child attributes

shipping_details.first_name

string | null

The first name(s) or given name for the buyer.

Required string length: 1 - 255

Example:

"John"

shipping_details.last_name

string | null

The last name, or family name, of the buyer.

Required string length: 1 - 255

Example:

"Doe"

shipping_details.email_address

string | null

The email address for the buyer.

Required string length: 1 - 320

Example:

"[email protected]"

shipping_details.phone_number

string | null

The phone number for the buyer which should be formatted according to the E164 number standard.

Example:

"+1234567890"

shipping_details.address

Address · object

The billing address for the buyer.

Show child attributes

shipping_details.address.city

string | null

The city for the address.

Required string length: 1 - 100

Example:

"San Jose"

shipping_details.address.country

string | null

The country for the address in ISO 3166 format.

Example:

"US"

shipping_details.address.postal_code

string | null

The postal code or zip code for the address.

Required string length: 1 - 50

Example:

"94560"

shipping_details.address.state

string | null

The state, county, or province for the address.

Required string length: 1 - 255

Example:

"California"

shipping_details.address.state_code

string | null

The code of state, county, or province for the address in ISO 3166-2 format.

Example:

"US-CA"

shipping_details.address.house_number_or_name

string | null

The house number or name for the address. Not all payment services use this field but some do.

Required string length: 1 - 255

Example:

"10"

shipping_details.address.line1

string | null

The first line of the address.

Required string length: 1 - 255

Example:

"Stafford Appartments"

shipping_details.address.line2

string | null

The second line of the address.

Required string length: 1 - 255

Example:

"29th Street"

shipping_details.address.organization

string | null

The optional name of the company or organisation to add to the address.

Required string length: 1 - 255

Example:

"Gr4vy"

shipping_details.id

string<uuid> | null

The ID for the shipping details.

Example:

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

shipping_details.buyer_id

string<uuid> | null

The ID for the buyer.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

shipping_details.type

string

default:shipping-details

Always shipping-details.

Allowed value: "shipping-details"

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

The gift card service used for this transaction.

Show child attributes

gift_card_service.id

string<uuid>

required

The ID for the gift card service.

gift_card_service.gift_card_service_definition_id

enum<string>

required

The ID of the definition for this service.

Available options:

mock-gift-card,

qwikcilver-gift-card

gift_card_service.display_name

string

required

The display name for the gift card service.

Required string length: 1 - 200

gift_card_service.type

string

default:gift-card-service

Always gift-card-service.

Allowed value: "gift-card-service"

airline

Airline · object

Contains information about an airline travel, if applicable.

Show child attributes

airline.booking_code

string | null

The unique identifier of the reservation in the global distribution system.

Required string length: 1 - 50

Example:

"X36Q9C"

airline.is_cardholder_traveling

boolean | null

Indicates whether the cardholder is traveling.

Example:

true

airline.issued_address

string | null

The address of the place/agency that issued the ticket.

Required string length: 1 - 255

Example:

"123 Broadway, New York"

airline.issued_at

string<date-time> | null

The date that the ticket was last issued in the airline reservation system.

Example:

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

airline.issuing_carrier_code

string | null

For airline aggregators, three-character IATA code of the airline issuing the ticket.

Required string length: 2 - 3

Example:

"649"

airline.issuing_carrier_name

string | null

For airline aggregators, name of the airline issuing the ticket.

Minimum string length: 1

Example:

"Air Transat A.T. Inc"

airline.issuing_iata_designator

string | null

For airline aggregators, two-character IATA code of the airline issuing the ticket.

Required string length: 2

Example:

"TS"

airline.issuing_icao_code

string | null

For airline aggregators, three-character ICAO code of the airline issuing the ticket.

Required string length: 3

Example:

"TSC"

airline.legs

AirlineLeg · object[] | null

An array of separate trip segments. Each leg contains detailed itinerary information.

Maximum array length: 20

Show child attributes

airline.legs.arrival_airport

string | null

Arrival airport code of leg. 3-letter ISO code according to IATA official directory.

Required string length: 3

Example:

"LAX"

airline.legs.arrival_at

string<date-time> | null

The date and time of travel in local time at the arrival airport.

Example:

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

airline.legs.arrival_city

string | null

Arrival city name.

Required string length: 1 - 100

Example:

"Los Angeles"

airline.legs.arrival_country

string | null

Arrival country code in ISO 3166 format.

Example:

"US"

airline.legs.carrier_code

string | null

3 character airline code as set by IATA.

Required string length: 2 - 3

Example:

"649"

airline.legs.carrier_name

string | null

Name of the airline.

Minimum string length: 1

Example:

"Air Transat A.T. Inc"

airline.legs.iata_designator

string | null

Two-character IATA code of the airline.

Required string length: 2

Example:

"TS"

airline.legs.icao_code

string | null

Three-character ICAO code of the airline.

Required string length: 3

Example:

"TSC"

airline.legs.coupon_number

string | null

Coupon number associated with the leg.

Required string length: 1 - 50

Example:

"15885566"

airline.legs.departure_airport

string | null

Departure airport code of leg. 3-letter ISO code according to IATA official directory.

Required string length: 3

Example:

"LHR"

airline.legs.departure_at

string<date-time> | null

The date and time of travel in local time at the departure airport.

Example:

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

airline.legs.departure_city

string | null

Departure city name.

Required string length: 1 - 100

Example:

"London"

airline.legs.departure_country

string | null

Departure airport code of leg. 3-letter ISO code according to IATA official directory.

Example:

"GB"

airline.legs.departure_tax_amount

integer | null

Departure tax amount charged by a country when a person is leaving the country.

Required range: 0 <= x <= 99999999

Example:

1200

airline.legs.fare_amount

integer | null

Amount of the ticket, for current leg of the trip, excluding taxes and fees.

Required range: 0 <= x <= 99999999

Example:

129900

airline.legs.fare_basis_code

string | null

The alphanumeric code for the booking class of a ticket.

Required string length: 1 - 8

Example:

"FY"

airline.legs.fee_amount

integer | null

Fee amount for current leg of the trip.

Required range: 0 <= x <= 99999999

Example:

1200

airline.legs.flight_class

string | null

Indicates service class (first class, business class, etc.).

Required string length: 1 - 5

Example:

"E"

airline.legs.flight_number

string | null

Unique identifier of the flight number.

Required string length: 3 - 6

Example:

"101"

airline.legs.route_type

enum<string> | null

The route type of the flight.

Available options:

round_trip,

one_way

Example:

"round_trip"

airline.legs.seat_class

string | null

Indicates seat class (first class, business class, etc.).

Required string length: 1 - 5

Example:

"F"

airline.legs.stop_over

boolean | null

Indicates whether a stopover is allowed on this ticket.

Example:

false

airline.legs.tax_amount

integer | null

Amount of the taxes for current leg of the trip.

Required range: 0 <= x <= 99999999

Example:

1200

airline.passenger_name_record

string | null

The Passenger Name Record (PNR) in the airline reservation system.

Required string length: 1 - 50

Example:

"JOHN L"

airline.passengers

AirlinePassenger · object[] | null

An array of the travelling passengers.

Maximum array length: 20

Show child attributes

airline.passengers.age_group

enum<string> | null

The age group for the passenger.

Available options:

adult,

infant

Example:

"adult"

airline.passengers.date_of_birth

string<date> | null

The passenger's date of birth in YYYY-MM-YY format.

Example:

"2013-07-16"

airline.passengers.email_address

string | null

The email address of the passenger.

Required string length: 1 - 320

Example:

"[email protected]"

airline.passengers.first_name

string | null

The first name(s) or given name of the passenger.

Required string length: 1 - 255

Example:

"John"

airline.passengers.frequent_flyer_number

string | null

The passenger's frequent flyer number.

Required string length: 5 - 50

Example:

"15885566"

airline.passengers.last_name

string | null

The last name, or family name, of the passenger.

Required string length: 1 - 255

Example:

"Luhn"

airline.passengers.passport_number

string | null

The passenger's unique passport number.

Required string length: 1 - 50

Example:

"11117700225"

airline.passengers.phone_number

string | null

The phone number of the passenger. This number is formatted according to the E164 number standard.

Example:

"+1234567890"

airline.passengers.ticket_number

string | null

The ticket number for a flight.

Required string length: 1 - 50

Example:

"BA1236699999"

airline.passengers.title

string | null

Title of the passenger.

Required string length: 1 - 50

Example:

"Mr."

airline.passengers.country_code

string | null

The country of residence of the passenger

Example:

"US"

airline.reservation_system

string | null

The name of the reservation system.

Required string length: 1 - 200

Example:

"Amadeus"

airline.restricted_ticket

boolean | null

Indicates whether the ticket is restricted (refundable).

Example:

false

airline.ticket_delivery_method

enum<string> | null

default:electronic

The delivery method of the ticket.

Available options:

electronic,

other

Example:

"electronic"

airline.ticket_number

string | null

The airline's unique ticket number.

Required string length: 1 - 50

Example:

"123-1234-151555"

airline.travel_agency_code

string | null

The IATA travel agency code.

Required string length: 1 - 50

Example:

"12345"

airline.travel_agency_invoice_number

string | null

The reference number of the invoice that was issued by the travel agency.

Required string length: 1 - 50

Example:

"EG15555155"

airline.travel_agency_name

string | null

The name of the travel agency.

Required string length: 1 - 200

Example:

"ACME Agency"

airline.travel_agency_plan_name

string | null

The name of the travel agency plan.

Required string length: 1 - 200

Example:

"B733"

auth_response_code

string | null

This is the response description received from the processor.

Example:

"00"

avs_response_code

enum<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.

Available options:

match,

no_match,

partial_match_address,

partial_match_postcode,

partial_match_name,

unavailable

Example:

"match"

cvv_response_code

enum<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.

Available options:

match,

no_match,

unavailable,

not_provided

Example:

"match"

anti_fraud_decision

enum<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.

Available options:

accept,

error,

exception,

reject,

review,

skipped,

pending

Example:

"accept"

cart_items

CartItem · object[] | null

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

Show child attributes

cart_items.name

string

required

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.

Required string length: 1 - 255

cart_items.quantity

integer

required

The quantity of this item in the cart. This value cannot be negative or zero.

Required range: x <= 99999999

cart_items.unit_amount

integer

required

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.

Required range: 0 <= x <= 99999999

cart_items.discount_amount

integer | null

default:0

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.

Required range: 0 <= x <= 99999999

Example:

0

cart_items.tax_amount

integer | null

default:0

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.

Required range: 0 <= x <= 99999999

Example:

0

cart_items.external_identifier

string | null

An external identifier for the cart item. This can be set to any value and is not sent to the payment service.

Required string length: 1 - 200

Example:

"goprohd"

cart_items.sku

string | null

The SKU or product code for the item.

Required string length: 1 - 200

Example:

"GPHD1078"

cart_items.upc

string | null

The UPC for the item.

Required string length: 1 - 50

Example:

"012345678905"

cart_items.product_url

string | null

The product URL for the item.

Example:

"https://example.com/catalog/go-pro-hd"

cart_items.image_url

string | null

The URL for the image of the item.

Example:

"https://example.com/images/go-pro-hd.jpg"

cart_items.categories

string[] | null

A list of strings containing product categories for the item.

Required string length: 1 - 50

Example:

["camera", "travel", "gear"]

cart_items.product_type

enum<string> | null

The product type of the cart item.

Available options:

physical,

discount,

shipping_fee,

sales_tax,

digital,

gift_card,

store_credit,

surcharge

Example:

"physical"

cart_items.seller_country

string | null

The seller country of the cart item.

Example:

"US"

cart_items.tax_exempt

boolean | null

Whether the item is exempt of tax.

Example:

false

cart_items.unit_of_measure

string | null

The unit of measure or the unit of measure code.

Required string length: 1 - 50

Example:

"feet"

cart_items.commodity_code

string | null

Item commodity code. Generally a UNSPSC code.

Required string length: 1 - 50

Example:

"43211503"

cart_items.description

string | null

Brief item description.

Required string length: 1 - 255

Example:

"A brief description of an interesting item."

cart_items.duty_amount

integer | null

Item import or export duties 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

cart_items.shipping_amount

integer | null

Freight/shipping amount 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

statement_descriptor

StatementDescriptor · object

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

Show child attributes

statement_descriptor.name

string | null

Reflects your doing business as (DBA) name.

Required string length: 5 - 22

Example:

"ACME"

statement_descriptor.description

string | null

A short description about the purchase.

Required string length: 5 - 22

Example:

"ACME San Jose Electronics"

statement_descriptor.city

string | null

The merchant's city to be displayed in a statement descriptor.

Required string length: 1 - 50

Example:

"San Jose"

statement_descriptor.country

string | null

The 2-letter ISO country code of the merchant to be displayed in a statement descriptor.

Example:

"US"

statement_descriptor.phone_number

string | null

The value in the phone number field of a customer's statement which should be formatted according to the E164 number standard.

Example:

"+1234567890"

statement_descriptor.url

string | null

The merchant's URL to be displayed in a statement descriptor.

Required string length: 1 - 50

Example:

"www.example.com"

statement_descriptor.postal_code

string | null

The merchant's postal code or zip code.

Required string length: 1 - 50

Example:

"94560"

scheme_transaction_id

string | null

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

Example:

"123456789012345"

three_d_secure

TransactionThreeDSecureSummary · object

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

Show child attributes

three_d_secure.version

string | null

The version of 3DS used for this transaction.

Example:

"2.2.0"

three_d_secure.status

enum<string> | null

The status of the 3DS challenge for this transaction.

Available options:

setup_error,

error,

declined,

cancelled,

complete

Example:

"complete"

three_d_secure.method

enum<string> | null

The method used for 3DS authentication for this transaction.

Available options:

challenge,

frictionless

Example:

"challenge"

three_d_secure.response_data

ThreeDSecureDataV1 · object

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.

ThreeDSecureDataV1
ThreeDSecureV2

Show child attributes

three_d_secure.response_data.cavv

string

required

The cardholder authentication value or AAV.

three_d_secure.response_data.eci

string

required

The ecommerce indicator for the 3DS transaction.

Required string length: 1 - 2

three_d_secure.response_data.version

string

required

The version of 3-D Secure that was used.

three_d_secure.response_data.directory_response

string

required

For 3-D Secure version 1, the enrolment response. For 3-D Secure version 2 and above, the transaction status from the ARes.

Maximum string length: 1

three_d_secure.response_data.authentication_response

string

required

The response for the 3DS authentication call.

Maximum string length: 1

three_d_secure.response_data.cavv_algorithm

string

required

The CAVV algorithm used.

Maximum string length: 1

three_d_secure.response_data.xid

string

required

The transaction identifier.

three_d_secure.response_data.scheme

enum<string> | null

The scheme/brand of the card that is used for 3-D Secure.

Available options:

accel,

amex,

bancontact,

carte-bancaire,

cirrus,

culiance,

dankort,

diners-club,

discover,

eftpos-australia,

elo,

hipercard,

jcb,

maestro,

mastercard,

mir,

nyce,

other,

pulse,

rupay,

star,

uatp,

unionpay,

visa

Example:

"visa"

three_d_secure.error_data

ThreeDSecureError · object

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.

Show child attributes

three_d_secure.error_data.code

string | null

The error code.

Required string length: 3

Example:

"305"

three_d_secure.error_data.description

string | null

The error description.

Maximum string length: 2048

Example:

"Invalid ThreeDSCompInd"

three_d_secure.error_data.detail

string | null

Detail about the 3DS error.

Maximum string length: 2048

Example:

"The threeDSCompInd must be 'Y' when successful"

three_d_secure.error_data.component

string | null

Code indicating the 3-D Secure component that identified the error.

Required string length: 1

Example:

"C"

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.

Show child attributes

additional_identifiers.{key}

string | null

metadata

Metadata · object

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

Show child attributes

metadata.{key}

string

Example:

{
  "cohort": "cohort-12345",
  "order": "order-12345"
}

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

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

Show child attributes

recipient.first_name

string

required

The first name of the recipient.

recipient.last_name

string

required

The last name of the recipient.

recipient.address

Address · object

The recipient of the fund's address.

Show child attributes

recipient.address.city

string | null

The city for the address.

Required string length: 1 - 100

Example:

"San Jose"

recipient.address.country

string | null

The country for the address in ISO 3166 format.

Example:

"US"

recipient.address.postal_code

string | null

The postal code or zip code for the address.

Required string length: 1 - 50

Example:

"94560"

recipient.address.state

string | null

The state, county, or province for the address.

Required string length: 1 - 255

Example:

"California"

recipient.address.state_code

string | null

The code of state, county, or province for the address in ISO 3166-2 format.

Example:

"US-CA"

recipient.address.house_number_or_name

string | null

The house number or name for the address. Not all payment services use this field but some do.

Required string length: 1 - 255

Example:

"10"

recipient.address.line1

string | null

The first line of the address.

Required string length: 1 - 255

Example:

"Stafford Appartments"

recipient.address.line2

string | null

The second line of the address.

Required string length: 1 - 255

Example:

"29th Street"

recipient.address.organization

string | null

The optional name of the company or organisation to add to the address.

Required string length: 1 - 255

Example:

"Gr4vy"

recipient.account_number

string | null

The account number of the recipient. Depending on the type of funds transfer, this could be a wallet ID, bank accoutn number, or email address.

Example:

"act12345"

recipient.date_of_birth

string<date> | null

The date of birth of the recipient.

Example:

"1995-12-23"

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

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Payouts

Refunds

Sessions

Settlement records

Disputes

Instruments

Vault

Connections

Errors

Other

Update a transaction

Authorizations

Headers

Path Parameters

Body

Response