Amazon Web Services, Inc.

Payment Cryptography Control Plane

Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create,…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide. To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the Amazon Web Services Payment Cryptography Data Plane . You can perform actions like encrypt, decrypt, generate, and verify payment-related data. All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests. Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide .

Endpoints 32

Key

  • POSTAdd key replication regions/#X-Amz-Target=PaymentCryptographyControlPlane.AddKeyReplicationRegionsAdds replication Amazon Web Services Regions to an existing Amazon Web Services Payment Cryptography key, enabling the key to be used for cryptographic…
  • POSTCreate key/#X-Amz-Target=PaymentCryptographyControlPlane.CreateKeyCreates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web…
  • POSTDelete key/#X-Amz-Target=PaymentCryptographyControlPlane.DeleteKeyDeletes the key material and metadata associated with Amazon Web Services Payment Cryptography key. Key deletion is irreversible. After a key is deleted, you…
  • POSTGet key/#X-Amz-Target=PaymentCryptographyControlPlane.GetKeyGets the key metadata for an Amazon Web Services Payment Cryptography key, including the immutable and mutable attributes specified when the key was created.…
  • POSTList keys/#X-Amz-Target=PaymentCryptographyControlPlane.ListKeysLists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys. This is a paginated operation,…
  • POSTRemove key replication regions/#X-Amz-Target=PaymentCryptographyControlPlane.RemoveKeyReplicationRegionsRemoves Replication Regions from an existing Amazon Web Services Payment Cryptography key, disabling the key's availability for cryptographic operations in…
  • POSTRestore key/#X-Amz-Target=PaymentCryptographyControlPlane.RestoreKeyCancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion. During the waiting period, the…
  • POSTStart key usage/#X-Amz-Target=PaymentCryptographyControlPlane.StartKeyUsageEnables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography…
  • POSTStop key usage/#X-Amz-Target=PaymentCryptographyControlPlane.StopKeyUsageDisables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography. You can use this operation…

Alias

  • POSTCreate alias/#X-Amz-Target=PaymentCryptographyControlPlane.CreateAliasCreates an alias , or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you…
  • POSTDelete alias/#X-Amz-Target=PaymentCryptographyControlPlane.DeleteAliasDeletes the alias, but doesn't affect the underlying key. Each key can have multiple aliases. To get the aliases of all keys, use the UpdateAlias operation.…
  • POSTGet alias/#X-Amz-Target=PaymentCryptographyControlPlane.GetAliasGets the Amazon Web Services Payment Cryptography key associated with the alias. Cross-account use: This operation can't be used across different Amazon Web…
  • POSTList aliases/#X-Amz-Target=PaymentCryptographyControlPlane.ListAliasesLists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by keyARN . For more…
  • POSTUpdate alias/#X-Amz-Target=PaymentCryptographyControlPlane.UpdateAliasAssociates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment…
  • POSTAssociate mpa team/#X-Amz-Target=PaymentCryptographyControlPlane.AssociateMpaTeamAssociates a Multi-Party Approval (MPA) team with a protected operation. For more information, see Multi-Party Approval in the Amazon Web Services Payment…
  • POSTDelete resource policy/#X-Amz-Target=PaymentCryptographyControlPlane.DeleteResourcePolicyRemoves the resource-based policy attached to an Amazon Web Services Payment Cryptography key. Cross-account use: This operation can't be used across…
  • POSTDisable default key replication regions/#X-Amz-Target=PaymentCryptographyControlPlane.DisableDefaultKeyReplicationRegionsDisables Multi-Region key replication settings for the specified Amazon Web Services Regions in your Amazon Web Services account, preventing new keys from…
  • POSTDisassociate mpa team/#X-Amz-Target=PaymentCryptographyControlPlane.DisassociateMpaTeamRemoves the association between a Multi-Party Approval (MPA) team and a protected operation. Cross-account use: This operation can't be used across different…
  • POSTEnable default key replication regions/#X-Amz-Target=PaymentCryptographyControlPlane.EnableDefaultKeyReplicationRegionsEnables Multi-Region key replication settings for your Amazon Web Services account, causing new keys to be automatically replicated to the specified Amazon…
  • POSTExport key/#X-Amz-Target=PaymentCryptographyControlPlane.ExportKeyExports a key from Amazon Web Services Payment Cryptography. Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing…
  • POSTGet certificate signing request/#X-Amz-Target=PaymentCryptographyControlPlane.GetCertificateSigningRequestCreates a certificate signing request (CSR) from a key pair.
  • POSTGet default key replication regions/#X-Amz-Target=PaymentCryptographyControlPlane.GetDefaultKeyReplicationRegionsRetrieves the list of Amazon Web Services Regions where Multi-Region key replication is currently enabled for your Amazon Web Services account. This operation…
  • POSTGet mpa team association/#X-Amz-Target=PaymentCryptographyControlPlane.GetMpaTeamAssociationReturns the Multi-Party Approval (MPA) team association for a protected operation. Cross-account use: This operation can't be used across different Amazon Web…
  • POSTGet parameters for export/#X-Amz-Target=PaymentCryptographyControlPlane.GetParametersForExportGets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography. The signing key…
  • POSTGet parameters for import/#X-Amz-Target=PaymentCryptographyControlPlane.GetParametersForImportGets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import…
  • POSTGet public key certificate/#X-Amz-Target=PaymentCryptographyControlPlane.GetPublicKeyCertificateGets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography. Unlike the private key of an…
  • POSTGet resource policy/#X-Amz-Target=PaymentCryptographyControlPlane.GetResourcePolicyReturns the resource-based policy attached to an Amazon Web Services Payment Cryptography key. Cross-account use: This operation can't be used across…
  • POSTImport key/#X-Amz-Target=PaymentCryptographyControlPlane.ImportKeyImports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography. Amazon Web Services Payment…
  • POSTList tags for resource/#X-Amz-Target=PaymentCryptographyControlPlane.ListTagsForResourceLists the tags for an Amazon Web Services resource. This is a paginated operation, which means that each response might contain only a subset of all the tags.…
  • POSTPut resource policy/#X-Amz-Target=PaymentCryptographyControlPlane.PutResourcePolicyAttaches or replaces a resource-based policy on an Amazon Web Services Payment Cryptography key. A resource-based policy can grant cross-account access to…
  • POSTTag resource/#X-Amz-Target=PaymentCryptographyControlPlane.TagResourceAdds or edits tags on an Amazon Web Services Payment Cryptography key. Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny…
  • POSTUntag resource/#X-Amz-Target=PaymentCryptographyControlPlane.UntagResourceDeletes a tag from an Amazon Web Services Payment Cryptography key. Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny…

API details

Base URL
https://controlplane.payment-cryptography.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
32 operations on 32 pathsPOST 32
Main resources
Key 9Alias 5
Description format
AWS Smithy model, API version 2021-09-14

How to test the Payment Cryptography Control Plane in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Payment Cryptography Control Plane collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add key replication regions” (POST /#X-Amz-Target=PaymentCryptographyControlPlane.AddKeyReplicationRegions), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Payment Cryptography Control Plane?

Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create,… It is listed under Payments and has 32 endpoints.

Who publishes the Payment Cryptography Control Plane?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Payment Cryptography Control Plane?

Requests go to https://controlplane.payment-cryptography.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Payment Cryptography Control Plane?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Payment Cryptography Control Plane have?

32 operations on 32 paths (32 POST). The largest groups are Key, Alias.

Is forking the Payment Cryptography Control Plane free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.