Skip to main content
GET
/
api
/
v1
/
business
/
collections
List local-rails collections
curl --request GET \
  --url http://localhost:3001/api/v1/business/collections \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "data": {
    "data": [
      {
        "id": "<string>",
        "object": "collection",
        "amount": 123,
        "currency": "<string>",
        "country": "<string>",
        "expiresAt": "<string>",
        "channel": {
          "provider": "<string>",
          "channelId": "<string>"
        },
        "instructions": {
          "bankName": "<string>",
          "accountNumber": "<string>",
          "accountName": "<string>",
          "reference": {},
          "phone": "<string>",
          "prompt": "<string>",
          "url": "<string>",
          "provider": "<string>"
        },
        "businessPaymentId": "<string>",
        "createdAt": "<string>",
        "metadata": {}
      }
    ],
    "hasMore": true
  }
}

Headers

x-api-key
string
required

Query Parameters

limit
string
starting_after
string

Response

OK

success
boolean
required
Example:

true

data
object
required