slikair
slikair APIV2
Back to the full API reference

API

Payouts

Send funds to the consumer and track the payout state.

Use these endpoints to send funds out to a customer through card, open banking, crypto or local rails, and to check the status of a payout you already created. Every operation below lists its required headers, the full request body fields, and the full body of each response it can return.

Endpoints on this page

MethodPathSummaryoperationId
POST/payouts/createCreate payoutcreatePayoutV2
POST/payouts/get-statusGet Payout StatusgetPayoutStatusV2
POST/payouts/create

Create payout

operationId: createPayoutV2

Creates a payout withdrawal with multiple methods and modes. Sandbox does not support payouts.

Required headers

merchant-tokenContent-TypeIdempotency-Key

Request body

Example variants

credit_cardcryptoopen_bankingfps

Responses

200Payout create response
400Payout create error response
401Payout error response
500Payout error response
Example: credit_card payout
{
  "merchant_id": "9e07802d51264b02b4b3ef09dfb94219",
  "site_id": "1234",
  "method": "credit_card",
  "mode": "direct",
  "amount": 50.00,
  "currency": "EUR",
  "merchantReference": "payout-2001",
  "country": "NLD",
  "notificationUrl": "https://example.com/payout-webhook",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+31600000000"
  },
  "paymentDetails": {
    "method": "credit_card",
    "cardNum": "4111111111111111",
    "cardHolder": "John Doe",
    "cardExpireMonth": "12",
    "cardExpireYear": "2030"
  }
}

Request body fields

Payout create request14 fields
FieldRequiredTypeDescriptionExample
merchant_idrequiredstring
methodrequiredenumcredit_card | open_banking | crypto | fps
site_idrequiredstring
moderequiredenumdirect | hosted
amountrequirednumber
currencyrequiredstring
merchantReferencerequiredstring
countryrequiredstring
notificationUrlrequiredstring (uri)
customerrequiredPayout customer object
successUrloptionalstring (uri)
pendingUrloptionalstring (uri)
failureUrloptionalstring (uri)
paymentDetailsoptionalPayout payment detailsDiscriminated by method.

Response body fields

200Payout create response5 fields
FieldRequiredTypeDescriptionExample
statusoptionalenuminitiated | processing | succeeded | failed
descriptionoptionalstring
timestampoptionalstring (date-time)
payoutIdoptionalstring
requestIdoptionalstring
400Payout create error response6 fields
FieldRequiredTypeDescriptionExample
statusrequiredenumfailedfailed
descriptionrequiredstringHuman readable error summary.invalid request
errorsrequiredstring[]Field level validation errors.[]
payoutIdoptionalintegerPresent only when the payout was created before the failure.123456
reasonCoderequiredstringMachine readable reason.TRANSIENT_ERROR
errorCoderequiredstringNumeric error code.42718
401500Payout error response5 fields
FieldRequiredTypeDescriptionExample
statusrequiredenumfailedfailed
descriptionrequiredstringHuman readable error summary.invalid request
errorsrequiredstring[]Field level validation errors.[]
reasonCoderequiredstringMachine readable reason.INVALID_OR_EXPIRED_TOKEN
errorCoderequiredstringNumeric error code.32201
POST/payouts/get-status

Get Payout Status

operationId: getPayoutStatusV2

Retrieves the payout status by payout ID.

Required headers

merchant-tokenContent-Type

Request body

Responses

200Payout status response
400Payout error response
500Payout error response

Request body fields

Payout status request2 fields
FieldRequiredTypeDescriptionExample
merchant_idrequiredstring
payoutIdrequiredstring

Response body fields

200Payout status response3 fields
FieldRequiredTypeDescriptionExample
statusoptionalenuminitiated | processing | succeeded | failed
payoutIdoptionalstring
idempotencyKeyoptionalstring
400500Payout error response5 fields
FieldRequiredTypeDescriptionExample
statusrequiredenumfailedfailed
descriptionrequiredstringHuman readable error summary.invalid request
errorsrequiredstring[]Field level validation errors.[]
reasonCoderequiredstringMachine readable reason.INVALID_OR_EXPIRED_TOKEN
errorCoderequiredstringNumeric error code.32201
Back to the full API reference