PowerBuilder
PowerBuilder
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 PowerBuilder Downloads
integer li_rc
integer li_Success
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
integer li_BAutoReconnect
oleobject loo_SbJsonResponse
oleobject loo_Json
integer li_NumPayments
integer i
integer j
integer li_NumTransactions
li_Success = 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)
loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
destroy loo_JsonToken
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_JsonToken.LoadFile("qa_data/tokens/paypal.json")
// Build the Authorization request header field value.
loo_SbAuth = create oleobject
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")
// token_type should be "Bearer"
loo_SbAuth.Append(loo_JsonToken.StringOf("token_type"))
loo_SbAuth.Append(" ")
loo_SbAuth.Append(loo_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.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("api.sandbox.paypal.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
return
end if
// ----------------------------------------------------------------------------------------------
// 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.
loo_Rest.ClearAllHeaders()
loo_Rest.ClearAllQueryParams()
loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
// Add query parameters.
loo_Rest.AddQueryParam("count","3")
loo_Rest.AddQueryParam("start_index","0")
loo_Rest.AddQueryParam("sort_by","create_time")
loo_Rest.AddQueryParam("sort_order","desc")
// Send the GET request and get the JSON response.
loo_SbJsonResponse = create oleobject
li_rc = loo_SbJsonResponse.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Rest.FullRequestNoBodySb("GET","/v1/payments/payment",loo_SbJsonResponse)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_SbJsonResponse
return
end if
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.EmitCompact = 0
loo_Json.LoadSb(loo_SbJsonResponse)
Write-Debug "Response Status Code = " + string(loo_Rest.ResponseStatusCode)
// Did we get a 200 success response?
if loo_Rest.ResponseStatusCode <> 200 then
Write-Debug loo_Json.Emit()
Write-Debug "Failed."
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_SbJsonResponse
destroy loo_Json
return
end if
// Sample JSON response is shown below.
Write-Debug loo_Json.Emit()
Write-Debug "----------------------"
// Iterate over the payments and show some information from each..
li_NumPayments = loo_Json.SizeOfArray("payments")
i = 0
do while i < li_NumPayments
loo_Json.I = i
Write-Debug "id: " + loo_Json.StringOf("payments[i].id")
Write-Debug "state: " + loo_Json.StringOf("payments[i].state")
Write-Debug "intent: " + loo_Json.StringOf("payments[i].intent")
j = 0
li_NumTransactions = loo_Json.SizeOfArray("payments[i].transactions")
do while j < li_NumTransactions
loo_Json.J = j
Write-Debug "amount: " + loo_Json.StringOf("payments[i].transactions[j].amount.total")
Write-Debug "description: " + loo_Json.StringOf("payments[i].transactions[j].description")
j = j + 1
loop
Write-Debug "----"
i = i + 1
loop
Write-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"
// }
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_SbJsonResponse
destroy loo_Json