List events

GET
/v1/events

Events in the order they became visible. Store next_cursor and pass it as after to poll; no event is ever skipped. With resource_id the list is the story of one resource, oldest first: every status it went through, from its creation to its outcome. Filters combine, and the cursor works the same with them.

Autorización

apiKey
headerAuthorizationBearer <clave>

Your secret API key, sent as Authorization: Bearer <key>. A key names its environment: psp_test_… works only against sandbox (https://api-sandbox.caibopay.app), psp_live_… only against live (https://api.caibopay.app). Keys are issued by Caibo when your account is opened; the dashboard (Developers) shows the key in use.

limit?integer

Maximum number of items to return.

Rango1 <= value <= 100
after?string

The next_cursor of the previous page.

type?string

Only events of this type (payout.completed), or of this family of types when it ends in a dot (payout.). A type the platform does not publish is a 400.

resource_id?string

Only events about this resource, by its id: a payout, a pay-in, a funding account, a refund, a withdrawal, a remittance, a settlement, a customer, a beneficiary, a payout batch, a reconciliation exception, a risk decision or a webhook endpoint.

Match^[a-z]+_[0-9a-z]+$

Cuerpo de la respuesta

OK

application/json
  1. response
data*array<>
has_more*boolean
next_cursor?string
Ejemplo de solicitud
curl -X GET 'https://api-sandbox.caibopay.app/v1/events'
Ejemplo de respuesta
{  "data": [    {      "data": {},      "id": "string",      "livemode": true,      "occurred_at": "2019-08-24T14:15:22Z",      "schema_version": 0,      "type": "beneficiary.created"    }  ],  "has_more": true,  "next_cursor": "string"}