GET api/PaymentHub/GetPaymentRequest?requestUid={requestUid}

Used to get payment request

Request Information

URI Parameters

Name	Description	Type	Additional information
requestUid		string	Required

Body Parameters

None.

Response Information

Resource Description

PaymentRequest

Name	Description	Type	Additional information
RequestUid	Gets or sets the request uid	string	None.
SponsorId	Gets or sets the sponsor id	integer	None.
SponsorName	Gets or sets sponsor displayname	string	None.
Email	Gets or sets sponsor email	string	None.
CompOrUniversity	Gets or sets sponsor company or university	string	None.
StudentId	Gets or sets student id	integer	None.
RequestAmount	Gets or sets amount to be requested	decimal number	None.
DisplayRequestAmount	Gets or sets the Display Request Amount	string	None.
RequestShortCode	Gets or sets request short code	string	None.
CoverNote	Gets or sets the covernote	string	None.
LstOrderItem	Gets or sets the list of order item	Collection of PaymentRequestInvoiceItem	None.
SendReminder	Gets or sets the SendReminder	boolean	None.
ContactUs		string	None.

Response Formats

application/json, text/json

Sample:

{
  "RequestUid": "sample string 1",
  "SponsorId": 2,
  "SponsorName": "sample string 3",
  "Email": "sample string 4",
  "CompOrUniversity": "sample string 5",
  "StudentId": 6,
  "RequestAmount": 7.1,
  "DisplayRequestAmount": "sample string 8",
  "RequestShortCode": "sample string 9",
  "CoverNote": "sample string 10",
  "LstOrderItem": [
    {
      "StudentProductId": 1,
      "itemType": "sample string 2",
      "SponsorPaymentRequestItemId": 3,
      "ItemName": "sample string 4",
      "Quantity": 5,
      "UnitPrice": 6.1,
      "DisplayUnitPrice": "sample string 7",
      "ItemType": "sample string 8",
      "SponsorPaymentRequestId": 9,
      "FinalAmount": 10.1,
      "DisplayFinalAmount": "sample string 11",
      "ItemTaxAmount": 12.1
    },
    {
      "StudentProductId": 1,
      "itemType": "sample string 2",
      "SponsorPaymentRequestItemId": 3,
      "ItemName": "sample string 4",
      "Quantity": 5,
      "UnitPrice": 6.1,
      "DisplayUnitPrice": "sample string 7",
      "ItemType": "sample string 8",
      "SponsorPaymentRequestId": 9,
      "FinalAmount": 10.1,
      "DisplayFinalAmount": "sample string 11",
      "ItemTaxAmount": 12.1
    }
  ],
  "SendReminder": true,
  "ContactUs": "sample string 12"
}