Exigo Web Services API v2022.12.19.1

 Search

GetBillPayoutQueue

Gets customer bill payout queue status and details

Input Properties

GetBillPayoutQueueRequest
PropertyData TypeNotes
PayoutQueueRequestIDGuidOptional. Unique numeric identifier for payout queue item.
CurrencyCode StringOptional.
CountryCode StringOptional.
PayableType Int32Optional.
PaymentCardType Int32Optional. Use only if PaymentType = Payment Card.
StartDateDateTimeOptional.
EndDateDateTimeOptional.

Output Properties

GetBillPayoutQueueResponse
PropertyData TypeNotes
BillPayoutQueueItemsBillPayoutQueueItem[]
BillPayoutQueueItem
PropertyData TypeNotes
PayoutQueueRequestIDGuid
CountInt32
AmountDecimal
MinimumAmountDecimal
MaximumAmountDecimal
CountryCode String
FeeDecimal
FeeDescriptionString
PayableType Int32
PaymentCardType Int32The type of paycard.
StartCheckNumberInt32
EndCheckNumberInt32
StartDateDateTime
EndDateDateTime
StartPaymentIDInt32
EndPaymentIDInt32
PaymentDateDateTime
CurrencyCode String
BankAccountID Int32Bank account identifier.
ReferenceString
RequestByUserIDInt32
RequestDateDateTime
RequestCompleteDateDateTime
BatchDescriptionString
UseBatchPayoutBoolean
StatusType PayoutQueueStatusTypeOptional status of the bill (default is unpaid).

Http Request

GET https://yourcompany-api.exigo.com/3.0/payout/payoutqueue?payoutQueueRequestID=1
  &currencyCode=usd
  &payableType=1
  &paymentCardType=1
  &startDate=1
  &endDate=1
Authorization: Basic base64Encoded

Http Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length


{
  "billPayoutQueueItems": null,
  "result": null
}

Soap Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: totallife-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetBillPayoutQueue"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ApiAuthentication xmlns="http://api.exigo.com/">
      <LoginName>string</LoginName>
      <Password>string</Password>
      <Company>string</Company>
      <Identity>string</Identity>
      <RequestTimeUtc>dateTime</RequestTimeUtc>
      <Signature>string</Signature>
    </ApiAuthentication>
  </soap:Header>
  <soap:Body>
    <GetBillPayoutQueueRequest xmlns="http://api.exigo.com/">
      <PayoutQueueRequestID>guid</PayoutQueueRequestID>
      <CurrencyCode>string</CurrencyCode>
      <CountryCode>string</CountryCode>
      <PayableType>int</PayableType>
      <PaymentCardType>int</PaymentCardType>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
    </GetBillPayoutQueueRequest>
  </soap:Body>
</soap:Envelope>

Soap Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetBillPayoutQueueResult xmlns="http://api.exigo.com/">
      <BillPayoutQueueItems>
        <BillPayoutQueueItem>
          <PayoutQueueRequestID>guid</PayoutQueueRequestID>
          <Count>int</Count>
          <Amount>decimal</Amount>
          <MinimumAmount>decimal</MinimumAmount>
          <MaximumAmount>decimal</MaximumAmount>
          <CountryCode>string</CountryCode>
          <Fee>decimal</Fee>
          <FeeDescription>string</FeeDescription>
          <PayableType>int</PayableType>
          <PaymentCardType>int</PaymentCardType>
          <StartCheckNumber>int</StartCheckNumber>
          <EndCheckNumber>int</EndCheckNumber>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <StartPaymentID>int</StartPaymentID>
          <EndPaymentID>int</EndPaymentID>
          <PaymentDate>dateTime</PaymentDate>
          <CurrencyCode>string</CurrencyCode>
          <BankAccountID>int</BankAccountID>
          <Reference>string</Reference>
          <RequestByUserID>int</RequestByUserID>
          <RequestDate>dateTime</RequestDate>
          <RequestCompleteDate>dateTime</RequestCompleteDate>
          <BatchDescription>string</BatchDescription>
          <UseBatchPayout>boolean</UseBatchPayout>
          <StatusType>Processing or Complete or CompleteWithErrors</StatusType>
        </BillPayoutQueueItem>
      </BillPayoutQueueItems>
    </GetBillPayoutQueueResult>
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new GetBillPayoutQueueRequest();

 

    req.PayoutQueueRequestID = 1;   //Unique numeric identifier for payout queue item.

    req.CurrencyCode = "usd";

    req.PayableType = 1;

    req.PaymentCardType = 1;        //Use only if PaymentType = Payment Card

    req.StartDate = DateTime.Today;

    req.EndDate = DateTime.Today;

 

    //Send Request to Server and Get Response

    var res = await api.GetBillPayoutQueueAsync(req);

 

    //Now examine the results:

 

    foreach (var billPayoutQueueItem in res.BillPayoutQueueItems)

    {

        Console.WriteLine("PayoutQueueRequestID: {0}", billPayoutQueueItem.PayoutQueueRequestID);

        Console.WriteLine("Count: {0}", billPayoutQueueItem.Count);

        Console.WriteLine("Amount: {0}", billPayoutQueueItem.Amount);

        Console.WriteLine("MinimumAmount: {0}", billPayoutQueueItem.MinimumAmount);

        Console.WriteLine("MaximumAmount: {0}", billPayoutQueueItem.MaximumAmount);

        Console.WriteLine("Fee: {0}", billPayoutQueueItem.Fee);

        Console.WriteLine("FeeDescription: {0}", billPayoutQueueItem.FeeDescription);

        Console.WriteLine("PayableType: {0}", billPayoutQueueItem.PayableType);

        Console.WriteLine("PaymentCardType: {0}", billPayoutQueueItem.PaymentCardType);

        Console.WriteLine("StartCheckNumber: {0}", billPayoutQueueItem.StartCheckNumber);

        Console.WriteLine("EndCheckNumber: {0}", billPayoutQueueItem.EndCheckNumber);

        Console.WriteLine("StartDate: {0}", billPayoutQueueItem.StartDate);

        Console.WriteLine("EndDate: {0}", billPayoutQueueItem.EndDate);

        Console.WriteLine("StartPaymentID: {0}", billPayoutQueueItem.StartPaymentID);

        Console.WriteLine("EndPaymentID: {0}", billPayoutQueueItem.EndPaymentID);

        Console.WriteLine("PaymentDate: {0}", billPayoutQueueItem.PaymentDate);

        Console.WriteLine("CurrencyCode: {0}", billPayoutQueueItem.CurrencyCode);

        Console.WriteLine("Reference: {0}", billPayoutQueueItem.Reference);

        Console.WriteLine("RequestByUserID: {0}", billPayoutQueueItem.RequestByUserID);

        Console.WriteLine("RequestDate: {0}", billPayoutQueueItem.RequestDate);

        Console.WriteLine("RequestCompleteDate: {0}", billPayoutQueueItem.RequestCompleteDate);

        Console.WriteLine("BatchDescription: {0}", billPayoutQueueItem.BatchDescription);

        Console.WriteLine("UseBatchPayout: {0}", billPayoutQueueItem.UseBatchPayout);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

C# Soap Client

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    GetBillPayoutQueueRequest req = new GetBillPayoutQueueRequest();

 

    req.PayoutQueueRequestID = 1;   //Unique numeric identifier for payout queue item.

    req.CurrencyCode = "usd";

    req.PayableType = 1;

    req.PaymentCardType = 1;        //Use only if PaymentType = Payment Card

    req.StartDate = DateTime.Today;

    req.EndDate = DateTime.Today;

 

    //Send Request to Server and Get Response

    GetBillPayoutQueueResponse res = api.GetBillPayoutQueue(req);

 

    //Now examine the results:

 

    foreach (BillPayoutQueueItem billPayoutQueueItem in res.BillPayoutQueueItems)

    {

        Console.WriteLine("PayoutQueueRequestID: {0}", billPayoutQueueItem.PayoutQueueRequestID);

        Console.WriteLine("Count: {0}", billPayoutQueueItem.Count);

        Console.WriteLine("Amount: {0}", billPayoutQueueItem.Amount);

        Console.WriteLine("MinimumAmount: {0}", billPayoutQueueItem.MinimumAmount);

        Console.WriteLine("MaximumAmount: {0}", billPayoutQueueItem.MaximumAmount);

        Console.WriteLine("Fee: {0}", billPayoutQueueItem.Fee);

        Console.WriteLine("FeeDescription: {0}", billPayoutQueueItem.FeeDescription);

        Console.WriteLine("PayableType: {0}", billPayoutQueueItem.PayableType);

        Console.WriteLine("PaymentCardType: {0}", billPayoutQueueItem.PaymentCardType);

        Console.WriteLine("StartCheckNumber: {0}", billPayoutQueueItem.StartCheckNumber);

        Console.WriteLine("EndCheckNumber: {0}", billPayoutQueueItem.EndCheckNumber);

        Console.WriteLine("StartDate: {0}", billPayoutQueueItem.StartDate);

        Console.WriteLine("EndDate: {0}", billPayoutQueueItem.EndDate);

        Console.WriteLine("StartPaymentID: {0}", billPayoutQueueItem.StartPaymentID);

        Console.WriteLine("EndPaymentID: {0}", billPayoutQueueItem.EndPaymentID);

        Console.WriteLine("PaymentDate: {0}", billPayoutQueueItem.PaymentDate);

        Console.WriteLine("CurrencyCode: {0}", billPayoutQueueItem.CurrencyCode);

        Console.WriteLine("Reference: {0}", billPayoutQueueItem.Reference);

        Console.WriteLine("RequestByUserID: {0}", billPayoutQueueItem.RequestByUserID);

        Console.WriteLine("RequestDate: {0}", billPayoutQueueItem.RequestDate);

        Console.WriteLine("RequestCompleteDate: {0}", billPayoutQueueItem.RequestCompleteDate);

        Console.WriteLine("BatchDescription: {0}", billPayoutQueueItem.BatchDescription);

        Console.WriteLine("UseBatchPayout: {0}", billPayoutQueueItem.UseBatchPayout);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new GetBillPayoutQueueRequest()

 

    req.PayoutQueueRequestID = 1

    req.CurrencyCode = "usd"

    req.PayableType = 1

    req.PaymentCardType = 1

    req.StartDate = DateTime.Today

    req.EndDate = DateTime.Today

 

    'Send Request to Server and Get Response

    Dim res As GetBillPayoutQueueResponse = api.GetBillPayoutQueue(req)

 

    'Now examine the results:

 

    For Each billPayoutQueueItem As BillPayoutQueueItem In res.BillPayoutQueueItems

        Console.WriteLine("PayoutQueueRequestID: {0}", billPayoutQueueItem.PayoutQueueRequestID)

        Console.WriteLine("Count: {0}", billPayoutQueueItem.Count)

        Console.WriteLine("Amount: {0}", billPayoutQueueItem.Amount)

        Console.WriteLine("MinimumAmount: {0}", billPayoutQueueItem.MinimumAmount)

        Console.WriteLine("MaximumAmount: {0}", billPayoutQueueItem.MaximumAmount)

        Console.WriteLine("Fee: {0}", billPayoutQueueItem.Fee)

        Console.WriteLine("FeeDescription: {0}", billPayoutQueueItem.FeeDescription)

        Console.WriteLine("PayableType: {0}", billPayoutQueueItem.PayableType)

        Console.WriteLine("PaymentCardType: {0}", billPayoutQueueItem.PaymentCardType)

        Console.WriteLine("StartCheckNumber: {0}", billPayoutQueueItem.StartCheckNumber)

        Console.WriteLine("EndCheckNumber: {0}", billPayoutQueueItem.EndCheckNumber)

        Console.WriteLine("StartDate: {0}", billPayoutQueueItem.StartDate)

        Console.WriteLine("EndDate: {0}", billPayoutQueueItem.EndDate)

        Console.WriteLine("StartPaymentID: {0}", billPayoutQueueItem.StartPaymentID)

        Console.WriteLine("EndPaymentID: {0}", billPayoutQueueItem.EndPaymentID)

        Console.WriteLine("PaymentDate: {0}", billPayoutQueueItem.PaymentDate)

        Console.WriteLine("CurrencyCode: {0}", billPayoutQueueItem.CurrencyCode)

        Console.WriteLine("Reference: {0}", billPayoutQueueItem.Reference)

        Console.WriteLine("RequestByUserID: {0}", billPayoutQueueItem.RequestByUserID)

        Console.WriteLine("RequestDate: {0}", billPayoutQueueItem.RequestDate)

        Console.WriteLine("RequestCompleteDate: {0}", billPayoutQueueItem.RequestCompleteDate)

        Console.WriteLine("BatchDescription: {0}", billPayoutQueueItem.BatchDescription)

        Console.WriteLine("UseBatchPayout: {0}", billPayoutQueueItem.UseBatchPayout)

    Next

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->PayoutQueueRequestID = 1;

    $req->CurrencyCode = "usd";

    $req->PayableType = 1;

    $req->PaymentCardType = 1;

    $req->StartDate = 1;

    $req->EndDate = 1;

 

    //Send Request to Server and Get Response

    $res = $api.GetBillPayoutQueue($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    GetBillPayoutQueueRequest req = new GetBillPayoutQueueRequest();

 

    req.setPayoutQueueRequestID(1);

    req.setCurrencyCode("usd");

    req.setPayableType(1);

    req.setPaymentCardType(1);

    req.setStartDate(1);

    req.setEndDate(1);

 

    //Send Request to Server and Get Response

    GetBillPayoutQueueResponse res = api.getExigoApiSoap().getBillPayoutQueue(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.