{"_id":"5c6c23e4735b81006177d08b","category":{"_id":"5c6c23e4735b81006177d008","version":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-13T18:31:11.123Z","from_sync":false,"order":2,"slug":"paypal-transaction-service","title":"PayPal Transactions"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-19T13:49:38.827Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"language":"text","code":""}]},"settings":"57ee593a21ceb20e0061959e","auth":"optional","params":[],"url":"/alt-transactions"},"isReference":true,"order":1,"body":"The Update PayPal Transaction is applicable for the Split-Step and Delayed Capture PayPal flows. After the Create PayPal Transaction, this step can be used to update the amount, create a pending order or complete the transaction and capture the funds\n\n[block:callout]\n{\n \"type\": \"success\",\n \"title\": \"Getting started with PayPal in BlueSnap\",\n \"body\": \"Go to the [PayPal Guide](doc:paypal) for a walkthrough of implementing the PayPal payment method via the API. To use PayPal, you will need to first connect your PayPal and BlueSnap account, as described in the guide.\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n\nSend an **[altTransaction](doc:alt-transaction)** object, with the following:\n\n `amount` *decimal* <span style=\"color:#F37500\">**required**</span>\n\n `payerInfo` *object* optional (see [payerInfo](doc:payer-info))\n\n `vaultedShopperId` *integer* optional\n\n `merchantTransactionId` *string* optional\n\n `softDescriptor` *string* optional\n\n `transactionDescription` *string* optional\n\n `currency` *string* <span style=\"color:#F37500\">**required**</span>\n\n `transactionMetaData` *object* optional (see [transactionMetaData](doc:transaction-meta-data))\n\n `transactionFraudInfo` *object* optional (see [transactionFraudInfo](doc:transaction-fraud-info))\n\n `paypalTransaction` *object* <span style=\"color:#F37500\">**required**</span> (see [paypalTransaction](doc:paypal-transaction))\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the request properties plus these additions:\n\n `vaultedShopperId`\n\n `paypalTransaction` is returned with the `paypalUrl` and `orderId` (see [paypalTransaction](doc:paypal-transaction))\n\n `processingInfo`\n\n `fraudResultInfo`\n\n<hr>\n\n##Examples \n\n###Request Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": \\\"105.00\\\",\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"paypalTransaction\\\": {\\n \\\"orderId\\\": \\\"4006145\\\",\\n \\\"transactionType\\\": \\\"CAPTURE\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Update PayPal Transaction for two-step flow (Capture)\"\n },\n {\n \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": \\\"105.00\\\",\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"paypalTransaction\\\": {\\n \\\"orderId\\\": \\\"4006145\\\",\\n \\\"transactionType\\\": \\\"DO_ORDER\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Update PayPal Transaction for three-step flow (Pending Order)\"\n },\n {\n \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n \\\"amount\\\": \\\"104.00\\\",\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"paypalTransaction\\\": {\\n \\\"orderId\\\": \\\"4006145\\\",\\n \\\"transactionType\\\": \\\"CAPTURE\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Update PayPal Transaction for three-step flow (Complete Order)\"\n }\n ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"transactionId\\\": \\\"38526326\\\",\\n \\\"amount\\\": \\\"105.00\\\",\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"vaultedShopperId\\\": \\\"19587618\\\",\\n \\\"paypalTransaction\\\": { \\\"orderId\\\": \\\"4006145\\\" },\\n \\\"processingInfo\\\": { \\\"processingStatus\\\": \\\"SUCCESS\\\" }\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"200 OK - two-step flow (Capture)\"\n },\n {\n \"code\": \"{\\n \\\"merchantTransactionId\\\": \\\"A3bn43\\\",\\n \\\"transactionId\\\": \\\"38526326\\\",\\n \\\"amount\\\": \\\"105.00\\\",\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"vaultedShopperId\\\": \\\"19587618\\\",\\n \\\"paypalTransaction\\\": { \\\"orderId\\\": \\\"4006145\\\" },\\n \\\"processingInfo\\\": { \\\"processingStatus\\\": \\\"SUCCESS\\\" }\\n}\",\n \"language\": \"json\",\n \"name\": \"200 OK - three-step flow (Pending Order)\"\n },\n {\n \"code\": \"{\\n \\\"merchantTransactionId\\\": \\\"A3bn43\\\",\\n \\\"transactionId\\\": \\\"38526326\\\",\\n \\\"amount\\\": \\\"104.00\\\",\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"vaultedShopperId\\\": \\\"19587618\\\",\\n \\\"paypalTransaction\\\": { \\\"orderId\\\": \\\"4006145\\\" },\\n \\\"processingInfo\\\": { \\\"processingStatus\\\": \\\"SUCCESS\\\" }\\n}\",\n \"language\": \"json\",\n \"name\": \"200 OK - three-step flow (Complete Order)\"\n }\n ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n##Example Descriptions\nFor details about the above examples, see:\n * [Update PayPal Transaction two-step](#section-update-paypal-transaction-two-step)\n * [Update PayPal Transaction three-step](#section-update-paypal-transaction-three-step)\n\n\n\n###Update PayPal Transaction two-step\nThis example shows an Update PayPal Transaction two-step request.\n\n###Update PayPal Transaction three-step\nThis example shows an Update PayPal Transaction two-step request.\n\n\n\n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter the request content below and then click **Try it!**\n\n**Tip**: Use the JSON code below as a starting point. You can enter different parameters to see how your test scenario would work. *The request headers, including authorization, are already built in for you in this test area, so you should not include them here.*\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"amount\\\": \\\"105.00\\\",\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"paypalTransaction\\\": {\\n \\\"orderId\\\": \\\"7078033\\\",\\n \\\"transactionType\\\": \\\"DO_ORDER\\\"\\n }\\n}\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]","excerpt":"","slug":"update-paypal-transaction","type":"endpoint","title":"Update PayPal Transaction"}putUpdate PayPal Transaction
Definition
{{ api_url }}{{ page_api_url }}
Documentation
The Update PayPal Transaction is applicable for the Split-Step and Delayed Capture PayPal flows. After the Create PayPal Transaction, this step can be used to update the amount, create a pending order or complete the transaction and capture the funds
Getting started with PayPal in BlueSnap
Go to the PayPal Guide for a walkthrough of implementing the PayPal payment method via the API. To use PayPal, you will need to first connect your PayPal and BlueSnap account, as described in the guide.
Request Content
Send an altTransaction object, with the following:
amount decimal required
payerInfo object optional (see payerInfo)
vaultedShopperId integer optional
merchantTransactionId string optional
softDescriptor string optional
transactionDescription string optional
currency string required
transactionMetaData object optional (see transactionMetaData)
transactionFraudInfo object optional (see transactionFraudInfo)
paypalTransaction object required (see paypalTransaction)
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the request properties plus these additions:
vaultedShopperId
paypalTransaction is returned with the paypalUrl and orderId (see paypalTransaction)
processingInfo
fraudResultInfo
Examples
Request Examples
curl -v -X PUT https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": "105.00",
"currency": "USD",
"paypalTransaction": {
"orderId": "4006145",
"transactionType": "CAPTURE"
}
}curl -v -X PUT https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": "105.00",
"currency": "USD",
"paypalTransaction": {
"orderId": "4006145",
"transactionType": "DO_ORDER"
}
}curl -v -X PUT https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": "104.00",
"currency": "USD",
"paypalTransaction": {
"orderId": "4006145",
"transactionType": "CAPTURE"
}
}{
"transactionId": "38526326",
"amount": "105.00",
"currency": "USD",
"vaultedShopperId": "19587618",
"paypalTransaction": { "orderId": "4006145" },
"processingInfo": { "processingStatus": "SUCCESS" }
}
}{
"merchantTransactionId": "A3bn43",
"transactionId": "38526326",
"amount": "105.00",
"currency": "USD",
"vaultedShopperId": "19587618",
"paypalTransaction": { "orderId": "4006145" },
"processingInfo": { "processingStatus": "SUCCESS" }
}{
"merchantTransactionId": "A3bn43",
"transactionId": "38526326",
"amount": "104.00",
"currency": "USD",
"vaultedShopperId": "19587618",
"paypalTransaction": { "orderId": "4006145" },
"processingInfo": { "processingStatus": "SUCCESS" }
}Example Descriptions
For details about the above examples, see:
Update PayPal Transaction two-step
This example shows an Update PayPal Transaction two-step request.
Update PayPal Transaction three-step
This example shows an Update PayPal Transaction two-step request.
API Explorer
To test out a call, enter the request content below and then click Try it!
Tip: Use the JSON code below as a starting point. You can enter different parameters to see how your test scenario would work. The request headers, including authorization, are already built in for you in this test area, so you should not include them here.
{
"amount": "105.00",
"currency": "USD",
"paypalTransaction": {
"orderId": "7078033",
"transactionType": "DO_ORDER"
}
}