API Reference

Connections

GitHub

Gr4vy

About Gr4vy

Create payout

The country for the address in ISO 3166 format.

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

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

The postal code or zip code for the address.

The state, county, or province for the address.

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

Address

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

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

The phone number of the buyer. This number is formatted according to the
[E164 number standard](https://www.twilio.com/docs/glossary/what-e164).

The tax information associated with the billing details.

The type of this resource. Is always `billing-details`.

Billing details

Billing details to use associated to a buyer.

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

The phone number for the buyer which should be formatted according to the
[E164 number standard](https://www.twilio.com/docs/glossary/what-e164).

The tax ID information associated with the billing details.

Billing details (Create)

Snapshot of a buyer, as used when embedded inside other
resources.

The billing details associated with the buyer, which include the
address and tax ID.

A unique name for this buyer which is used in the Gr4vy admin panel to give a buyer a human readable name.

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

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

Buyer (Snapshot)

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

Unique value which identifies a merchant for processing transactions, also known as a MID.

Merchant classification for the type of goods or services it provides.

The phone number for the merchant which should be formatted according to the
[E164 number standard](https://www.twilio.com/docs/glossary/what-e164).

Value to explain charges or payments on bank statements.

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

Merchant

Snapshot of a payment method, as used when embedded inside other
resources.

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

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

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.

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.

The expiration date for this payment method. This is mostly used by cards
where the card might have an expiration date.

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

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

A label for the payment method. This can be the last 4 digits for a card,
or the email address for an alternative payment method.

The date and time when this card was last replaced.

When the Account Updater determines that new card details are available, existing details are not
changed immediately. There are three scenarios in which the actual replacement occurs:

1. When this card has expired.
2. When only the expiration date changed.
3. When a transaction using this card is declined with any of the following codes:
    * `canceled_payment_method`
    * `expired_payment_method`
    * `unavailable_payment_method`
    * `unknown_payment_method`

When the replacement is applied, this field is updated.
For non-card payment methods, the value of this field is always set to `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.
This value will be unique if the same underlying account was used, regardless of
the actual payment method used. For example, a network token or an Apple Pay device
token will return the same PAR when possible.

The uniqueness of this value will depend on the card scheme, please refer to their documentation
for further details. The availability of the PAR in our API depends on the availability
of its value in the API of the payment service used for the transaction.

An additional label used to differentiate different sub-types of a payment
method. Most notably this can include the type of card used in a
transaction. This field is `null` for the non-card payment methods.
This represents the card scheme sent to the connector and it could be different from the
actual card scheme that is being used by the PSP to process the transaction
in the following situations: 1. `use_additional_scheme` transformation is used
with the `PAN` instrument but we already have a PSP token for the card.
2. `use_additional_scheme` transformation is used but PSP has fallen back to the
main card scheme internally.

Payment method (Snapshot)

The first 6 digits of the full card number (the BIN).

The type of card, one of `credit`, `debit` or `prepaid`.

Card

The payment method that this services handles.

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


A payment service

Custom options for checkout-card payment service.

The processing channel to be used for the payment.

The ID of the currency account that will fund the payout.

Payout

The expiration date of the card, formatted `MM/YY`.

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

The 13-19 digit number for this card as it can be found on the
front of the card.

Payout card payment method

The tax ID information associated to a buyer.

Tax ID

The optional billing details for the a buyer.

An external identifier that can be used to match the buyer against your own records. This value needs to be unique for all buyers.

The optional shipping details for the buyer.

Buyer

Payout (Create)

bearerAuth

Bad Request

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

Create payout

Authorizations

Body

Response