Payouts

A payout is created when you are receiving money from Vibrant.

Payouts are typically created once per day, covering all sales and refunds for that day.

The timing of payouts may vary depending on country, bank closing days and other variables. But in general a payout will take place two days after a sale.

Fees to vibrant are deducted from the payout, so you do not have to do anything to handle that.

The payout holds a settlement Id, so it is easy to correlate all sale and refunds that are contained in a specific payout.

You can get payouts listed by time, fetched by id or search by attributes.

Here is an example getting the list:

curl

curl -X 'GET' \
  'https://pos.dev-api.vibrant.app/pos/v1/payouts' \
  -H 'accept: application/json' \
  -H 'apikey: vibrant_pos.YOUR_SECRET_KEY'

Get a Payout by id

get

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

403

Forbidden.

get

HTTPcURLJavaScriptPython

GET /pos/v1/payouts/{id} HTTP/1.1
Host: 
apikey: YOUR_API_KEY
Accept: */*

{
  "id": "po_2froTe3Wd8W3aSn1hX4vzE",
  "object": "payout",
  "accountId": "acct_1LqEqnFYPs6vK4Hr",
  "amount": 2000,
  "arrivalDate": 1671087901251,
  "balanceTransactionId": "text",
  "automatic": true,
  "currency": "DKK",
  "description": " ",
  "destination": "123",
  "failureBalance_transaction": "123",
  "failureCode": "",
  "failureMessage": "",
  "metadata": "{\"correlation_id: \"abc123\"}",
  "method": "",
  "originalPayout": "",
  "reconciliationStatus": "",
  "reversedBy": "",
  "sourceType": "",
  "statementDescriptor": "",
  "status": "",
  "type": ""
}