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

Description

Creates a payment item in a file.

Request (CreatePaymentSoapIn)

The request body is of type CreatePayment.

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
amount	The amount for the payment (1 period/decimal point and no commas allowed.)	xml:decimal
description	The name of the payment that signers see.	xml:string
recurrence	The interval at which the payment gets charged.	PaymentReccurence
datePaymentDue	date in yyyy-MM-dd format	xml:string
operation	Whether this will charge a card, 'Pay', or just authorise the card, 'Authorize'.	PaymentOperationType
xmlContent	An XML document specifying billing details of the payment, including whether or not surcharging will be applied.	xml:string
usePaymentRules	Should this payment abide by the site's overall payment requirements?	xml:boolean

Response (CreatePaymentSoapOut)

The response body is of type CreatePaymentResponse.

Response Body Parameters

Name	Description	Data Type
CreatePaymentResult	payment id or error message.	xml:string

Example

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://apps.sertifi.net/services/">
   <soap:Header/>
   <soap:Body>
      <ser:CreatePayment>
         
         <ser:p_APICode>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</ser:p_APICode>
         
         <ser:p_FileID>.AQA31tmhpHmJIBR_Jfl3Khy30</ser:p_FileID>
         <ser:amount>1.00</ser:amount>
         
         <ser:description>Dave's bill</ser:description>
         
         <ser:recurrence>OneTime</ser:recurrence>
         
         <ser:datePaymentDue>2017-05-15</ser:datePaymentDue>
         
         <ser:operation>Pay</ser:operation>
         
         <ser:xmlContent><![cdata[<?xml version="1.0" encoding="UTF-8"?>
            <payment>
               <parameter name="billingname" value="Sertifi Test" />
               <parameter name="billingaddress1" value="123 Test Ave" />
               <parameter name="billingaddress2" value="Apt 2R" />
               <parameter name="billingcity" value="Test City/>
               <parameter name="billingstate" value="IL" />
               <parameter name="billingzipcode" value="60654" />
               <parameter name="billingcountry" value="USA" />
               <parameter name="payeremail" value="[email protected]" />
               <parameter name="allowedpaymethods" value="cc" />
              <parameter name="hassurcharge" value="true"/>
            </payment>]]>
         </ser:xmlContent>
         <ser:usePaymentRules>true</ser:usePaymentRules>
      </ser:CreatePayment>
   </soap:Body>
</soap:Envelope>

Remarks

Common error messages:
"ERROR: Invalid API Code"
"ERROR: Payments are not enabled for this account."
"ERROR: File could not be accessed"
"ERROR: Payments can no longer be added to this file."
"ERROR: Could not save payment"

Values for AllowedPaymentMethods:
"CC", "SEPA", "banktransfer", "ach", "ach,cc", "all"