API Reference

Initiate a collection

post
https://api.gravv.xyz/v1/collections

Initiates a collection request using a specified collection method (card, bank transfer, and mobile money).

If the collection method is card, a payment link will be generated for the customer to complete the payment. For mobile money and bank transfer methods, payment instructions will be provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Amount to collect

string
required
length between 3 and 3
^[A-Z]{3}$

Three-letter uppercase ISO 4217 currency code

string
required

Alpha-2 country code

uuid
required

Unique customer identifier

string
required

A unique identifier assigned by the client to reference the customer when storing payment details

string
required

Client unique reference

metadata
object

Custom JSON data that will be returned in webhook notifications for this transaction

source
required
destination
required
Headers
string

A unique key to prevent duplicate requests.

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?