API Reference

Connections

GitHub

Gr4vy

About Gr4vy

Returns a list of all available card scheme definitions.

List card scheme definitions

Definitions of a card scheme including icon, label, etc.

Card Scheme Definition

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

bearerAuth

A list of available card scheme definitions.

Card Scheme Definitions

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

Settlement records

Reconciling settlement records

Settlement report specification

Single Sign-On

Okta

Single Sign-On with Okta

Azure AD

Single Sign-On with Azure AD

3-D Secure

Setup 3-D Secure

Embed

3-D Secure in Embed

Hosted via API

Hosted 3-D Secure

External 3DS server

External 3-D Secure server

Testing

3-D Secure Testing

Account Updater

Manual updates

Manual account updates

Scheduled updates

Scheduled account updates

Anti-fraud

Anti-fraud setup

Fingerprints

Automatic anti-fraud device fingerprinting

Reviews

Anti-fraud reviews

Cybersource

Cybersource Decision Manager

Forter

Sift

Simulator

Anti-fraud simulator

Apple Pay

Web with Embed

Apple Pay on web with Embed

Web without Embed

Apple Pay on web without Embed

iOS with SDK

Apple Pay on iOS with the SDK

iOS without SDK

Apple Pay on iOS without the SDK

Decrypted tokens

Decrypted Apple Pay tokens

Gift Cards

Gift card simulator

Google Pay

Google Pay on web with Embed

Google Pay on web without Embed

Android with SDK

Google Pay on Android with the SDK

Android without SDK

Google Pay on Android without the SDK

Decrypted Google Pay tokens

Create transactions without a creating a buyer first

Guest checkout

Merchant accounts

Accounts

Managing merchant accounts

Users

Users & merchant accounts

API & merchant accounts

Embed & merchant accounts

Using scheme tokens with payment orchestration

Network tokens

How to use scheme tokens with or without payment orchestration

Implementation

Network token implementation

Managing the full lifecycle of network tokens

Lifecycle

Network token lifecycle management

Network Token Testing

Pass through

Network token pass through

Introduction

Payouts

Push payments

Push payments and Embed

Recurring payments

Common scenarios

In Embed

Recurring transactions with Embed

Open or Closed-loop

Open-loop versus closed-loop

Recurring payments with network tokens

A unique hash for every card in our vault

Card fingerprints

A unique ID for the account behind the card

Payment account references

Webhooks

Payload

Webhook payload

Webhook events

Technical considerations

Technical webhook considerations

A list of best practices for integrating Gr4vy into your checkout.

Best practice

API authentication basics and best practices.

Authentication

Sandbox and Production environments within an instance.

Environments

Best practices on handling errors and other exceptions.

Errors

Error handling

Best practices on handling retries in an idempotent way.

Idempotent Requests

Best practices on handling the original IP address for a transaction.

IP Address Forwarding

Best practices on handling pagination in the API.

Pagination

Rate limiting

Payments

Instruments

Vault

Connections

Dashboard

Errors

List card scheme definitions

Authorizations

Response