From c3b6cb780e17cbeccc3bb50b86506f3d4bcf4272 Mon Sep 17 00:00:00 2001 From: AdyenAutomationBot Date: Mon, 19 Jun 2023 11:16:48 +0000 Subject: [PATCH] Update latest definitions files --- postman/CheckoutService-v37.json | 24 ++++++++++++------------ postman/CheckoutService-v40.json | 24 ++++++++++++------------ postman/CheckoutService-v41.json | 22 +++++++++++----------- postman/CheckoutService-v46.json | 22 +++++++++++----------- postman/CheckoutService-v49.json | 22 +++++++++++----------- postman/CheckoutService-v50.json | 22 +++++++++++----------- postman/CheckoutService-v51.json | 22 +++++++++++----------- postman/CheckoutService-v52.json | 22 +++++++++++----------- postman/CheckoutService-v53.json | 22 +++++++++++----------- postman/CheckoutService-v64.json | 22 +++++++++++----------- postman/CheckoutService-v65.json | 22 +++++++++++----------- postman/CheckoutService-v66.json | 22 +++++++++++----------- postman/CheckoutService-v67.json | 32 ++++++++++++++++---------------- postman/CheckoutService-v68.json | 32 ++++++++++++++++---------------- postman/CheckoutService-v69.json | 32 ++++++++++++++++---------------- postman/CheckoutService-v70.json | 30 +++++++++++++++--------------- 16 files changed, 197 insertions(+), 197 deletions(-) diff --git a/postman/CheckoutService-v37.json b/postman/CheckoutService-v37.json index 3cd8026..4e83ead 100644 --- a/postman/CheckoutService-v37.json +++ b/postman/CheckoutService-v37.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -1555,7 +1555,7 @@ "description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. ", "item": [ { - "name": "Submit details for the 3D Secure payment ", + "name": "Submit details for the 3D Secure payment", "request": { "method": "POST", "header": [ diff --git a/postman/CheckoutService-v40.json b/postman/CheckoutService-v40.json index 8dcfca8..c924265 100644 --- a/postman/CheckoutService-v40.json +++ b/postman/CheckoutService-v40.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -1899,7 +1899,7 @@ "description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. ", "item": [ { - "name": "Submit details for the 3D Secure payment ", + "name": "Submit details for the 3D Secure payment", "request": { "method": "POST", "header": [ diff --git a/postman/CheckoutService-v41.json b/postman/CheckoutService-v41.json index 1a1180e..2f9a387 100644 --- a/postman/CheckoutService-v41.json +++ b/postman/CheckoutService-v41.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v46.json b/postman/CheckoutService-v46.json index 1d485e7..1db2a19 100644 --- a/postman/CheckoutService-v46.json +++ b/postman/CheckoutService-v46.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v49.json b/postman/CheckoutService-v49.json index f41b892..6e4735a 100644 --- a/postman/CheckoutService-v49.json +++ b/postman/CheckoutService-v49.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v50.json b/postman/CheckoutService-v50.json index d450db2..4e3c8d2 100644 --- a/postman/CheckoutService-v50.json +++ b/postman/CheckoutService-v50.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v51.json b/postman/CheckoutService-v51.json index 4ad5cf3..bd756c9 100644 --- a/postman/CheckoutService-v51.json +++ b/postman/CheckoutService-v51.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v52.json b/postman/CheckoutService-v52.json index 77687cd..9e8d68b 100644 --- a/postman/CheckoutService-v52.json +++ b/postman/CheckoutService-v52.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v53.json b/postman/CheckoutService-v53.json index c2d3331..b0abf82 100644 --- a/postman/CheckoutService-v53.json +++ b/postman/CheckoutService-v53.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v64.json b/postman/CheckoutService-v64.json index acd18c3..a36416c 100644 --- a/postman/CheckoutService-v64.json +++ b/postman/CheckoutService-v64.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v65.json b/postman/CheckoutService-v65.json index 5ecffaa..02d16ca 100644 --- a/postman/CheckoutService-v65.json +++ b/postman/CheckoutService-v65.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v66.json b/postman/CheckoutService-v66.json index 7521853..4a9b629 100644 --- a/postman/CheckoutService-v66.json +++ b/postman/CheckoutService-v66.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v67.json b/postman/CheckoutService-v67.json index 4304f0b..b0a3512 100644 --- a/postman/CheckoutService-v67.json +++ b/postman/CheckoutService-v67.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -1912,7 +1912,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAcocount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", "options": { "raw": { "language": "json" @@ -1985,7 +1985,7 @@ "description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. ", "item": [ { - "name": "Submit 3D Secure 2 authentication result", + "name": "Submit the redirect result", "request": { "method": "POST", "header": [ @@ -2004,7 +2004,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", "options": { "raw": { "language": "json" @@ -2029,7 +2029,7 @@ } }, { - "name": "Submit the redirect result", + "name": "Submit 3D Secure 2 authentication result", "request": { "method": "POST", "header": [ @@ -2048,7 +2048,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v68.json b/postman/CheckoutService-v68.json index b896495..eea1537 100644 --- a/postman/CheckoutService-v68.json +++ b/postman/CheckoutService-v68.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -1912,7 +1912,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAcocount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", "options": { "raw": { "language": "json" @@ -1985,7 +1985,7 @@ "description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. ", "item": [ { - "name": "Submit 3D Secure 2 authentication result", + "name": "Submit the redirect result", "request": { "method": "POST", "header": [ @@ -2004,7 +2004,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", "options": { "raw": { "language": "json" @@ -2029,7 +2029,7 @@ } }, { - "name": "Submit the redirect result", + "name": "Submit 3D Secure 2 authentication result", "request": { "method": "POST", "header": [ @@ -2048,7 +2048,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v69.json b/postman/CheckoutService-v69.json index 8ae9138..75b32e5 100644 --- a/postman/CheckoutService-v69.json +++ b/postman/CheckoutService-v69.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -1912,7 +1912,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAcocount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", + "raw": "{\n \"paymentMethod\" : {\n \"type\" : \"scheme\",\n \"number\" : \"4111111111111111\",\n \"cvc\" : \"737\",\n \"expiryMonth\" : \"03\",\n \"expiryYear\" : \"2030\",\n \"holderName\" : \"John Smith\"\n },\n \"amount\" : {\n \"value\" : 40000,\n \"currency\" : \"USD\"\n },\n \"reference\" : \"{{$guid}}\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\" : \"https://your-company.com/...\",\n \"platformChargebackLogic\" : {\n \"behavior\" : \"deductFromOneBalanceAccount\",\n \"targetAccount\" : \"BA00000000000000000000001\"\n },\n \"splits\" : [ {\n \"amount\" : {\n \"value\" : 39600\n },\n \"type\" : \"BalanceAccount\",\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the sale amount\",\n \"description\" : \"Your description for the sale amount\"\n }, {\n \"amount\" : {\n \"value\" : 400\n },\n \"type\" : \"Commission\",\n \"reference\" : \"Your reference for the commission\",\n \"description\" : \"Your description for the commission\"\n }, {\n \"account\" : \"BA00000000000000000000001\",\n \"reference\" : \"Your reference for the fees\",\n \"description\" : \"Your description for the fees\",\n \"type\" : \"PaymentFee\"\n } ]\n}", "options": { "raw": { "language": "json" @@ -1985,7 +1985,7 @@ "description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. ", "item": [ { - "name": "Submit 3D Secure 2 authentication result", + "name": "Submit the redirect result", "request": { "method": "POST", "header": [ @@ -2004,7 +2004,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", "options": { "raw": { "language": "json" @@ -2029,7 +2029,7 @@ } }, { - "name": "Submit the redirect result", + "name": "Submit 3D Secure 2 authentication result", "request": { "method": "POST", "header": [ @@ -2048,7 +2048,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", "options": { "raw": { "language": "json" diff --git a/postman/CheckoutService-v70.json b/postman/CheckoutService-v70.json index 66f9c49..c072d8c 100644 --- a/postman/CheckoutService-v70.json +++ b/postman/CheckoutService-v70.json @@ -17,7 +17,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel a payment using your own reference", "request": { "method": "POST", "header": [ @@ -36,7 +36,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"paymentReference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -66,7 +66,7 @@ "description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "item": [ { - "name": "Update an authorised amount", + "name": "Update the amount of an authorised payment", "request": { "method": "POST", "header": [ @@ -85,7 +85,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"industryUsage\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reason\" : \"delayedCharge\",\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\"\n}", "options": { "raw": { "language": "json" @@ -122,7 +122,7 @@ "description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "item": [ { - "name": "Cancel an authorised payment", + "name": "Cancel payment using a PSP reference", "request": { "method": "POST", "header": [ @@ -141,7 +141,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -197,7 +197,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\" : {\n \"value\" : 2000,\n \"currency\" : \"EUR\"\n }\n}", "options": { "raw": { "language": "json" @@ -234,7 +234,7 @@ "description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "item": [ { - "name": "Refund a captured payment", + "name": "Refund a payment", "request": { "method": "POST", "header": [ @@ -253,7 +253,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\n}", + "raw": "{\n \"amount\" : {\n \"currency\" : \"EUR\",\n \"value\" : 2500\n },\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -290,7 +290,7 @@ "description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "item": [ { - "name": "Refund or cancel a payment", + "name": "Reverse (cancel or refund) a payment", "request": { "method": "POST", "header": [ @@ -309,7 +309,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\n}", + "raw": "{\n \"reference\" : \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\" : \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", "options": { "raw": { "language": "json" @@ -2094,7 +2094,7 @@ "description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. ", "item": [ { - "name": "Submit 3D Secure 2 authentication result", + "name": "Submit the redirect result", "request": { "method": "POST", "header": [ @@ -2113,7 +2113,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", + "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", "options": { "raw": { "language": "json" @@ -2138,7 +2138,7 @@ } }, { - "name": "Submit the redirect result", + "name": "Submit 3D Secure 2 authentication result", "request": { "method": "POST", "header": [ @@ -2157,7 +2157,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"details\" : {\n \"redirectResult\" : \"X6XtfGC3!Y...\"\n }\n}", + "raw": "{\n \"details\" : {\n \"threeDSResult\" : \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n }\n}", "options": { "raw": { "language": "json"