Payouts API

C#PHPNodeShell

Scroll down for code samples, example requests and responses.
Select a language for code samples from the tabs or the mobile navigation menu.

Create Payout

POST /

Creates a new payout transaction.

Parameters

Authorizationstringrequired
Authorization header using the Bearer scheme.

Create Payout

C#
PHP
Node
Shell

var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payouts/");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

amountnumber (double)optional
currencyCodestringoptional
ALL, DZD, ARS, AUD, BSD, BHD, BDT, AMD, BBD, BMD, BTN, BOB, BWP, BZD, SBD, BND, MMK, BIF, KHR, CAD, CVE, KYD, LKR, CLP, CNY, COP, KMF, CRC, HRK, CUP, CZK, DKK, DOP, SVC, ETB, ERN, FKP, FJD, DJF, GMD, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, HUF, ISK, INR, IDR, IRR, IQD, ILS, JMD, JPY, KZT, JOD, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, LRD, LYD, MOP, MWK, MYR, MVR, MUR, MXN, MNT, MDL, MAD, OMR, NAD, NPR, ANG, AWG, VUV, NZD, NIO, NGN, NOK, PKR, PAB, PGK, PYG, PEN, PHP, QAR, RUB, RWF, SHP, SAR, SCR, SGD, VND, SOS, ZAR, SSP, SZL, SEK, CHF, SYP, THB, TOP, TTD, AED, TND, UGX, MKD, EGP, GBP, TZS, USD, UYU, UZS, WST, YER, TWD, SLE, VED, MRU, STN, CUC, ZWL, BYN, TMT, GHS, VEF, SDG, UYI, RSD, MZN, AZN, RON, CHE, CHW, TRY, XAF, XCD, XOF, XPF, XDR, XUA, ZMW, SRD, MGA, COU, AFN, TJS, AOA, BGN, CDF, BAM, EUR, MXV, UAH, GEL, BOV, PLN, BRL, CLF, XSU, USN
externalRefstringoptional
descriptionstringoptional
typestringoptional
OfflineGambling, OnlineGambling, FundsDisbursement
paymentDetailsobjectoptional
- receiverobjectoptional
  - tokenstringoptional
  - panstringoptional
  - expiryMonthstringoptional
  - expiryYearstringoptional
  - firstNamestringoptional
  - middleNamestringoptional
  - lastNamestringoptional

Request body

{
    "amount": 0.1,
    "currencyCode": "ALL",
    "externalRef": "string",
    "description": "string",
    "type": "OfflineGambling",
    "paymentDetails": {
        "receiver": {
            "token": "string",
            "pan": "string",
            "expiryMonth": "string",
            "expiryYear": "string",
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
        }
    }
}

Responses

202Acceptedoptional
- idstringoptional
- externalRefstringoptional
- createdAtstring (date-time)optional
- modifiedAtstring (date-time)optional
- statusstringoptional
  Success, Failure, InProgress, Unknown
- descriptionstringoptional
- amountnumber (double)optional
- currencyCodestringoptional
  ALL, DZD, ARS, AUD, BSD, BHD, BDT, AMD, BBD, BMD, BTN, BOB, BWP, BZD, SBD, BND, MMK, BIF, KHR, CAD, CVE, KYD, LKR, CLP, CNY, COP, KMF, CRC, HRK, CUP, CZK, DKK, DOP, SVC, ETB, ERN, FKP, FJD, DJF, GMD, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, HUF, ISK, INR, IDR, IRR, IQD, ILS, JMD, JPY, KZT, JOD, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, LRD, LYD, MOP, MWK, MYR, MVR, MUR, MXN, MNT, MDL, MAD, OMR, NAD, NPR, ANG, AWG, VUV, NZD, NIO, NGN, NOK, PKR, PAB, PGK, PYG, PEN, PHP, QAR, RUB, RWF, SHP, SAR, SCR, SGD, VND, SOS, ZAR, SSP, SZL, SEK, CHF, SYP, THB, TOP, TTD, AED, TND, UGX, MKD, EGP, GBP, TZS, USD, UYU, UZS, WST, YER, TWD, SLE, VED, MRU, STN, CUC, ZWL, BYN, TMT, GHS, VEF, SDG, UYI, RSD, MZN, AZN, RON, CHE, CHW, TRY, XAF, XCD, XOF, XPF, XDR, XUA, ZMW, SRD, MGA, COU, AFN, TJS, AOA, BGN, CDF, BAM, EUR, MXV, UAH, GEL, BOV, PLN, BRL, CLF, XSU, USN
- typestringoptional
  OfflineGambling, OnlineGambling, FundsDisbursement
- paymentDetailsobjectoptional
  - receiverobjectoptional
    tokenstringoptional
    binstringoptional
    last4stringoptional
    cardBrandstringoptional
    Visa, Mastercard
    expiryMonthstringoptional
    expiryYearstringoptional
    firstNamestringoptional
    middleNamestringoptional
    lastNamestringoptional
400Bad Requestoptional
- typestringoptional
- titlestringoptional
- statusinteger (int32)optional
- detailstringoptional
- instancestringoptional

{
    "id": "string",
    "externalRef": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "status": "Success",
    "description": "string",
    "amount": 0.1,
    "currencyCode": "ALL",
    "type": "OfflineGambling",
    "paymentDetails": {
        "receiver": {
            "token": "string",
            "bin": "string",
            "last4": "string",
            "cardBrand": "Visa",
            "expiryMonth": "string",
            "expiryYear": "string",
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
        }
    }
}

Get multiple payouts

GET /

Get many payouts transactions. Supports pagination, sorting and filtering.

Parameters

Authorizationstringrequired
Authorization header using the Bearer scheme.
PageNumberinteger (int32)optional
PageSizeinteger (int32)optional
SortBystringoptional
SortDirstringoptional
CreatedAtFromnumber (double)optional
CreatedAtTonumber (double)optional
ModifiedAtFromnumber (double)optional
ModifiedAtTonumber (double)optional
ExternalRefstringoptional
Statusstringoptional

Get multiple payouts

C#
PHP
Node
Shell

var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payouts/?PageNumber=SOME_INTEGER_VALUE&PageSize=SOME_INTEGER_VALUE&SortBy=SOME_STRING_VALUE&SortDir=SOME_STRING_VALUE&CreatedAtFrom=SOME_NUMBER_VALUE&CreatedAtTo=SOME_NUMBER_VALUE&ModifiedAtFrom=SOME_NUMBER_VALUE&ModifiedAtTo=SOME_NUMBER_VALUE&ExternalRef=SOME_STRING_VALUE&Status=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

Responses

200Successoptional
- dataarrayoptional
  - idstringoptional
  - externalRefstringoptional
  - createdAtstring (date-time)optional
  - modifiedAtstring (date-time)optional
  - statusstringoptional
    Success, Failure, InProgress, Unknown
  - providerCodestringoptional
  - providerMessagestringoptional
  - descriptionstringoptional
  - amountnumber (double)optional
  - currencyCodestringoptional
    ALL, DZD, ARS, AUD, BSD, BHD, BDT, AMD, BBD, BMD, BTN, BOB, BWP, BZD, SBD, BND, MMK, BIF, KHR, CAD, CVE, KYD, LKR, CLP, CNY, COP, KMF, CRC, HRK, CUP, CZK, DKK, DOP, SVC, ETB, ERN, FKP, FJD, DJF, GMD, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, HUF, ISK, INR, IDR, IRR, IQD, ILS, JMD, JPY, KZT, JOD, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, LRD, LYD, MOP, MWK, MYR, MVR, MUR, MXN, MNT, MDL, MAD, OMR, NAD, NPR, ANG, AWG, VUV, NZD, NIO, NGN, NOK, PKR, PAB, PGK, PYG, PEN, PHP, QAR, RUB, RWF, SHP, SAR, SCR, SGD, VND, SOS, ZAR, SSP, SZL, SEK, CHF, SYP, THB, TOP, TTD, AED, TND, UGX, MKD, EGP, GBP, TZS, USD, UYU, UZS, WST, YER, TWD, SLE, VED, MRU, STN, CUC, ZWL, BYN, TMT, GHS, VEF, SDG, UYI, RSD, MZN, AZN, RON, CHE, CHW, TRY, XAF, XCD, XOF, XPF, XDR, XUA, ZMW, SRD, MGA, COU, AFN, TJS, AOA, BGN, CDF, BAM, EUR, MXV, UAH, GEL, BOV, PLN, BRL, CLF, XSU, USN
  - typestringoptional
    OfflineGambling, OnlineGambling, FundsDisbursement
  - paymentDetailsobjectoptional
    receiverobjectoptional
    tokenstringoptional
    binstringoptional
    last4stringoptional
    expiryMonthstringoptional
    expiryYearstringoptional
    cardBrandstringoptional
    Visa, Mastercard
    firstNamestringoptional
    middleNamestringoptional
    lastNamestringoptional
- pageinteger (int32)optional
- pageSizeinteger (int32)optional
- totalPagesinteger (int32)optional

200

{
    "data": [
        {
            "id": "string",
            "externalRef": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "modifiedAt": "2019-08-24T14:15:22Z",
            "status": "Success",
            "providerCode": "string",
            "providerMessage": "string",
            "description": "string",
            "amount": 0.1,
            "currencyCode": "ALL",
            "type": "OfflineGambling",
            "paymentDetails": {
                "receiver": {
                    "token": "string",
                    "bin": "string",
                    "last4": "string",
                    "expiryMonth": "string",
                    "expiryYear": "string",
                    "cardBrand": "Visa",
                    "firstName": "string",
                    "middleName": "string",
                    "lastName": "string"
                }
            }
        }
    ],
    "page": 0,
    "pageSize": 0,
    "totalPages": 0
}

Get single payout

GET /{payoutId}

Get single payout transaction with specific identifier

Parameters

Authorizationstringrequired
Authorization header using the Bearer scheme.
payoutIdstringrequired

Get single payout

C#
PHP
Node
Shell

var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payouts/{payoutId}");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
IRestResponse response = client.Execute(request);

Responses

200Successoptional
- idstringoptional
- externalRefstringoptional
- createdAtstring (date-time)optional
- modifiedAtstring (date-time)optional
- statusstringoptional
  Success, Failure, InProgress, Unknown
- providerCodestringoptional
- providerMessagestringoptional
- descriptionstringoptional
- amountnumber (double)optional
- currencyCodestringoptional
  ALL, DZD, ARS, AUD, BSD, BHD, BDT, AMD, BBD, BMD, BTN, BOB, BWP, BZD, SBD, BND, MMK, BIF, KHR, CAD, CVE, KYD, LKR, CLP, CNY, COP, KMF, CRC, HRK, CUP, CZK, DKK, DOP, SVC, ETB, ERN, FKP, FJD, DJF, GMD, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, HUF, ISK, INR, IDR, IRR, IQD, ILS, JMD, JPY, KZT, JOD, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, LRD, LYD, MOP, MWK, MYR, MVR, MUR, MXN, MNT, MDL, MAD, OMR, NAD, NPR, ANG, AWG, VUV, NZD, NIO, NGN, NOK, PKR, PAB, PGK, PYG, PEN, PHP, QAR, RUB, RWF, SHP, SAR, SCR, SGD, VND, SOS, ZAR, SSP, SZL, SEK, CHF, SYP, THB, TOP, TTD, AED, TND, UGX, MKD, EGP, GBP, TZS, USD, UYU, UZS, WST, YER, TWD, SLE, VED, MRU, STN, CUC, ZWL, BYN, TMT, GHS, VEF, SDG, UYI, RSD, MZN, AZN, RON, CHE, CHW, TRY, XAF, XCD, XOF, XPF, XDR, XUA, ZMW, SRD, MGA, COU, AFN, TJS, AOA, BGN, CDF, BAM, EUR, MXV, UAH, GEL, BOV, PLN, BRL, CLF, XSU, USN
- typestringoptional
  OfflineGambling, OnlineGambling, FundsDisbursement
- paymentDetailsobjectoptional
  - receiverobjectoptional
    tokenstringoptional
    binstringoptional
    last4stringoptional
    expiryMonthstringoptional
    expiryYearstringoptional
    cardBrandstringoptional
    Visa, Mastercard
    firstNamestringoptional
    middleNamestringoptional
    lastNamestringoptional
400Bad Requestoptional
- typestringoptional
- titlestringoptional
- statusinteger (int32)optional
- detailstringoptional
- instancestringoptional

{
    "id": "string",
    "externalRef": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "status": "Success",
    "providerCode": "string",
    "providerMessage": "string",
    "description": "string",
    "amount": 0.1,
    "currencyCode": "ALL",
    "type": "OfflineGambling",
    "paymentDetails": {
        "receiver": {
            "token": "string",
            "bin": "string",
            "last4": "string",
            "expiryMonth": "string",
            "expiryYear": "string",
            "cardBrand": "Visa",
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
        }
    }
}