Payouts

A payout is created when charges made through Vibrant are pending payout.

Currently payouts from NETS (Dankort and BankAxept) are not visible in our platform due to lack of visibility from NETS.

Payouts are created according to the schedule defined in the your merchant contract, which typically is daily or weekly payouts.

The timing of payouts depends on the delay configured in the contracts. Depending on country, bank closing days and other variables, there can be a minimum requirement on the delay. In general a payout will take place three business days after a sale and would be written as T+3 (transactions day + 3 business days)

We currently only support net settlement payouts, meaning that all sales, refunds and fees are summed together to formt the net amount, which is the resulting payout amount.

There are currently fees which is NET collected though payouts. We have several fees that are invoiced, which includes subscription fees and fees to other providers like MobilePay.

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

apikey

apikeystringRequired

Path parameters

idstringRequired

Responses

200Success

application/json

403

Forbidden.

get

/pos/v1/payouts/{id}

HTTPcURLJavaScriptPython

GET /pos/v1/payouts/{id} HTTP/1.1
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": ""
}