Payouts

The Payouts functionality enables you to disburse the funds quickly, safely and securely to your customers card accounts using Visa Direct and Mastercard Send.

Prerequisites

The Payouts functionality will be activated upon your request and it requires special procedures during the onboarding process.

Process a Payout

A payout can be initiated by sending a request as described in the API reference.

All request and response parameters are described below in the table.

Payout request with plain card data

{
    "externalRef": "payoutExternalRef_123",
    "description": "payout description",
    "amount": 10000,

Payout request with a payment token

{
    "externalRef": "payoutExternalRef_123",
    "description": "payout description",
    "amount": 10000,

POST /payouts (response)

{
    "id": "78b0e59c451d459eb6bc73458cf29607",
    "externalRef": "payoutExternalRef_123",
    "createdAt": "2023-01-23T11:45:26.6486576+00:00",

Get Info on Processed Payouts

Get info on single payout

In case you want to get information about an executed payout, you need to use the payoutId and perform standard GET request as described here.

GET /payouts/{payoutId} (response)

{
    "id": "78b0e59c451d459eb6bc73458cf29607",
    "externalRef": "payoutExternalRef_123",
    "createdAt": "2023-01-23T11:45:26.6486576+00:00",

Get a list of processed payouts

In case you want to get information about multiple executed payouts, you need to perform GET request as described here.

This endpoint is supporting filtering, sorting and pagination using query parameters. Description of these parameters can be found here.

GET /payouts (response)

{
    "data": [       
        "id": "78b0e59c451d459eb6bc73458cf29607",
        "externalRef": "payoutExternalRef_123",

Parameter Specifications

Request and response parameters

Parameter	Format	Description
id	string	Unique identifier of the payout Only present in the response.
type	string enum	Type of the payout. Possible values: OfflineGambling OnlineGambling FundsDisbursement Mandatory Part of both request and response.
createdAt	string ISO 8601 date format in UTC	Timestamp of creation. Only present in the response.
modifiedAt	string ISO 8601 date format in UTC	Timestamp of the last update. Only present in the response.
status	string enum	Status of the payout. Possible values: Success Failure InProgress Unknown - in case Payout service is not able to get the final status even after retry/resubmit Only present in the response.
providerCode	string	Provider code indicating the processing result in string format. Only present in the response.
providerMessage	string	Provider message is expected to give information mainly in case of error. Only present in the response.
amount	numeric	Payout amount in minor units. Mandatory Part of both request and response.
currencyCode	string enum	Payout currency. 3 characters ISO 4217. E.g. USD, GBP, EUR etc. Mandatory Part of both request and response.
externalRef	string	External reference provided by the merchant for the payout. Optional Part of both request and response.
paymentDetails	object	Container for the payment details. Mandatory Part of both request and response.
paymentDetails.receiver	object	Container for the receiver payment details. Mandatory Part of both request and response.
paymentDetails.receiver.token	string	Payment token referencing the receiver card account. Will be used by non PCI DSS compliant merchants. Conditional Part of both request and response.
paymentDetails.receiver.pan	string	Card number of the receiver. Conditional Only passed as part of the request. Alternatively to using a token a plain payment data could be provided by PCI DSS certified merchants.
paymentDetails.receiver.bin	string	Bin of the card. Only present in the response.
paymentDetails.receiver.last4	string	Last four digits of the card number. Only present in the response.
paymentDetails.receiver.cardBrand	string	Card brand. Only present in the response.
paymentDetails.receiver.expiryMonth	string	Two-digit number representing the card's expiry month. (mm format) Conditional Part of both request and response.
paymentDetails.receiver.expiryYear	string	Two-digit number representing the card's expiry year. (yy format) Conditional Part of both request and response.
paymentDetails.receiver.firstName	string	First name of the receiver. Optional Part of both request and response.
paymentDetails.receiver.middleName	string	Middle name of the receiver. Optional Part of both request and response.
paymentDetails.receiver.lastName	string	Last name of the receiver. Optional Part of both request and response.

Filtering, sorting and pagination parameters

Parameter	Parameter function	Format	Description
CreatedAtFrom	Filtering based on comparison	Timestamp in ms	Payout creation timestamp in ms since Epoch used as a starting point in time. Example: CreatedAtFrom=1665871200000 means that all payouts created starting from date 15.10.2022 time 00:00:00.000 (incl.) should be listed.
CreatedAtTo	Filtering based on comparison	Timestamp in ms	Payout creation timestamp in ms since Epoch used as a final point in time. Example: CreatedAtTo=1666303199999 means that all payouts created ending to date 20.10.2022 time 23:59:59.999 (incl.) should be listed.
ModifiedAtFrom	Filtering based on comparison	Timestamp in ms	Payout modification timestamp in ms since Epoch used as a starting point in time. Example: ModifiedAtFrom=1665871200000 means that all payouts modified starting from date 15.10.2022 time 00:00:00.000 (incl.) should be listed.
ModifiedAtTo	Filtering based on comparison	Timestamp in ms	Payout modification timestamp timestamp in ms since Epoch used as a final point in time. Example: ModifiedAtFrom=1666303199999 means that all payouts modified ending to date 20.10.2022 time 23:59:59.999 (incl.) should be listed.
ExternalRef	Filtering based on equality	string	External payout reference provided by the merchant sent in the payout creation request. Will work as a filtering option only if provided by the merchant.
Status	Filtering based on equality	enum string	Status of the payout. Possible values: Success Failure InProgress Unknown
SortBy	Sorting	enum string	Array of parameters based on which the sorting will be performed. Allowed values: CreatedAt
SortDir	Sorting	enum string	Sorting direction. (By default descending sorted by the payout creation timestamp) Possible values: ASC DESC
Page	Pagination	numeric	The number of a page that is requested. The possible values here are dynamic depending on the number of the stored payouts and the size of the page.
PageSize	Pagination	numeric	The number of the payouts that will be displayed in a single page. max page size = 100