/testsite/Services/Gateway.asmx/GetPaymentsStatus (Method)

Description

Get a summary of the status of a payment.

Request (GetPaymentsStatusSoapIn)

The request body is of type GetPaymentsStatus.

Request Body Parameters

Name	Description	Data Type
p_APICode	The API code of the site. This can be found through your Sertifi web interface under Administration -> Account Settings.	xml:string
p_FileID	The id of the relevant file.	xml:string
paymentId	The id of the payment to get information about.	xml:string

Response (GetPaymentsStatusSoapOut)

The response body is of type GetPaymentsStatusResponse.

Response Body Parameters

Name	Description	Data Type
GetPaymentsStatusResult	Summary XML or error message.	xml:string

Example

Example Response for unpaid payment:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetPaymentsStatusResponse xmlns="http://apps.sertifi.net/services/">
         <GetPaymentsStatusResult><![CDATA[<Payments Count="1">
<Payment>
    <Amount>1.00</Amount>
    <Currency>USD</Currency>
    <AVSStatus />
    <BillingName />
    <BillingAddress1 />
    <BillingAddress2 />
    <BillingCity />
    <BillingState />
    <BillingZip />
    <BillingCountry />
    <CVVStatus />
    <DateCreated>2018-02-26T15:51:10.53</DateCreated>
    <DateProcessed />
    <DateDue />
    <Email />
    <ErrorMessage />
    <IpAddress />
    <PaymentId>.AAC2uF64kLBNHvY9boHI8--I0</PaymentId>
    <DocumentId></DocumentId>
    <Status>Awaiting payment</Status>
    <CardLastFour />
    <CardType />
    <PaymentMethod>CreditCard</PaymentMethod>
    <BankName />
    <RoutingNumber />
    <BankAccountType />
    <GatewayTokenId />
    <GatewayTransactionId />
    <GatewayName />
    <Identifier>20180226155111433</Identifier>
    <Operation>Pay</Operation>
</Payment>
</Payments>]]></GetPaymentsStatusResult>
      </GetPaymentsStatusResponse>
   </soap:Body>
</soap:Envelope>

Remarks

Note: for security reasons Sertifi retains a limited amount of information about credit cards and it may be neccessary to contact the payment gateway directly for additional information.

Common error messages:
"ERROR: Invalid API Code"
"ERROR: Payments are not enabled for this account."
"ERROR: File could not be accessed"
"ERROR: Payment request could not be accessed"