B4X
B4X
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 B4X Downloads
Dim success As Boolean = 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)
Dim jsonToken As ChilkatJsonObject
jsonToken.Initialize
jsonToken.LoadFile("qa_data/tokens/paypal.json")
' Build the Authorization request header field value.
Dim sbAuth As ChilkatStringBuilder
sbAuth.Initialize
' 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.
Dim rest As ChilkatRest
rest.Initialize("rest")
Dim bAutoReconnect As Boolean = True
success = rest.Connect("api.sandbox.paypal.com", 443, True, bAutoReconnect)
If success <> True Then
Log(rest.LastErrorText)
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.
rest.ClearAllHeaders
rest.ClearAllQueryParams
rest.AddHeader("Authorization", sbAuth.GetAsString)
' Add query parameters.
rest.AddQueryParam("count", "3")
rest.AddQueryParam("start_index", "0")
rest.AddQueryParam("sort_by", "create_time")
rest.AddQueryParam("sort_order", "desc")
' Send the GET request and get the JSON response.
Dim sbJsonResponse As ChilkatStringBuilder
sbJsonResponse.Initialize
success = rest.FullRequestNoBodySb("GET", "/v1/payments/payment", sbJsonResponse)
If success <> True Then
Log(rest.LastErrorText)
Return
End If
Dim json As ChilkatJsonObject
json.Initialize
json.EmitCompact = False
json.LoadSb(sbJsonResponse)
Log("Response Status Code = " & rest.ResponseStatusCode)
' Did we get a 200 success response?
If rest.ResponseStatusCode <> 200 Then
Log(json.Emit)
Log("Failed.")
Return
End If
' Sample JSON response is shown below.
Log(json.Emit)
Log("----------------------")
' Iterate over the payments and show some information from each..
Dim numPayments As Int = json.SizeOfArray("payments")
Dim i As Int = 0
Do While i < numPayments
json.I = i
Log("id: " & json.StringOf("payments[i].id"))
Log("state: " & json.StringOf("payments[i].state"))
Log("intent: " & json.StringOf("payments[i].intent"))
Dim j As Int = 0
Dim numTransactions As Int = json.SizeOfArray("payments[i].transactions")
Do While j < numTransactions
json.J = j
Log("amount: " & json.StringOf("payments[i].transactions[j].amount.total"))
Log("description: " & json.StringOf("payments[i].transactions[j].description"))
j = j + 1
Loop
Log("----")
i = i + 1
Loop
Log("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"
' }