API Reference

About

Wpay

Contact

Documentation Hub

Returns a list of available payment method options for the combination of
amount, currency, country, metadata and list of cart items.

If the amount is zero, payment options which do not support zero amounts,
will be omitted in the response.

Checkout flow rules are used to limit these result.

List payment options with POST

A cart item that represents a single cart line item for a transaction.
Note that some optional properties are required for certain payment
service providers. If no value is set for these properties, we will use
their default value.

If the total due to be paid for the item is required by the payment service
provider, generally referred to as the "total amount", the formula below
will usually be used to calculate this amount:

`(unit_amount * quantity) - discount_amount + tax_amount`

It's highly recommended that the total amount to pay for all items
should match the transaction's amount to reduce the risk of the
transaction being declined by the payment service provider.

The amount discounted for this item represented as a monetary amount
in the smallest currency unit for the given currency, for example `1299`
USD cents represents `$12.99`.

Please note that this amount is for the total of the cart item and not
for an individual item. For example, if the quantity is 5, this value
should be the total discount amount for 5 of the cart item.

You might see unexpected failed transactions if the `discount_amount` can
not be equally divided by the `quantity` value. This is due to the fact
that some payment services require this amount to be specified per unit.

In this situation we recommend splitting this item into separate items,
each with their own specific discount.

An external identifier for the cart item. This can be set to any value and is not sent to the payment service.

The name of the cart item. The value you set for this property may
be truncated if the maximum length accepted by a payment service
provider is less than 255 characters.

The quantity of this item in the cart. This value cannot be negative
or zero.

The tax amount for this item represented as a monetary amount
in the smallest currency unit for the given currency, for example `1299`
USD cents represents `$12.99`.

Please not that this amount is for the total of the cart item and not
for an individual item. For example, if the quantity is 5, this value
should be the total tax amount for 5 of the cart item.

You might see unexpected failed transactions if the `tax_amount` can
not be equally divided by the `quantity` value. This is due to the fact
that some payment services require this amount to be specified per unit.

In this situation we recommend splitting this item into separate items,
each with their own specific tax amount.

The amount for an individual item represented as a monetary amount
in the smallest currency unit for the given currency, for example
`1299` USD cents represents `$12.99`.
The amount sent through to the payment processor as unitary amount
will be calculated to include the discount and tax values sent
as part of this cart item.

Cart Item

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

An available payment option for a locale.

A flag to indicate if delayed capture is supported.

A flag to indicate if storing the payment method is supported.

Additional context specific to the payment option.
This is currently only returned for Apple Pay and Google Pay.

Gateway merchant identifier used for Google Pay payments.

Display name of the merchant as registered with the digital wallet
provider.

Card schemes supported by the digital wallet provider.

An icon to display for the payment option.

A label that describes this payment option. This label is returned in the
language defined by the `locale` query parameter. The label can be used
to display a list of payment options to the buyer in their language.

The type of payment method that is available.

The mode to use with this payment option.

Payment option

Configuration for the approval interface that should be shown to the buyer.

Height of the approval interface in either pixels or view height (vh).

Width of the approval interface in either pixels or view width (vw).

Payment Option Approval UI

The scheme of the transaction

The fields that are required to process a transaction for this payment option.

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

The postal code or zip code for the billing address.

The state, county, or province for the billing address.

The tax id code associated with the billing details.

Required Fields

A request to get list of payment options.

Payment Options (List)

bearerAuth

A list of payment options

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

Securing user access with fine-grained controls

Roles & Permissions

Roles

User roles

Additional permissions

Additional user permissions

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

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

Lists all transactions for an account. Sorted by last updated at.

List transactions

Attempts to create an authorization for a payment method. In some cases it is
not possible to create the authorization without redirecting the user for
their authorization. In these cases the status is set to
indicate buyer approval is pending and an approval URL is returned.

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


New transaction

Get transaction

Captures a previously authorized transaction.

Capture transaction

Voids a transaction.

If the transaction was not yet successfully authorized, or was already
captured, the void will not be processed. Captured transactions can be
refunded instead.

Voiding zero-amount authorized transactions is not supported.

Once voided, the status of the transaction will be either `authorization_voided`,
`authorization_void_pending`, or if the void fails the original status will remain.

Void transaction

Get a list of events related to processing a transaction.

List events for transaction

Sync the transaction with the payment service to get the latest status,
amounts, and some of the identifiers. This is only available for some payment
service providers.

Payments

Instruments

Vault

Connections

Dashboard

Errors

List payment options with POST

Authorizations

Body

Response