Contents

Retrieve Merchant Token Public Key

Get the merchant token public key.

URL

POST https://apple-pay-gateway.apple.com/paymentservices/v1/merchantId/{merchantId}/merchantToken/publicKey

Path Parameters

NameTypeDescription
merchantId Requiredstring

Your merchant identifier.

Header Parameters

NameTypeDescription
Accept Optionalstring

The response format the client expects, for example, application/json for JSON.

Content-Type Requiredstring

The format of the data sent in the request body, for example, application/json for JSON payloads.

x-request-id Requiredstring

The header used to uniquely identify the request.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
RetrieveMerchantTokenPublicKeyResponse

Successful response.

202Accepted
Content-Type: application/json
ErrorResponse

Accepted. The public key isn’t yet available. Apple notifies via tokenNotificationURL when it’s available.

400Bad Request
Content-Type: application/json
ErrorResponse

Bad request.

403Forbidden
Content-Type: application/json
ErrorResponse

Authorization failed.

404Not Found
Content-Type: application/json
ErrorResponse

Resource not found.

409Conflict
Content-Type: application/json
ErrorResponse

Metadata conflict. Update the tokenNotificationURL.

500Internal Server Error
Content-Type: application/json
ErrorResponse

Internal server error.

Discussion

Your server calls this API to get the public key of a particular merchant token. This public key is created by the merchant token owner’s device. The key is a P-384 public key. The response includes the supportedCiphersuite, which specifies the cipher suite to use when calling the Merchant-Token-Usage-Data-Availability-Notification or responding to Get MerchantToken Usage Information Package.

HTTP Body

The request body you use for the merchant token public key.

See Also

Merchant token usage information