Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.girostack.com/llms.txt

Use this file to discover all available pages before exploring further.

POST {{baseurl}}/collection-accounts 
   https://gw.stg.girostack.com/v1

Headers

​
x-giro-key
string
required
Pass your account’s secret key as the value.

Body Params

​
destination
string
required
Value should be the publicId of your wallet
​
accountName
string
required
Value could be username or customer name
​
amount
number
required
Value should be in kobo
​
expireIn
number
required
Range is 10 mins - 30mins. Value should be in seconds.
​
reference
string
When provided, this should be unique and minimum length should be 5.
curl --location --request POST '{{API_BASE_URL}}/collection-accounts' \
--header 'x-giro-key: {{SECRET_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
    "destination": "vba-19aeceea-1bd6-4e85-89fa-2ca0b1c57d61",
    "accountName": "John Doe",
    "amount": 14500,
    "expireIn": 1800
}'

{
  "meta": {
    "statusCode": 201,
    "success": true,
    "message": "CollectionAccount successfully created"
  },
  "data": {
    "publicId": "vba-6989bcba-15b0-4552-8d78-44fc0b1dd06d",
    "account": "65b12bbf36e38c6bfbe35f95",
    "reference": "4cacf856-9b10-4d13-9f53-0244d2c77514",
    "parentAccountNumber": "9685018742",
    "accountName": "John Doe",
    "accountNumber": "9153058747",
    "amount": 14500,
    "bankName": "Source MFB",
    "bankCode": "090641",
    "live": true,
    "processor": "source",
    "expiration": "2024-05-27T09:30:40.942Z",
    "id": 1,
    "createdAt": "2024-05-27T09:00:40.978Z",
    "updatedAt": "2024-05-27T09:00:40.978Z",
    "currency": "NGN",
    "active": true,
    "status": "pending"
  }
}