Sample code for 30+ languages & platforms
Dart

PayPal - Create Stored Credit Card Payment

See more PayPal Examples

Creates a credit card payment using a card ID from a previously stored credit card (where the credit card was stored in PayPal's vault).

Note: For sandbox calls, you can use the credit card numbers provided in your sandbox test accounts.

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

Chilkat Dart Downloads

Dart
import 'package:chilkat/chilkat.dart';

void main() {
  // 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)
  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/paypal.json');

  // Build the Authorization request header field value.
  final sbAuth = CkStringBuilder();
  // 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.
  final rest = CkRest();
  final bAutoReconnect = true;
  try {
    rest.connect('api.sandbox.paypal.com', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.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..
  // ----------------------------------------------------------------------------------------------

  // We previously stored the user's credit card data in PayPal's vault.
  // See Store Card in PayPal Vault for sample code.

  // Build the JSON containing the stored credit card information and transaction information.
  final json = CkJsonObject();
  json.emitCompact = false;
  json.updateString('intent', 'sale');
  json.updateString('payer.payment_method', 'credit_card');
  json.updateString('payer.funding_instruments[0].credit_card_token.credit_card_id', 'CARD-52W84623JH8043102LA3CLGA');
  json.updateString('payer.funding_instruments[0].credit_card_token.payer_id', 'user12345');
  json.updateString('transactions[0].amount.total', '6.70');
  json.updateString('transactions[0].amount.currency', 'USD');
  json.updateString('transactions[0].description', 'This is the payment transaction description.');

  print(json.emit());

  // The JSON created by the above code is this:

  // 	{ 
  // 	  "intent": "sale",
  // 	  "payer": { 
  // 	    "payment_method": "credit_card",
  // 	    "funding_instruments": [
  // 	      { 
  // 	        "credit_card_token": { 
  // 	          "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
  // 	          "payer_id": "user12345"
  // 	        }
  // 	      }
  // 	    ]
  // 	  },
  // 	  "transactions": [
  // 	    { 
  // 	      "amount": { 
  // 	        "total": "6.70",
  // 	        "currency": "USD"
  // 	      },
  // 	      "description": "This is the payment transaction description."
  // 	    }
  // 	  ]
  // 	}

  rest.addHeader('Authorization', sbAuth.getAsString());
  rest.addHeader('Content-Type', 'application/json');

  // Send the POST request containign the JSON in the request body, and get the JSON response.
  final sbJsonRequest = CkStringBuilder();
  json.emitCompact = true;
  json.emitSb(sbJsonRequest);
  final sbJsonResponse = CkStringBuilder();
  try {
    rest.fullRequestSb('POST', '/v1/payments/payment', sbJsonRequest, sbJsonResponse);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  json.emitCompact = false;
  json.loadSb(sbJsonResponse);

  print('Response Status Code = ${rest.responseStatusCode}');

  // Did we get a 201 success response?
  if (rest.responseStatusCode != 201) {
    print(json.emit());
    print('Failed.');
    return;
  }

  // Sample JSON response is shown below.
  print(json.emit());

  // Demonstrate how to access a few parts of the JSON response..
  print('credit_card_id: ${json.stringOf('payer.funding_instruments[0].credit_card_token.credit_card_id')}');
  print('subtotal: ${json.stringOf('transactions[0].amount.details.subtotal')}');
  print('refund href: ${json.stringOf('transactions[0].related_resources[0].sale.links[1].href')}');
  print('success');

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

  // 	{ 
  // 	  "id": "PAY-12T35751GS725073SLA3CQNQ",
  // 	  "create_time": "2016-11-23T23:37:26Z",
  // 	  "update_time": "2016-11-23T23:37:31Z",
  // 	  "state": "approved",
  // 	  "intent": "sale",
  // 	  "payer": { 
  // 	    "payment_method": "credit_card",
  // 	    "funding_instruments": [
  // 	      { 
  // 	        "credit_card_token": { 
  // 	          "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
  // 	          "payer_id": "user12345",
  // 	          "last4": "9974",
  // 	          "type": "visa",
  // 	          "expire_month": "9",
  // 	          "expire_year": "2021"
  // 	        }
  // 	      }
  // 	    ]
  // 	  },
  // 	  "transactions": [
  // 	    { 
  // 	      "amount": { 
  // 	        "total": "6.70",
  // 	        "currency": "USD",
  // 	        "details": { 
  // 	          "subtotal": "6.70"
  // 	        }
  // 	      },
  // 	      "description": "This is the payment transaction description.",
  // 	      "related_resources": [
  // 	        { 
  // 	          "sale": { 
  // 	            "id": "4F194018A1618453G",
  // 	            "create_time": "2016-11-23T23:37:26Z",
  // 	            "update_time": "2016-11-23T23:37:31Z",
  // 	            "amount": { 
  // 	              "total": "6.70",
  // 	              "currency": "USD"
  // 	            },
  // 	            "state": "completed",
  // 	            "parent_payment": "PAY-12T35751GS725073SLA3CQNQ",
  // 	            "links": [
  // 	              { 
  // 	                "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G",
  // 	                "rel": "self",
  // 	                "method": "GET"
  // 	              },
  // 	              { 
  // 	                "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G/refund",
  // 	                "rel": "refund",
  // 	                "method": "POST"
  // 	              },
  // 	              { 
  // 	                "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
  // 	                "rel": "parent_payment",
  // 	                "method": "GET"
  // 	              }
  // 	            ],
  // 	            "fmf_details": {},
  // 	            "processor_response": { 
  // 	              "avs_code": "X",
  // 	              "cvv_code": "M"
  // 	            }
  // 	          }
  // 	        }
  // 	      ]
  // 	    }
  // 	  ],
  // 	  "links": [
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
  // 	      "rel": "self",
  // 	      "method": "GET"
  // 	    }
  // 	  ]
  // 	}
  // 
}