Overview

This API call is designed to list any payment methods that are on the account.

Retrieve Existing Payment Methods

 To retrieve existing payment methods

  1. Create a RetrieveExistingPaymentMethodsRequest 
  2. Specify the Account ID and Payment Method(specifically credit cards in this case).

WSDL

https://api.emersion.com.au/Services.wsdl

Operation name

RetrieveExistingPaymentMethods



Business Rules

The process should only return cards where the 'Date Effective' is in the past and the 'End Date' is either empty or in the future.




SOAP Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:RetrieveExistingPaymentMethodsRequest>
         <urn:AccountID>3725800</urn:AccountID>
         <urn:PaymentMethod>creditcard</urn:PaymentMethod>
      </urn:RetrieveExistingPaymentMethodsRequest>
   </soapenv:Body>
</soapenv:Envelope>
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns1:RetrieveExistingPaymentMethodsResponse>
         <ns1:ObscuredCreditCardNumber>XXXXXXXXXXXX1406</ns1:ObscuredCreditCardNumber>
         <ns1:ExpiryDate>02/2036</ns1:ExpiryDate>
         <ns1:CardToken>1111111111111111111111111111111111111111111111111</ns1:CardToken>
         <ns1:Reference/>
      </ns1:RetrieveExistingPaymentMethodsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>




Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information..

NameDescriptionRequired?Field Type

Character

limit

Values 
AccountID
The id of the account.YesInteger

123456789

PaymentMethodThe requested payment methodYesString
creditcard (fixed, case-insensitive)



Error Handling


Error MessageDescription
Invalid account IDThe ID could not be found in our system or not own to caller.
Account provided is not currently activeThe account is not active status.
Invalid Payment StatusThe payment method is not same as 'creditcard' (case-insensitive)
Account ID [XXXXX] has no payment informationThe account has no payment information
Account ID [XXXXX] has no credit card in its payment methodThe account has no credit card for its payment information