AI-generated Key Takeaways
-
This revision history documents all significant changes made to the One Time Payment Code APIs, including new features, updates, and bug fixes.
-
Each entry includes the date of the change, the API version affected, a description of the change, and the specific APIs impacted.
-
API versions range from v1.0.0 to v1.0.11, with the most recent update introducing the
inquiryNotificationAPI for refundable one-time payment codes. -
Updates have been made to various aspects of the APIs, such as refund functionality, legal address requirements, remittance statement details, and network identifiers.
-
The documentation has also been improved with standalone sites and updates to field comments and base paths.
One Time Payment Code v1 Specification Revision History
This is a revision history noting significant changes to the One Time Payment Code APIs.
| Date | API Version | Change Description | APIs Impacted |
|---|---|---|---|
| 2025-09-15 | 1.0.23 | Add PAYMENT_CANCELLED_BY_THE_USER, ENROLLMENT_CANCELLED_BY_THE_USER error code. | CreateMandateResultNotification |
| 2025-09-15 | 1.0.22 | Add MULTIPLE_PAYMENT_IN_PAYMENT_CYCLE error code. | AsynchronousCapture |
| 2025-09-19 | 1.0.21 | Add support for settlement exchange rate modifications. | acceptRemittanceStatementWithModifications |
| 2025-07-29 | 1.0.20 | Add paidAmount field inside the instantPaymentInfo Message. | CreateMandateResultNotification |
| 2025-07-21 | 1.0.19 | Add referenceNumber, paymentTimestamp field in CreateMandateResultNotification Request. | CreateMandateResultNotification |
| 2025-07-15 | 1.0.18 | Clarify documentation of idempotency keys. | AsynchronousCapture, AsynchronousRefund, Refund and RemittanceStatementNotification |
| 2025-07-07 | 1.0.17 | Add Pix end to end ID to the mandate spec. | CreateMandateResultNotification, CaptureResultNotification |
| 2025-07-07 | 1.0.16 | Mark endDate as optional in the spec. | CreateMandateWithOptionalInstantPayment |
| 2025-06-05 | 1.0.15 | Adding support for refunds of Recurring Mandates. Added captureRequestId as a oneof for paymentRequestId field. |
AsynchronousRefund |
| 2025-05-15 | 1.0.14 | Adding support for Recurring Mandates. Added AsynchronousCapture and CaptureResultNotification API. |
AsynchronousCapture, CaptureResultNotification |
| 2025-04-16 | 1.0.13 | Adding support for Recurring Mandates. Added CancelMandate and CreateMandateResultNotification API. |
CancelMandate, CreateMandateResultNotification |
| 2025-04-16 | 1.0.12 | Adding support for Recurring Mandates. Added CreateMandateWithOptionalInstantPayment API. |
createMandateWithOptionalInstantPayment |
| 2024-09-25 | 1.0.11 | Add inquiryNotification to refundable-one-time-payment-code-v1. |
inquiryNotification |
| 2023-08-07 | 1.0.10 | Add asynchronous refund API. | All |
| 2023-07-31 | 1.0.9 | Added amount field to ReferenceNumberPaidNotificationRequest. |
Google-hosted |
| 2022-11-15 | 1.0.8 | Make legal address optional. | Integrator-hosted |
| 2022-11-07 | 1.0.7 | Added total_withholding_taxes field to RemittanceStatementDetailsResponse. |
remittanceStatementDetails |
| 2022-09-27 | 1.0.6 | Add network specific identifier. | All |
| 2021-09-30 | 1.0.5 | Update comment for reference number field. | Google-hosted |
| 2021-09-29 | 1.0.4 | Move base path concept to host string on Overview pages. Add basePath field and drop http scheme from OpenAPI spec files. |
All |
| 2021-09-28 | 1.0.3 | Deduplicate v1 Request and Response headers on ErrorResponse. | All |
| 2021-09-23 | 1.0.2 | Update displayable_reference_number. | Integrator-hosted |
| 2021-09-21 | 1.0.1 | Add displayable_reference_number to GenerateReferenceNumberResponse. | Integrator-hosted |
| 2021-09-07 | 1.0.0 | Create stand-alone documentation site for refundable-one-time-payment-code-v1. | All |