Stay organized with collections
Save and categorize content based on your preferences.
In this section, we explain how to establish connectivity and provide details
on the API design patterns and security model.
API communication details
Communication with the One Time Payment Code API involves transport layer and
application layer security. The transport layer
uses TLS to secure HTTP requests (HTTPS) and the
application layer uses
either PGP or
JWE encryption.
In addition, our Protocol standards to find details on
our API design patterns and strategy for maintaining a robust connection with
partners.
Key exchanges
Encryption keys need to be rotated before they expire or if they are
compromised. As part of your implementation, you need to have a process for
managing these exchanges.
To ensure key rotations do not cause temporary outages or require significant
management overhead, One Time Payment Code partners must support the use
of multiple encryption keys at once. During a key rotation, a second key will
be trusted and verified to be working correctly before the old key is removed.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["\u003cp\u003eThis section outlines how to establish a secure connection with the One Time Payment Code API, covering transport and application layer security using TLS and either PGP or JWE encryption respectively.\u003c/p\u003e\n"],["\u003cp\u003eIt provides guidance on API design patterns and maintaining robust connections through documented protocol standards.\u003c/p\u003e\n"],["\u003cp\u003eEncryption key rotation is crucial for security, and partners must implement a process to manage these exchanges and support the use of multiple keys concurrently to prevent service disruptions.\u003c/p\u003e\n"],["\u003cp\u003eFailure to support multiple encryption keys during rotation is a critical issue that must be addressed before launch.\u003c/p\u003e\n"]]],["The API uses TLS for transport layer security (HTTPS) and PGP or JWE for application layer security. Partners must adhere to protocol standards for API design patterns and robust connections. Encryption key rotation is mandatory, requiring support for multiple active keys simultaneously to prevent outages. A second key must be verified before the old key is removed; failing this verification is a launch-blocking issue.\n"],null,["# Overview\n\nIn this section, we explain how to establish connectivity and provide details\non the API design patterns and security model.\n\nAPI communication details\n-------------------------\n\nCommunication with the One Time Payment Code API involves transport layer and\napplication layer security. The [transport layer](/pay/refundable-one-time-payment-code-v2/guides/connectivity/security/transport-layer)\nuses TLS to secure HTTP requests (HTTPS) and the\n[application layer](/pay/refundable-one-time-payment-code-v2/guides/connectivity/security/application-layer) uses\n\neither [PGP](/pay/refundable-one-time-payment-code-v2/guides/connectivity/security/application-layer#pgp_encryption) or\n[JWE](/pay/refundable-one-time-payment-code-v2/guides/connectivity/security/application-layer#jwe_encryption) encryption.\n\nIn addition, our [Protocol standards](/pay/refundable-one-time-payment-code-v2/guides/connectivity/protocol-standards) to find details on\nour API design patterns and strategy for maintaining a robust connection with\npartners.\n\nKey exchanges\n-------------\n\nEncryption keys need to be rotated before they expire or if they are\ncompromised. As part of your implementation, you need to have a process for\nmanaging these exchanges.\n\nTo ensure key rotations do not cause temporary outages or require significant\nmanagement overhead, One Time Payment Code partners **must** support the use\nof multiple encryption keys at once. During a key rotation, a second key will\nbe trusted and verified to be working correctly before the old key is removed.\n| **Warning:** If support for multiple keys is not verified, it will be considered a launch blocking bug until it is resolved."]]