The Merchant Approve Transaction request lets you approve or decline transactions with invoice status of PENDING_MERCHANT_REVIEW.
Important
The API Explorer Try It! feature does not currently send XML requests to our sandbox environment.
For request and response examples, refer to the Examples section.
Request Content
The request must include either the transactionid
or merchanttransactionid
.
For example:
services/2/transactions/approval?transactionid=38612140&approvetransaction=true
OR
services/2/transactions/approval?merchanttransactionid=MyUniqueMTI&approvetransaction=true
Note: If approvetransaction
is not included, true
is assumed.
Response Details
If successful, the response HTTP status code is 200 OK
and will include the following parameters:
Possible Responses
Case | Examples |
---|---|
Approve | |
- Auth Only (with amount > 0) | with transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <transaction-id>38611602</transaction-id> <transaction-status>Waiting</transaction-status> </merchant-approval> with merchant-transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <transaction-id>38611602</transaction-id> <transaction-status>Waiting</transaction-status> <merchant-transaction-id>MerchantTransactionID122222</merchant-transaction-id> </merchant-approval> |
Auth Only (with amount = 0) Auth Capture Create PayPal Transaction Create Local Bank Transfer Transaction | with transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <transaction-id>38611602</transaction-id> <transaction-status>Approved</transaction-status> </merchant-approval> with merchant-transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <transaction-id>38611602</transaction-id> <transaction-status>Approved</transaction-status> <merchant-transaction-id>MerchantTransactionID122222</merchant-transaction-id> </merchant-approval> |
Create Subscription Create Merchant-Managed Subscription | with transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <subscription-id>39606170</subscription-id> <transaction-id>38611602</transaction-id> <transaction-status>Approved</transaction-status> </merchant-approval> with merchant-transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <subscription-id>39606170</subscription-id> <transaction-id>38611602</transaction-id> <transaction-status>Approved</transaction-status> <merchant-transaction-id>MerchantTransactionID122222</merchant-transaction-id> </merchant-approval> |
Decline | |
- Create Local Bank Transfer Transaction | with transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <transaction-id>38611602</transaction-id> <transaction-status>Short OrderContext Declined By Vendor (Refund Needed)</transaction-status> </merchant-approval> with merchant-transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <transaction-id>38611602</transaction-id> <transaction-status>Short OrderContext Declined By Vendor (Refund Needed)</transaction-status> <merchant-transaction-id>MerchantTransactionID122222</merchant-transaction-id> </merchant-approval> |
- all others | with transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <transaction-id>38611602</transaction-id> <transaction-status>Canceled</transaction-status> </merchant-approval> with merchant-transaction-id xml <merchant-approval xmlns="http://ws.plimus.com"> <transaction-id>38611602</transaction-id> <transaction-status>Canceled</transaction-status> <merchant-transaction-id>MerchantTransactionID122222</merchant-transaction-id> </merchant-approval> |
Examples
Request Example
curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions/approval?transactionid=38612140&approvetransaction=true \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions/approval?transactionid=38612140&approvetransaction=false \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
Response Examples
<merchant-approval xmlns="http://ws.plimus.com">
<transaction-id>38611602</transaction-id>
<transaction-status>Approved</transaction-status>
</merchant-approval>
<merchant-approval xmlns="http://ws.plimus.com">
<transaction-id>38611602</transaction-id>
<transaction-status>Approved</transaction-status>
<merchant-transaction-id>MerchantTransactionID122222</merchant-transaction-id>
</merchant-approval>
API Explorer
To test a call, enter an existing transaction ID in the transaction-id
field. This automatically inserts the ID into the request URL.