API Reference

Connections

GitHub

Gr4vy

About Gr4vy

Returns a list of rules for a given flow. Each rule has an
associated action, conditions, and outcome.

List flow rules

Additional detail about the part of a request body that caused an issue.

The location where the error caused an issue.

A human readable message for this error detail.

The exact item for which the validation did not succeed. This is a JSON
pointer for request bodies, while for query, path, and header parameters
it is the name of the parameter.

A unique identifier for the type of error that occurred.

Error details

Amount conditions with a name, operator, and value.

The comparison to make on the currency code `value`.

Currency ISO codes to compare the transaction to.

Amount value to compare transaction value to.

Flow amount condition

Amount range conditions with a name, operator, and value.

Maximum value to compare transaction value to.

Minimum value to compare transaction value to.

Flow amount range condition

Amount conditions matching a value of 0 in any currency.

The comparison to make on the transaction `value`.

Flow zero amount condition

Anti-fraud decision condition with a name, operator, and value.

Flow anti-fraud decision condition

BIN range conditions with a name, operator, and value.

The comparison to make on the `card_bin` `value`.

BIN range to compare with the transaction. A card BIN is
8 characters long at maximum.

Flow BIN range condition

Browser language conditions with a name, operator, and value.

The comparison to make on the browser language `value`.

Browser language two-letter ISO 639-1 codes to compare the transaction to.

Flow browser language condition

Card country condition with a name, operator, and value.

Countries to compare the card originating country to
in `ISO-3166` 2 character format.

Flow card country condition

Card scheme conditions with a name, operator, and value.

Card scheme(s) to compare the transaction to.

Flow card scheme condition

Card source conditions with a name, operator, and value.

Card sources to compare the transaction to.

Flow card source condition

Card type condition with a name, operator, and value.

Flow card type condition

Country conditions with a name, operator, and value.

The comparison to make on the country code `value`.

Country two-letter ISO codes to compare the transaction to.

Flow country condition

Currency conditions with a name, operator, and value.

Flow currency condition

`is_subsequent_payment` flag conditions with a name, operator, and value.

The comparison to make on the `is_subsequent_payment` flag `value`.

`is_subsequent_payment` flag value to compare the transaction to.

Flow is subsequent payment condition

`merchant_initiated` flag conditions with a name, operator, and value.

The comparison to make on the `merchant_initiated` flag `value`.

`merchant_initiated` flag value to compare the transaction to.

Flow merchant initiated condition

Metadata conditions with a name, operator, and value.

The metadata to compare the transaction to.

Key to metadata value to compare transaction to.

Flow metadata condition

Payment method conditions with a name, operator, and value. This
condition is only for use with the `route-transaction` action.

The payment method to compare the transaction to.

Flow payment method condition

Payment methods condition with a name, operator, and value. This
condition is only for use with the `decline-early` action.

Payment method(s) to compare the transaction to.

Flow payment methods condition

Payment source conditions with a name, operator, and value.

The comparison to make on the payment source `value`.

Payment sources to compare the transaction to.

Flow payment source condition

Cart items' product categories conditions with a name, operator, and value.

Cart items' product categories to compare the transaction to.

Flow product categories condition

Cart items' product types conditions with a name, operator, and value.

Cart items' product types to compare the transaction to.

Flow product types condition

Action for the given rule. Actions can only be used in
flows that support them.

* The `checkout` flow only supports the
`select-payment-options` action.
* The `card-transaction` supports the `route-transaction`,
`skip-3ds`, and `decline-early` actions.
* The `non-card-transaction` flow only supports the
`decline-early` action.
* The `redirect-transaction` flow only supports
the `route-transaction` action.


One or more conditions that apply for this rule. Each condition
needs to match for this rule to go into effect.

The date and time
when this buyer was created in our system.

A custom error code returned when this rule is triggered. This only applies
to `"decline-early"` rule actions. The value must have a `flow_` prefix.

The type of this resource. Is always `rule`.

The date and time
when this buyer was last updated in our system.

Flow rule

Defines the outcome of a rule in a flow where the result
is a boolean.

The type of action outcome for the given rule.

Boolean outcome

Defines the outcome of a rule in a flow where the result
is a list of payment types.

Payment method outcome

Defines the outcome of a rule in a flow where the result
is a list of dictionaries that define the payment service,
instrument and transformation to be used to process a
transaction.

Version of the rule outcome. Current version is `2`.

Payment service outcome

Defines the outcome of a rule in a flow for 3DS.

3DS outcome

Defines the outcome of a rule in a flow where the result
is a list of UUIDs.

Depending on the flow and action where this outcome is used, the UUIDs
may have an important meaning like the ID of a payment service to be
used (this is the case for `redirect-transaction` flow and
`route-transaction` action).

UUIDs list outcome

Cart items' SKUs conditions with a name, operator, and value.

Cart items' SKU values to compare the transaction to.

Flow SKUs condition

bearerAuth

Flow rules

Unauthorized Error

Grow your payment capabilities with code.

Overview

How scalable payments flow

Digital wallets

Digital wallets in Embed

Events

Embed events

Locales

Embed localization

Theming

Embed Theming

Options

Embed options

In-app browsers

In-app browsers with Embed

Use Secure Fields to collect the CVV for cards previously stored.

Stored cards

Secure Fields with stored cards

Each field can be customized to match your brand using the `styles` property
when adding the field.

Secure Fields Theming

Secure Fields events

Enable Click to Pay for use with Secure Fields

Click to Pay

Click to Pay with Secure Fields

Secure Fields and 3DS

PayPal

PayPal via the API

Vault token import

Import file

Token import file creation

Upload tokens

Token import file upload

Buyers & payment methods

Creating buyers & payment methods on import

Vault Forward

Enable endpoint

Enable a Vault Forward endpoint

Forward to endpoint

Vault Forward card data to API endpoint

Control payment options presented at checkout, and the flow of card
and non-card payments all the way through to your payment service.

Flow

Control what payment options are displayed at checkout.

Checkout Flow

Control how card payments are routed, retried, and rejected.

Card Transactions Flow

Control how non-card payments are routed, retried, and rejected.

Other Transactions Flow

Securing user access with fine-grained controls

Roles & Permissions

Roles

User roles

Additional permissions

Additional user permissions

Generate and schedule transactions via the dashboard.

Reports

The specification of a report as defined by the API.

Specification

Report specification

Learn how to create a report via the dashboard.

Setup

Setup a report

Settlement reports

Ingestion

Settlement report ingestion

Schedule & Retrieve

Settlement report scheduling

Reconciliation

Settlement reconciliation

Reconciling settlement records against transactions

Payments

Instruments

Vault

Connections

Dashboard

Errors

List flow rules

Authorizations

Path Parameters

Response