| POST | /fundingsources/paypal | Either provide a payment method token or a nonce but not both |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentMethodToken | body | string | No | The payment method token if already vaulted |
| PaymentMethodNonce | body | string | No | The payment method nonce |
| IsDefault | body | bool | No | |
| RememberPaymentMethod | body | bool? | No | False to save PayPal as disabled otherwise save as normal in Dynamics |
| CustomerId | body | string | No | |
| IsNewCustomerPayPalFee | body | bool? | No | |
| RequestReference | body | RequestReference | 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 |
|---|---|---|---|---|
| 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 |
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 /fundingsources/paypal HTTP/1.1
Host: azs-stg-lotteries-web.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
paymentMethodToken: String,
paymentMethodNonce: String,
isDefault: False,
rememberPaymentMethod: False,
customerId: String,
isNewCustomerPayPalFee: False,
requestReference:
{
campaignId: String,
retailChannelId: String,
referenceId: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
payPalAccountId: String,
token: String,
email: String,
billingAgreementId: String,
createdAt: 0001-01-01,
isDefault: False,
disabled: False,
isNewCustomerPayPalFee: False
}