PureBasic
PureBasic
PayPal - List Payments
See more PayPal Examples
Lists payments that were created by the create payment call and are in any state. The list shows the payments that are made to the merchant who makes the call.Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat PureBasic Downloads
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"
Procedure ChilkatExample()
success.i = 0
; 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 = 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..
; ----------------------------------------------------------------------------------------------
; Clear the REST object of any headers or query params from previous requests.
CkRest::ckClearAllHeaders(rest)
CkRest::ckClearAllQueryParams(rest)
CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
; Add query parameters.
CkRest::ckAddQueryParam(rest,"count","3")
CkRest::ckAddQueryParam(rest,"start_index","0")
CkRest::ckAddQueryParam(rest,"sort_by","create_time")
CkRest::ckAddQueryParam(rest,"sort_order","desc")
; Send the GET request and get the JSON response.
sbJsonResponse.i = CkStringBuilder::ckCreate()
If sbJsonResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestNoBodySb(rest,"GET","/v1/payments/payment",sbJsonResponse)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndIf
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckLoadSb(json,sbJsonResponse)
Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))
; Did we get a 200 success response?
If CkRest::ckResponseStatusCode(rest) <> 200
Debug CkJsonObject::ckEmit(json)
Debug "Failed."
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbJsonResponse)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
; Sample JSON response is shown below.
Debug CkJsonObject::ckEmit(json)
Debug "----------------------"
; Iterate over the payments and show some information from each..
numPayments.i = CkJsonObject::ckSizeOfArray(json,"payments")
i.i = 0
While i < numPayments
CkJsonObject::setCkI(json, i)
Debug "id: " + CkJsonObject::ckStringOf(json,"payments[i].id")
Debug "state: " + CkJsonObject::ckStringOf(json,"payments[i].state")
Debug "intent: " + CkJsonObject::ckStringOf(json,"payments[i].intent")
j.i = 0
numTransactions.i = CkJsonObject::ckSizeOfArray(json,"payments[i].transactions")
While j < numTransactions
CkJsonObject::setCkJ(json, j)
Debug "amount: " + CkJsonObject::ckStringOf(json,"payments[i].transactions[j].amount.total")
Debug "description: " + CkJsonObject::ckStringOf(json,"payments[i].transactions[j].description")
j = j + 1
Wend
Debug "----"
i = i + 1
Wend
Debug "success"
; ------------------------------------------------
; A sample JSON response:
; {
; "payments": [
; {
; "id": "PAY-66A12106PU3254228LA3BYKI",
; "create_time": "2016-11-23T22:46:01Z",
; "update_time": "2016-11-23T22:46:07Z",
; "state": "approved",
; "intent": "sale",
; "payer": {
; "payment_method": "credit_card",
; "funding_instruments": [
; {
; "credit_card": {
; "type": "visa",
; "number": "xxxxxxxxxxxx9974",
; "expire_month": "9",
; "expire_year": "2021",
; "first_name": "Joe",
; "last_name": "Buyer"
; }
; }
; ]
; },
; "transactions": [
; {
; "amount": {
; "total": "7.47",
; "currency": "USD",
; "details": {
; "subtotal": "7.47"
; }
; },
; "description": "This is the payment transaction description.",
; "related_resources": [
; {
; "sale": {
; "id": "70L88278E6781074B",
; "create_time": "2016-11-23T22:46:01Z",
; "update_time": "2016-11-23T22:46:07Z",
; "amount": {
; "total": "7.47",
; "currency": "USD"
; },
; "state": "completed",
; "parent_payment": "PAY-66A12106PU3254228LA3BYKI",
; "links": [
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/sale/70L88278E6781074B",
; "rel": "self",
; "method": "GET"
; },
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/sale/70L88278E6781074B/refund",
; "rel": "refund",
; "method": "POST"
; },
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-66A12106PU3254228LA3BYKI",
; "rel": "parent_payment",
; "method": "GET"
; }
; ]
; }
; }
; ]
; }
; ],
; "links": [
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-66A12106PU3254228LA3BYKI",
; "rel": "self",
; "method": "GET"
; }
; ]
; },
; {
; "id": "PAY-65M1278399433341ALA3B4JY",
; "create_time": "2016-11-23T22:54:31Z",
; "update_time": "2016-11-23T22:54:35Z",
; "state": "approved",
; "intent": "sale",
; "payer": {
; "payment_method": "credit_card",
; "funding_instruments": [
; {
; "credit_card": {
; "type": "visa",
; "number": "xxxxxxxxxxxx9974",
; "expire_month": "9",
; "expire_year": "2021",
; "first_name": "Joe",
; "last_name": "Buyer"
; }
; }
; ]
; },
; "transactions": [
; {
; "amount": {
; "total": "7.47",
; "currency": "USD",
; "details": {
; "subtotal": "7.47"
; }
; },
; "description": "This is the payment transaction description.",
; "related_resources": [
; {
; "sale": {
; "id": "1CP21441CY030683B",
; "create_time": "2016-11-23T22:54:31Z",
; "update_time": "2016-11-23T22:54:35Z",
; "amount": {
; "total": "7.47",
; "currency": "USD"
; },
; "state": "completed",
; "parent_payment": "PAY-65M1278399433341ALA3B4JY",
; "links": [
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/sale/1CP21441CY030683B",
; "rel": "self",
; "method": "GET"
; },
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/sale/1CP21441CY030683B/refund",
; "rel": "refund",
; "method": "POST"
; },
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-65M1278399433341ALA3B4JY",
; "rel": "parent_payment",
; "method": "GET"
; }
; ]
; }
; }
; ]
; }
; ],
; "links": [
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-65M1278399433341ALA3B4JY",
; "rel": "self",
; "method": "GET"
; }
; ]
; },
; {
; "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"
; }
; ]
; }
; }
; ]
; }
; ],
; "links": [
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
; "rel": "self",
; "method": "GET"
; }
; ]
; }
; ],
; "count": 3,
; "next_id": "PAY-2005552565085590VLA3CR5Q"
; }
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbJsonResponse)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure