Chilkat Online Tools

Objective-C / New FreshBooks / Gateway Details

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api.freshbooks.com/payments/account/{{accountId}}/gateway" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "gateway_connections": [
//     {
//       "stripe": {
//         "currencies": [
//           "AED",
//           "AFN",
//           "ALL",
//           "AMD",
//           "ANG",
//           "AOA",
//           "ARS",
//           "AUD",
//           "AWG",
//           "AZN",
//           "BAM",
//           "BBD",
//           "BDT",
//           "BGN",
//           "BIF",
//           "BMD",
//           "BND",
//           "BOB",
//           "BRL",
//           "BSD",
//           "BWP",
//           "BZD",
//           "CAD",
//           "CDF",
//           "CHF",
//           "CLP",
//           "CNY",
//           "COP",
//           "CRC",
//           "CVE",
//           "CZK",
//           "DJF",
//           "DKK",
//           "DOP",
//           "DZD",
//           "EGP",
//           "ETB",
//           "EUR",
//           "FJD",
//           "FKP",
//           "GBP",
//           "GEL",
//           "GIP",
//           "GMD",
//           "GNF",
//           "GTQ",
//           "GYD",
//           "HKD",
//           "HNL",
//           "HRK",
//           "HTG",
//           "HUF",
//           "IDR",
//           "ILS",
//           "INR",
//           "ISK",
//           "JMD",
//           "JPY",
//           "KES",
//           "KGS",
//           "KHR",
//           "KMF",
//           "KRW",
//           "KYD",
//           "KZT",
//           "LAK",
//           "LBP",
//           "LKR",
//           "LRD",
//           "LSL",
//           "MAD",
//           "MDL",
//           "MGA",
//           "MKD",
//           "MMK",
//           "MNT",
//           "MOP",
//           "MRO",
//           "MUR",
//           "MVR",
//           "MWK",
//           "MXN",
//           "MYR",
//           "MZN",
//           "NAD",
//           "NGN",
//           "NIO",
//           "NOK",
//           "NPR",
//           "NZD",
//           "PAB",
//           "PEN",
//           "PGK",
//           "PHP",
//           "PKR",
//           "PLN",
//           "PYG",
//           "QAR",
//           "RON",
//           "RSD",
//           "RUB",
//           "RWF",
//           "SAR",
//           "SBD",
//           "SCR",
//           "SEK",
//           "SGD",
//           "SHP",
//           "SLL",
//           "SOS",
//           "SRD",
//           "STD",
//           "SZL",
//           "THB",
//           "TJS",
//           "TOP",
//           "TRY",
//           "TTD",
//           "TWD",
//           "TZS",
//           "UAH",
//           "UGX",
//           "USD",
//           "UYU",
//           "UZS",
//           "VND",
//           "VUV",
//           "WST",
//           "XAF",
//           "XCD",
//           "XOF",
//           "XPF",
//           "YER",
//           "ZAR",
//           "ZMW"
//         ],
//         "country": "CA",
//         "gateway_user_id": "acct_198989W3477IY7l9murJy",
//         "id": "b5d4f07757ff444db095d4877878f3bc6",
//         "user_state": "registered",
//         "email": "api.freshbooks@gmail.com"
//       },
//       "fbpay": {
//         "currencies": [
//           "CAD"
//         ],
//         "account_id": "27873233720",
//         "action_reasons": [
//           "kyc",
//           "bank_account"
//         ],
//         "country": "CA",
//         "tos_accepted": true,
//         "email": "api.freshbooks@gmail.com",
//         "manage_account_url": "https://wepay.com/account/2430223721",
//         "state": "complete_kyc",
//         "bank_info": {
//           "bank_name": null,
//           "withdrawal_period": null,
//           "last_payment_date": null,
//           "withdrawal_schedule": [
//           ],
//           "next_payout_date": null,
//           "incoming_pending_amount": "0",
//           "last_payment_amount": null,
//           "withdrawal_type": null,
//           "outgoing_withdrawal_schedule": [
//           ],
//           "total_payout": "0"
//         },
//         "pricing": {
//           "ach_tier_3": null,
//           "percent_amex": "3.50",
//           "percent_non_amex_with_card": "2.70",
//           "percent_non_amex": "2.90",
//           "percent_virtual_terminal": "3.50",
//           "percent_amex_with_card": "3.40",
//           "ach_tier_1": null,
//           "ach_tier_2": null,
//           "tier_id": 105,
//           "per_transaction_fee": "0.30"
//         },
//         "visa_debit_accepted": false,
//         "id": "1074c55d1195cd470e0989b60a2f4ffad68c",
//         "bank_transfer_enabled": true
//       }
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *Country = 0;
NSString *Gateway_user_id = 0;
NSString *Id = 0;
NSString *User_state = 0;
NSString *v_Email = 0;
NSString *Account_id = 0;
NSString *fbpayCountry = 0;
BOOL Tos_accepted;
NSString *fbpayEmail = 0;
NSString *Manage_account_url = 0;
NSString *State = 0;
NSString *Bank_name = 0;
NSString *Withdrawal_period = 0;
NSString *Last_payment_date = 0;
NSString *Next_payout_date = 0;
NSString *Incoming_pending_amount = 0;
NSString *Last_payment_amount = 0;
NSString *Withdrawal_type = 0;
NSString *Total_payout = 0;
NSString *Ach_tier_3 = 0;
NSString *Percent_amex = 0;
NSString *Percent_non_amex_with_card = 0;
NSString *Percent_non_amex = 0;
NSString *Percent_virtual_terminal = 0;
NSString *Percent_amex_with_card = 0;
NSString *Ach_tier_1 = 0;
NSString *Ach_tier_2 = 0;
int Tier_id;
NSString *Per_transaction_fee = 0;
BOOL Visa_debit_accepted;
NSString *fbpayId = 0;
BOOL Bank_transfer_enabled;
int j;
int count_j;
NSString *strVal = 0;

int i = 0;
int count_i = [[jResp SizeOfArray: @"gateway_connections"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    Country = [jResp StringOf: @"gateway_connections[i].stripe.country"];
    Gateway_user_id = [jResp StringOf: @"gateway_connections[i].stripe.gateway_user_id"];
    Id = [jResp StringOf: @"gateway_connections[i].stripe.id"];
    User_state = [jResp StringOf: @"gateway_connections[i].stripe.user_state"];
    v_Email = [jResp StringOf: @"gateway_connections[i].stripe.email"];
    Account_id = [jResp StringOf: @"gateway_connections[i].fbpay.account_id"];
    fbpayCountry = [jResp StringOf: @"gateway_connections[i].fbpay.country"];
    Tos_accepted = [jResp BoolOf: @"gateway_connections[i].fbpay.tos_accepted"];
    fbpayEmail = [jResp StringOf: @"gateway_connections[i].fbpay.email"];
    Manage_account_url = [jResp StringOf: @"gateway_connections[i].fbpay.manage_account_url"];
    State = [jResp StringOf: @"gateway_connections[i].fbpay.state"];
    Bank_name = [jResp StringOf: @"gateway_connections[i].fbpay.bank_info.bank_name"];
    Withdrawal_period = [jResp StringOf: @"gateway_connections[i].fbpay.bank_info.withdrawal_period"];
    Last_payment_date = [jResp StringOf: @"gateway_connections[i].fbpay.bank_info.last_payment_date"];
    Next_payout_date = [jResp StringOf: @"gateway_connections[i].fbpay.bank_info.next_payout_date"];
    Incoming_pending_amount = [jResp StringOf: @"gateway_connections[i].fbpay.bank_info.incoming_pending_amount"];
    Last_payment_amount = [jResp StringOf: @"gateway_connections[i].fbpay.bank_info.last_payment_amount"];
    Withdrawal_type = [jResp StringOf: @"gateway_connections[i].fbpay.bank_info.withdrawal_type"];
    Total_payout = [jResp StringOf: @"gateway_connections[i].fbpay.bank_info.total_payout"];
    Ach_tier_3 = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.ach_tier_3"];
    Percent_amex = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.percent_amex"];
    Percent_non_amex_with_card = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.percent_non_amex_with_card"];
    Percent_non_amex = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.percent_non_amex"];
    Percent_virtual_terminal = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.percent_virtual_terminal"];
    Percent_amex_with_card = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.percent_amex_with_card"];
    Ach_tier_1 = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.ach_tier_1"];
    Ach_tier_2 = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.ach_tier_2"];
    Tier_id = [[jResp IntOf: @"gateway_connections[i].fbpay.pricing.tier_id"] intValue];
    Per_transaction_fee = [jResp StringOf: @"gateway_connections[i].fbpay.pricing.per_transaction_fee"];
    Visa_debit_accepted = [jResp BoolOf: @"gateway_connections[i].fbpay.visa_debit_accepted"];
    fbpayId = [jResp StringOf: @"gateway_connections[i].fbpay.id"];
    Bank_transfer_enabled = [jResp BoolOf: @"gateway_connections[i].fbpay.bank_transfer_enabled"];
    j = 0;
    count_j = [[jResp SizeOfArray: @"gateway_connections[i].stripe.currencies"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        strVal = [jResp StringOf: @"gateway_connections[i].stripe.currencies[j]"];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"gateway_connections[i].fbpay.currencies"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        strVal = [jResp StringOf: @"gateway_connections[i].fbpay.currencies[j]"];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"gateway_connections[i].fbpay.action_reasons"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        strVal = [jResp StringOf: @"gateway_connections[i].fbpay.action_reasons[j]"];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"gateway_connections[i].fbpay.bank_info.withdrawal_schedule"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"gateway_connections[i].fbpay.bank_info.outgoing_withdrawal_schedule"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    i = i + 1;
}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/payments/account/{{accountId}}/gateway

Postman Collection Item JSON

{
  "name": "Gateway Details",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/payments/account/{{accountId}}/gateway",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "payments",
        "account",
        "{{accountId}}",
        "gateway"
      ]
    }
  },
  "response": [
    {
      "name": "Gateway Details",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/payments/account/{{accountId}}/gateway",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "payments",
            "account",
            "{{accountId}}",
            "gateway"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/vnd.api+json"
        },
        {
          "key": "X-CardApp-Version",
          "value": "1905.6.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABV1FUDwYGV1QTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FAkpXURQRTEVURAkRQ1VWEUgEA0QHTwNBFkZXQApME1IECQUFQlIWBxpKVkMLFBBUVBVKVB0GHVpVWloEUQFaAAwFCgZSAFAdTAJORgQHVQRTDQUAVVFWVVRVVl0TGlUDChAHbQ=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557346766"
        },
        {
          "key": "Retry-After",
          "value": "57"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 20:18:28 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Content-Length",
          "value": "2097"
        },
        {
          "key": "Date",
          "value": "Wed, 08 May 2019 20:18:28 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17361-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"gateway_connections\": [\n        {\n            \"stripe\": {\n                \"currencies\": [\n                    \"AED\",\n                    \"AFN\",\n                    \"ALL\",\n                    \"AMD\",\n                    \"ANG\",\n                    \"AOA\",\n                    \"ARS\",\n                    \"AUD\",\n                    \"AWG\",\n                    \"AZN\",\n                    \"BAM\",\n                    \"BBD\",\n                    \"BDT\",\n                    \"BGN\",\n                    \"BIF\",\n                    \"BMD\",\n                    \"BND\",\n                    \"BOB\",\n                    \"BRL\",\n                    \"BSD\",\n                    \"BWP\",\n                    \"BZD\",\n                    \"CAD\",\n                    \"CDF\",\n                    \"CHF\",\n                    \"CLP\",\n                    \"CNY\",\n                    \"COP\",\n                    \"CRC\",\n                    \"CVE\",\n                    \"CZK\",\n                    \"DJF\",\n                    \"DKK\",\n                    \"DOP\",\n                    \"DZD\",\n                    \"EGP\",\n                    \"ETB\",\n                    \"EUR\",\n                    \"FJD\",\n                    \"FKP\",\n                    \"GBP\",\n                    \"GEL\",\n                    \"GIP\",\n                    \"GMD\",\n                    \"GNF\",\n                    \"GTQ\",\n                    \"GYD\",\n                    \"HKD\",\n                    \"HNL\",\n                    \"HRK\",\n                    \"HTG\",\n                    \"HUF\",\n                    \"IDR\",\n                    \"ILS\",\n                    \"INR\",\n                    \"ISK\",\n                    \"JMD\",\n                    \"JPY\",\n                    \"KES\",\n                    \"KGS\",\n                    \"KHR\",\n                    \"KMF\",\n                    \"KRW\",\n                    \"KYD\",\n                    \"KZT\",\n                    \"LAK\",\n                    \"LBP\",\n                    \"LKR\",\n                    \"LRD\",\n                    \"LSL\",\n                    \"MAD\",\n                    \"MDL\",\n                    \"MGA\",\n                    \"MKD\",\n                    \"MMK\",\n                    \"MNT\",\n                    \"MOP\",\n                    \"MRO\",\n                    \"MUR\",\n                    \"MVR\",\n                    \"MWK\",\n                    \"MXN\",\n                    \"MYR\",\n                    \"MZN\",\n                    \"NAD\",\n                    \"NGN\",\n                    \"NIO\",\n                    \"NOK\",\n                    \"NPR\",\n                    \"NZD\",\n                    \"PAB\",\n                    \"PEN\",\n                    \"PGK\",\n                    \"PHP\",\n                    \"PKR\",\n                    \"PLN\",\n                    \"PYG\",\n                    \"QAR\",\n                    \"RON\",\n                    \"RSD\",\n                    \"RUB\",\n                    \"RWF\",\n                    \"SAR\",\n                    \"SBD\",\n                    \"SCR\",\n                    \"SEK\",\n                    \"SGD\",\n                    \"SHP\",\n                    \"SLL\",\n                    \"SOS\",\n                    \"SRD\",\n                    \"STD\",\n                    \"SZL\",\n                    \"THB\",\n                    \"TJS\",\n                    \"TOP\",\n                    \"TRY\",\n                    \"TTD\",\n                    \"TWD\",\n                    \"TZS\",\n                    \"UAH\",\n                    \"UGX\",\n                    \"USD\",\n                    \"UYU\",\n                    \"UZS\",\n                    \"VND\",\n                    \"VUV\",\n                    \"WST\",\n                    \"XAF\",\n                    \"XCD\",\n                    \"XOF\",\n                    \"XPF\",\n                    \"YER\",\n                    \"ZAR\",\n                    \"ZMW\"\n                ],\n                \"country\": \"CA\",\n                \"gateway_user_id\": \"acct_198989W3477IY7l9murJy\",\n                \"id\": \"b5d4f07757ff444db095d4877878f3bc6\",\n                \"user_state\": \"registered\",\n                \"email\": \"api.freshbooks@gmail.com\"\n            },\n            \"fbpay\": {\n                \"currencies\": [\n                    \"CAD\"\n                ],\n                \"account_id\": \"27873233720\",\n                \"action_reasons\": [\n                    \"kyc\",\n                    \"bank_account\"\n                ],\n                \"country\": \"CA\",\n                \"tos_accepted\": true,\n                \"email\": \"api.freshbooks@gmail.com\",\n                \"manage_account_url\": \"https://wepay.com/account/2430223721\",\n                \"state\": \"complete_kyc\",\n                \"bank_info\": {\n                    \"bank_name\": null,\n                    \"withdrawal_period\": null,\n                    \"last_payment_date\": null,\n                    \"withdrawal_schedule\": [],\n                    \"next_payout_date\": null,\n                    \"incoming_pending_amount\": \"0\",\n                    \"last_payment_amount\": null,\n                    \"withdrawal_type\": null,\n                    \"outgoing_withdrawal_schedule\": [],\n                    \"total_payout\": \"0\"\n                },\n                \"pricing\": {\n                    \"ach_tier_3\": null,\n                    \"percent_amex\": \"3.50\",\n                    \"percent_non_amex_with_card\": \"2.70\",\n                    \"percent_non_amex\": \"2.90\",\n                    \"percent_virtual_terminal\": \"3.50\",\n                    \"percent_amex_with_card\": \"3.40\",\n                    \"ach_tier_1\": null,\n                    \"ach_tier_2\": null,\n                    \"tier_id\": 105,\n                    \"per_transaction_fee\": \"0.30\"\n                },\n                \"visa_debit_accepted\": false,\n                \"id\": \"1074c55d1195cd470e0989b60a2f4ffad68c\",\n                \"bank_transfer_enabled\": true\n            }\n        }\n    ]\n}"
    }
  ]
}