Definition
https://sandbox.bluesnap.com/services/2/wallets/onboarding
Documentation
The Onboard Apple Pay request allows you to specify the domains on which you will display the Apple Pay button. To register a new domain in the future, you may perform this request again with the new domain.
This API call is supported for Apple Pay on the web. For more detailed setup instructions, see Apple Pay in your website.
Retrieve onboarding information
The first time you send this request, a unique Apple Pay Onboarding ID will be created for your account. You may retrieve onboarding information with this ID.
###JSON Request Content Send a [wallet](doc:wallet-json) object with the following:
walletType string required
applePay object required; Contains:
domains array required Do not include https:// in the domain name
JSON Response Details
If successful, the response HTTP status code is 201 Created.
The Apple Pay Onboarding ID will be returned in the Location header of the response. For example:
Location: https://sandbox.bluesnap.com/services/2/wallets/onboarding/385
JSON Examples
Request Examples
curl -v -X POST https://sandbox.bluesnap.com/services/2/wallets/onboarding \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"walletType": "APPLE_PAY",
"applePay": {
"domains": ["bluesnap.com", "mystore.example.com", "merchant.com"]
}
}'
Response Examples
HTTP 201 Created
Location: https://sandbox.bluesnap.com/services/2/wallets/onboarding/385
##Example Descriptions ###Onboard Apple Pay In this example, we added the three web domains ("bluesnap.com", "mystore.example.com", and "merchant.com") on which we will display the Apple Pay button. The response was successful and contained an Apple Pay Onboarding ID of 385, which we can use to [retrieve onboarding details](doc:retrieve-apple-pay-onboarding-information) later.
###XML Request Content Send a [wallet](doc:wallet) resource with the following:
wallet-type string required
apple-pay container required; Contains:
domain string required Do not include https://
XML Response Details
If successful, the response HTTP status code is 201 Created.
The Apple Pay Onboarding ID will be returned in the Location header of the response. For example:
Location: https://sandbox.bluesnap.com/services/2/wallets/onboarding/385
XML Examples
Request Examples
curl -v -X POST https://sandbox.bluesnap.com/services/2/wallets/onboarding \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<wallet xmlns="http://ws.plimus.com">
<wallet-type>APPLE_PAY</wallet-type>
<apple-pay>
<domain>bluesnap.com</domain>
<domain>mystore.example.com</domain>
<domain>merchant.com</domain>
</apple-pay>
</wallet>'
Response Examples
HTTP 201 Created
Location: https://sandbox.bluesnap.com/services/2/wallets/onboarding/385
##Example Descriptions ###Onboard Apple Pay In this example, we added the three web domains ("bluesnap.com", "mystore.example.com", and "merchant.com") on which we will display the Apple Pay button. The response was successful and contained an Apple Pay Onboarding ID of 385, which we can use to [retrieve onboarding details](doc:retrieve-apple-pay-onboarding-information) later.
Back to Top