POST v1/Midnight/GetPaymentSurchargeInfo

Returns surcharge info for a payment based on global settings and customer surcharge settings.

Request Information

URI Parameters

None.

Body Parameters

PaymentMethodUpdateRequest

PaymentSurchargeInfoRequest
NameDescriptionTypeAdditional information
ProvidePaymentActualDetails

Provide the Payment's Actual Amount Detail

 boolean

None.
CustomerPaymentId

Provide the CustomerPaymentId

 integer

None.
CustomerPaymentNumber

Provide the CustomerPaymentNumber ( IF CustomerPaymentId does not exists )

 string

None.
Invoices

Provide Invoices list ( IF CustomerPaymentId or CustomerPaymentNumber does not exists )

 Collection of SurchangeInvoiceDetail

None.
TotalAmount

Provide the TotalAmount

 decimal number

None.
PageName

Provides page name from PRC

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProvidePaymentActualDetails": true,
  "CustomerPaymentId": 1,
  "CustomerPaymentNumber": "sample string 2",
  "Invoices": [
    {
      "Number": "sample string 1",
      "Amount": 2.0
    },
    {
      "Number": "sample string 1",
      "Amount": 2.0
    }
  ],
  "TotalAmount": 3.0,
  "PageName": "sample string 4"
}

application/xml, text/xml

Sample: 
<PaymentSurchargeInfoRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ProvidePaymentActualDetails>true</ProvidePaymentActualDetails>
  <CustomerPaymentId>1</CustomerPaymentId>
  <CustomerPaymentNumber>sample string 2</CustomerPaymentNumber>
  <Invoices>
    <SurchangeInvoiceDetail>
      <Number>sample string 1</Number>
      <Amount>2</Amount>
    </SurchangeInvoiceDetail>
    <SurchangeInvoiceDetail>
      <Number>sample string 1</Number>
      <Amount>2</Amount>
    </SurchangeInvoiceDetail>
  </Invoices>
  <TotalAmount>3</TotalAmount>
  <PageName>sample string 4</PageName>
</PaymentSurchargeInfoRequest>

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 'PaymentSurchargeInfoRequest'.

Response Information

Resource Description

PaymentSurchargeInfoResponse
NameDescriptionTypeAdditional information
CustomerId

Customer Id mapped with Payment Record

 integer

None.
CustomerPaymentId

Customer Payment Id mapped with Payment Record

 integer

None.
InvoiceNumber

Invoice Number mapped with Payment

 string

None.
SurchargeName

Surchange Name

 string

None.
PaymentDetails

Payment Details of given parameters like CustomerPaymentId or InvoiceNumber

 ActualPaymentDetails

None.
PaymentActualDetails

Actual Payment Details required to mark payment record as Paid

 ActualPaymentDetails

None.

Response Formats

application/json, text/json

Sample: 
{
  "CustomerId": 1,
  "CustomerPaymentId": 1,
  "InvoiceNumber": "sample string 2",
  "SurchargeName": "sample string 3",
  "PaymentDetails": {
    "AmountWithoutSurcharge": 1.0,
    "CardSurchargeDetail": {
      "TotalSurchargeAmount": 1.0
    },
    "ACHSurchargeDetail": {
      "TotalSurchargeAmount": 1.0
    }
  },
  "PaymentActualDetails": {
    "AmountWithoutSurcharge": 1.0,
    "CardSurchargeDetail": {
      "TotalSurchargeAmount": 1.0
    },
    "ACHSurchargeDetail": {
      "TotalSurchargeAmount": 1.0
    }
  }
}

application/xml, text/xml

Sample: 
<PaymentSurchargeInfoResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerId>1</CustomerId>
  <CustomerPaymentId>1</CustomerPaymentId>
  <InvoiceNumber>sample string 2</InvoiceNumber>
  <SurchargeName>sample string 3</SurchargeName>
  <PaymentDetails>
    <AmountWithoutSurcharge>1</AmountWithoutSurcharge>
    <CardSurchargeDetail>
      <TotalSurchargeAmount>1</TotalSurchargeAmount>
      <ServiceSurchargeAmount>2</ServiceSurchargeAmount>
      <PostageSurchargeAmount>3</PostageSurchargeAmount>
      <EarmarkedSurchargeAmount>4</EarmarkedSurchargeAmount>
      <EscrowSurchargeAmount>5</EscrowSurchargeAmount>
    </CardSurchargeDetail>
    <ACHSurchargeDetail>
      <TotalSurchargeAmount>1</TotalSurchargeAmount>
      <ServiceSurchargeAmount>2</ServiceSurchargeAmount>
      <PostageSurchargeAmount>3</PostageSurchargeAmount>
      <EarmarkedSurchargeAmount>4</EarmarkedSurchargeAmount>
      <EscrowSurchargeAmount>5</EscrowSurchargeAmount>
    </ACHSurchargeDetail>
  </PaymentDetails>
  <PaymentActualDetails>
    <AmountWithoutSurcharge>1</AmountWithoutSurcharge>
    <CardSurchargeDetail>
      <TotalSurchargeAmount>1</TotalSurchargeAmount>
      <ServiceSurchargeAmount>2</ServiceSurchargeAmount>
      <PostageSurchargeAmount>3</PostageSurchargeAmount>
      <EarmarkedSurchargeAmount>4</EarmarkedSurchargeAmount>
      <EscrowSurchargeAmount>5</EscrowSurchargeAmount>
    </CardSurchargeDetail>
    <ACHSurchargeDetail>
      <TotalSurchargeAmount>1</TotalSurchargeAmount>
      <ServiceSurchargeAmount>2</ServiceSurchargeAmount>
      <PostageSurchargeAmount>3</PostageSurchargeAmount>
      <EarmarkedSurchargeAmount>4</EarmarkedSurchargeAmount>
      <EscrowSurchargeAmount>5</EscrowSurchargeAmount>
    </ACHSurchargeDetail>
  </PaymentActualDetails>
</PaymentSurchargeInfoResponse>