Get a list of payments

This action allows you to get a list of payments. Without specifying any parameter, the default number of transactions that will be returned per page will be the one configured in our system. Please be aware that only a limited amount of details for each payment will be provided.

Definition: GET /v1/payments

In the response you will receive additional information in order to keep track of your transactions, like:

  • TotalPages: the total number of pages;
  • PageSize: the maximum number of transactions that will be returned per page;
  • PageIndex: the number of the current page;
  • Count: the number of transactions on the current page. Please note that on the last page the Count parameter will refer to the number of the remaining transactions;
  • TotalCount: the total number of transactions.

Request:

GET https://paytest.smart2pay.com/v1/payments
Authorization: Basic MzAyMDE6aEo1Um9iWXg5cjdGZk53Q3ZIWTlMWEhxcXIrRkV6cmM3YUp2UVFrNEdhejFtZzdSeXk=

Response:

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


{
  "Payments": [
    {
      "ID": 3127172,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170818080941",
      "MerchantTransactionID": "WPD_1503043646_2119_1662",
      "OriginatorTransactionID": null,
      "Amount": 1,
      "Currency": "EUR",
      "ReturnURL": "https://docs.smart2pay.com/wp-content/plugins/smart2pay-api/views/funcs/demo_clean_return.php",
      "Description": null,
      "MethodID": null,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 1,
        "Info": "Open",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3121249,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817144711",
      "MerchantTransactionID": "cristinatesting125",
      "OriginatorTransactionID": null,
      "Amount": 500,
      "Currency": "EUR",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": "TestPayment",
      "MethodID": 9,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 2,
        "Info": "Success",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3121248,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817144412",
      "MerchantTransactionID": "cristinatesting124",
      "OriginatorTransactionID": null,
      "Amount": 5,
      "Currency": "MXN",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": "TestPayment",
      "MethodID": 9,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 4,
        "Info": "Failed",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3121247,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817144329",
      "MerchantTransactionID": "cristinatesting123",
      "OriginatorTransactionID": null,
      "Amount": 5,
      "Currency": "MXN",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": "TestPayment",
      "MethodID": 49,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 2,
        "Info": "Success",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3121242,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817143541",
      "MerchantTransactionID": "cristinatest16",
      "OriginatorTransactionID": null,
      "Amount": 980,
      "Currency": "EUR",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": "smart2pay test",
      "MethodID": 9,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 2,
        "Info": "Success",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3121241,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817143454",
      "MerchantTransactionID": "cristinatest15",
      "OriginatorTransactionID": null,
      "Amount": 980,
      "Currency": "EUR",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": "smart2pay test",
      "MethodID": 75,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 9,
        "Info": "Authorized",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3120486,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817131458",
      "MerchantTransactionID": "s2psabaassaSadadeedte99xst_g20",
      "OriginatorTransactionID": null,
      "Amount": 1,
      "Currency": "EUR",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": null,
      "MethodID": 2,
      "MethodOptionID": 20,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 1,
        "Info": "Open",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3119625,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817121535",
      "MerchantTransactionID": "s2psabaassaSaaedtexst_g20",
      "OriginatorTransactionID": null,
      "Amount": 1,
      "Currency": "EUR",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": null,
      "MethodID": 2,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 1,
        "Info": "Open",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3119610,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817121352",
      "MerchantTransactionID": "s2psabaassaSedtexst_g20",
      "OriginatorTransactionID": null,
      "Amount": 1,
      "Currency": "EUR",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": null,
      "MethodID": 2,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 1,
        "Info": "Open",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null
    },
    {
      "ID": 3119557,
      "SkinID": null,
      "ClientIP": null,
      "Created": "20170817121224",
      "MerchantTransactionID": "s2psabaassaSdtexst_g20",
      "OriginatorTransactionID": null,
      "Amount": 11,
      "Currency": "CNY",
      "ReturnURL": "http://demo.smart2pay.com/redirect.php",
      "Description": null,
      "MethodID": 2,
      "MethodOptionID": null,
      "IncludeMethodIDs": null,
      "ExcludeMethodIDs": null,
      "PrioritizeMethodIDs": null,
      "SiteID": 30201,
      "NotificationDateTime": null,
      "Customer": null,
      "BillingAddress": null,
      "ShippingAddress": null,
      "Articles": null,
      "Details": null,
      "ReferenceDetails": null,
      "CustomParameters": null,
      "PreapprovalID": null,
      "Status": {
        "ID": 1,
        "Info": "Open",
        "Reasons": null
      },
      "MethodTransactionID": null,
      "TokenLifetime": null,
      "Capture": null,
      "PreapprovalDetails": null,
      "RedirectURL": null,
      "Count": 10,
      "TotalPages": 358,
      "TotalCount": 3576,
      "PageIndex": 1,
      "PageSize": 10
    }
  ]  
}