Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Gr4vy home page

Status
GitHub
Gr4vy
Gr4vy

Introduction

Authentication
Compatibility
Connectivity
JWTs
Environments
Errors
Idempotent requests
IP address forwarding
OpenAPI
Pagination
Prefer header
Rate limiting
Timeouts
Error Codes

Transactions

GET
List transactions
POST
New transaction
GET
Get transaction
POST
Capture transaction
POST
Void transaction

Buyers

GET
List buyers
POST
New buyer
GET
Get buyer
PUT
Update buyer
DEL
Delete buyer

Checkout Sessions

POST
New checkout session
GET
Get checkout session
PUT
Update checkout session
DEL
Delete checkout session
PUT
Update session fields

Payment links

GET
List payment links
POST
New payment link
GET
Get payment link
POST
Expire payment link

Payment options

POST
List payment options

Payouts

GET
List payouts
POST
New payout
GET
Get payout

Refunds

GET
List transaction refunds
POST
Refund transaction
POST
Refund all instruments
GET
Get refund

Sessions

POST
Get session
POST
Get session by ID

Settlement records

GET
List settlement records
GET
Get settlement record

Disputes

GET
List chargeback records
GET
List chargeback reversal records

Instruments

Vault

PSPs & Gateways

Errors

Client errors
Server errors
GET
List 4XX errors

Other

Webhook subscriptions

Get webhook subscription

This endpoint requires the webhook-subscriptions.read scope.

⌘I

Gr4vy home page

website twitter github linkedin

About

Payment orchestration Gr4vy for merchants Gr4vy for platforms Increasing your revenue

Developers

GitHub Latest news System status Customer support

website twitter github linkedin

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform