POST | /sales/member/{MemberId}/payment/makepayment | Make a Payment for a Member |
---|
export class ApiDtoBase
{
public ApiKey: string;
public StoreId?: number;
public ChainId?: number;
public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}
export class MakePaymentRequest extends ApiDtoBase
{
public UserId: number;
public Amount: number;
public Invoice: number[];
public constructor(init?: Partial<MakePaymentRequest>) { super(init); (Object as any).assign(this, init); }
}
export enum RestrictedResourceType
{
Store = 'Store',
Chain = 'Chain',
User = 'User',
Undefined = 'Undefined',
}
export class MakePayment extends MakePaymentRequest implements IRestrictedApiRequest
{
/**
* Api Key - grants access to resources
*/
// @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
public ApiKey: string;
/**
* ID # of store member belongs to
*/
// @ApiMember(DataType="integer", Description="ID # of store member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
public StoreId: number;
/**
* ID # of chain member belongs to
*/
// @ApiMember(DataType="integer", Description="ID # of chain member belongs to", Name="ChainId", ParameterType="query")
public ChainId?: number;
/**
* Member ID of user to make payment for
*/
// @ApiMember(DataType="integer", Description="Member ID of user to make payment for", IsRequired=true, Name="MemberId", ParameterType="path")
public MemberId: number;
/**
* Amount of the payment, including sales tax
*/
// @ApiMember(DataType="decimal", Description="Amount of the payment, including sales tax", IsRequired=true, Name="Amount", ParameterType="query")
public Amount: number;
/**
* Invoice ID to be paid
*/
// @ApiMember(DataType="integer", Description="Invoice ID to be paid", IsRequired=true, Name="Invoice", ParameterType="query")
public Invoice: number[];
public RestrictedId?: number;
public RestrictedResourceType: RestrictedResourceType;
public constructor(init?: Partial<MakePayment>) { super(init); (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sales/member/{MemberId}/payment/makepayment HTTP/1.1
Host: clubready.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ApiKey":"String","StoreId":0,"ChainId":0,"MemberId":0,"Amount":0,"Invoice":[0],"RestrictedId":0,"RestrictedResourceType":"Chain","UserId":0}