POST api/Purchase/{affiliateId}/ChargeCustomerBasket

Charges a customers basket.

Request Information

URI Parameters

Name	Description	Type	Additional information
affiliateId	The affiliate identifier.	integer	Required
v	The requested API version	string	Default value is 2.0

Body Parameters

The charge dto.

FilmFlex.Platform.Api.Models.ChargeCustomerLimitedDTO

Name	Description	Type	Additional information
TempCardToken	One off customer payment token	string	None.
SaveCardWithProvider	Save customer details with provider	boolean	None.
VoucherCode	Voucher code	string	None.
AmountDue	Amount to pay/charge	decimal number	None.
VoucherRedeemableValue	Voucher redeemable value	decimal number	None.
CurrencyCode	Currency ISO code	string	None.
PaymentProviderType		string	None.
CollectionId	Optional collection id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "TempCardToken": "sample string 1",
  "SaveCardWithProvider": true,
  "VoucherCode": "sample string 3",
  "AmountDue": 4.0,
  "VoucherRedeemableValue": 5.0,
  "CurrencyCode": "sample string 6",
  "PaymentProviderType": "sample string 7",
  "CollectionId": 1
}

Response Information

Resource Description

Charges a customers basket.

FilmFlex.Platform.Common.API.Contracts.V2.ChargeCustomerResultDTO

Name	Description	Type	Additional information
PurchaseOrderId	PO id	integer	None.
PaymentTransactionId	Transaction id	string	None.
PaymentStatus	Status	string	None.
ChargedAmount	Amount charged	decimal number	None.
StatementDescriptor	Statement descriptor	string	None.
PaymentProviderCustomerId	User id with PP if save was requested	string	None.
Message		string	None.
HttpStatusCode	Http status code	string	None.
ErrorType		string	None.
ErrorCode		string	None.
DeclineCode	Gets or sets the decline code.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PurchaseOrderId": 1,
  "PaymentTransactionId": "sample string 2",
  "PaymentStatus": "sample string 3",
  "ChargedAmount": 4.0,
  "StatementDescriptor": "sample string 5",
  "PaymentProviderCustomerId": "sample string 6",
  "Message": "sample string 7",
  "HttpStatusCode": "sample string 8",
  "ErrorType": "sample string 9",
  "ErrorCode": "sample string 10",
  "DeclineCode": "sample string 11"
}