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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	AccountId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CreditCards: 
	[
		{
			ExpirationMonth: 0,
			ExpirationYear: 0,
			CardTypeDesc: String,
			CardId: 0,
			Bankname: String,
			Name: String,
			DisplayCardNumber: String,
			PostalCode: String,
			IsPrimaryCard: False,
			CardType: 0
		}
	],
	DirectDebits: 
	[
		{
			AccountId: 0,
			AchId: 0,
			AccountHolder: String,
			AccountNumber: String,
			SortCode: String,
			BankId: String,
			BankName: String,
			DisplayACHInfo: String,
			IsPrimaryDirectDebit: False,
			Priority: 0
		}
	],
	IsAutoPay: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	}
}