C#

PayPal - Get Capture Details

See more PayPal Examples

Shows details for a captured payment, by capture ID.

Note: This example requires Chilkat v9.5.0.65 or greater.

C#

bool success = false;

// Note: Requires Chilkat v9.5.0.65 or greater.

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Load our previously obtained access token. (see PayPal OAuth2 Access Token)
Chilkat.JsonObject jsonToken = new Chilkat.JsonObject();
jsonToken.LoadFile("qa_data/tokens/paypal.json");

// Build the Authorization request header field value.
Chilkat.StringBuilder sbAuth = new Chilkat.StringBuilder();
// token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf("token_type"));
sbAuth.Append(" ");
sbAuth.Append(jsonToken.StringOf("access_token"));

// Make the initial connection.
// A single REST object, once connected, can be used for many PayPal REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
Chilkat.Rest rest = new Chilkat.Rest();
bool bAutoReconnect = true;
success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request.  Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------

// Clear the REST object of any headers or query params from previous requests.
rest.ClearAllHeaders();
rest.ClearAllQueryParams();

// This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
rest.AddHeader("Authorization",sbAuth.GetAsString());

// The capture ID is added to the path.
// To list your captures: Find Captures. 
Chilkat.StringBuilder sbPath = new Chilkat.StringBuilder();
sbPath.Append("/v1/payments/capture/capture_id");
int numReplaced = sbPath.Replace("capture_id","1LY5310469661362J");

// Send the GET request and get the JSON response.
Chilkat.StringBuilder sbJsonResponse = new Chilkat.StringBuilder();
success = rest.FullRequestNoBodySb("GET",sbPath.GetAsString(),sbJsonResponse);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.EmitCompact = false;
json.LoadSb(sbJsonResponse);

Debug.WriteLine("Response Status Code = " + Convert.ToString(rest.ResponseStatusCode));

// Did we get a 200 success response?
if (rest.ResponseStatusCode != 200) {
    Debug.WriteLine(json.Emit());
    Debug.WriteLine("Failed.");
    return;
}

// Sample JSON response is shown below.
Debug.WriteLine(json.Emit());
Debug.WriteLine("----------------------");

Debug.WriteLine("success");

// ------------------------------------------------
// A sample JSON response:

// 	{ 
// 	  "id": "1LY5310469661362J",
// 	  "create_time": "2016-11-24T00:40:50Z",
// 	  "update_time": "2016-11-24T00:40:54Z",
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "state": "completed",
// 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	  "transaction_fee": { 
// 	    "value": "0.43",
// 	    "currency": "USD"
// 	  },
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J/refund",
// 	      "rel": "refund",
// 	      "method": "POST"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    }
// 	  ]
//