.payment-service-definition {
    background-color: white !important;
    border: 1px solid #0a0e0d1a;
    border-radius: 16px;
    padding: 2em;
    vertical-align: middle;
}

.payment-service-definition img {
    margin: 0 1em 0 0;
    max-width: 3em;
    display: inline-block;
}

.payment-service-definition h2 {
    margin: 0;
    display: inline-block;
    position: relative;
    top: 0.1em;
} 

*[data-group-tag] > div {
    flex-direction: row-reverse;
}

#sidebar-title {
    text-transform: uppercase;
}


Overview

Connections

Gr4vy

Grow your payment capabilities with code.

How scalable payments flow

Command Line Interface (CLI)

Postman

Postman Collection

High level transaction insights with a daily, weekly, or monthly view.

Insights

A data dashboard that allows you to deep dive into your payments data

Authorizations

Authorization Insights

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

ACI Worldwide

Card via ACI Worldwide

Authorize.net

Card via Authorize.Net

ChaseOrbital

Card via ChaseOrbital

Checkout.com

Card via Checkout.com

Mastercard Gateway

Card via Mastercard Gateway

Card via NMI

Merchant Warrior

Card via Merchant Warrior

Powertranz

Card via Powertranz

Shift4 i4go

USAePay

Card via USAePay

Affirm

Afterpay

SPEI

SPEI via Arcus

Banked

Bitpay

Clearpay

GoCardless

Klarna

Latitude/Gem

LINE Pay

Multipago

OXXO

Scalapay

Smartpay

The Giving Block

Trustly (Europe)

Trustly (US)

plug

API authentication basics and best practices.

Authentication

JWTs

Authentication with JWTs

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

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 all buyers or search for a specific buyer.

List all buyers

Add a buyer

Get a buyer

Update a buyer

Delete a buyer

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

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

Delete checkout session

Update a checkout session with card data.

Update session fields

Update checkout session fields

List all payment links

Add a payment link

Get payment link

Expire a payment link

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

List payment option

List payment options

List payouts created.

Create a payout.

Get a payout.

List transaction refunds

Create transaction refund

Create a refund for all instruments on a transaction.

Refund all instruments

Create batch transaction refund

Get refund

Creates a session for a payment service that supports sessions.

Get session

Create a session for apayment service definition

Get session by ID

List all settlements for a specific transaction.

List settlement records

List transaction settlements

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

Get settlement record

Get transaction settlement

Client errors

Client-side errors (4XX)

Server errors

Server-side errors (5XX)

List 4XX errors

square-terminal

The latest product news, changes, and other announcements

Latest

Updates & Announcements

Java

Python

TypeScript

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.

Gateways & PSPs

Wallets, Banking & other

Connections

Gateways & PSPs

Wallets, Banking, and other