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/pos/v1/payouts/{id}

Authorization

apikey

Path parameters

id*string

Response

200403

Body

application/json

id*string

Unique id of the Payout

object*string

Object type

accountId*string

Id of the account

amount*number

Amount in cents

arrivalDate*number

UnixtimeStamp when the Payout arrives to merchant

balanceTransactionId*string

ID of the balance transaction that describes the impact of this Payout on your account balance

automatic*boolean

Created automatically or manually

currency*string

Currency this Payout was created with

description*string

A custom description can be added to a payout

destination*string

ID of the bank account or card the payout was sent to.

failureBalance_transaction*string

If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.

failureCode*string

Error code explaining reason for payout failure if available.

failureMessage*string

Message explaining reason for payout failure if available.

metadata*object

Custom data provided when this payout was created

method*string

Standard or instant.

originalPayout*string

If the payout reverses another, this is the ID of the original payout.

reconciliationStatus*string

not_applicable, in_progress or completed.

reversedBy*string

If the payout was reversed, this is the ID of the payout that reverses this payout.

sourceType*string

The source balance this payout came from. One of card, or bank_account.

statementDescriptor*string

Extra information about a payout to be displayed on the user’s bank statement.

status*string

Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). Some failed payouts may initially show as paid but then change to failed.

type*string

Can be bank_account or card.

Request

JavaScriptCurl

const response = await fetch('/pos/v1/payouts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": "text",
  "failureMessage": "text",
  "method": "text",
  "originalPayout": "text",
  "reconciliationStatus": "text",
  "reversedBy": "text",
  "sourceType": "text",
  "statementDescriptor": "text",
  "status": "text",
  "type": "text"
}