Initialize Collection
https://sandboxapi.onbrails.com/api/v1/wallets/collections/initialize (opens in a new tab)
Initiate a new collection payload
Path Parameters
| Parameter | type | Required |
|---|---|---|
| country | string | ✅ |
| currency | string | ✅ |
| customerEmail | string | ✅ |
| amount | number | ✅ |
| reference | string | ✅ |
| description | string | ✅ |
| payload | JSON | ✅ |
Request
Initialize Collections [POST]
curl --location 'https://sandboxapi.onbrails.com/api/v1/wallets/collections/initialize' \
--header 'Authorization: Bearer sk.48cceba3f9a2.xxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
"country": "NG",
"currency": "NGN",
"customerEmail": "youknowwho@gmail.com",
"amount": 65000,
"reference": "73f2d70c-7b0c-491f-85a73e527235",
"description": "Try",
"payload": {
"type": "BANK",
"accountName": "Ray"
}
}'Responses
🟢 200 - Result example
{
"status": true,
"message": "collection initialized successfully",
"data": {
"accountName": "BRAILSSOLUTIONS Checkout",
"accountNumber": "8062723217",
"type": "credit",
"bankName": "SAFE HAVEN MICROFINANCE BANK",
"description": "Try",
"customerId": "5fd96da7-4024-4e0b-8631-869d25981e83",
"createdAt": "2024-07-25T08:44:25.028Z",
"updatedAt": "2024-07-25T08:44:25.509Z",
"reference": "1b374ad3-811a-d35202abf49e",
"companyId": "be18709e-4717-bb1c-2a3e6b1",
"channel": "collection",
"amount": 650,
"currency": "NGN",
"action": "deposit_ngn",
"status": "processing",
"fees": 0,
"id": "9c-9217-4311-a074-cb5cb",
"expiryInSeconds": 7200,
"expiryDate": "2024-07-25T10:44:25.456Z"
}
}