Sertifi API Web Service
Get a summary of the status of a payment.
Request (GetPaymentsStatusSoapIn)

The request body is of type GetPaymentsStatus.

Request Body Parameters

NameDescriptionData Type
p_APICodeThe API code of the site.  This can be found through your Sertifi web interface under Administration -> Account Settings.xml:string
p_FileIDThe id of the relevant file.xml:string
paymentIdThe id of the payment to get information about.xml:string
paymentId Element p_FileID Element p_APICode Element Sequence GetPaymentsStatus Element
Response (GetPaymentsStatusSoapOut)

The response body is of type GetPaymentsStatusResponse.

Response Body Parameters

NameDescriptionData Type
GetPaymentsStatusResultSummary XML or error message.xml:string
GetPaymentsStatusResult Element Sequence GetPaymentsStatusResponse Element
Example Response for unpaid payment:
<soap:Envelope xmlns:soap="" xmlns:xsi="" xmlns:xsd="">
      <GetPaymentsStatusResponse xmlns="">
         <GetPaymentsStatusResult><![CDATA[<Payments Count="1">
    <AVSStatus />
    <BillingName />
    <BillingAddress1 />
    <BillingAddress2 />
    <BillingCity />
    <BillingState />
    <BillingZip />
    <BillingCountry />
    <CVVStatus />
    <DateProcessed />
    <DateDue />
    <Email />
    <ErrorMessage />
    <IpAddress />
    <Status>Awaiting payment</Status>
    <CardLastFour />
    <CardType />
    <BankName />
    <RoutingNumber />
    <BankAccountType />
    <GatewayTokenId />
    <GatewayTransactionId />
    <GatewayName />

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"

See Also
All Operations Resource GroupSertifi API Web Service



© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.