POST api/Home/InitiateLookup?trn={trn}&payId={payId}

Request Information

URI Parameters

Name	Description	Type	Additional information
trn		string	Required
payId		string	Required

Body Parameters

None.

Response Information

Resource Description

InitiateLookup

Name	Type	Additional information
TransactionRefNo	string	None.
PaymentAmount	decimal number	None.
FinancialInstitutionName	string	None.
MerchantReference	string	None.
MerchantDefinedData	string	None.
EstablishedDateTime	date	None.
CompletionDateTime	date	None.
ExternalTransactionStatus	string	None.
StatementNarrative	string	None.
ReceiptNo	string	None.
UserIPAddress	string	None.
CurrencyCode	string	None.
MerchantName	string	None.
CanRefund	boolean	None.
CustomerID	string	None.
RefundItems	Collection of RefundItem	None.
PaymentSpeed	Collection of RefundsProvider	None.
PayIDReference	string	None.
IsPayIDTransaction	boolean	None.
PayIDReferenceType	string	None.
IsWaaveTransaction	boolean	None.
IsAkahuTransaction	boolean	None.
IsOpenBankingTransaction	boolean	None.
IsTMXTransaction	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "TransactionRefNo": "sample string 1",
  "PaymentAmount": 2.0,
  "FinancialInstitutionName": "sample string 3",
  "MerchantReference": "sample string 4",
  "MerchantDefinedData": "sample string 5",
  "EstablishedDateTime": "2026-04-07T20:10:05.4856403+10:00",
  "CompletionDateTime": "2026-04-07T20:10:05.4856403+10:00",
  "ExternalTransactionStatus": "sample string 8",
  "StatementNarrative": "sample string 9",
  "ReceiptNo": "sample string 10",
  "UserIPAddress": "sample string 11",
  "CurrencyCode": "sample string 12",
  "MerchantName": "sample string 13",
  "CanRefund": true,
  "CustomerID": "sample string 15",
  "RefundItems": [
    {
      "RefundRequestID": 1,
      "RefundsRequestID": "86fc9050-51f5-4b72-8716-5398e54c7e67",
      "TransactionRefNo": "sample string 3",
      "RefundStateID": 4,
      "POLiEntityID": "75e29653-efd3-4d79-a57b-5b9b55d18c32",
      "CreatedDateTime": "2026-04-07T20:10:05.4856403+10:00",
      "ModifiedDateTime": "2026-04-07T20:10:05.4856403+10:00",
      "RefundAmount": 8.0,
      "bsbNumber": "sample string 9",
      "accountNumber": "sample string 10",
      "UserID": "2708cc44-2a76-41a4-8c9a-3224e1e8b722",
      "RefundState": "sample string 12",
      "UserName": "sample string 13",
      "MerchantCode": "sample string 14",
      "MerchantCommonName": "sample string 15",
      "SecurePayResult": "sample string 16",
      "ReasonForRefund": "sample string 17",
      "RefundsID": "sample string 18"
    },
    {
      "RefundRequestID": 1,
      "RefundsRequestID": "86fc9050-51f5-4b72-8716-5398e54c7e67",
      "TransactionRefNo": "sample string 3",
      "RefundStateID": 4,
      "POLiEntityID": "75e29653-efd3-4d79-a57b-5b9b55d18c32",
      "CreatedDateTime": "2026-04-07T20:10:05.4856403+10:00",
      "ModifiedDateTime": "2026-04-07T20:10:05.4856403+10:00",
      "RefundAmount": 8.0,
      "bsbNumber": "sample string 9",
      "accountNumber": "sample string 10",
      "UserID": "2708cc44-2a76-41a4-8c9a-3224e1e8b722",
      "RefundState": "sample string 12",
      "UserName": "sample string 13",
      "MerchantCode": "sample string 14",
      "MerchantCommonName": "sample string 15",
      "SecurePayResult": "sample string 16",
      "ReasonForRefund": "sample string 17",
      "RefundsID": "sample string 18"
    }
  ],
  "PaymentSpeed": [
    {
      "ProviderName": "sample string 1",
      "ProviderID": 2,
      "SpeedID": 3,
      "SpeedName": "sample string 4",
      "IsDefault": true,
      "willspecify": true
    },
    {
      "ProviderName": "sample string 1",
      "ProviderID": 2,
      "SpeedID": 3,
      "SpeedName": "sample string 4",
      "IsDefault": true,
      "willspecify": true
    }
  ],
  "PayIDReference": "sample string 16",
  "IsPayIDTransaction": true,
  "PayIDReferenceType": "sample string 18",
  "IsWaaveTransaction": true,
  "IsAkahuTransaction": true,
  "IsOpenBankingTransaction": true,
  "IsTMXTransaction": true
}

application/xml, text/xml

Sample:

<InitiateLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models">
  <CanRefund>true</CanRefund>
  <CompletionDateTime>2026-04-07T20:10:05.4856403+10:00</CompletionDateTime>
  <CurrencyCode>sample string 12</CurrencyCode>
  <CustomerID>sample string 15</CustomerID>
  <EstablishedDateTime>2026-04-07T20:10:05.4856403+10:00</EstablishedDateTime>
  <ExternalTransactionStatus>sample string 8</ExternalTransactionStatus>
  <FinancialInstitutionName>sample string 3</FinancialInstitutionName>
  <IsAkahuTransaction>true</IsAkahuTransaction>
  <IsOpenBankingTransaction>true</IsOpenBankingTransaction>
  <IsPayIDTransaction>true</IsPayIDTransaction>
  <IsTMXTransaction>true</IsTMXTransaction>
  <IsWaaveTransaction>true</IsWaaveTransaction>
  <MerchantDefinedData>sample string 5</MerchantDefinedData>
  <MerchantName>sample string 13</MerchantName>
  <MerchantReference>sample string 4</MerchantReference>
  <PayIDReference>sample string 16</PayIDReference>
  <PayIDReferenceType>sample string 18</PayIDReferenceType>
  <PaymentAmount>2</PaymentAmount>
  <PaymentSpeed xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Refunds">
    <d2p1:RefundsProvider>
      <d2p1:IsDefault>true</d2p1:IsDefault>
      <d2p1:ProviderID>2</d2p1:ProviderID>
      <d2p1:ProviderName>sample string 1</d2p1:ProviderName>
      <d2p1:SpeedID>3</d2p1:SpeedID>
      <d2p1:SpeedName>sample string 4</d2p1:SpeedName>
      <d2p1:willspecify>true</d2p1:willspecify>
    </d2p1:RefundsProvider>
    <d2p1:RefundsProvider>
      <d2p1:IsDefault>true</d2p1:IsDefault>
      <d2p1:ProviderID>2</d2p1:ProviderID>
      <d2p1:ProviderName>sample string 1</d2p1:ProviderName>
      <d2p1:SpeedID>3</d2p1:SpeedID>
      <d2p1:SpeedName>sample string 4</d2p1:SpeedName>
      <d2p1:willspecify>true</d2p1:willspecify>
    </d2p1:RefundsProvider>
  </PaymentSpeed>
  <ReceiptNo>sample string 10</ReceiptNo>
  <RefundItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Transactions">
    <d2p1:RefundItem>
      <d2p1:CreatedDateTime>2026-04-07T20:10:05.4856403+10:00</d2p1:CreatedDateTime>
      <d2p1:MerchantCode>sample string 14</d2p1:MerchantCode>
      <d2p1:MerchantCommonName>sample string 15</d2p1:MerchantCommonName>
      <d2p1:ModifiedDateTime>2026-04-07T20:10:05.4856403+10:00</d2p1:ModifiedDateTime>
      <d2p1:POLiEntityID>75e29653-efd3-4d79-a57b-5b9b55d18c32</d2p1:POLiEntityID>
      <d2p1:ReasonForRefund>sample string 17</d2p1:ReasonForRefund>
      <d2p1:RefundAmount>8</d2p1:RefundAmount>
      <d2p1:RefundRequestID>1</d2p1:RefundRequestID>
      <d2p1:RefundState>sample string 12</d2p1:RefundState>
      <d2p1:RefundStateID>4</d2p1:RefundStateID>
      <d2p1:RefundsID>sample string 18</d2p1:RefundsID>
      <d2p1:RefundsRequestID>86fc9050-51f5-4b72-8716-5398e54c7e67</d2p1:RefundsRequestID>
      <d2p1:SecurePayResult>sample string 16</d2p1:SecurePayResult>
      <d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
      <d2p1:UserID>2708cc44-2a76-41a4-8c9a-3224e1e8b722</d2p1:UserID>
      <d2p1:UserName>sample string 13</d2p1:UserName>
      <d2p1:accountNumber>sample string 10</d2p1:accountNumber>
      <d2p1:bsbNumber>sample string 9</d2p1:bsbNumber>
    </d2p1:RefundItem>
    <d2p1:RefundItem>
      <d2p1:CreatedDateTime>2026-04-07T20:10:05.4856403+10:00</d2p1:CreatedDateTime>
      <d2p1:MerchantCode>sample string 14</d2p1:MerchantCode>
      <d2p1:MerchantCommonName>sample string 15</d2p1:MerchantCommonName>
      <d2p1:ModifiedDateTime>2026-04-07T20:10:05.4856403+10:00</d2p1:ModifiedDateTime>
      <d2p1:POLiEntityID>75e29653-efd3-4d79-a57b-5b9b55d18c32</d2p1:POLiEntityID>
      <d2p1:ReasonForRefund>sample string 17</d2p1:ReasonForRefund>
      <d2p1:RefundAmount>8</d2p1:RefundAmount>
      <d2p1:RefundRequestID>1</d2p1:RefundRequestID>
      <d2p1:RefundState>sample string 12</d2p1:RefundState>
      <d2p1:RefundStateID>4</d2p1:RefundStateID>
      <d2p1:RefundsID>sample string 18</d2p1:RefundsID>
      <d2p1:RefundsRequestID>86fc9050-51f5-4b72-8716-5398e54c7e67</d2p1:RefundsRequestID>
      <d2p1:SecurePayResult>sample string 16</d2p1:SecurePayResult>
      <d2p1:TransactionRefNo>sample string 3</d2p1:TransactionRefNo>
      <d2p1:UserID>2708cc44-2a76-41a4-8c9a-3224e1e8b722</d2p1:UserID>
      <d2p1:UserName>sample string 13</d2p1:UserName>
      <d2p1:accountNumber>sample string 10</d2p1:accountNumber>
      <d2p1:bsbNumber>sample string 9</d2p1:bsbNumber>
    </d2p1:RefundItem>
  </RefundItems>
  <StatementNarrative>sample string 9</StatementNarrative>
  <TransactionRefNo>sample string 1</TransactionRefNo>
  <UserIPAddress>sample string 11</UserIPAddress>
</InitiateLookup>