Update Apple Pay Onboarding Information

Definition

https://sandbox.bluesnap.com/services/2/wallets/onboarding

Documentation

The Update Apple Pay Onboarding Information request allows you to register a new domain that will display the Apple Pay button or to unregister an existing domain.

👍
This API call is supported for Apple Pay on the web. For more detailed setup instructions, see Apple Pay in your website.

JSON
XML

###JSON Request Content Send a [wallet](doc:wallet-json) object with the following:

walletType string required

applePay object required; Contains:

domains array Optional Do not include https:// in the domain name

unregisterDomains array Optional Do not include https:// in the domain name

JSON Response Details

If successful, the response HTTP status code is 200 OK and the body contains an array of currently registered domains.

JSON Examples

Request Examples

curl -v -X PUT 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": ["test4.bluesnap.com"]
  }
}'

curl -v -X PUT 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": {
    "unregisterDomains": [
      "test2.bluesnap.com",
      "test3.bluesnap.com"
    ]
  }
}'

Response Examples

{
  "walletType": "APPLE_PAY",
  "applePay": {
    "domains": ["test1.bluesnap.com", "test4.bluesnap.com"]
  }
}

##Example Descriptions

Register new domain

In this example, we registered a new domain, test4.bluesnap.com, that will display the Apple Pay button.

Unregister existing domain

In this example, we unregistered two domains, test2.bluesnap.com and test3.bluesnap.com.

###XML Request Content Send a [wallet](doc:wallet) resource with the following:

wallet-type string required

apple-pay container required; Contains:

domain string Optional Do not include https:// in the domain name

unregister-domain string Optional Do not include https:// in the domain name

XML Response Details

If successful, the response HTTP status code is 200 OK and the body contains the currently registered domains.

XML Examples

Request Examples

curl -v -X PUT 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>test4.bluesnap.com</domain>
  </apple-pay>
</wallet>'

curl -v -X PUT 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>
    <unregister-domain>test2.bluesnap.com</unregister-domain>
    <unregister-domain>test3.bluesnap.com</unregister-domain>
  </apple-pay>
</wallet>'

Response Examples

<wallet xmlns="http://ws.plimus.com">
  <wallet-type>APPLE_PAY</wallet-type>
  <apple-pay>
    <domain>test1.bluesnap.com</domain>
    <domain>test4.bluesnap.com</domain>
  </apple-pay>
</wallet>

##Example Descriptions

Register new domain

In this example, we registered a new domain, test4.bluesnap.com, that will display the Apple Pay button.

Unregister existing domain

In this example, we unregistered two domains: test2.bluesnap.com and test3.bluesnap.com.