Skip to main content

The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.

ApplePayCertificate

Requires mobile_payments access scope.

You can use the ApplePayCertificate resource to create a certificate signing request (CSR) and upload the signed certificate from Apple to Shopify. To use the resource, you'll first need to send a POST request to the ApplePayCertificate resource to obtain an id. You'll then use this id to create a base64 encoded key to be included in the body of your CSR to Apple. After you've uploaded the CSR to Apple and received the certificate, you'll provide it to Shopify by using a PUT request.

Was this section helpful?

Anchor to

The ApplePayCertificate resource

Anchor to

Properties


id

Unique numeric identifier for the Apple Pay certificate.


status

Status of your Apple Pay certificate. Possible values are issuing, csr, or completed.


merchant_id

Merchant ID for your Apple Pay certificate.


Was this section helpful?
{}

The ApplePayCertificate resource

{
"id": 915396206,
"status": "issuing",
"merchant_id": {
"value_type": "merchant.id"
}
}

Anchor to POST request, Create an Apple Pay certificate
post
Create an Apple Pay certificate

Create an Apple Pay certificate

Anchor to Parameters of Create an Apple Pay certificateParameters


api_version
string
required

Was this section helpful?

Anchor to post-apple-pay-certificates-examplesExamples

Create an Apple Pay certificate

Was this section helpful?
post

/admin/api/2025-01/apple_pay_certificates.json

curl -d '{"apple_pay_certificate":{}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

{}

Response

JSON
HTTP/1.1 201 Created
{
"apple_pay_certificate": {
"id": 1068938278,
"status": "issuing",
"merchant_id": null
}
}

Retrieve an Apple Pay certificate


api_version
string
required

apple_pay_certificate_id
string
required

Was this section helpful?

Retrieve an Apple Pay certificate

Path parameters
apple_pay_certificate_id=1068938274
string
required
Was this section helpful?
get

/admin/api/2025-01/apple_pay_certificates/1068938274.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates/1068938274.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"apple_pay_certificate": {
"id": 1068938274,
"status": "csr",
"merchant_id": null
}
}

Anchor to GET request, Create a base64 encoded key to be included in the body of the CSR
get
Create a base64 encoded key to be included in the body of the CSR

Create a base64 encoded key to be included in the body of the CSR


api_version
string
required

apple_pay_certificate_id
string
required

Was this section helpful?

Create a base64 encoded key to be included in the body of the CSR

Path parameters
apple_pay_certificate_id=1068938275
string
required
Was this section helpful?
get

/admin/api/2025-01/apple_pay_certificates/1068938275/csr.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates/1068938275/csr.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"csr": {
"key": "YXBwbGUtcGF5LWNzcg==\n"
}
}

Anchor to PUT request, Upload Apple Pay certificate to enable Apple Pay on your app
put
Upload Apple Pay certificate to enable Apple Pay on your app

Upload Apple Pay certificate to enable Apple Pay on your app


api_version
string
required

apple_pay_certificate_id
string
required

Was this section helpful?

Upload Apple Pay certificate to enable Apple Pay on your app

Path parameters
apple_pay_certificate_id=1068938276
string
required
Request body
apple_pay_certificate
Apple_pay_certificate resource
Show apple_pay_certificate properties
apple_pay_certificate.id:1068938276

Unique numeric identifier for the Apple Pay certificate.

apple_pay_certificate.status:"completed"

Status of your Apple Pay certificate. Possible values are issuing, csr, or completed.

apple_pay_certificate.merchant_id:"merchant.something"

Merchant ID for your Apple Pay certificate.

Was this section helpful?
put

/admin/api/2025-01/apple_pay_certificates/1068938276.json

curl -d '{"apple_pay_certificate":{"id":1068938276,"status":"completed","merchant_id":"merchant.something","encoded_signed_certificate":"MIIEZzCCBA6gAwIBAgIIWGMideLkDJAwCgYIKoZIzj0EAwIwgYAxNDAyBgNV\nBAMMK0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0g\nRzIxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMw\nEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xNDEyMDgyMTMy\nMDBaFw0xNzAxMDYyMTMyMDBaMIGZMSowKAYKCZImiZPyLGQBAQwabWVyY2hh\nbnQuY29tLm5vcm1vcmUuamFzb24xMDAuBgNVBAMMJ01lcmNoYW50IElEOiBt\nZXJjaGFudC5jb20ubm9ybW9yZS5qYXNvbjETMBEGA1UECwwKNVVZMzJOTE5O\nOTEXMBUGA1UECgwOSm9zaHVhIFRlc3NpZXIxCzAJBgNVBAYTAkNBMFkwEwYH\nKoZIzj0CAQYIKoZIzj0DAQcDQgAEAxDDCvzG6MnsZSJOtbr0hr3MRq+4HzTZ\nx8J4FD34E3kU5CallEnZLBmnzfqmjP8644SO28LLJxvWBnrg7lHFtaOCAlUw\nggJRMEcGCCsGAQUFBwEBBDswOTA3BggrBgEFBQcwAYYraHR0cDovL29jc3Au\nYXBwbGUuY29tL29jc3AwNC1hcHBsZXd3ZHJjYTIwMTAdBgNVHQ4EFgQUkPsO\nKEKvhL/takKomy5GWXtCd8wwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSE\ntoTMOoZichZZlOgao71I3zrfCzCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZI\nhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMg\nY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBv\nZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25k\naXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZp\nY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRw\nOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNgYDVR0f\nBC8wLTAroCmgJ4YlaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGV3d2RyY2Ey\nLmNybDAOBgNVHQ8BAf8EBAMCAygwTwYJKoZIhvdjZAYgBEIMQDM0NTBBMjhB\nOTlGRjIyRkI5OTdDRERFODU1REREOTI5NTE4RjVGMDdBQUM4NzdDMzRCQjM3\nODFCQTg2MzkyNjIwCgYIKoZIzj0EAwIDRwAwRAIgZ/oNx0gCc/PM4pYhOWL2\nCecFQrIgzHr/fZd8qcy3Be8CIEQCaAPpmvQrXEX0hFexoYMHtOHY9dgN2D8L\nNKpVyn3t\n"}}' \
-X PUT "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates/1068938276.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

{}

Response

JSON
HTTP/1.1 200 OK
{
"apple_pay_certificate": {
"id": 1068938276,
"status": "completed",
"merchant_id": "merchant.something"
}
}

Delete Apple Pay certificate


api_version
string
required

apple_pay_certificate_id
string
required

Was this section helpful?

Delete Apple Pay certificate

Path parameters
apple_pay_certificate_id=1068938277
string
required
Was this section helpful?
del

/admin/api/2025-01/apple_pay_certificates/1068938277.json

curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates/1068938277.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 204 No Content