Chilkat Online Tools

Ruby / Afterpay Online US API v2 / Create Checkout

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("100100248")
http.put_Password("117f3fe5a01a0e400f3e4782baf8ffa43a9d21e9217a15f50d545bc72480d081ecaecc1d6a42ac7a785b7437232bd4cf62dbee679b78a75a3892547059018f9b")

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "amount": {
#     "amount": "37.00",
#     "currency": "USD"
#   },
#   "consumer": {
#     "phoneNumber": "2120000000",
#     "givenNames": "Joe",
#     "surname": "Consumer",
#     "email": "test@afterpay.com"
#   },
#   "billing": {
#     "name": "Joe Consumer",
#     "line1": "1004 Point Lobos Ave",
#     "area1": "San Francisco",
#     "region": "CA",
#     "postcode": "94121",
#     "countryCode": "US",
#     "phoneNumber": "2120000000"
#   },
#   "shipping": {
#     "name": "Joe Consumer",
#     "line1": "1004 Point Lobos Ave",
#     "area1": "San Francisco",
#     "region": "CA",
#     "postcode": "94121",
#     "countryCode": "US",
#     "phoneNumber": "2120000000"
#   },
#   "items": [
#     {
#       "name": "Blue Carabiner",
#       "sku": "12341234",
#       "quantity": 1,
#       "pageUrl": "https://www.afterpay-merchant.com/carabiner-354193.html",
#       "imageUrl": "https://img.afterpay-merchant.com/carabiner-7378-391453-1.jpg",
#       "price": {
#         "amount": "40.00",
#         "currency": "USD"
#       },
#       "categories": [
#         [
#           "Sporting Goods",
#           "Climbing Equipment",
#           "Climbing",
#           "Climbing Carabiners"
#         ],
#         [
#           "Discounts",
#           "Climbing"
#         ]
#       ]
#     },
#     {
#       "name": "Jeans",
#       "sku": "12341235",
#       "quantity": 1,
#       "pageUrl": "https://www.afterpay-merchant.com/jeans-354193.html",
#       "imageUrl": "https://img.afterpay-merchant.com/jeans-7378-391453-1.jpg",
#       "price": {
#         "amount": "20.00",
#         "currency": "USD"
#       }
#     }
#   ],
#   "discounts": [
#     {
#       "displayName": "10% Off Subtotal",
#       "amount": {
#         "amount": "3.00",
#         "currency": "USD"
#       }
#     }
#   ],
#   "merchant": {
#     "redirectConfirmUrl": "https://www.afterpay-merchant.com/confirm",
#     "redirectCancelUrl": "https://www.afterpay-merchant.com/cancel"
#   },
#   "merchantReference": "merchant-order-number",
#   "taxAmount": {
#     "amount": "0.00",
#     "currency": "USD"
#   },
#   "shippingAmount": {
#     "amount": "10.00",
#     "currency": "USD"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("amount.amount","37.00")
json.UpdateString("amount.currency","USD")
json.UpdateString("consumer.phoneNumber","2120000000")
json.UpdateString("consumer.givenNames","Joe")
json.UpdateString("consumer.surname","Consumer")
json.UpdateString("consumer.email","test@afterpay.com")
json.UpdateString("billing.name","Joe Consumer")
json.UpdateString("billing.line1","1004 Point Lobos Ave")
json.UpdateString("billing.area1","San Francisco")
json.UpdateString("billing.region","CA")
json.UpdateString("billing.postcode","94121")
json.UpdateString("billing.countryCode","US")
json.UpdateString("billing.phoneNumber","2120000000")
json.UpdateString("shipping.name","Joe Consumer")
json.UpdateString("shipping.line1","1004 Point Lobos Ave")
json.UpdateString("shipping.area1","San Francisco")
json.UpdateString("shipping.region","CA")
json.UpdateString("shipping.postcode","94121")
json.UpdateString("shipping.countryCode","US")
json.UpdateString("shipping.phoneNumber","2120000000")
json.UpdateString("items[0].name","Blue Carabiner")
json.UpdateString("items[0].sku","12341234")
json.UpdateInt("items[0].quantity",1)
json.UpdateString("items[0].pageUrl","https://www.afterpay-merchant.com/carabiner-354193.html")
json.UpdateString("items[0].imageUrl","https://img.afterpay-merchant.com/carabiner-7378-391453-1.jpg")
json.UpdateString("items[0].price.amount","40.00")
json.UpdateString("items[0].price.currency","USD")
json.UpdateString("items[0].categories[0][0]","Sporting Goods")
json.UpdateString("items[0].categories[0][1]","Climbing Equipment")
json.UpdateString("items[0].categories[0][2]","Climbing")
json.UpdateString("items[0].categories[0][3]","Climbing Carabiners")
json.UpdateString("items[0].categories[1][0]","Discounts")
json.UpdateString("items[0].categories[1][1]","Climbing")
json.UpdateString("items[1].name","Jeans")
json.UpdateString("items[1].sku","12341235")
json.UpdateInt("items[1].quantity",1)
json.UpdateString("items[1].pageUrl","https://www.afterpay-merchant.com/jeans-354193.html")
json.UpdateString("items[1].imageUrl","https://img.afterpay-merchant.com/jeans-7378-391453-1.jpg")
json.UpdateString("items[1].price.amount","20.00")
json.UpdateString("items[1].price.currency","USD")
json.UpdateString("discounts[0].displayName","10% Off Subtotal")
json.UpdateString("discounts[0].amount.amount","3.00")
json.UpdateString("discounts[0].amount.currency","USD")
json.UpdateString("merchant.redirectConfirmUrl","https://www.afterpay-merchant.com/confirm")
json.UpdateString("merchant.redirectCancelUrl","https://www.afterpay-merchant.com/cancel")
json.UpdateString("merchantReference","merchant-order-number")
json.UpdateString("taxAmount.amount","0.00")
json.UpdateString("taxAmount.currency","USD")
json.UpdateString("shippingAmount.amount","10.00")
json.UpdateString("shippingAmount.currency","USD")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.us-sandbox.afterpay.com/v2/checkouts","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-u '100100248:117f3fe5a01a0e400f3e4782baf8ffa43a9d21e9217a15f50d545bc72480d081ecaecc1d6a42ac7a785b7437232bd4cf62dbee679b78a75a3892547059018f9b'
	-H "Accept: application/json"
	-H "Content-Type: application/json"
	-d '{
         "amount": {
            "amount": "37.00",
            "currency": "USD"
         },
         "consumer": {
            "phoneNumber": "2120000000",
            "givenNames": "Joe",
            "surname": "Consumer",
            "email": "test@afterpay.com"
         },
        "billing": {
            "name": "Joe Consumer",
            "line1": "1004 Point Lobos Ave",
            "area1": "San Francisco",
            "region": "CA",
            "postcode": "94121",
            "countryCode": "US",
            "phoneNumber": "2120000000"
        },
        "shipping": {
            "name": "Joe Consumer",
            "line1": "1004 Point Lobos Ave",
            "area1": "San Francisco",
            "region": "CA",
            "postcode": "94121",
            "countryCode": "US",
            "phoneNumber": "2120000000"
        },
        "items":[
            {
                "name": "Blue Carabiner",
                "sku": "12341234",
                "quantity": 1,
                "pageUrl": "https://www.afterpay-merchant.com/carabiner-354193.html",
                "imageUrl": "https://img.afterpay-merchant.com/carabiner-7378-391453-1.jpg",
                "price": {
                    "amount": "40.00",
                    "currency": "USD"
                },
                "categories": [
                            ["Sporting Goods", "Climbing Equipment", "Climbing", "Climbing Carabiners"],
                            ["Discounts", "Climbing"]
                ]
            },
            {
             "name": "Jeans",
             "sku": "12341235",
             "quantity": 1,
             "pageUrl": "https://www.afterpay-merchant.com/jeans-354193.html",
             "imageUrl": "https://img.afterpay-merchant.com/jeans-7378-391453-1.jpg",
             "price": {
                 "amount": "20.00",
                 "currency": "USD"
                }
            }
         ],
         "discounts": [
            {
                "displayName": "10% Off Subtotal",
                "amount": {
                    "amount": "3.00",
                    "currency": "USD"
                }
            }
         ],
         "merchant": {
            "redirectConfirmUrl": "https://www.afterpay-merchant.com/confirm",
            "redirectCancelUrl": "https://www.afterpay-merchant.com/cancel"
         },
         "merchantReference": "merchant-order-number",
         "taxAmount": {
            "amount": "0.00",
            "currency": "USD"
         },
         "shippingAmount": {
             "amount": "10.00",
             "currency": "USD"
         }
      }'
https://api.us-sandbox.afterpay.com/v2/checkouts

Postman Collection Item JSON

{
  "name": "Create Checkout",
  "event": [
    {
      "listen": "test",
      "script": {
        "id": "6e77d6b5-ef19-40b1-a665-41bbc1cff1c8",
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"token\", jsonData.token);"
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "prerequest",
      "script": {
        "id": "28dad3a2-886b-4a2a-8605-6257dee08b82",
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n         \"amount\": {\n            \"amount\": \"37.00\",\n            \"currency\": \"USD\"\n         },\n         \"consumer\": {\n            \"phoneNumber\": \"2120000000\",\n            \"givenNames\": \"Joe\",\n            \"surname\": \"Consumer\",\n            \"email\": \"test@afterpay.com\"\n         },\n        \"billing\": {\n            \"name\": \"Joe Consumer\",\n            \"line1\": \"1004 Point Lobos Ave\",\n            \"area1\": \"San Francisco\",\n            \"region\": \"CA\",\n            \"postcode\": \"94121\",\n            \"countryCode\": \"US\",\n            \"phoneNumber\": \"2120000000\"\n        },\n        \"shipping\": {\n            \"name\": \"Joe Consumer\",\n            \"line1\": \"1004 Point Lobos Ave\",\n            \"area1\": \"San Francisco\",\n            \"region\": \"CA\",\n            \"postcode\": \"94121\",\n            \"countryCode\": \"US\",\n            \"phoneNumber\": \"2120000000\"\n        },\n        \"items\":[\n            {\n                \"name\": \"Blue Carabiner\",\n                \"sku\": \"12341234\",\n                \"quantity\": 1,\n                \"pageUrl\": \"https://www.afterpay-merchant.com/carabiner-354193.html\",\n                \"imageUrl\": \"https://img.afterpay-merchant.com/carabiner-7378-391453-1.jpg\",\n                \"price\": {\n                    \"amount\": \"40.00\",\n                    \"currency\": \"USD\"\n                },\n                \"categories\": [\n                            [\"Sporting Goods\", \"Climbing Equipment\", \"Climbing\", \"Climbing Carabiners\"],\n                            [\"Discounts\", \"Climbing\"]\n                ]\n            },\n            {\n             \"name\": \"Jeans\",\n             \"sku\": \"12341235\",\n             \"quantity\": 1,\n             \"pageUrl\": \"https://www.afterpay-merchant.com/jeans-354193.html\",\n             \"imageUrl\": \"https://img.afterpay-merchant.com/jeans-7378-391453-1.jpg\",\n             \"price\": {\n                 \"amount\": \"20.00\",\n                 \"currency\": \"USD\"\n                }\n            }\n         ],\n         \"discounts\": [\n            {\n                \"displayName\": \"10% Off Subtotal\",\n                \"amount\": {\n                    \"amount\": \"3.00\",\n                    \"currency\": \"USD\"\n                }\n            }\n         ],\n         \"merchant\": {\n            \"redirectConfirmUrl\": \"https://www.afterpay-merchant.com/confirm\",\n            \"redirectCancelUrl\": \"https://www.afterpay-merchant.com/cancel\"\n         },\n         \"merchantReference\": \"merchant-order-number\",\n         \"taxAmount\": {\n            \"amount\": \"0.00\",\n            \"currency\": \"USD\"\n         },\n         \"shippingAmount\": {\n             \"amount\": \"10.00\",\n             \"currency\": \"USD\"\n         }\n      }"
    },
    "url": {
      "raw": "https://api.us-sandbox.afterpay.com/v2/checkouts",
      "protocol": "https",
      "host": [
        "api",
        "us-sandbox",
        "afterpay",
        "com"
      ],
      "path": [
        "v2",
        "checkouts"
      ]
    },
    "description": "This endpoint creates a checkout that is used to initiate the afterpay payment process. Afterpay uses the information in the checkout request to assist with the consumer’s pre-approval process."
  },
  "response": [
  ]
}