List Payments

curl https://api-b2b.bigcommerce.com/api/v3/io/ip/payments \
     -H "X-Auth-Token: <apiKey>"

{
  "code": 200,
  "data": [
    {
      "id": 70,
      "createdAt": 1618800393,
      "updatedAt": 1618803026,
      "storeHash": "jexy81vb0h",
      "customerId": "95075",
      "payerName": "Store offline payment",
      "payerCustomerId": "95075",
      "details": {
        "memo": "memo"
      },
      "moduleName": "payments_offline",
      "fees": [],
      "moduleData": {
        "transactions": [
          {
            "memo": "k",
            "type": "OfflineTransaction"
          }
        ]
      },
      "processingStatus": 3,
      "appliedStatus": 1,
      "fundingStatus": 2,
      "total": {
        "code": "USD",
        "value": "6.0000"
      },
      "lineItems": [
        {
          "paymentId": 70,
          "invoiceId": 26,
          "invoiceNumber": "00000141",
          "amount": {
            "code": "USD",
            "value": "6.0000"
          }
        }
      ],
      "customerName": "silk",
      "allowedOperations": [],
      "allowedStatuses": [
        1,
        2,
        3,
        4
      ]
    },
    {
      "id": 66,
      "createdAt": 1618590401,
      "updatedAt": 1618797215,
      "storeHash": "jexy81vb0h",
      "customerId": "3",
      "payerName": "Store offline payment",
      "payerCustomerId": "3",
      "details": {
        "memo": "Check#:12345"
      },
      "moduleName": "payments_offline",
      "fees": [],
      "moduleData": {
        "transactions": [
          {
            "memo": "k",
            "type": "OfflineTransaction"
          }
        ]
      },
      "processingStatus": 2,
      "appliedStatus": 1,
      "fundingStatus": 2,
      "total": {
        "code": "USD",
        "value": "30.0000"
      },
      "lineItems": [
        {
          "paymentId": 66,
          "invoiceId": 30,
          "invoiceNumber": "00000141",
          "amount": {
            "code": "USD",
            "value": "10.0000"
          }
        },
        {
          "paymentId": 66,
          "invoiceId": 28,
          "invoiceNumber": "00000141",
          "amount": {
            "code": "USD",
            "value": "20.0000"
          }
        }
      ],
      "customerName": "ABC123",
      "allowedOperations": [],
      "allowedStatuses": [
        1,
        2,
        3,
        4
      ]
    },
    {
      "id": 65,
      "createdAt": 1618502653,
      "updatedAt": 1618502653,
      "storeHash": "jexy81vb0h",
      "customerId": "3",
      "payerName": "Store offline payment",
      "payerCustomerId": "3",
      "details": {
        "memo": "123456"
      },
      "moduleName": "payments_offline",
      "fees": [],
      "moduleData": {
        "transactions": [
          {
            "memo": "k",
            "type": "OfflineTransaction"
          }
        ]
      },
      "processingStatus": 3,
      "appliedStatus": 1,
      "fundingStatus": 2,
      "total": {
        "code": "USD",
        "value": "30.0000"
      },
      "lineItems": [
        {
          "paymentId": 65,
          "invoiceId": 30,
          "invoiceNumber": "00000141",
          "amount": {
            "code": "USD",
            "value": "10.0000"
          }
        },
        {
          "paymentId": 65,
          "invoiceId": 28,
          "invoiceNumber": "00000141",
          "amount": {
            "code": "USD",
            "value": "20.0000"
          }
        }
      ],
      "customerName": "ABC123",
      "allowedOperations": [],
      "allowedStatuses": [
        1,
        2,
        3,
        4
      ],
      "channelId": "1",
      "channelName": "string"
    }
  ],
  "meta": {
    "message": "SUCCESS",
    "pagination": {
      "totalCount": 59,
      "offset": 0,
      "limit": 10
    }
  }
}

Get payment list

Authentication

X-Auth-Tokenstring

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Query parameters

offsetdoubleOptional

Pagination offset

limitdoubleOptional

Pagination limit

orderByenumOptional

"DESC" or "ASC"

Allowed values:

sortByenumOptional

Sort by the field value

searchByenumOptional

Filter by a field

Allowed values:

qstringOptional

You can perform keyword queries on fields corresponding to the value of "searchBy" or, if "searchBy" is empty, on all fields supported by "searchBy".

customerNamestringOptional

Query by invoice B2B Edition company name

invoiceIddoubleOptional

Query by Invoice ID

processingStatusenumOptional

payment processing status(0=“Incomplete”, 1=“Awaiting Processing”, 2=“Processing”, 3=“Completed”, 4=“Refunded”)

Allowed values:

channelIdslist of doublesOptional

Query by BigCommerce Channel IDs. This parameter is not needed if you don't have multiple storefront channels.

Response

codedouble

datalist of objects

metaobject

Authentication

Authentication header

Further reading

Authentication header

Query parameters

Response

Authentication header

Further reading

Authentication header