Rsl.Lotteries

<back to all web services

TopupCustomerWallet

Topup customer account balance

The following routes are available for this service:
POST/customers/{CustomerId}/wallet/topup
TopupCustomerWallet Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathstringYesThe customer identifier
PaymentMethodbodyPaymentMethodType?YesThe payment method. CreditCard is currently not supported

Allowable Values

  • Cash
  • Cheque
  • MoneyOrder
  • CreditCard
  • PayPal
  • DirectDebit
  • Wallet
  • GooglePay
  • ApplePay
PaymentDatebodyDateTime?YesThe payment date - Universal format
AmountbodydecimalYesThe amount to be added to customer's balance. It must be greater than 0 and less than top up limit
ChequeNumberbodystringNoCheque number
ReferencebodystringNoThe payment reference
PaymentMethodType Enum:
Cash
Cheque
MoneyOrder
CreditCard
PayPal
DirectDebit
Wallet
GooglePay
ApplePay
TopupCustomerWalletResponse Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodNameformstringNo
JournalBatchNumberformstringNo
LineNumberformintNo
CreditAmountformdecimalNo
TransactionDateformDateTimeOffsetNo
TransactionTextformstringNo
PaymentReferenceformstringNo
ResponseStatusformResponseStatusNo

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.

POST /customers/{CustomerId}/wallet/topup HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	customerId: String,
	paymentMethod: Cash,
	paymentDate: 0001-01-01,
	amount: 0,
	chequeNumber: String,
	reference: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	paymentMethodName: String,
	journalBatchNumber: String,
	lineNumber: 0,
	creditAmount: 0,
	transactionDate: 0001-01-01T00:00:00.0000000+00:00,
	transactionText: String,
	paymentReference: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}