Collections overview
Use the Collections API to initiate 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
Collections let you accept money into Gravv from your customers through three methods: card, bank transfer, and mobile money.
- Call
POST /v1/collectionswith the collection method.- Card — the response includes a payment link the customer opens to complete payment on the hosted checkout.
- Bank transfer / mobile money — the response includes payment instructions to display to the customer.
- Track the collection with
GET /v1/collections/{id}or subscribe to collections webhook events.
For card payments you can also work at a lower level with payment intents, and charge saved cards server-to-server for recurring or merchant-initiated transactions.
Endpoints
Collections
| Endpoint | Description |
|---|---|
POST /v1/collections |
Initiate a collection via card, bank transfer, or mobile money |
GET /v1/collections/{id} |
Status and details of a collection — public, no API key required |
Card payments
| Endpoint | Description |
|---|---|
POST /v1/collections/cards/payment-intents |
Create a card payment intent and hosted checkout link. Providing a card_token automatically initiates a charge |
POST /v1/collections/cards/payment-intents/charge |
Charge a saved card token server-to-server (recurring / merchant-initiated) |
GET /v1/collections/cards |
List the customer's active saved cards |
GET /v1/collections/cards/{card_id} |
Retrieve a single saved card |
DELETE /v1/collections/cards/{card_id} |
Delete a saved card (idempotent) |
When charging a saved card, billing fields are optional — omitted fields fall back to the customer record on file, and any fields you provide take precedence.
Authentication
All requests use https://api.gravv.xyz/v1/ and authenticate with the Api-Key header, except GET /v1/collections/{id}, which is public so your payer-facing pages can poll payment status.