Checkissuing API Documentation

Get Payment Mail Profile

Retrieve the stored return-envelope assignment and computed mail profile for one payment. List Payments includes this endpoint's absolute URL in each payment's mail_profile_url. This read does not recalculate the profile or change fees.

Send GET to the URL with an OAuth bearer token in the Authorization header. The token must belong to the payment's client and the same API environment as the URL. The link itself does not grant access.

Production Endpoint

GET https://next-api.checkissuing.com/payments/mail-profile/{id}

Sandbox Endpoint

GET https://next-sb-api.checkissuing.com/payments/mail-profile/{id}

Parameters

Parameter	Type	Required	Description
`id`	int	Yes	Payment ID in the URL path.

Response Fields

On success, mail_profile contains payment_id and the eight fields below. See Payment Fields for classification values and legacy aliases. Existing add, update, upload, confirm, and get-by-ID responses keep these fields directly on their payment objects.

Field	JSON Type	Description
`payment_id`	int	ID of the requested payment.
`return_envelope_id`	int\|null	Assigned return envelope; null when none.
`mail_class`	string\|null	Stored mail classification; null when not yet profiled.
`mail_class_reason`	string\|null	Reason for the stored classification.
`sheet_count`	int\|null	Total physical sheets in the mailpiece.
`check_sheet_count`	int	Check-stock sheets.
`insert_sheet_count`	int	Insert and overflow paper sheets.
`computed_weight_oz`	decimal string\|null	Stored weight in ounces, such as `"0.465"`.
`large_envelope`	int	`1` for large-envelope handling; `0` otherwise.

Sample Response

{
  "status": 1,
  "errors": [],
  "error_message": "",
  "mail_profile": {
    "payment_id": 1,
    "return_envelope_id": null,
    "mail_class": "letter",
    "mail_class_reason": "letter",
    "sheet_count": 1,
    "check_sheet_count": 1,
    "insert_sheet_count": 0,
    "computed_weight_oz": "0.465",
    "large_envelope": 0
  }
}

Payment Without a Stored Profile

An accessible payment without a stored profile still returns status: 1 and all eight fields, using nulls and defaults. A missing profile does not make the payment unavailable.

{
  "status": 1,
  "errors": [],
  "error_message": "",
  "mail_profile": {
    "payment_id": 2,
    "return_envelope_id": null,
    "mail_class": null,
    "mail_class_reason": null,
    "sheet_count": null,
    "check_sheet_count": 0,
    "insert_sheet_count": 0,
    "computed_weight_oz": null,
    "large_envelope": 0
  }
}

Errors

An unknown or deleted payment, or a payment belonging to another client, returns HTTP 200 with status: 0 and mail_profile: null:

{
  "status": 0,
  "errors": ["Payment not found"],
  "error_message": "Payment not found",
  "mail_profile": null
}

Missing or invalid OAuth credentials return HTTP 403 with an Access Denied error.