Chilkat Online Tools

Node.js / Afterpay Online US API v2 / List Payments

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "100100248";
    http.Password = "117f3fe5a01a0e400f3e4782baf8ffa43a9d21e9217a15f50d545bc72480d081ecaecc1d6a42ac7a785b7437232bd4cf62dbee679b78a75a3892547059018f9b";

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("merchantReferences","merchant-order-number");
    queryParams.UpdateString("ids","{{id}}");

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

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://api.us-sandbox.afterpay.com/v2/payments",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -G -d "merchantReferences=merchant-order-number"
	-d "ids=%7B%7Bid%7D%7D"
	-u '100100248:117f3fe5a01a0e400f3e4782baf8ffa43a9d21e9217a15f50d545bc72480d081ecaecc1d6a42ac7a785b7437232bd4cf62dbee679b78a75a3892547059018f9b'
	-H "Accept: */*"
	-H "Content-Type: application/json"
https://api.us-sandbox.afterpay.com/v2/payments

Postman Collection Item JSON

{
  "name": "List Payments",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "*/*"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "https://api.us-sandbox.afterpay.com/v2/payments?merchantReferences=merchant-order-number&ids={{id}}",
      "protocol": "https",
      "host": [
        "api",
        "us-sandbox",
        "afterpay",
        "com"
      ],
      "path": [
        "v2",
        "payments"
      ],
      "query": [
        {
          "key": "fromCreatedDate",
          "value": "1970-01-01T00:00:00.000Z",
          "disabled": true
        },
        {
          "key": "toCreatedDate",
          "value": "2019-11-11T00:00:00.000Z",
          "disabled": true
        },
        {
          "key": "tokens",
          "value": "ro0ubumh557el6n6pqitjp4c11d9ui77p6mj5i1bgjlep8k8305m",
          "disabled": true
        },
        {
          "key": "merchantReferences",
          "value": "merchant-order-number"
        },
        {
          "key": "statuses",
          "value": "APPROVED",
          "disabled": true
        },
        {
          "key": "offset",
          "value": "1",
          "disabled": true
        },
        {
          "key": "limit",
          "value": "250",
          "disabled": true
        },
        {
          "key": "orderBy",
          "value": "createdAt",
          "disabled": true
        },
        {
          "key": "ascending",
          "value": "false",
          "disabled": true
        },
        {
          "key": "ids",
          "value": "{{id}}"
        }
      ]
    },
    "description": "Get a list of payments for the merchant.\n\nTo retrieve a filtered list of payments, the following request parameters can be included:\n\ntokens\n*optional\n*string[]\n*A list of order tokens. Parameter can be used multiple times to search by multiple ids.\n\nids\n*optional\n*string[]\n*Search by Afterpay payment ID. Parameter can be used multiple times to search by multiple IDs.\n\nmerchantReferences\n*optional\n*string[]\n*Search by merchant references. Parameter can be used multiple times to search by multiple merchant references.\n\nMore documentation available at:\nhttps://docs.afterpay.com.au/online-api-v2-b857508478e7.html#list-payments"
  },
  "response": [
  ]
}