(PureBasic) PayPal - Create Stored Credit Card Payment

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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    ; 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)
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/paypal.json")

    ; Build the Authorization request header field value.
    sbAuth.i = CkStringBuilder::ckCreate()
    If sbAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; token_type should be "Bearer"
    CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"token_type"))
    CkStringBuilder::ckAppend(sbAuth," ")
    CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"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.
    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"api.sandbox.paypal.com",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; ----------------------------------------------------------------------------------------------
    ; 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.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckUpdateString(json,"intent","sale")
    CkJsonObject::ckUpdateString(json,"payer.payment_method","credit_card")
    CkJsonObject::ckUpdateString(json,"payer.funding_instruments[0].credit_card_token.credit_card_id","CARD-52W84623JH8043102LA3CLGA")
    CkJsonObject::ckUpdateString(json,"payer.funding_instruments[0].credit_card_token.payer_id","user12345")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.total","6.70")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.currency","USD")
    CkJsonObject::ckUpdateString(json,"transactions[0].description","This is the payment transaction description.")

    Debug CkJsonObject::ckEmit(json)

    ; 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."
    ; 	    }
    ; 	  ]
    ; 	}

    CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
    CkRest::ckAddHeader(rest,"Content-Type","application/json")

    ; Send the POST request containign the JSON in the request body, and get the JSON response.
    sbJsonRequest.i = CkStringBuilder::ckCreate()
    If sbJsonRequest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 1)
    CkJsonObject::ckEmitSb(json,sbJsonRequest)
    sbJsonResponse.i = CkStringBuilder::ckCreate()
    If sbJsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestSb(rest,"POST","/v1/payments/payment",sbJsonRequest,sbJsonResponse)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbJsonRequest)
        CkStringBuilder::ckDispose(sbJsonResponse)
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckLoadSb(json,sbJsonResponse)

    Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))

    ; Did we get a 201 success response?
    If CkRest::ckResponseStatusCode(rest) <> 201
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed."
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbJsonRequest)
        CkStringBuilder::ckDispose(sbJsonResponse)
        ProcedureReturn
    EndIf

    ; Sample JSON response is shown below.
    Debug CkJsonObject::ckEmit(json)

    ; Demonstrate how to access a few parts of the JSON response..
    Debug "credit_card_id: " + CkJsonObject::ckStringOf(json,"payer.funding_instruments[0].credit_card_token.credit_card_id")
    Debug "subtotal: " + CkJsonObject::ckStringOf(json,"transactions[0].amount.details.subtotal")
    Debug "refund href: " + CkJsonObject::ckStringOf(json,"transactions[0].related_resources[0].sale.links[1].href")
    Debug "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"
    ; 	    }
    ; 	  ]
    ; 	}
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkStringBuilder::ckDispose(sbAuth)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbJsonRequest)
    CkStringBuilder::ckDispose(sbJsonResponse)


    ProcedureReturn
EndProcedure