Get Payment List for Merchant

GET 
/payments

Use this endpoint to retrieve a list of transactions.

Note

There are no request parameters for this endpoint, besides the merchantId in the URI.

Request

Query Parameters

limit integer
Limit's the amount of items that can be returned.
Example: 25
id string
The merchantId to query results by.
Example: {{merchantId}}

Header Parameters

Authorization string
appToken created by /auth/token Format: Bearer xxxxxx...
Example: Bearer <appToken>

Responses

200

Successful response for getting payments

application/json

Schema

Schema

links

object

self string

URL for the current resource.

next string

URL for the next set of data.

note string

Note about the URL to call for the next set.

meta

object

items integer

Number of items in the current set.

count integer

Total count of items.

limit string

Limit of items per set.

more boolean

Indicates if there is more data available.

data

object[]

Array [

id string

Identifier for the payment entry.

type string

Type of the payment entry.

attributes object

Attributes associated with the payment entry.

]

Example (from schema)

{
  "links": {
    "self": "string",
    "next": "string",
    "note": "string"
  },
  "meta": {
    "items": 0,
    "count": 0,
    "limit": "string",
    "more": true
  },
  "data": [
    {
      "id": "string",
      "type": "string",
      "attributes": {}
    }
  ]
}

paymentIdWithBank

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "paymentIdWithBank",
      "type": "payments",
      "attributes": {
        "bank": {
          "routingNumber": "xxxx9593",
          "bankName": "Wells Fargo",
          "accountNumber": "xxxx4567",
          "accountName": "MegaCorp",
          "accountType": "checking"
        },
        "created": "2019-10-10T19:05:58.955Z",
        "merchantId": "merchantId",
        "paymentType": "ACH",
        "transaction": {
          "amount": "3635",
          "currency": "USD",
          "invoice": "Payment-ACH-02",
          "code": "0",
          "message": "Success"
        }
      }
    }
  ]
}

VoidId

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "VoidId",
      "type": "payments",
      "attributes": {
        "created": "2019-10-10T18:49:55.628Z",
        "merchantId": "merchantId",
        "paymentType": "void",
        "transaction": {
          "amount": "500",
          "currency": "USD",
          "code": "0",
          "invoice": "123456",
          "message": "Success"
        }
      }
    }
  ]
}

cardPaymentId

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "cardPaymentId",
      "type": "payments",
      "attributes": {
        "billingAddress": {
          "zip": "90210",
          "country": "USA",
          "state": "CA",
          "line2": "Suite 007",
          "city": "Los Angeles",
          "line1": "21 Jump Street"
        },
        "card": {
          "number": "xxxx1685",
          "holder": "Jane Doe",
          "expiry": "0220",
          "code": "xxx"
        },
        "created": "2019-10-10T18:49:35.311Z",
        "merchantId": "merchantId",
        "paymentType": "card",
        "transaction": {
          "amount": "500",
          "code": "0",
          "authCode": "A11111",
          "avsResult": "T",
          "gross": "500",
          "rate": "2.95",
          "fee": "35",
          "currency": "USD",
          "invoice": "123456",
          "message": "Success",
          "net": "450",
          "grossMinusNet": "50"
        }
      }
    }
  ]
}

cardSplitId

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "cardSplitId",
      "type": "payments",
      "attributes": {
        "card": {
          "number": "xxxx4426",
          "holder": "Dinh Huyen",
          "expiry": "1299",
          "code": "xxx"
        },
        "created": "2019-10-10T18:45:05.688Z",
        "merchantId": "merchantId",
        "paymentType": "cardSplit",
        "transaction": {
          "amount": "500",
          "code": "0",
          "authCode": "A11111",
          "avsResult": "T",
          "currency": "USD",
          "invoice": "123456",
          "message": "Success"
        }
      }
    }
  ]
}

cardRefundId

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "cardRefundId",
      "type": "payments",
      "attributes": {
        "created": "2019-10-10T18:40:37.793Z",
        "merchantId": "merchantId",
        "paymentType": "cardRefund",
        "transaction": {
          "amount": "500",
          "currency": "USD",
          "code": "0",
          "invoice": "123456",
          "message": "Success"
        }
      }
    }
  ]
}

secondSplitId

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "secondSplitId",
      "type": "payments",
      "attributes": {
        "created": "2019-10-10T18:30:34.906Z",
        "merchantId": "merchantId",
        "paymentType": "secondSplit",
        "transaction": {
          "message": "Success",
          "amount": "100",
          "code": "0"
        }
      }
    }
  ]
}

tokenSplitId

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "tokenSplitId",
      "type": "payments",
      "attributes": {
        "created": "2019-10-10T18:29:13.447Z",
        "merchantId": "merchantId",
        "paymentType": "tokenSplit",
        "transaction": {
          "amount": "15000",
          "currency": "USD",
          "codeResult": "NotPresent",
          "invoice": "123456",
          "authCode": "A11111"
        }
      }
    }
  ]
}

TokenPaymentId

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "TokenPaymentId",
      "type": "payments",
      "attributes": {
        "created": "2019-10-10T18:24:01.141Z",
        "merchantId": "merchantId",
        "paymentType": "token",
        "transaction": {
          "amount": "001",
          "code": "0",
          "authCode": null,
          "gross": null,
          "rate": null,
          "fee": null,
          "currency": "USD",
          "codeResult": "NotPresent",
          "invoice": "PAYMENT-TOKEN-7",
          "message": "Success",
          "net": null,
          "grossMinusNet": null
        }
      }
    }
  ]
}

ACHPaymentId

{
  "links": {
    "self": "x",
    "next": "x",
    "note": "URL to call for next set"
  },
  "meta": {
    "items": 25,
    "count": 26,
    "limit": "25",
    "more": true
  },
  "data": [
    {
      "id": "ACHPaymentId",
      "type": "payments",
      "attributes": {
        "created": "2019-10-10T18:20:50.905Z",
        "merchantId": "merchantId",
        "paymentType": "ACH",
        "transaction": {
          "amount": "3635",
          "currency": "USD",
          "invoice": "Payment-ACH-02",
          "code": "0",
          "message": "Success",
          "bank": {
            "routingNumber": "xxxx9593",
            "bankName": "Wells Fargo",
            "accountNumber": "xxxx4567",
            "accountName": "MegaCorp",
            "accountType": "checking"
          }
        }
      }
    }
  ]
}

Loading...