A valid request URL is required to generate request examples{
"totalCount": 123,
"items": [
{
"id": "<string>",
"groupId": {
"targetType": "<string>",
"targetId": "<string>",
"targetNumber": 123
},
"paymentServiceTransactionId": "<string>",
"availableActions": [
"<string>"
],
"orderId": "<string>",
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"externalTransactionId": "<string>",
"billingInfo": {
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"billingContact": {
"id": 123,
"email": "<string>",
"firstName": "<string>",
"middleNameOrInitial": "<string>",
"lastNameOrSurname": "<string>",
"companyOrOrganization": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"cityOrTown": "<string>",
"stateOrProvince": "<string>",
"postalOrZipCode": "<string>",
"countryCode": "<string>",
"addressType": "<string>",
"isValidated": true
}
},
"isSameBillingShippingAddress": true,
"card": {
"paymentOrCardType": "<string>",
"cardNumberPartOrMask": "<string>",
"expireMonth": 123,
"expireYear": 123,
"bin": "<string>",
"paymentServiceCardId": "<string>",
"isUsedRecurring": true,
"nameOnCard": "<string>",
"isCardInfoSaved": true,
"isTokenized": true,
"ccLastFour": "<string>"
},
"token": {
"paymentServiceTokenId": "<string>",
"type": "<string>"
},
"purchaseOrder": {
"purchaseOrderNumber": "<string>",
"paymentTerm": {
"code": "<string>",
"description": "<string>"
},
"customFields": [
{
"code": "<string>",
"label": "<string>",
"value": "<string>"
}
]
},
"check": {
"checkNumber": "<string>"
},
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"storeCreditCode": "<string>",
"storeCreditType": "<string>",
"customCreditType": "<string>",
"externalTransactionId": "<string>",
"isRecurring": true,
"recurringTransactionId": "<string>",
"data": {}
},
"data": {},
"status": "<string>",
"subPayments": [
{
"status": "<string>",
"amountCollected": 123,
"amountCredited": 123,
"amountRequested": 123,
"amountRefunded": 123,
"target": {
"targetType": "<string>",
"targetId": "<string>",
"targetNumber": 123
}
}
],
"interactions": [
{
"id": "<string>",
"gatewayInteractionId": 123,
"paymentId": "<string>",
"orderId": "<string>",
"target": {
"targetType": "<string>",
"targetId": "<string>",
"targetNumber": 123
},
"currencyCode": "<string>",
"interactionType": "<string>",
"checkNumber": "<string>",
"status": "<string>",
"paymentEntryStatus": "<string>",
"isRecurring": true,
"isManual": true,
"isPending": true,
"gatewayTransactionId": "<string>",
"gatewayAuthCode": "<string>",
"gatewayAVSCodes": "<string>",
"gatewayCVV2Codes": "<string>",
"gatewayResponseCode": "<string>",
"gatewayResponseText": "<string>",
"gatewayResponseData": [
{
"key": "<string>",
"value": "<string>"
}
],
"paymentTransactionInteractionIdReference": 123,
"amount": 123,
"note": "<string>",
"interactionDate": "2023-11-07T05:31:56Z",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"returnId": "<string>",
"refundId": "<string>",
"capturableShipmentsSummary": [
{
"shipmentNumber": 123,
"shipmentTotal": 123,
"amountApplied": 123
}
]
}
],
"isRecurring": true,
"amountCollected": 123,
"amountCredited": 123,
"amountRequested": 123,
"changeMessages": [
{
"id": "<string>",
"correlationId": "<string>",
"userId": "<string>",
"userFirstName": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"subjectType": "<string>",
"success": true,
"identifier": "<string>",
"subject": "<string>",
"verb": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"oldValue": "<string>",
"newValue": "<string>",
"amount": 123,
"createDate": "2023-11-07T05:31:56Z",
"attributes": {}
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"gatewayGiftCard": {
"id": "<string>",
"cardNumber": "<string>",
"cardPin": "<string>",
"amount": 123,
"currencyCode": "<string>"
},
"installmentPlanCode": "<string>"
}
]
}Retrieves payment transactions for an order. Allows filtering and sorting.
A valid request URL is required to generate request examples{
"totalCount": 123,
"items": [
{
"id": "<string>",
"groupId": {
"targetType": "<string>",
"targetId": "<string>",
"targetNumber": 123
},
"paymentServiceTransactionId": "<string>",
"availableActions": [
"<string>"
],
"orderId": "<string>",
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"externalTransactionId": "<string>",
"billingInfo": {
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"billingContact": {
"id": 123,
"email": "<string>",
"firstName": "<string>",
"middleNameOrInitial": "<string>",
"lastNameOrSurname": "<string>",
"companyOrOrganization": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"cityOrTown": "<string>",
"stateOrProvince": "<string>",
"postalOrZipCode": "<string>",
"countryCode": "<string>",
"addressType": "<string>",
"isValidated": true
}
},
"isSameBillingShippingAddress": true,
"card": {
"paymentOrCardType": "<string>",
"cardNumberPartOrMask": "<string>",
"expireMonth": 123,
"expireYear": 123,
"bin": "<string>",
"paymentServiceCardId": "<string>",
"isUsedRecurring": true,
"nameOnCard": "<string>",
"isCardInfoSaved": true,
"isTokenized": true,
"ccLastFour": "<string>"
},
"token": {
"paymentServiceTokenId": "<string>",
"type": "<string>"
},
"purchaseOrder": {
"purchaseOrderNumber": "<string>",
"paymentTerm": {
"code": "<string>",
"description": "<string>"
},
"customFields": [
{
"code": "<string>",
"label": "<string>",
"value": "<string>"
}
]
},
"check": {
"checkNumber": "<string>"
},
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"storeCreditCode": "<string>",
"storeCreditType": "<string>",
"customCreditType": "<string>",
"externalTransactionId": "<string>",
"isRecurring": true,
"recurringTransactionId": "<string>",
"data": {}
},
"data": {},
"status": "<string>",
"subPayments": [
{
"status": "<string>",
"amountCollected": 123,
"amountCredited": 123,
"amountRequested": 123,
"amountRefunded": 123,
"target": {
"targetType": "<string>",
"targetId": "<string>",
"targetNumber": 123
}
}
],
"interactions": [
{
"id": "<string>",
"gatewayInteractionId": 123,
"paymentId": "<string>",
"orderId": "<string>",
"target": {
"targetType": "<string>",
"targetId": "<string>",
"targetNumber": 123
},
"currencyCode": "<string>",
"interactionType": "<string>",
"checkNumber": "<string>",
"status": "<string>",
"paymentEntryStatus": "<string>",
"isRecurring": true,
"isManual": true,
"isPending": true,
"gatewayTransactionId": "<string>",
"gatewayAuthCode": "<string>",
"gatewayAVSCodes": "<string>",
"gatewayCVV2Codes": "<string>",
"gatewayResponseCode": "<string>",
"gatewayResponseText": "<string>",
"gatewayResponseData": [
{
"key": "<string>",
"value": "<string>"
}
],
"paymentTransactionInteractionIdReference": 123,
"amount": 123,
"note": "<string>",
"interactionDate": "2023-11-07T05:31:56Z",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"returnId": "<string>",
"refundId": "<string>",
"capturableShipmentsSummary": [
{
"shipmentNumber": 123,
"shipmentTotal": 123,
"amountApplied": 123
}
]
}
],
"isRecurring": true,
"amountCollected": 123,
"amountCredited": 123,
"amountRequested": 123,
"changeMessages": [
{
"id": "<string>",
"correlationId": "<string>",
"userId": "<string>",
"userFirstName": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"subjectType": "<string>",
"success": true,
"identifier": "<string>",
"subject": "<string>",
"verb": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"oldValue": "<string>",
"newValue": "<string>",
"amount": 123,
"createDate": "2023-11-07T05:31:56Z",
"attributes": {}
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"gatewayGiftCard": {
"id": "<string>",
"cardNumber": "<string>",
"cardPin": "<string>",
"amount": 123,
"currencyCode": "<string>"
},
"installmentPlanCode": "<string>"
}
]
}JWT Authorization header using the Bearer scheme.
Unique identifier of the order whose payment transactions you want to get.
limits which fields are returned in the response body