Get Payment Detail | BigCommerce Developer Center

import requests
url = "https://api-b2b.bigcommerce.com/api/v3/io/ip/payments/paymentId"
headers = {"X-Auth-Token": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "code": 200,
  "data": {
    "id": 20,
    "createdAt": 1617761431,
    "updatedAt": 1617762957,
    "storeHash": "jexy81vb0h",
    "customerId": "95075",
    "payerName": "Hannah Admin",
    "payerCustomerId": "95075",
    "details": {
      "memo": "memo"
    },
    "moduleName": "payments_bigcommerce_sales_order",
    "fees": [],
    "moduleData": {
      "transactions": [
        {
          "type": "UnknownTransaction"
        }
      ],
      "cartId": "d0afeab8-ff76-4b4e-867a-0675c0ea6e6e",
      "orderId": 121
    },
    "processingStatus": 4,
    "appliedStatus": 0,
    "fundingStatus": 2,
    "total": {
      "code": "USD",
      "value": "11.0000"
    },
    "lineItems": [
      {
        "paymentId": 20,
        "invoiceId": 9,
        "invoiceNumber": "00000141",
        "amount": {
          "code": "USD",
          "value": "11.0000"
        }
      }
    ],
    "customerName": "silk",
    "allowedOperations": [],
    "allowedStatuses": [
      1,
      2,
      3,
      4
    ],
    "channelId": "1",
    "channelName": "string"
  },
  "meta": {
    "message": "SUCCESS"
  }
}

Get payment detail

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-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

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. |

Path parameters

paymentIdstringRequired

Response

codedouble

dataobject

metaobject

Errors

404

Not Found Error