mirror of
https://github.com/gcatanese/adyen-postman.git
synced 2026-03-10 08:01:18 +00:00
Update latest definitions files
This commit is contained in:
AdyenAutomationBot
committed by
github-actions[bot]
github-actions[bot]
parent
07cd638eb7
commit
0fa86b3129
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1855,7 +1855,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1880,7 +1880,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -1904,6 +1904,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2136,6 +2524,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2150,7 +2652,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2088,7 +2476,7 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).",
|
||||
"item": [
|
||||
{
|
||||
"name": "Start a donation transaction",
|
||||
"name": "Make a donation",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2145,7 +2533,7 @@
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"status\": \"completed\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"payment\": {\n \"pspReference\": \"8535762347980628\",\n \"resultCode\": \"Authorised\",\n \"additionalData\": {\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n}\n}\n}",
|
||||
"body" : "{\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"status\": \"completed\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"payment\": {\n \"pspReference\": \"8535762347980628\",\n \"resultCode\": \"Authorised\",\n \"additionalData\": {\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n}\n}\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2196,7 +2584,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Start a donation transaction with a token",
|
||||
"name": "Make a donation with a token",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2088,7 +2476,7 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).",
|
||||
"item": [
|
||||
{
|
||||
"name": "Start a donation transaction",
|
||||
"name": "Make a donation",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2145,7 +2533,7 @@
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"status\": \"completed\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"payment\": {\n \"pspReference\": \"8535762347980628\",\n \"resultCode\": \"Authorised\",\n \"additionalData\": {\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n}\n}\n}",
|
||||
"body" : "{\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"status\": \"completed\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"payment\": {\n \"pspReference\": \"8535762347980628\",\n \"resultCode\": \"Authorised\",\n \"additionalData\": {\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n}\n}\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2196,7 +2584,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Start a donation transaction with a token",
|
||||
"name": "Make a donation with a token",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2088,7 +2476,7 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).",
|
||||
"item": [
|
||||
{
|
||||
"name": "Start a donation transaction",
|
||||
"name": "Make a donation",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2145,7 +2533,7 @@
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"status\": \"completed\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"payment\": {\n \"pspReference\": \"8535762347980628\",\n \"resultCode\": \"Authorised\",\n \"additionalData\": {\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n}\n}\n}",
|
||||
"body" : "{\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"status\": \"completed\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"payment\": {\n \"pspReference\": \"8535762347980628\",\n \"resultCode\": \"Authorised\",\n \"additionalData\": {\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n}\n}\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2196,7 +2584,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Start a donation transaction with a token",
|
||||
"name": "Make a donation with a token",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2632,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2760,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,21 +2012,68 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Recurring",
|
||||
"item": [
|
||||
{
|
||||
"name": "/storedPaymentMethods",
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.",
|
||||
"item": [
|
||||
},
|
||||
{
|
||||
"name": "Create a token to store payment details",
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2051,7 +2098,348 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"shopperEmail\": \"<string>\",\n \"shopperIP\": \"<string>\",\n \"shopperReference\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Recurring",
|
||||
"item": [
|
||||
{
|
||||
"name": "/storedPaymentMethods",
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Store encrypted card details for subscription payments",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2074,6 +2462,171 @@
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
"code": 201,
|
||||
"status": "Created",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"id\": \"KHQC5N7G84BLNK43\",\n \"lastFour\": \"1111\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"type\": \"scheme\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Store encrypted card details for subscription payments",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"cvc\": \"737\",\n \"holderName\": \"John Smith\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
"code": 201,
|
||||
"status": "Created",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"id\": \"KHQC5N7G84BLNK43\",\n \"lastFour\": \"1111\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"type\": \"scheme\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"cvc\": \"737\",\n \"holderName\": \"John Smith\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2797,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2925,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,21 +2012,68 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Recurring",
|
||||
"item": [
|
||||
{
|
||||
"name": "/storedPaymentMethods",
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.",
|
||||
"item": [
|
||||
},
|
||||
{
|
||||
"name": "Create a token to store payment details",
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2051,7 +2098,348 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"shopperEmail\": \"<string>\",\n \"shopperIP\": \"<string>\",\n \"shopperReference\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Recurring",
|
||||
"item": [
|
||||
{
|
||||
"name": "/storedPaymentMethods",
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Store encrypted card details for subscription payments",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2074,6 +2462,171 @@
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
"code": 201,
|
||||
"status": "Created",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"id\": \"KHQC5N7G84BLNK43\",\n \"lastFour\": \"1111\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"type\": \"scheme\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Store encrypted card details for subscription payments",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"cvc\": \"737\",\n \"holderName\": \"John Smith\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
"code": 201,
|
||||
"status": "Created",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"id\": \"KHQC5N7G84BLNK43\",\n \"lastFour\": \"1111\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"type\": \"scheme\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"cvc\": \"737\",\n \"holderName\": \"John Smith\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2244,6 +2797,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2258,7 +2925,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2083,7 +2471,7 @@
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Create a token to store payment details",
|
||||
"name": "Store encrypted card details for subscription payments",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2108,7 +2496,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"recurringProcessingModel\": \"<string>\",\n \"shopperEmail\": \"<string>\",\n \"shopperIP\": \"<string>\",\n \"shopperReference\": \"<string>\"\n}",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"recurringProcessingModel\": \"Subscription\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2131,6 +2519,171 @@
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
"code": 201,
|
||||
"status": "Created",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"id\": \"KHQC5N7G84BLNK43\",\n \"lastFour\": \"1111\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"type\": \"scheme\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"recurringProcessingModel\": \"Subscription\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Store encrypted card details for subscription payments",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"cvc\": \"737\",\n \"holderName\": \"John Smith\"\n},\n \"recurringProcessingModel\": \"Subscription\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
"code": 201,
|
||||
"status": "Created",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"id\": \"KHQC5N7G84BLNK43\",\n \"lastFour\": \"1111\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"type\": \"scheme\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"cvc\": \"737\",\n \"holderName\": \"John Smith\"\n},\n \"recurringProcessingModel\": \"Subscription\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2358,6 +2911,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2372,7 +3039,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -3023,6 +3690,63 @@
|
||||
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"resultCode\": \"IdentifyShopper\",\n \"action\": {\n \"paymentData\": \"Ab02b4c0!BQABAgCuZFJrQOjSsl\/zt+...\",\n \"paymentMethodType\": \"scheme\",\n \"authorisationToken\": \"Ab02b4c0!BQABAgAvrX03p...\",\n \"subtype\": \"fingerprint\",\n \"token\": \"eyJ0aHJlZURTTWV0aG9kTm90aWZpY...\",\n \"type\": \"threeDS2\"\n}\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"authenticationData\": {\n \"threeDSRequestData\": {\n \"nativeThreeDS\": \"preferred\"\n}\n},\n \"billingAddress\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"street\": \"Redwood Block\",\n \"houseNumberOrName\": \"37C\",\n \"stateOrProvince\": \"NY\",\n \"postalCode\": \"10039\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\",\n \"browserInfo\": {\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\": \"nl-NL\",\n \"colorDepth\": 24,\n \"screenHeight\": 723,\n \"screenWidth\": 1536,\n \"timeZoneOffset\": 0,\n \"javaEnabled\": true\n},\n \"channel\": \"Web\",\n \"origin\": \"https://your-company.com\",\n \"returnUrl\": \"https://your-company.com/checkout/\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/payments",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"payments"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -3074,6 +3798,63 @@
|
||||
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"additionalData\": {\n \"cardSummary\": \"5454\",\n \"threeds2.threeDS2ResponseData.messageVersion\": \"2.1.0\",\n \"threeds2.threeDS2Token\": \"R5CZ2NWPJTGV9D82...\",\n \"threeds2.threeDSServerTransID\": \"8835538461311270...\",\n \"cardBin\": \"545454\",\n \"threeds2.cardEnrolled\": \"true\",\n \"paymentMethod\": \"mc\",\n \"cardPaymentMethod\": \"mc\",\n \"fundingSource\": \"CREDIT\",\n \"merchantReference\": \"Your order number\",\n \"issuerBin\": \"54545454\",\n \"threeds2.threeDSMethodURL\": \"https://pal-test.adyen.com/threeds2simulator/acs/startMethod.shtml\",\n \"cardIssuingCountry\": \"PL\"\n},\n \"pspReference\": \"JLCMPCQ8HXSKGK82\",\n \"resultCode\": \"RedirectShopper\",\n \"action\": {\n \"paymentMethodType\": \"scheme\",\n \"url\": \"https://checkoutshopper-test.adyen.com/checkoutshopper/threeDS/redirect...\",\n \"method\": \"GET\",\n \"type\": \"redirect\"\n}\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4212345678901237\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"browserInfo\": {\n \"userAgent\": \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\": \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\": true,\n \"colorDepth\": 10,\n \"screenHeight\": 2000,\n \"screenWidth\": 3000,\n \"timeZoneOffset\": 5,\n \"language\": \"en\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/payments",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"payments"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
},
|
||||
{
|
||||
"name": "/payments/:paymentPspReference/cancels",
|
||||
"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).",
|
||||
"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 payment using a PSP reference",
|
||||
@@ -311,7 +311,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
@@ -375,7 +375,7 @@
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"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)."
|
||||
"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)."
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -1963,7 +1963,7 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Updates the order for PayPal Express Checkout",
|
||||
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -1988,7 +1988,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": \"<string>\",\n \"deliveryMethods\": \"<string>\",\n \"paymentData\": \"<string>\",\n \"pspReference\": \"<string>\",\n \"sessionId\": \"<string>\"\n}",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2012,6 +2012,394 @@
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in an Advanced flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Update a PayPal order in a Sessions flow integration",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/paypal/updateOrder",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"paypal",
|
||||
"updateOrder"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2083,7 +2471,7 @@
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.",
|
||||
"item": [
|
||||
{
|
||||
"name": "Create a token to store payment details",
|
||||
"name": "Store encrypted card details for subscription payments",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -2108,7 +2496,7 @@
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"recurringProcessingModel\": \"<string>\",\n \"shopperEmail\": \"<string>\",\n \"shopperIP\": \"<string>\",\n \"shopperReference\": \"<string>\"\n}",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"recurringProcessingModel\": \"Subscription\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
@@ -2131,6 +2519,171 @@
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
"code": 201,
|
||||
"status": "Created",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"id\": \"KHQC5N7G84BLNK43\",\n \"lastFour\": \"1111\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"type\": \"scheme\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"recurringProcessingModel\": \"Subscription\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Store encrypted card details for subscription payments",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"cvc\": \"737\",\n \"holderName\": \"John Smith\"\n},\n \"recurringProcessingModel\": \"Subscription\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
|
||||
"code": 201,
|
||||
"status": "Created",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"id\": \"KHQC5N7G84BLNK43\",\n \"lastFour\": \"1111\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"type\": \"scheme\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"cvc\": \"737\",\n \"holderName\": \"John Smith\"\n},\n \"recurringProcessingModel\": \"Subscription\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/storedPaymentMethods",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"storedPaymentMethods"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2358,6 +2911,120 @@
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
},
|
||||
{"name": "Unprocessable Entity - a request validation error.",
|
||||
"code": 422,
|
||||
"status": "Unprocessable Entity",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/donations",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"donations"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2372,7 +3039,7 @@
|
||||
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get a list of brands on a card",
|
||||
"name": "Get a list of brands on a card with the unencrypted card number",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
@@ -3023,6 +3690,63 @@
|
||||
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"resultCode\": \"IdentifyShopper\",\n \"action\": {\n \"paymentData\": \"Ab02b4c0!BQABAgCuZFJrQOjSsl\/zt+...\",\n \"paymentMethodType\": \"scheme\",\n \"authorisationToken\": \"Ab02b4c0!BQABAgAvrX03p...\",\n \"subtype\": \"fingerprint\",\n \"token\": \"eyJ0aHJlZURTTWV0aG9kTm90aWZpY...\",\n \"type\": \"threeDS2\"\n}\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"authenticationData\": {\n \"threeDSRequestData\": {\n \"nativeThreeDS\": \"preferred\"\n}\n},\n \"billingAddress\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"street\": \"Redwood Block\",\n \"houseNumberOrName\": \"37C\",\n \"stateOrProvince\": \"NY\",\n \"postalCode\": \"10039\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\",\n \"browserInfo\": {\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\": \"nl-NL\",\n \"colorDepth\": 24,\n \"screenHeight\": 723,\n \"screenWidth\": 1536,\n \"timeZoneOffset\": 0,\n \"javaEnabled\": true\n},\n \"channel\": \"Web\",\n \"origin\": \"https://your-company.com\",\n \"returnUrl\": \"https://your-company.com/checkout/\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/payments",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"payments"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -3074,6 +3798,63 @@
|
||||
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
|
||||
}
|
||||
,"response": [
|
||||
{"name": "OK - the request has succeeded.",
|
||||
"code": 200,
|
||||
"status": "OK",
|
||||
"header": [{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"}
|
||||
],
|
||||
"_postman_previewlanguage": "json",
|
||||
"cookie": [],
|
||||
"body" : "{\n \"additionalData\": {\n \"cardSummary\": \"5454\",\n \"threeds2.threeDS2ResponseData.messageVersion\": \"2.1.0\",\n \"threeds2.threeDS2Token\": \"R5CZ2NWPJTGV9D82...\",\n \"threeds2.threeDSServerTransID\": \"8835538461311270...\",\n \"cardBin\": \"545454\",\n \"threeds2.cardEnrolled\": \"true\",\n \"paymentMethod\": \"mc\",\n \"cardPaymentMethod\": \"mc\",\n \"fundingSource\": \"CREDIT\",\n \"merchantReference\": \"Your order number\",\n \"issuerBin\": \"54545454\",\n \"threeds2.threeDSMethodURL\": \"https://pal-test.adyen.com/threeds2simulator/acs/startMethod.shtml\",\n \"cardIssuingCountry\": \"PL\"\n},\n \"pspReference\": \"JLCMPCQ8HXSKGK82\",\n \"resultCode\": \"RedirectShopper\",\n \"action\": {\n \"paymentMethodType\": \"scheme\",\n \"url\": \"https://checkoutshopper-test.adyen.com/checkoutshopper/threeDS/redirect...\",\n \"method\": \"GET\",\n \"type\": \"redirect\"\n}\n}",
|
||||
"originalRequest": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Accept",
|
||||
"value": "application/json",
|
||||
"description": "",
|
||||
"disabled": false
|
||||
},
|
||||
{
|
||||
"key": "Idempotency-Key",
|
||||
"value": "",
|
||||
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
|
||||
"disabled": true
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4212345678901237\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"browserInfo\": {\n \"userAgent\": \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\": \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\": true,\n \"colorDepth\": 10,\n \"screenHeight\": 2000,\n \"screenWidth\": 3000,\n \"timeZoneOffset\": 5,\n \"language\": \"en\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
|
||||
"options": {
|
||||
"raw": {
|
||||
"language": "json"
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/payments",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"payments"
|
||||
],
|
||||
"variable": [
|
||||
],
|
||||
"query": [
|
||||
]
|
||||
},
|
||||
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user