API Reference

About

Wpay

Contact

Documentation Hub

Verify & get balance

Verify and get gift card balances

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

The amount remaining on the balance for this gift card according to the
gift card service. This may be `null` if the balance could not be fetched.

If the last balance update failed, this will contain the
internal code for this error.

If the last balance update failed, this will contain the
the raw error code received from the gift card provider.

If the last balance update failed, this will contain the
the raw error message received from the gift card provider.

The first 6 digits of the full gift card number.

The ISO-4217 currency code that this gift card has a balance for.

The date and time when this gift card expires. This is a full
date/time and may be more accurate than the actual expiry date
received by the gift card service.

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

A stored gift card (summary)

Check the balance for a non-stored gift card.

The 16-19 digit number for this gift card.

Gift Card Balance (New)

Check the balance for a stored gift card.

The ID of the gift card to check a balance for.

Gift Card Balance (Stored)

Verify gift cards are enrolled and fetch their balances.

This verifies a list of gift cards are enrolled for your gift card programme,
if this feature is available via your gift card service. It then also fetches each card's
current balance.

Duplicated gift card numbers are not supported. This includes both stored gift
cards, as well as those directly provided via the request.

A request to check the balance for a set of stored and
non-stored gift cards.

A gift card balance check request

bearerAuth

A list of gift cards in a short format including the latest balance.

Gift Cards (Summary)

Bad Request

Unauthorized Error

Too Many Requests Error

Verify and check gift card balances

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

Common issues

Common issues 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

Afterpay

Afterpay via the API

PayPal

PayPal via the API

Zip 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

3-D Secure

Setup

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

Attributes

Anti-fraud Specific Attributes

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

Simulator

Gift card simulator

Connections

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

Use guest buyer details in combination with stored buyer records and their payment methods

Buyer linking

Linking guests buyer details

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

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

Refund all instruments

Get refund

Get session

Get session by ID

List settlement records

Get settlement record

Create a job

List endpoints

Get endpoint

Get authentications

Get authentication

Add authentication

Update authentication

Remove authentication

Get service definition

Verify credentials

Client errors

Client-side errors (4XX)

Server errors

Server-side errors (5XX)

List 4XX errors

Payments

Instruments

Vault

Connections

Dashboard

Errors

Verify and get gift card balances

Authorizations

Body

Response