Rsl.Lotteries

<back to all web services

GetCustomer

Find a customer by Id. Handling of field IsVip not implemented.

The following routes are available for this service:
GET/customers/{CustomerId}
GetCustomer Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathstringYesThe customer identifier
IncludeFundingSourcesqueryboolNoWhen true, the customer funding sources are also returned. Default is false.
IncludeSubscriptionsqueryboolNoWhen true, the customer subscriptions are also returned. Default is false.
IncludeGiftContactsqueryboolNoWhen true, the customer gift contacts are also returned. Default is false.
Customer Parameters:
NameParameterData TypeRequiredDescription
CustomerIdformstringNo
AccountTypeformstringNo
CustomerStatusformCustomerAccountStatusNo
IdentityStatusformIdentityStatus?No
KnownAsformstringNo
TitleformPersonTitle?No
FirstNameformstringNo
LastNameformstringNo
DateOfBirthformDateTime?No
EmailformstringNo
HomePhoneformstringNo
MobilePhoneformstringNo
AddressformAddressNo
NotForPublicationformboolNo
AccountInstructionsformstringNo
SendTicketsViaPostformboolNo
SendTicketsViaEmailformboolNo
OptOutSMSformboolNo
OptOutPhoneformboolNo
LoyalSupporterformboolNo
IsVipformbool?No
LastOrderAmountformdouble?No
Over18formbool?No
ContactsformList<GroupContact>No
DefaultFundingSourceIdformstringNo
CreditCardsformList<CreditCard>No
PayPalAccountsformList<PayPalAccount>No
GooglePayAccountsformList<GooglePayAccount>No
ApplePayAccountsformList<ApplePayAccount>No
BankAccountsformList<BankAccount>No
SubscriptionsformList<Subscription>No
CreatedDateformDateTime?No
CustomerAccountStatus Enum:
Active
Suspended
Closed
IdentityStatus Enum:
NameValue
NewCustomer0
NoOnlineAccount1
ValidOnlineAccount2
PrimaryEmailChange3
EmailAlreadyInIM4
PrimaryEmailRemoved5
Unknown-1
PersonTitle Enum:
Mr
Mrs
Miss
Ms
Dr
Address Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
CityformstringNo
ZipCodeformstringNo
StateformstringNo
CountryRegionIdformstringNo
DPIDformintNo
SuburbformstringNo
GroupContact Parameters:
NameParameterData TypeRequiredDescription
ContactIdformstringNo
TitleformPersonTitle?NoPerson title

Allowable Values

  • Mr
  • Mrs
  • Miss
  • Ms
  • Dr
FirstNameformstringNo
LastNameformstringNo
CreditCard Parameters:
NameParameterData TypeRequiredDescription
CreditCardIdformstringNo
CardTokenformstringNo
TokenformstringNo
CardholderNameformstringNo
CardTypeformCreditCardTypeNo
UniqueNumberIdentifierformstringNo
ExpirationMonthformstringNo
ExpirationYearformstringNo
BinformstringNo
LastFourformstringNoThe last 4 digits of the credit card number
IsDefaultformboolNo
DisabledformboolNo
LastModifiedformDateTimeNo
CreditCardType Enum:
Unknown
AmericanExpress
CarteBlanche
ChinaUnionPay
DinersClub
Discover
JCB
Laser
Maestro
MasterCard
Solo
Switch
Visa
PayPalAccount Parameters:
NameParameterData TypeRequiredDescription
PayPalAccountIdformstringNoThe unique identifier of the PayPal acount in Dynamics
TokenformstringNoThe payment method token
EmailformstringNoThe email address belonging to the Paypal account
BillingAgreementIdformstringNoThe unique identifier of the vaulted payment flow agreement between the customer's PayPal account and RSL PayPal business account
CreatedAtformDateTimeNoThe date/time the payment method was created
IsDefaultformboolNo
DisabledformboolNo
IsNewCustomerPayPalFeeformbool?NoWhether to apply a different fee for customer coming from PayPal
GooglePayAccount Parameters:
NameParameterData TypeRequiredDescription
UniqueCardIdformstringNo
SourceCardTypeformstringNo
CustomerIdformstringNo
ExpirationMonthformstringNo
ExpirationYearformstringNo
BinformstringNoThe first 6 digits of the credit card, known as the Bank Identification Number.
GoogleTransactionIdformstringNoThe last 4 digits of the credit card number
SourceCardLast4formstringNo
CardholderNameformstringNo
CreatedAtformDateTimeNoThe date/time the payment method was created
TokenformstringNoThe payment method token
DisabledformboolNo
IsDefaultformboolNo
ApplePayAccount Parameters:
NameParameterData TypeRequiredDescription
UniqueCardIdformstringNo
CardTypeformstringNo
CustomerIdformstringNo
ExpirationMonthformstringNo
ExpirationYearformstringNo
BinformstringNoThe first 6 digits of the credit card, known as the Bank Identification Number.
LastFourformstringNoThe last 4 digits of the credit card number
CardholderNameformstringNo
CreatedAtformDateTimeNoThe date/time the payment method was created
TokenformstringNo
IsDefaultformboolNo
DisabledformboolNo
BankAccount Parameters:
NameParameterData TypeRequiredDescription
BankAccountIdformstringNo
AccountNameformstringNo
AccountNumberformstringNo
BSBformstringNo
CreatedDateformDateTimeNo
Subscription Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdformstringNo
CustomerIdformstringNo
StartFromArtUnionIdformstringNo
PaymentMethodformPaymentMethodTypeNo
FundingSourceIdformstringNo
PlanformstringNo
GameTypeformstringNo
StartDateformDateTimeNo
EndDateformDateTime?No
SubscriptionSuspensionformIEnumerable<SubscriptionSuspension>No
StatusformSubscriptionStatusNo
SubscribedDateformDateTimeNo
CreditCardformCreditCardNo
GooglePayAccountformGooglePayAccountNo
ApplePayAccountformApplePayAccountNo
PayPalformPayPalAccountNo
ReasonCodeformstringNo
PaymentMethodType Enum:
Cash
Cheque
MoneyOrder
CreditCard
PayPal
DirectDebit
Wallet
GooglePay
ApplePay
SubscriptionSuspension Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdformstringNo
StartDateformDateTimeNo
EndDateformDateTime?No
ReasonCodeformstringNo
SubscriptionStatus Enum:
Pending
Active
Suspended
Cancelled

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /customers/{CustomerId} HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"customerId":"String","accountType":"String","customerStatus":"Active","identityStatus":"NewCustomer","knownAs":"String","title":"Mr","firstName":"String","lastName":"String","dateOfBirth":"0001-01-01T00:00:00.0000000","email":"String","homePhone":"String","mobilePhone":"String","address":{"street":"String","city":"String","zipCode":"String","state":"String","countryRegionId":"String","dpid":0,"suburb":"String"},"notForPublication":false,"accountInstructions":"String","sendTicketsViaPost":false,"sendTicketsViaEmail":false,"optOutSMS":false,"optOutPhone":false,"loyalSupporter":false,"isVip":false,"lastOrderAmount":0,"over18":false,"contacts":[{"contactId":"String","title":"Mr","firstName":"String","lastName":"String"}],"defaultFundingSourceId":"String","creditCards":[{"creditCardId":"String","cardToken":"String","token":"String","cardholderName":"String","cardType":"Unknown","uniqueNumberIdentifier":"String","expirationMonth":"String","expirationYear":"String","bin":"String","lastFour":"String","isDefault":false,"disabled":false,"lastModified":"0001-01-01T00:00:00.0000000"}],"payPalAccounts":[{"payPalAccountId":"String","token":"String","email":"String","billingAgreementId":"String","createdAt":"0001-01-01T00:00:00.0000000","isDefault":false,"disabled":false,"isNewCustomerPayPalFee":false}],"googlePayAccounts":[{"uniqueCardId":"String","sourceCardType":"String","customerId":"String","expirationMonth":"String","expirationYear":"String","bin":"String","googleTransactionId":"String","sourceCardLast4":"String","cardholderName":"String","createdAt":"0001-01-01T00:00:00.0000000","token":"String","disabled":false,"isDefault":false}],"applePayAccounts":[{"uniqueCardId":"String","cardType":"String","customerId":"String","expirationMonth":"String","expirationYear":"String","bin":"String","lastFour":"String","cardholderName":"String","createdAt":"0001-01-01T00:00:00.0000000","token":"String","isDefault":false,"disabled":false}],"bankAccounts":[{"bankAccountId":"String","accountName":"String","accountNumber":"String","bsb":"String","createdDate":"0001-01-01T00:00:00.0000000"}],"subscriptions":[{"subscriptionId":"String","customerId":"String","startFromArtUnionId":"String","paymentMethod":"Cash","fundingSourceId":"String","plan":"String","gameType":"String","startDate":"0001-01-01T00:00:00.0000000","endDate":"0001-01-01T00:00:00.0000000","status":"Pending","subscribedDate":"0001-01-01T00:00:00.0000000","creditCard":{"creditCardId":"String","cardToken":"String","token":"String","cardholderName":"String","cardType":"Unknown","uniqueNumberIdentifier":"String","expirationMonth":"String","expirationYear":"String","bin":"String","lastFour":"String","isDefault":false,"disabled":false,"lastModified":"0001-01-01T00:00:00.0000000"},"googlePayAccount":{"uniqueCardId":"String","sourceCardType":"String","customerId":"String","expirationMonth":"String","expirationYear":"String","bin":"String","googleTransactionId":"String","sourceCardLast4":"String","cardholderName":"String","createdAt":"0001-01-01T00:00:00.0000000","token":"String","disabled":false,"isDefault":false},"applePayAccount":{"uniqueCardId":"String","cardType":"String","customerId":"String","expirationMonth":"String","expirationYear":"String","bin":"String","lastFour":"String","cardholderName":"String","createdAt":"0001-01-01T00:00:00.0000000","token":"String","isDefault":false,"disabled":false},"payPal":{"payPalAccountId":"String","token":"String","email":"String","billingAgreementId":"String","createdAt":"0001-01-01T00:00:00.0000000","isDefault":false,"disabled":false,"isNewCustomerPayPalFee":false},"reasonCode":"String"}],"createdDate":"0001-01-01T00:00:00.0000000"}