Embed

Server-to-server

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

IP Address Forwarding

Gr4vy

Grow your payment capabilities with code.

Overview

How scalable payments flow

AFTs

Account funding transactions

Partial auth

Partial authorization

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

Best practice

Client errors

Client-side errors (4XX)

Server errors

Server-side errors (5XX)

List 4XX errors

square-terminal

Schedule one or more stored cards for an account update.

Create account updater job

List all the stored payment methods for a specific buyer.

List payment methods for a buyer

List all payment methods

Create payment method

Get payment method

Delete payment method

List all gateway tokens stored for a payment method.

List payment service tokens

Create a gateway tokens for a payment method.

Create payment service token

Delete a gateway tokens for a payment method.

Delete payment service token

List all network tokens stored for a payment method.

List network tokens

Provision a network token for a payment method.

Provision network token

Provision a cryptogram for a network token.

Provision network token cryptogram

Suspend a network token for a payment method.

Suspend network token

Resume a suspended network token for a payment method.

Resume network token

Delete a network token for a payment method.

Delete network token

Fetch the balances for one or more gift cards.

List gift card balances

Get gift card

List gift cards

Create gift card

Delete a gift card

List all the stored gift cards for a specific buyer.

List gift cards for a buyer

List all buyers or search for a specific buyer.

List all buyers

Add a buyer

Get a buyer

Update a buyer

Delete a buyer

List all the shipping details associated to a specific buyer.

List a buyer's shipping details

Add buyer shipping details

Get buyer shipping details

Update the shipping details associated to a specific buyer.

Update a buyer's shipping details

Delete the shipping details associated to a specific buyer.

Delete a buyer's shipping details

Fetch a list of the definitions of each card scheme.

List card scheme definitions

List digital wallets

Register a digital wallet like Apple Pay, Google Pay, or Click to Pay.

Register digital wallet

Get digital wallet

Update digital wallet

Delete digital wallet

Register a digital wallet domain (Apple Pay only).

Register a digital wallet domain

Remove a digital wallet domain (Apple Pay only).

Remove a digital wallet domain

Create a session for use with Google Pay.

Create a Google Pay session

Create a Apple Pay session

Create a session for use with Click to Pay.

Create a Click to Pay session

Returns a paginated list of transactions for the merchant account, sorted by most recently updated. You can filter, sort, and search transactions using query parameters.

List transactions

Create a new transaction using a supported payment method. If additional buyer authorization is required, an approval URL will be returned. Duplicated gift card numbers are not supported.

Create transaction

Retrieve the details of a transaction by its unique identifier.

Get transaction

Captures a previously authorized transaction. You can capture the full or a partial amount, as long as it does not exceed the authorized amount (unless over-capture is enabled).

Capture transaction

Voids a previously authorized transaction. If the transaction was not yet successfully authorized, or was already captured, the void will not be processed. This operation releases the hold on the buyer's funds. Captured transactions can be refunded instead.

Void transaction

Retrieve a paginated list of events related to processing a transaction, including status changes, API requests, and webhook delivery attempts. Events are listed in chronological order, with the most recent events first.

List transaction events

Synchronizes the status of a transaction with the underlying payment service provider. This is useful for transactions in a pending state to check if they've been completed or failed. Only available for some payment service providers.

Sync transaction

List transaction refunds

Create transaction refund

Get transaction refund

Get refund

Create a refund for all instruments on a transaction.

Create batch transaction refund

Retrieve a specific settlement for a transaction by its unique identifier.

Get transaction settlement

List all settlements for a specific transaction.

List transaction settlements

List the payment options available at checkout. filtering by country, currency, and additional fields passed to Flow rules.

List payment options

List the definitions of each payment service that can be configured.

List payment service definitions

Get the definition of a payment service that can be configured.

Get a payment service definition

Creates a session for a payment service that supports sessions.

Create a session for apayment service definition

List payment services

Updates the configuration of a payment service.

Update a configured payment service

Get the details of a configured payment service.

Get payment service

Configures a new payment service for use by merchants.

Configure a payment service

Deletes all the configuration of a payment service.

Delete a configured payment service

Verify the credentials of a configured payment service

Verify payment service credentials

Returns a list of activity by dashboard users.

List audit log entries

List all configured reports that can be generated.

List configured reports

Add a report

Get a report

Update a report

List all executions of a specific report.

List executions for report

Creates a download URL for a specific execution of a report.

Create URL for executed report

List all executed reports that have been generated.

List executed reports

Get executed report

Create checkout session

Retrieve the information stored on a checkout session.

Get checkout session

Update the information stored on a checkout session.

Update checkout session

Deleta a checkout session and all of its (PCI) data.

Delete checkout session

List all merchant accounts in an instance.

List all merchant accounts

Create a new merchant account in an instance.

Create a merchant account

Get info about a merchant account in an instance.

Get a merchant account

Update info for a merchant account in an instance.

Getting Started

Payments

Cloud Vault

Dashboard

Features

API

IP Address Forwarding

Embed

Server-to-server

Getting Started

Payments

Cloud Vault

Dashboard

Features

API

​Embed

​Server-to-server

Embed

Server-to-server