POST Api/Vending/PerformCreditVend

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
VendingPurchaseID	globally unique identifier	None.
PaymentReference	string	None.
CustomerReferenceNumber	string	None.
CardContributionAmount	decimal number	None.
InstantEFTContributionAmount	decimal number	None.
WalletContributionAmount	decimal number	None.
Amount	decimal number	None.
AmountWithConvenience	decimal number	None.
PaymentTypeID	PaymentTypes	None.
Charges	Collection of Charges	None.
Username	string	None.
Password	string	None.
DeviceManufacturer	string	None.
DeviceModel	string	None.
DeviceSDKInt	string	None.
DeviceSDKVersion	string	None.

Request Formats

application/json, text/json

Sample:

{
  "VendingPurchaseID": "dfa2b62d-87ad-4986-8507-592400302918",
  "PaymentReference": "sample string 1",
  "CustomerReferenceNumber": "sample string 2",
  "CardContributionAmount": 3.0,
  "InstantEFTContributionAmount": 4.0,
  "WalletContributionAmount": 5.0,
  "Amount": 6.0,
  "AmountWithConvenience": 7.0,
  "PaymentTypeID": 1,
  "Charges": [
    {
      "LinkedAccountNo": "sample string 1",
      "Description": "sample string 2",
      "Balance": 3.0,
      "MinimumDue": 4.0,
      "DueDate": "2026-05-17T03:30:27.9075316+02:00",
      "NextTxMinAmountDue": 6.0,
      "AmountToPay": 7.0,
      "LinkedAccountUniqueID": "b10fd219-7ef7-49d2-b3a0-e6cad36d3e51",
      "MaxMonthlyElectPurchaseAmount": 9.0,
      "RecordTypeName": "sample string 10",
      "PrimaryAccountNo": "sample string 11",
      "PaymentMethod": "sample string 12"
    },
    {
      "LinkedAccountNo": "sample string 1",
      "Description": "sample string 2",
      "Balance": 3.0,
      "MinimumDue": 4.0,
      "DueDate": "2026-05-17T03:30:27.9075316+02:00",
      "NextTxMinAmountDue": 6.0,
      "AmountToPay": 7.0,
      "LinkedAccountUniqueID": "b10fd219-7ef7-49d2-b3a0-e6cad36d3e51",
      "MaxMonthlyElectPurchaseAmount": 9.0,
      "RecordTypeName": "sample string 10",
      "PrimaryAccountNo": "sample string 11",
      "PaymentMethod": "sample string 12"
    }
  ],
  "Username": "sample string 8",
  "Password": "sample string 9",
  "DeviceManufacturer": "sample string 10",
  "DeviceModel": "sample string 11",
  "DeviceSDKInt": "sample string 12",
  "DeviceSDKVersion": "sample string 13"
}

application/xml, text/xml

Sample:

<PerformCreditVendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <DeviceManufacturer>sample string 10</DeviceManufacturer>
  <DeviceModel>sample string 11</DeviceModel>
  <DeviceSDKInt>sample string 12</DeviceSDKInt>
  <DeviceSDKVersion>sample string 13</DeviceSDKVersion>
  <Password>sample string 9</Password>
  <Username>sample string 8</Username>
  <Amount>6</Amount>
  <AmountWithConvenience>7</AmountWithConvenience>
  <CardContributionAmount>3</CardContributionAmount>
  <Charges>
    <Charges>
      <AmountToPay>7</AmountToPay>
      <Balance>3</Balance>
      <Description>sample string 2</Description>
      <DueDate>2026-05-17T03:30:27.9075316+02:00</DueDate>
      <LinkedAccountNo>sample string 1</LinkedAccountNo>
      <LinkedAccountUniqueID>b10fd219-7ef7-49d2-b3a0-e6cad36d3e51</LinkedAccountUniqueID>
      <MaxMonthlyElectPurchaseAmount>9</MaxMonthlyElectPurchaseAmount>
      <MinimumDue>4</MinimumDue>
      <NextTxMinAmountDue>6</NextTxMinAmountDue>
      <PaymentMethod>sample string 12</PaymentMethod>
      <PrimaryAccountNo>sample string 11</PrimaryAccountNo>
      <RecordTypeName>sample string 10</RecordTypeName>
    </Charges>
    <Charges>
      <AmountToPay>7</AmountToPay>
      <Balance>3</Balance>
      <Description>sample string 2</Description>
      <DueDate>2026-05-17T03:30:27.9075316+02:00</DueDate>
      <LinkedAccountNo>sample string 1</LinkedAccountNo>
      <LinkedAccountUniqueID>b10fd219-7ef7-49d2-b3a0-e6cad36d3e51</LinkedAccountUniqueID>
      <MaxMonthlyElectPurchaseAmount>9</MaxMonthlyElectPurchaseAmount>
      <MinimumDue>4</MinimumDue>
      <NextTxMinAmountDue>6</NextTxMinAmountDue>
      <PaymentMethod>sample string 12</PaymentMethod>
      <PrimaryAccountNo>sample string 11</PrimaryAccountNo>
      <RecordTypeName>sample string 10</RecordTypeName>
    </Charges>
  </Charges>
  <CustomerReferenceNumber>sample string 2</CustomerReferenceNumber>
  <InstantEFTContributionAmount>4</InstantEFTContributionAmount>
  <PaymentReference>sample string 1</PaymentReference>
  <PaymentTypeID>CreditCard</PaymentTypeID>
  <VendingPurchaseID>dfa2b62d-87ad-4986-8507-592400302918</VendingPurchaseID>
  <WalletContributionAmount>5</WalletContributionAmount>
</PerformCreditVendRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PerformCreditVendRequest'.

Response Information

Resource Description

PerformCreditVendResponse

Name	Type	Additional information
ReceiptData	ReceiptData	None.
ReceiptTokens	Collection of ReceiptTokens	None.
VendingResponseID	globally unique identifier	None.
CustomerReferenceNumber	string	None.
TransactionDateTime	string	None.
TotalAmount	string	None.
Success	boolean	None.
ErrorMessage	string	None.
ServerDateTime	string	None.
ErrorType	Errors	None.

Response Formats

application/json, text/json

Sample:

{
  "ReceiptData": {
    "Data": null
  },
  "ReceiptTokens": [
    {
      "TokenIndex": 1,
      "TokenDescription": "sample string 2",
      "Token": "sample string 3"
    },
    {
      "TokenIndex": 1,
      "TokenDescription": "sample string 2",
      "Token": "sample string 3"
    }
  ],
  "VendingResponseID": "ac1ce90e-8b21-4f68-9006-0e7d62c1056d",
  "CustomerReferenceNumber": "sample string 2",
  "TransactionDateTime": "sample string 3",
  "TotalAmount": "sample string 4",
  "Success": true,
  "ErrorMessage": "sample string 6",
  "ServerDateTime": "sample string 7",
  "ErrorType": 0
}

application/xml, text/xml

Sample:

<PerformCreditVendResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <ErrorMessage>sample string 6</ErrorMessage>
  <ErrorType>SystemError</ErrorType>
  <ServerDateTime>sample string 7</ServerDateTime>
  <Success>true</Success>
  <CustomerReferenceNumber>sample string 2</CustomerReferenceNumber>
  <ReceiptData xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Helpers">
    <d2p1:Data i:nil="true" />
  </ReceiptData>
  <ReceiptTokens>
    <ReceiptTokens>
      <Token>sample string 3</Token>
      <TokenDescription>sample string 2</TokenDescription>
      <TokenIndex>1</TokenIndex>
    </ReceiptTokens>
    <ReceiptTokens>
      <Token>sample string 3</Token>
      <TokenDescription>sample string 2</TokenDescription>
      <TokenIndex>1</TokenIndex>
    </ReceiptTokens>
  </ReceiptTokens>
  <TotalAmount>sample string 4</TotalAmount>
  <TransactionDateTime>sample string 3</TransactionDateTime>
  <VendingResponseID>ac1ce90e-8b21-4f68-9006-0e7d62c1056d</VendingResponseID>
</PerformCreditVendResponse>