GET api/PayId/GetPayIdTransaction?trn={trn}

Request Information

URI Parameters

Name	Description	Type	Additional information
trn		string	Required

Body Parameters

None.

Response Information

Resource Description

PayIdTransaction

Name	Type	Additional information
TransactionRefNo	string	None.
EstablishedUtc	date	None.
MerchantCode	string	None.
MerchantReference	string	None.
Currency	string	None.
Amount	decimal number	None.
Status	string	None.
StatusCode	integer	None.
Timeout	integer	None.
PayId	string	None.
IsRegistered	boolean	None.
IsDirectEntry	boolean	None.
Payments	Collection of PaymentObj	None.
Maps	Collection of MapObj	None.
Maprs	Collection of MaprObj	None.
Rtrfs	Collection of RtrfObj	None.
Raprs	Collection of RaprObj	None.
Audits	Collection of AuditObj	None.

Response Formats

application/json, text/json

Sample:

{
  "TransactionRefNo": "sample string 1",
  "EstablishedUtc": "2026-04-07T20:09:28.1313947+10:00",
  "MerchantCode": "sample string 3",
  "MerchantReference": "sample string 4",
  "Currency": "sample string 5",
  "Amount": 6.0,
  "Status": "sample string 7",
  "StatusCode": 8,
  "Timeout": 9,
  "PayId": "sample string 10",
  "IsRegistered": true,
  "IsDirectEntry": true,
  "Payments": [
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "MessageId": "sample string 3",
      "OriginalMessageId": "sample string 4",
      "CreatedUtc": "2026-04-07T20:09:28.1313947+10:00",
      "Party": "sample string 6",
      "InstructionId": "sample string 7",
      "CustomerReference": "sample string 8",
      "Amount": 9.0
    },
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "MessageId": "sample string 3",
      "OriginalMessageId": "sample string 4",
      "CreatedUtc": "2026-04-07T20:09:28.1313947+10:00",
      "Party": "sample string 6",
      "InstructionId": "sample string 7",
      "CustomerReference": "sample string 8",
      "Amount": 9.0
    }
  ],
  "Maps": [
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "SourceSequenceNo": 3,
      "MessageId": "sample string 4",
      "InstructionId": "sample string 5",
      "CreatedUtc": "2026-04-07T20:09:28.1313947+10:00",
      "Amount": 1.0,
      "Status": "sample string 6",
      "StatusReasonCode": "sample string 7"
    },
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "SourceSequenceNo": 3,
      "MessageId": "sample string 4",
      "InstructionId": "sample string 5",
      "CreatedUtc": "2026-04-07T20:09:28.1313947+10:00",
      "Amount": 1.0,
      "Status": "sample string 6",
      "StatusReasonCode": "sample string 7"
    }
  ],
  "Maprs": [
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "SourceSequenceNo": 3,
      "IsRtrf": true,
      "MessageId": "sample string 5",
      "CreatedUtc": "2026-04-07T20:09:28.1313947+10:00",
      "InstructionId": "sample string 6",
      "ReasonCode": "sample string 7",
      "ReturnReasonAddInfo": [
        "sample string 1",
        "sample string 2"
      ],
      "Amount": 1.0,
      "Status": "sample string 8",
      "StatusReasonCode": "sample string 9"
    },
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "SourceSequenceNo": 3,
      "IsRtrf": true,
      "MessageId": "sample string 5",
      "CreatedUtc": "2026-04-07T20:09:28.1313947+10:00",
      "InstructionId": "sample string 6",
      "ReasonCode": "sample string 7",
      "ReturnReasonAddInfo": [
        "sample string 1",
        "sample string 2"
      ],
      "Amount": 1.0,
      "Status": "sample string 8",
      "StatusReasonCode": "sample string 9"
    }
  ],
  "Rtrfs": [
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "MessageId": "sample string 3",
      "CreatedUtc": "2026-04-07T20:09:28.1313947+10:00",
      "OriginalMessageId": "sample string 4",
      "Party": "sample string 5",
      "OriginalTransactionId": "sample string 6",
      "CustomerReference": "sample string 7",
      "CaseId": "sample string 8",
      "ReturnReasonCode": "sample string 9",
      "ReturnReasonAddInfo": [
        "sample string 1",
        "sample string 2"
      ],
      "Amount": 1.0
    },
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "MessageId": "sample string 3",
      "CreatedUtc": "2026-04-07T20:09:28.1313947+10:00",
      "OriginalMessageId": "sample string 4",
      "Party": "sample string 5",
      "OriginalTransactionId": "sample string 6",
      "CustomerReference": "sample string 7",
      "CaseId": "sample string 8",
      "ReturnReasonCode": "sample string 9",
      "ReturnReasonAddInfo": [
        "sample string 1",
        "sample string 2"
      ],
      "Amount": 1.0
    }
  ],
  "Raprs": [
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "SourceSequenceNo": 3,
      "MessageId": "sample string 4",
      "OriginalMessageId": "sample string 5",
      "InstructionId": "sample string 6",
      "CreatedUtc": "2026-04-07T20:09:28.1399536+10:00",
      "Party": "sample string 7",
      "OriginalTransactionId": "sample string 8",
      "CustomerReference": "sample string 9",
      "ReasonCode": "sample string 10",
      "AdditionalInfo": [
        "sample string 1",
        "sample string 2"
      ],
      "Amount": 1.0
    },
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "SourceSequenceNo": 3,
      "MessageId": "sample string 4",
      "OriginalMessageId": "sample string 5",
      "InstructionId": "sample string 6",
      "CreatedUtc": "2026-04-07T20:09:28.1399536+10:00",
      "Party": "sample string 7",
      "OriginalTransactionId": "sample string 8",
      "CustomerReference": "sample string 9",
      "ReasonCode": "sample string 10",
      "AdditionalInfo": [
        "sample string 1",
        "sample string 2"
      ],
      "Amount": 1.0
    }
  ],
  "Audits": [
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "Event": "sample string 3",
      "Utc": "2026-04-07T20:09:28.1399536+10:00",
      "Data": "sample string 5"
    },
    {
      "TransactionRefNo": "sample string 1",
      "SequenceNo": 2,
      "Event": "sample string 3",
      "Utc": "2026-04-07T20:09:28.1399536+10:00",
      "Data": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<PayIdTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.External.Models.PayId">
  <Amount>6</Amount>
  <Audits>
    <PayIdTransaction.AuditObj>
      <Data>sample string 5</Data>
      <Event>sample string 3</Event>
      <SequenceNo>2</SequenceNo>
      <TransactionRefNo>sample string 1</TransactionRefNo>
      <Utc>2026-04-07T20:09:28.1399536+10:00</Utc>
    </PayIdTransaction.AuditObj>
    <PayIdTransaction.AuditObj>
      <Data>sample string 5</Data>
      <Event>sample string 3</Event>
      <SequenceNo>2</SequenceNo>
      <TransactionRefNo>sample string 1</TransactionRefNo>
      <Utc>2026-04-07T20:09:28.1399536+10:00</Utc>
    </PayIdTransaction.AuditObj>
  </Audits>
  <Currency>sample string 5</Currency>
  <EstablishedUtc>2026-04-07T20:09:28.1313947+10:00</EstablishedUtc>
  <IsDirectEntry>true</IsDirectEntry>
  <IsRegistered>true</IsRegistered>
  <Maprs>
    <PayIdTransaction.MaprObj>
      <Amount>1</Amount>
      <CreatedUtc>2026-04-07T20:09:28.1313947+10:00</CreatedUtc>
      <InstructionId>sample string 6</InstructionId>
      <IsRtrf>true</IsRtrf>
      <MessageId>sample string 5</MessageId>
      <ReasonCode>sample string 7</ReasonCode>
      <ReturnReasonAddInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ReturnReasonAddInfo>
      <SequenceNo>2</SequenceNo>
      <SourceSequenceNo>3</SourceSequenceNo>
      <Status>sample string 8</Status>
      <StatusReasonCode>sample string 9</StatusReasonCode>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.MaprObj>
    <PayIdTransaction.MaprObj>
      <Amount>1</Amount>
      <CreatedUtc>2026-04-07T20:09:28.1313947+10:00</CreatedUtc>
      <InstructionId>sample string 6</InstructionId>
      <IsRtrf>true</IsRtrf>
      <MessageId>sample string 5</MessageId>
      <ReasonCode>sample string 7</ReasonCode>
      <ReturnReasonAddInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ReturnReasonAddInfo>
      <SequenceNo>2</SequenceNo>
      <SourceSequenceNo>3</SourceSequenceNo>
      <Status>sample string 8</Status>
      <StatusReasonCode>sample string 9</StatusReasonCode>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.MaprObj>
  </Maprs>
  <Maps>
    <PayIdTransaction.MapObj>
      <Amount>1</Amount>
      <CreatedUtc>2026-04-07T20:09:28.1313947+10:00</CreatedUtc>
      <InstructionId>sample string 5</InstructionId>
      <MessageId>sample string 4</MessageId>
      <SequenceNo>2</SequenceNo>
      <SourceSequenceNo>3</SourceSequenceNo>
      <Status>sample string 6</Status>
      <StatusReasonCode>sample string 7</StatusReasonCode>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.MapObj>
    <PayIdTransaction.MapObj>
      <Amount>1</Amount>
      <CreatedUtc>2026-04-07T20:09:28.1313947+10:00</CreatedUtc>
      <InstructionId>sample string 5</InstructionId>
      <MessageId>sample string 4</MessageId>
      <SequenceNo>2</SequenceNo>
      <SourceSequenceNo>3</SourceSequenceNo>
      <Status>sample string 6</Status>
      <StatusReasonCode>sample string 7</StatusReasonCode>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.MapObj>
  </Maps>
  <MerchantCode>sample string 3</MerchantCode>
  <MerchantReference>sample string 4</MerchantReference>
  <PayId>sample string 10</PayId>
  <Payments>
    <PayIdTransaction.PaymentObj>
      <Amount>9</Amount>
      <CreatedUtc>2026-04-07T20:09:28.1313947+10:00</CreatedUtc>
      <CustomerReference>sample string 8</CustomerReference>
      <InstructionId>sample string 7</InstructionId>
      <MessageId>sample string 3</MessageId>
      <OriginalMessageId>sample string 4</OriginalMessageId>
      <Party>sample string 6</Party>
      <SequenceNo>2</SequenceNo>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.PaymentObj>
    <PayIdTransaction.PaymentObj>
      <Amount>9</Amount>
      <CreatedUtc>2026-04-07T20:09:28.1313947+10:00</CreatedUtc>
      <CustomerReference>sample string 8</CustomerReference>
      <InstructionId>sample string 7</InstructionId>
      <MessageId>sample string 3</MessageId>
      <OriginalMessageId>sample string 4</OriginalMessageId>
      <Party>sample string 6</Party>
      <SequenceNo>2</SequenceNo>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.PaymentObj>
  </Payments>
  <Raprs>
    <PayIdTransaction.RaprObj>
      <AdditionalInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AdditionalInfo>
      <Amount>1</Amount>
      <CreatedUtc>2026-04-07T20:09:28.1399536+10:00</CreatedUtc>
      <CustomerReference>sample string 9</CustomerReference>
      <InstructionId>sample string 6</InstructionId>
      <MessageId>sample string 4</MessageId>
      <OriginalMessageId>sample string 5</OriginalMessageId>
      <OriginalTransactionId>sample string 8</OriginalTransactionId>
      <Party>sample string 7</Party>
      <ReasonCode>sample string 10</ReasonCode>
      <SequenceNo>2</SequenceNo>
      <SourceSequenceNo>3</SourceSequenceNo>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.RaprObj>
    <PayIdTransaction.RaprObj>
      <AdditionalInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AdditionalInfo>
      <Amount>1</Amount>
      <CreatedUtc>2026-04-07T20:09:28.1399536+10:00</CreatedUtc>
      <CustomerReference>sample string 9</CustomerReference>
      <InstructionId>sample string 6</InstructionId>
      <MessageId>sample string 4</MessageId>
      <OriginalMessageId>sample string 5</OriginalMessageId>
      <OriginalTransactionId>sample string 8</OriginalTransactionId>
      <Party>sample string 7</Party>
      <ReasonCode>sample string 10</ReasonCode>
      <SequenceNo>2</SequenceNo>
      <SourceSequenceNo>3</SourceSequenceNo>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.RaprObj>
  </Raprs>
  <Rtrfs>
    <PayIdTransaction.RtrfObj>
      <Amount>1</Amount>
      <CaseId>sample string 8</CaseId>
      <CreatedUtc>2026-04-07T20:09:28.1313947+10:00</CreatedUtc>
      <CustomerReference>sample string 7</CustomerReference>
      <MessageId>sample string 3</MessageId>
      <OriginalMessageId>sample string 4</OriginalMessageId>
      <OriginalTransactionId>sample string 6</OriginalTransactionId>
      <Party>sample string 5</Party>
      <ReturnReasonAddInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ReturnReasonAddInfo>
      <ReturnReasonCode>sample string 9</ReturnReasonCode>
      <SequenceNo>2</SequenceNo>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.RtrfObj>
    <PayIdTransaction.RtrfObj>
      <Amount>1</Amount>
      <CaseId>sample string 8</CaseId>
      <CreatedUtc>2026-04-07T20:09:28.1313947+10:00</CreatedUtc>
      <CustomerReference>sample string 7</CustomerReference>
      <MessageId>sample string 3</MessageId>
      <OriginalMessageId>sample string 4</OriginalMessageId>
      <OriginalTransactionId>sample string 6</OriginalTransactionId>
      <Party>sample string 5</Party>
      <ReturnReasonAddInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ReturnReasonAddInfo>
      <ReturnReasonCode>sample string 9</ReturnReasonCode>
      <SequenceNo>2</SequenceNo>
      <TransactionRefNo>sample string 1</TransactionRefNo>
    </PayIdTransaction.RtrfObj>
  </Rtrfs>
  <Status>sample string 7</Status>
  <StatusCode>8</StatusCode>
  <Timeout>9</Timeout>
  <TransactionRefNo>sample string 1</TransactionRefNo>
</PayIdTransaction>