WebAPI

<back to all web services

GetPaymentMethods

Retrieves all active payment methods for the account given the account id.

The following routes are available for this service:
GET/GetPaymentMethods/{AccountId}RESTFUL call with Account ID and Page Size in the URI
Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathintegerYes

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetPaymentMethods HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<GetPaymentMethods xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <AccountId>0</AccountId>
</GetPaymentMethods>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPaymentMethodsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <CreditCards xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:PaymentCreditCard>
      <d2p1:Bankname>String</d2p1:Bankname>
      <d2p1:CardId>0</d2p1:CardId>
      <d2p1:CardType>0</d2p1:CardType>
      <d2p1:DisplayCardNumber>String</d2p1:DisplayCardNumber>
      <d2p1:IsPrimaryCard>false</d2p1:IsPrimaryCard>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:CardTypeDesc>String</d2p1:CardTypeDesc>
      <d2p1:ExpirationMonth>0</d2p1:ExpirationMonth>
      <d2p1:ExpirationYear>0</d2p1:ExpirationYear>
    </d2p1:PaymentCreditCard>
  </CreditCards>
  <DirectDebits xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:PaymentACH>
      <d2p1:AccountHolder>String</d2p1:AccountHolder>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:AccountNumber>String</d2p1:AccountNumber>
      <d2p1:AchId>0</d2p1:AchId>
      <d2p1:BankId>String</d2p1:BankId>
      <d2p1:BankName>String</d2p1:BankName>
      <d2p1:DisplayACHInfo>String</d2p1:DisplayACHInfo>
      <d2p1:IsPrimaryDirectDebit>false</d2p1:IsPrimaryDirectDebit>
      <d2p1:Priority>0</d2p1:Priority>
      <d2p1:SortCode>String</d2p1:SortCode>
    </d2p1:PaymentACH>
  </DirectDebits>
  <IsAutoPay>false</IsAutoPay>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</GetPaymentMethodsResponse>