API Changelog - 2026-07-03: Summary
The failed transaction status now returns dedicated response schemas that
include paymentMethod.scheme.responseCode for all operations (payments,
cancels, increments, refunds, and credits) and their webhook notifications. The
succeeded transaction card scheme details are also expanded with the scheme
response code and, for cancel, increment, and refund, the scheme transaction ID.
Visa payment authorizations additionally gain a responseCodeCategory field.
approvalCode has been removed from declined scheme details across these
operations.
POST /v1/payments — Create Payment
The failed status exposes paymentMethod.scheme.responseCode, letting
integrations distinguish gateway failures from soft declines. Visa, Mastercard,
and Maestro succeeded responses also now include
paymentMethod.scheme.responseCode. Visa additionally gains a
responseCodeCategory field.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Response body (failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added to failed response |
| Example | "05" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Response body (succeeded — Visa, Mastercard, Maestro) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added |
| Example | "00" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCodeCategory |
| Location | Response body (succeeded — Visa only) |
| Type | string |
| Required | No (optional) |
| Format | Visa response code category — added |
| Example | "approved" |
POST /v1/payments/{paymentId}/cancels — Cancel Payment
The failed status in the synchronous response now include responseCode and
transactionId. The declined scheme details no longer include approvalCode.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Response body (succeeded and failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added |
| Example | "00" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.transactionId |
| Location | Response body (succeeded) |
| Type | string |
| Required | No (optional) |
| Format | 13–15 character scheme transaction ID — added |
| Example | "MCD74F2350212" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.approvalCode |
| Location | Response body (declined) |
| Type | string |
| Required | — |
| Format | Approval code — removed from declined response |
| Example | — |
POST /v1/payments/{paymentId}/increments — Increment Payment
The failed status in the synchronous response now include responseCode and
transactionId. The declined scheme details no longer include approvalCode.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Response body (succeeded and failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added |
| Example | "00" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.transactionId |
| Location | Response body (succeeded) |
| Type | string |
| Required | No (optional) |
| Format | 13–15 character scheme transaction ID — added |
| Example | "MCD74F2350212" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.approvalCode |
| Location | Response body (declined) |
| Type | string |
| Required | — |
| Format | Approval code — removed from declined response |
| Example | — |
POST /v1/payments/{paymentId}/refunds — Refund Payment
The failed status in the synchronous response now include responseCode and
transactionId. The declined response paymentMethod structure has been
simplified: it no longer uses a card-brand-specific oneOf discriminator and
instead exposes a unified scheme.responseCode field. approvalCode has been
removed from declined scheme details.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Response body (succeeded and failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added |
| Example | "00" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.transactionId |
| Location | Response body (succeeded) |
| Type | string |
| Required | No (optional) |
| Format | 13–15 character scheme transaction ID — added |
| Example | "MCD74F2350212" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.approvalCode |
| Location | Response body (declined) |
| Type | string |
| Required | — |
| Format | Approval code — removed from declined response |
| Example | — |
POST /v1/credits — Create Credit
The failed status in the synchronous response now include responseCode. In
the declined scheme details, approvalCode and transactionId have been
removed.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Response body (succeeded and failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added to succeeded |
| Example | "00" |
| Property | Details |
|---|
| Name | paymentMethod.scheme.approvalCode |
| Location | Response body (declined) |
| Type | string |
| Required | — |
| Format | Approval code — removed from declined response |
| Example | — |
| Property | Details |
|---|
| Name | paymentMethod.scheme.transactionId |
| Location | Response body (declined) |
| Type | string |
| Required | — |
| Format | Transaction ID — removed from declined response |
| Example | — |
Webhook /payment — Payment Notification
The new failed payload includes paymentMethod.scheme.responseCode.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Webhook payload (failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added to failed payload |
| Example | "05" |
Webhook /cancel — Cancel Notification
The new failed payload includes paymentMethod.scheme.responseCode.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Webhook payload (failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added to failed payload |
| Example | "05" |
Webhook /increment — Increment Notification
The new failed payload includes paymentMethod.scheme.responseCode.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Webhook payload (failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added to failed payload |
| Example | "05" |
Webhook /refund — Refund Notification
The new failed payload includes paymentMethod.scheme.responseCode.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Webhook payload (failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added to failed payload |
| Example | "05" |
Webhook /credit — Credit Notification
The new failed payload includes paymentMethod.scheme.responseCode.
| Property | Details |
|---|
| Name | paymentMethod.scheme.responseCode |
| Location | Webhook payload (failed) |
| Type | string |
| Required | No (optional) |
| Format | Scheme response code — added to failed payload |
| Example | "05" |