YM REST Services

<back to all web services

PaymentProcessors

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/PaymentProcessorsReturn a list of Payment Processors.
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
PaymentProcessorsResponse Parameters:
NameParameterData TypeRequiredDescription
PaymentProcessorListformList<PaymentProcessor>No
PaymentProcessor Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
IdformintNo
ActiveformboolNo
PrimaryformboolNo
CardOrderTypeformCardOrderTypeEnum?No

To override the Content-type in your clients, use the 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.

GET /Ams/{ClientID}/PaymentProcessors HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PaymentProcessorList: 
	[
		{
			Name: String,
			Id: 0,
			Active: False,
			Primary: False,
			CardOrderType: 0
		}
	],
	UsingRedis: True,
	AppInitTime: 2024-05-03T08:16:34.0403300-04:00,
	ServerID: WS-5-31-738,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T08:17:29.5241755-04:00,
	Device: Desktop
}