POST

/v1/account_events

Bearer*
curl --request POST \
  --url https://api.oneslipstream.com/v1/account_events \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account": "acc_bPKKB3sYsukFanSsaBcMCMR2",
  "eventType": "payment"
}'

Account events are used to track changes to accounts e.g. when the credit limit changes.

The eventType field is used to indicate the type of event and the data that is included in the event.

E.g. To update the credit limit the eventType would be limit and the limit field would contain the new credit limit.

{
  "id": "acc_evt_bPKKB3sYsukFanSsaBcMCMR2",
  "eventType": "payment",
  "payment": {
    "amount": 50000,
    "status": "success"
  },
  "createdAt": "2022-01-01T00:00:00.000Z"
}

Authorizations

Authorizationheaderrequired
string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
accountrequired
string

The unique identifier for the account

cashAdvance
object
close
object
default
object
eventTyperequired
enum<string>
Available options:
payment,
flag,
cash_advance,
default,
close,
limit,
update
flag
object
limit
object
payment
object
update
object

Response

200 - application/json
accountrequired
string

The unique identifier for the account

cashAdvance
object
close
object
default
object
eventTyperequired
enum<string>
Available options:
payment,
flag,
cash_advance,
default,
close,
limit,
update
flag
object
idrequired
string

The unique identifier for the account event

limit
object
payment
object
update
object
createdAt
string

The date and time the account event was created