Collections overview
Use the Collections API to start collections, retrieve collection details, and create or manage card payment intents.
Create a collection or browse the operations in this category.
Learn how collection methods and payment flows work.
How it works
A collection accepts money from your customer into Gravv. There are two kinds of collection method, card (card, apple_pay, google_pay) and bank transfer (bank_transfer). Gravv does not support mobile money or pix. See Collection methods for the countries.
- Call
POST /v1/collectionswith the collection method.- Card. The response includes a payment link. The customer opens it and pays on the hosted checkout.
- Bank transfer. The response includes payment instructions to show to the customer.
- Track the collection with
GET /v1/collections/{id}or subscribe to collections webhook events.
On or after 31 October 2026, Gravv changes the values in onramp_status and renames two collection event types. Read new_onramp_status today. See Status label change.
For card payments, you can also create payment intents directly, and charge saved cards server-to-server for recurring or merchant-initiated payments.
Endpoints
Collections
| Endpoint | Description |
|---|---|
POST /v1/collections |
Start a collection by card or bank transfer |
GET /v1/collections/{id} |
Get the status and details of a collection |
Card payments
| Endpoint | Description |
|---|---|
POST /v1/collections/cards/payment-intents |
Create a card payment intent and hosted checkout link. Sending a card_token starts a charge automatically |
POST /v1/collections/cards/payment-intents/charge |
Charge a saved card token server-to-server, for recurring or merchant-initiated payments |
GET /v1/collections/cards |
List a customer's saved cards and their card_token values. customer_id is required |
GET /v1/collections/cards/{card_id} |
Retrieve a single saved card |
DELETE /v1/collections/cards/{card_id} |
Delete a saved card. Send a JSON body with customer_id and card_token |
When you charge a saved card, billing fields are optional. An omitted field falls back to the saved card's billing record, then to the customer record. Fields you send take precedence.
Authentication
All requests use https://api.gravv.xyz/v1/ and authenticate with the Api-Key header, including GET /v1/collections/{id}. Call that endpoint from your server, not from pages the payer sees.