Get a list of payouts (filtered)

You can specify various filters as parameters in the query string in order to get a customized list of payouts.

Requests:

GET https://securetest.smart2pay.com/v1/payouts?limit=3
Authorization: Basic MTAxMDpnYWJp
GET https://securetest.smart2pay.com/v1/payouts?maximumAmount=1000
Authorization: Basic MTAxMDpnYWJp

The following table describes the possible filters you can use. You can mix the filters so you can obtain the desired results.

FILTERS
FieldDescriptionData type
limitThe maximum number of items that will be returnedLong
offsetA list of payments starting with the value of the offset parameter will be returned. The offset parameter can also be used together with the limit parameter to select specific entries within a list of payments.String
startDateThe date and time after which the payments are returnedDateTime (YYYYMMDDHHMMSS)
endDateThe date and time until which the payments are returnedDateTime (YYYYMMDDHHMMSS)
countryOnly the transactions having this country code will be returnedString (ISO 3166-1-alpha-2)
currencyOnly the transactions having this currency code will be returnedString (ISO 4217)
minimumAmountOnly the payments with an amount higher than this will be returnedInteger (last 2 digits representing the decimal part)
maximumAmountOnly the payments with an amount lower than this will be returnedInteger (last 2 digits representing the decimal part)
merchantTransactionIDOnly the payment having this merchantTransactionID will be returnedString

^[0-9a-zA-Z_-]{1,50}$

statusIDOnly the transactions having this statusID will be returned.Integer

The ID of the payment status can have the following values: 1 – Open, 2 – Success, 3 – Cancelled, 4 – Failed, 5 – Expired, 9 – Authorized.

methodTransactionIDOnly the payments having this methodTransactionID will be returned. This transaction ID from the payment method provider can be used for customer support.String

^[0-9a-zA-Z_-]{1,50}$

Here is an example of a request with the minimumAmount filter set to 2000. This means that it will return only the transactions with an amount higher than this.

Request:

GET https://securetest.smart2pay.com/v1/payouts?limit=3
Authorization: Basic MTAxMDpnYWJp

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Payouts": [
    {
      "ID": 79,
      "SiteID": 1010,
      "Created": "20161003095713",
      "MerchantTransactionID": "test_g23",
      "Amount": 1000,
      "Currency": "EUR",
      "Description": "payment product",
      "StatementDescriptor": null,
      "Status": {
        "ID": 2,
        "Info": "Success",
        "Reasons": []
      }
    },
    {
      "ID": 78,
      "SiteID": 1010,
      "Created": "20161003095708",
      "MerchantTransactionID": "test_g22",
      "Amount": 1000,
      "Currency": "EUR",
      "Description": "payment product",
      "StatementDescriptor": null,
      "Status": {
        "ID": 2,
        "Info": "Success",
        "Reasons": []
      }
    },
    {
      "ID": 77,
      "SiteID": 1010,
      "Created": "20161003095114",
      "MerchantTransactionID": "test_g20",
      "Amount": 1000,
      "Currency": "EUR",
      "Description": "payment product",
      "StatementDescriptor": null,
      "Status": {
        "ID": 2,
        "Info": "Success",
        "Reasons": []
      }
    }
  ]
}

You can also mix various filters to get specific results. Here is an example of a request with the limit filter set to 2 and the currency EUR. This means that it will return the last two payout entries that have the transaction currency EUR.

Request:

GET https://securetest.smart2pay.com/v1/payouts?limit=2&currency=EUR
Authorization: Basic MTAxMDpnYWJp

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Payouts": [
    {
      "ID": 79,
      "SiteID": 1010,
      "Created": "20161003095713",
      "MerchantTransactionID": "test_g23",
      "Amount": 1000,
      "Currency": "EUR",
      "Description": "payment product",
      "StatementDescriptor": null,
      "Status": {
        "ID": 2,
        "Info": "Success",
        "Reasons": []
      }
    },
    {
      "ID": 78,
      "SiteID": 1010,
      "Created": "20161003095708",
      "MerchantTransactionID": "test_g22",
      "Amount": 1000,
      "Currency": "EUR",
      "Description": "payment product",
      "StatementDescriptor": null,
      "Status": {
        "ID": 2,
        "Info": "Success",
        "Reasons": []
      }
    }
  ]
}