SQL Server Requires Chilkat v11.0.0+
SQL Server
Amazon Pay - Close Charge Permission
See more Amazon Pay Examples
Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true.Chilkat SQL Server Downloads
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- Implements the following CURL command:
-- curl "https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId/close" \
-- -X DELETE
-- -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
-- -H "x-amz-pay-date:20201012T235046Z"
-- -d '{
-- "closureReason": "No more charges required",
-- "cancelPendingCharges": false
-- }'
-- Use the following online tool to generate HTTP code from a CURL command
-- Convert a cURL Command to HTTP Source Code
-- Use this online tool to generate code from sample JSON:
-- Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "closureReason": "No more charges required",
-- "cancelPendingCharges": false
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'closureReason', 'No more charges required'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'cancelPendingCharges', 0
DECLARE @sbRequestBody int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
-- Load your Amazon Pay private key.
-- There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
-- or from in-memory strings or bytes.
DECLARE @privKey int
EXEC @hr = sp_OACreate 'Chilkat.PrivateKey', @privKey OUT
EXEC sp_OAMethod @privKey, 'LoadPemFile', @success OUT, 'C:/someDir/myAmazonPayPrivateKey.pem'
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @privKey, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @privKey
RETURN
END
-- Provide your Amazon Pay private key and Public Key ID
-- Use your public key ID here. It must be the one associated with the private key.
-- Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
DECLARE @publicKeyId nvarchar(4000)
SELECT @publicKeyId = 'SANDBOX-AHEGSJCM3L2S637RBGABLAFW'
EXEC sp_OAMethod @http, 'SetAuthPrivateKey', @success OUT, @publicKeyId, @privKey
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @privKey
RETURN
END
-- Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
-- and will also sign the request. Nothing more is needed.
-- Chilkat automatically generates and adds the following headers:
--
-- x-amz-pay-date
-- x-amz-pay-host
-- x-amz-pay-region
-- Authorization
EXEC sp_OASetProperty @http, 'Accept', 'application/json'
-- Use the actual chargePermissionId here:
EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'chargePermissionId', 'P21-1111111-1111111'
-- To use the live system, replace "sandbox" with "live" in the URL passed to HttpSb.
-- Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
DECLARE @resp int
EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT
EXEC sp_OAMethod @http, 'HttpSb', @success OUT, 'DELETE', 'https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close', @sbRequestBody, 'utf-8', 'application/json', @resp
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @privKey
EXEC @hr = sp_OADestroy @resp
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
-- If the status code is not equal to 200, this will display error information.
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode <> 200
BEGIN
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @privKey
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "chargePermissionId": "chargePermission-1",
-- "chargePermissionReferenceId": null,
-- "buyer": {
-- "buyerId": "buyerId",
-- "name": "name-1",
-- "email": "name@amazon.com",
-- "phoneNumber": "800-000-0000",
-- "primeMembershipTypes": null
-- },
-- "releaseEnvironment": "Live",
-- "shippingAddress": { // Null for PayOnly product type
-- "name": "Work",
-- "addressLine1": "440 Terry Ave",
-- "addressLine2": "",
-- "addressLine3": "",
-- "city": "Seattle",
-- "county": "King",
-- "district": "Seattle",
-- "stateOrRegion": "WA",
-- "postalCode": "98121",
-- "countryCode": "US",
-- "phoneNumber": "800-000-0000"
-- },
-- "billingAddress": { // Only available in EU or for PayOnly product type
-- "name": "Work",
-- "addressLine1": "440 Terry Ave",
-- "addressLine2": "",
-- "addressLine3": "",
-- "city": "Seattle",
-- "county": "King",
-- "district": "Seattle",
-- "stateOrRegion": "WA",
-- "postalCode": "98121",
-- "countryCode": "US",
-- "phoneNumber": "800-000-0000"
-- },
-- "paymentPreferences": [
-- {
-- "paymentDescriptor": null
-- }],
-- "statusDetails": {
-- "state": "Closed",
-- "reasons":
-- [{
-- "reasonCode": null,
-- "reasonDescription": null
-- }],
-- "lastUpdatedTimestamp": "20190714T155300Z"
-- },
-- "creationTimestamp": "20190714T155300Z",
-- "expirationTimestamp": "20190715T155300Z",
-- "merchantMetadata":{
-- "merchantReferenceId": "123-77-876",
-- "merchantStoreName": "AmazonTestStoreFront",
-- "noteToBuyer": "merchantNoteForBuyer",
-- "customInformation": "This is custom information"
-- },
-- "platformId": "SPId",
-- "limits": {
-- "amountLimit": {
-- "amount": "14.00",
-- "currencyCode": "USD"
-- },
-- "amountBalance": {
-- "amount": "14.00",
-- "currencyCode": "USD"
-- }
-- },
-- "presentmentCurrency": "USD"
-- }
-- Sample code for parsing the JSON response...
-- Use the following online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON
DECLARE @paymentDescriptor nvarchar(4000)
DECLARE @reasonCode nvarchar(4000)
DECLARE @reasonDescription nvarchar(4000)
DECLARE @chargePermissionId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @chargePermissionId OUT, 'chargePermissionId'
DECLARE @chargePermissionReferenceId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @chargePermissionReferenceId OUT, 'chargePermissionReferenceId'
DECLARE @buyerBuyerId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @buyerBuyerId OUT, 'buyer.buyerId'
DECLARE @buyerName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @buyerName OUT, 'buyer.name'
DECLARE @buyerEmail nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @buyerEmail OUT, 'buyer.email'
DECLARE @buyerPhoneNumber nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @buyerPhoneNumber OUT, 'buyer.phoneNumber'
DECLARE @buyerPrimeMembershipTypes nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @buyerPrimeMembershipTypes OUT, 'buyer.primeMembershipTypes'
DECLARE @releaseEnvironment nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @releaseEnvironment OUT, 'releaseEnvironment'
DECLARE @shippingAddressName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressName OUT, 'shippingAddress.name'
DECLARE @shippingAddressAddressLine1 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressAddressLine1 OUT, 'shippingAddress.addressLine1'
DECLARE @shippingAddressAddressLine2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressAddressLine2 OUT, 'shippingAddress.addressLine2'
DECLARE @shippingAddressAddressLine3 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressAddressLine3 OUT, 'shippingAddress.addressLine3'
DECLARE @shippingAddressCity nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressCity OUT, 'shippingAddress.city'
DECLARE @shippingAddressCounty nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressCounty OUT, 'shippingAddress.county'
DECLARE @shippingAddressDistrict nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressDistrict OUT, 'shippingAddress.district'
DECLARE @shippingAddressStateOrRegion nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressStateOrRegion OUT, 'shippingAddress.stateOrRegion'
DECLARE @shippingAddressPostalCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressPostalCode OUT, 'shippingAddress.postalCode'
DECLARE @shippingAddressCountryCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressCountryCode OUT, 'shippingAddress.countryCode'
DECLARE @shippingAddressPhoneNumber nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @shippingAddressPhoneNumber OUT, 'shippingAddress.phoneNumber'
DECLARE @billingAddressName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressName OUT, 'billingAddress.name'
DECLARE @billingAddressAddressLine1 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressAddressLine1 OUT, 'billingAddress.addressLine1'
DECLARE @billingAddressAddressLine2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressAddressLine2 OUT, 'billingAddress.addressLine2'
DECLARE @billingAddressAddressLine3 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressAddressLine3 OUT, 'billingAddress.addressLine3'
DECLARE @billingAddressCity nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressCity OUT, 'billingAddress.city'
DECLARE @billingAddressCounty nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressCounty OUT, 'billingAddress.county'
DECLARE @billingAddressDistrict nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressDistrict OUT, 'billingAddress.district'
DECLARE @billingAddressStateOrRegion nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressStateOrRegion OUT, 'billingAddress.stateOrRegion'
DECLARE @billingAddressPostalCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressPostalCode OUT, 'billingAddress.postalCode'
DECLARE @billingAddressCountryCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressCountryCode OUT, 'billingAddress.countryCode'
DECLARE @billingAddressPhoneNumber nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @billingAddressPhoneNumber OUT, 'billingAddress.phoneNumber'
DECLARE @statusDetailsState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @statusDetailsState OUT, 'statusDetails.state'
DECLARE @statusDetailsLastUpdatedTimestamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @statusDetailsLastUpdatedTimestamp OUT, 'statusDetails.lastUpdatedTimestamp'
DECLARE @creationTimestamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @creationTimestamp OUT, 'creationTimestamp'
DECLARE @expirationTimestamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @expirationTimestamp OUT, 'expirationTimestamp'
DECLARE @merchantMetadataMerchantReferenceId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @merchantMetadataMerchantReferenceId OUT, 'merchantMetadata.merchantReferenceId'
DECLARE @merchantMetadataMerchantStoreName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @merchantMetadataMerchantStoreName OUT, 'merchantMetadata.merchantStoreName'
DECLARE @merchantMetadataNoteToBuyer nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @merchantMetadataNoteToBuyer OUT, 'merchantMetadata.noteToBuyer'
DECLARE @merchantMetadataCustomInformation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @merchantMetadataCustomInformation OUT, 'merchantMetadata.customInformation'
DECLARE @platformId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @platformId OUT, 'platformId'
DECLARE @limitsAmountLimitAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @limitsAmountLimitAmount OUT, 'limits.amountLimit.amount'
DECLARE @limitsAmountLimitCurrencyCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @limitsAmountLimitCurrencyCode OUT, 'limits.amountLimit.currencyCode'
DECLARE @limitsAmountBalanceAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @limitsAmountBalanceAmount OUT, 'limits.amountBalance.amount'
DECLARE @limitsAmountBalanceCurrencyCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @limitsAmountBalanceCurrencyCode OUT, 'limits.amountBalance.currencyCode'
DECLARE @presentmentCurrency nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @presentmentCurrency OUT, 'presentmentCurrency'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'paymentPreferences'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @paymentDescriptor OUT, 'paymentPreferences[i].paymentDescriptor'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'statusDetails.reasons'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @reasonCode OUT, 'statusDetails.reasons[i].reasonCode'
EXEC sp_OAMethod @jResp, 'StringOf', @reasonDescription OUT, 'statusDetails.reasons[i].reasonDescription'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @privKey
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO