| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| KnownAs | query | string | No | The name the customer is known as |
| Title | query | PersonTitle? | No | The person title. Allowed values: Mr, Mrs, Miss, Ms, DrAllowable Values
|
| FirstName | query | string | Yes | First name |
| LastName | query | string | Yes | Last name |
| DateOfBirth | query | DateTime? | No | Date of birth. Format YYYY-MM-DD |
| MobilePhone | query | string | No | Mobile phone |
| HomePhone | query | string | No | Home phone |
| query | string | Yes | ||
| Address | query | Address | Yes | Postal address |
| SendTicketsViaPost | query | bool | No | True to mail tickets to the postal address. Default is false |
| Contacts | query | List<GroupContact> | No | The list of group contacts is any for this customer |
| Password | query | string | No | The password for the new web user or a random unique password if not provided. This field is ignored when RegisterUser is false. |
| IdentityProvider | query | string | No | The Identity Provider using which the customer would like to sign-up. This field is ignored when RegisterUser is false. Supported Providers: { Facebook }Allowable Values |
| AccessToken | query | string | No | User's access token retrieved from the Identity Provider. This field is ignored when RegisterUser is false. |
| RequestReference | query | RequestReference | No | Attribution values associated to the request if any |
| AccountInstructions | query | string | No | Additional information / notes about customer. e.g. when calling, Speak Loud for this customer |
| Mr |
| Mrs |
| Miss |
| Ms |
| Dr |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Street | form | string | No | |
| City | form | string | No | |
| ZipCode | form | string | No | |
| State | form | string | No | |
| CountryRegionId | form | string | No | |
| DPID | form | int | No | |
| Suburb | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | form | string | No | |
| Title | form | PersonTitle? | No | Person titleAllowable Values
|
| FirstName | form | string | No | |
| LastName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | form | string | No | |
| RetailChannelId | form | string | Yes | |
| ReferenceId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | form | string | No | |
| AccountType | form | string | No | |
| CustomerStatus | form | CustomerAccountStatus | No | |
| IdentityStatus | form | IdentityStatus? | No | |
| KnownAs | form | string | No | |
| Title | form | PersonTitle? | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| DateOfBirth | form | DateTime? | No | |
| form | string | No | ||
| HomePhone | form | string | No | |
| MobilePhone | form | string | No | |
| Address | form | Address | No | |
| NotForPublication | form | bool | No | |
| AccountInstructions | form | string | No | |
| SendTicketsViaPost | form | bool | No | |
| SendTicketsViaEmail | form | bool | No | |
| OptOutSMS | form | bool | No | |
| OptOutPhone | form | bool | No | |
| LoyalSupporter | form | bool | No | |
| IsVip | form | bool? | No | |
| LastOrderAmount | form | double? | No | |
| Over18 | form | bool? | No | |
| Contacts | form | List<GroupContact> | No | |
| DefaultFundingSourceId | form | string | No | |
| CreditCards | form | List<CreditCard> | No | |
| PayPalAccounts | form | List<PayPalAccount> | No | |
| GooglePayAccounts | form | List<GooglePayAccount> | No | |
| ApplePayAccounts | form | List<ApplePayAccount> | No | |
| BankAccounts | form | List<BankAccount> | No | |
| Subscriptions | form | List<Subscription> | No | |
| CreatedDate | form | DateTime? | No |
| Active |
| Suspended |
| Closed |
| Name | Value |
|---|---|
| NewCustomer | 0 |
| NoOnlineAccount | 1 |
| ValidOnlineAccount | 2 |
| PrimaryEmailChange | 3 |
| EmailAlreadyInIM | 4 |
| PrimaryEmailRemoved | 5 |
| Unknown | -1 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreditCardId | form | string | No | |
| CardToken | form | string | No | |
| Token | form | string | No | |
| CardholderName | form | string | No | |
| CardType | form | CreditCardType | No | |
| UniqueNumberIdentifier | form | string | No | |
| ExpirationMonth | form | string | No | |
| ExpirationYear | form | string | No | |
| Bin | form | string | No | |
| LastFour | form | string | No | The last 4 digits of the credit card number |
| IsDefault | form | bool | No | |
| Disabled | form | bool | No | |
| LastModified | form | DateTime | No |
| Unknown |
| AmericanExpress |
| CarteBlanche |
| ChinaUnionPay |
| DinersClub |
| Discover |
| JCB |
| Laser |
| Maestro |
| MasterCard |
| Solo |
| Switch |
| Visa |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PayPalAccountId | form | string | No | The unique identifier of the PayPal acount in Dynamics |
| Token | form | string | No | The payment method token |
| form | string | No | The email address belonging to the Paypal account | |
| BillingAgreementId | form | string | No | The unique identifier of the vaulted payment flow agreement between the customer's PayPal account and RSL PayPal business account |
| CreatedAt | form | DateTime | No | The date/time the payment method was created |
| IsDefault | form | bool | No | |
| Disabled | form | bool | No | |
| IsNewCustomerPayPalFee | form | bool? | No | Whether to apply a different fee for customer coming from PayPal |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UniqueCardId | form | string | No | |
| SourceCardType | form | string | No | |
| CustomerId | form | string | No | |
| ExpirationMonth | form | string | No | |
| ExpirationYear | form | string | No | |
| Bin | form | string | No | The first 6 digits of the credit card, known as the Bank Identification Number. |
| GoogleTransactionId | form | string | No | The last 4 digits of the credit card number |
| SourceCardLast4 | form | string | No | |
| CardholderName | form | string | No | |
| CreatedAt | form | DateTime | No | The date/time the payment method was created |
| Token | form | string | No | The payment method token |
| Disabled | form | bool | No | |
| IsDefault | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UniqueCardId | form | string | No | |
| CardType | form | string | No | |
| CustomerId | form | string | No | |
| ExpirationMonth | form | string | No | |
| ExpirationYear | form | string | No | |
| Bin | form | string | No | The first 6 digits of the credit card, known as the Bank Identification Number. |
| LastFour | form | string | No | The last 4 digits of the credit card number |
| CardholderName | form | string | No | |
| CreatedAt | form | DateTime | No | The date/time the payment method was created |
| Token | form | string | No | |
| IsDefault | form | bool | No | |
| Disabled | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BankAccountId | form | string | No | |
| AccountName | form | string | No | |
| AccountNumber | form | string | No | |
| BSB | form | string | No | |
| CreatedDate | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubscriptionId | form | string | No | |
| CustomerId | form | string | No | |
| StartFromArtUnionId | form | string | No | |
| PaymentMethod | form | PaymentMethodType | No | |
| FundingSourceId | form | string | No | |
| Plan | form | string | No | |
| GameType | form | string | No | |
| StartDate | form | DateTime | No | |
| EndDate | form | DateTime? | No | |
| SubscriptionSuspension | form | IEnumerable<SubscriptionSuspension> | No | |
| Status | form | SubscriptionStatus | No | |
| SubscribedDate | form | DateTime | No | |
| CreditCard | form | CreditCard | No | |
| GooglePayAccount | form | GooglePayAccount | No | |
| ApplePayAccount | form | ApplePayAccount | No | |
| PayPal | form | PayPalAccount | No | |
| ReasonCode | form | string | No |
| Cash |
| Cheque |
| MoneyOrder |
| CreditCard |
| PayPal |
| DirectDebit |
| Wallet |
| GooglePay |
| ApplePay |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubscriptionId | form | string | No | |
| StartDate | form | DateTime | No | |
| EndDate | form | DateTime? | No | |
| ReasonCode | form | string | No |
| Pending |
| Active |
| Suspended |
| Cancelled |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/CreateCustomer HTTP/1.1
Host: azs-stg-lotteries-web.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
knownAs: String,
title: Mr,
firstName: String,
lastName: String,
dateOfBirth: 0001-01-01,
mobilePhone: String,
homePhone: String,
email: String,
address:
{
street: String,
city: String,
zipCode: String,
state: String,
countryRegionId: String,
dpid: 0,
suburb: String
},
sendTicketsViaPost: False,
contacts:
[
{
contactId: String,
title: Mr,
firstName: String,
lastName: String
}
],
password: String,
identityProvider: String,
accessToken: String,
requestReference:
{
campaignId: String,
retailChannelId: String,
referenceId: String
},
accountInstructions: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
customerId: String,
accountType: String,
customerStatus: Active,
identityStatus: NewCustomer,
knownAs: String,
title: Mr,
firstName: String,
lastName: String,
dateOfBirth: 0001-01-01,
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-01
}
],
payPalAccounts:
[
{
payPalAccountId: String,
token: String,
email: String,
billingAgreementId: String,
createdAt: 0001-01-01,
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-01,
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-01,
token: String,
isDefault: False,
disabled: False
}
],
bankAccounts:
[
{
bankAccountId: String,
accountName: String,
accountNumber: String,
bsb: String,
createdDate: 0001-01-01
}
],
subscriptions:
[
{
subscriptionId: String,
customerId: String,
startFromArtUnionId: String,
paymentMethod: Cash,
fundingSourceId: String,
plan: String,
gameType: String,
startDate: 0001-01-01,
endDate: 0001-01-01,
status: Pending,
subscribedDate: 0001-01-01,
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-01
},
googlePayAccount:
{
uniqueCardId: String,
sourceCardType: String,
customerId: String,
expirationMonth: String,
expirationYear: String,
bin: String,
googleTransactionId: String,
sourceCardLast4: String,
cardholderName: String,
createdAt: 0001-01-01,
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-01,
token: String,
isDefault: False,
disabled: False
},
payPal:
{
payPalAccountId: String,
token: String,
email: String,
billingAgreementId: String,
createdAt: 0001-01-01,
isDefault: False,
disabled: False,
isNewCustomerPayPalFee: False
},
reasonCode: String
}
],
createdDate: 0001-01-01
}