Get Payment by ID

GET /rest/merchants/{MID}/groups/{GroupID}/payments/{PaymentID}

Description: Returns the full details for a specific scheduled payment, including the authorization response if the payment has been processed, and any void or refund response history.

Transactions alias: Also accessible at GET /rest/merchants/{MID}/groups/{GroupID}/transactions/{TransactionID}.

Path Parameters

MID (required)

Type: string — 8 or 11 digits

Example: 32350000576

GroupID (required)

Type: string (UUID)

Example: 01234567-abcd-1234-9876-abcdef123456

PaymentID (required)

Type: string (UUID)

Description: The scheduled payment ID.

Example: aaaaaaaa-1111-2222-3333-444444444444

Example Request

GET /rest/merchants/32350000576/groups/01234567-abcd-1234-9876-abcdef123456/payments/aaaaaaaa-1111-2222-3333-444444444444
Authorization: Bearer <token>

Responses

200 OK — Pending Payment (not yet processed)

{
  "paymentId": "aaaaaaaa-1111-2222-3333-444444444444",
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "profileId": "5380083609111899173/5274056435998490280",
  "amount": 125.00,
  "deleted": false,
  "orderId": "INV-2030-055",
  "recurring": false,
  "allowPartial": false,
  "sendEmailReceipt": true,
  "sendPaymentScheduledNotification": true,
  "dateCreated": "2025-06-01T14:30:00Z",
  "lastUpdated": "2025-06-01T14:30:00Z",
  "customAttributes": { "studentId": "STU-101" },
  "fees": [],
  "authResponse": null,
  "voidOrRefundResponses": null
}

200 OK — Processed Payment

{
  "paymentId": "aaaaaaaa-1111-2222-3333-444444444444",
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "profileId": "5380083609111899173/5274056435998490280",
  "amount": 125.00,
  "deleted": false,
  "sendEmailReceipt": true,
  "sendPaymentScheduledNotification": true,
  "authResponse": {
    "retref": 987654321098,
    "respcode": "00",
    "respstat": "A",
    "resptext": "Approval",
    "authdate": "1231",
    "amount": 125.00,
    "transactionAmount": 125.00,
    "payorName": "Jane Smith",
    "lastFour": "4242",
    "accountType": "VISA"
  },
  "voidOrRefundResponses": null
}

Error Responses

Status	Meaning
400	Invalid path parameter format.
401	Missing or expired bearer token.
404	Payment not found or does not belong to this merchant/group.
500	Unexpected server error.

authResponse Fields

Field	Type	Description
`retref`	integer	Gateway retrieval reference number. Use with Integration Service to query full transaction details.
`respcode`	string	Gateway response code (e.g., `"00"` = approved).
`respstat`	string	`A` = Approved, `B` = Retry, `C` = Declined.
`resptext`	string	Human-readable response message.
`authdate`	string	Authorization date (MMDD format).
`amount`	number	Authorized amount.
`transactionAmount`	number	Original requested amount.
`payorName`	string	Account holder name.
`lastFour`	string	Last 4 digits of account number.
`accountType`	string	Payment method type (e.g., VISA, MC, ECHK).