Skip to main content

Retrieve Transaction by ID


Overview

Use the GET method to fetch full details of a specific transaction by ID or externalId.


Resource Access

Production (api.ahrvo.network)

GET https://api.ahrvo.network/banking/us2/v1/transaction/id/{transactionId}

Staging (gateway.ahrvo.network)

GET https://gateway.ahrvo.network/banking/us2/v1/transaction/id/{transactionId}

Example Requests Covered
  • ACH (pre-existing, one-time, reversal — SEND / COLLECT)
  • CARD (pre-existing, one-time, token, sale terminal, auth terminal)
  • CHECK (PENDING SEND, COMPLETED SEND, COMPLETED COLLECT, EXTERNAL SEND)
  • WIRE (pre-existing, one-time, tax wire payment, COLLECT via third-party)
  • INTERNATIONAL_WIRE (pre-existing USD, pre-existing non-USD, one-time)
  • BOOK (system fee, PPI transfer)
  • VIRTUAL_CARD (pre-existing customer)
  • REFUND (ACH & CARD, ad-hoc surcharge)

Retrieve Transaction — Complete Example Set

(Part 1 of 5 · examples 1 – 6)


Sample — ACH (pre-existing)
{
"resourceName": "transaction",
"url": "v1/transaction/id/247193",
"id": 247193,
"amount": "100.00",
"type": "REGULAR",
"method": "ACH",
"purpose": "Bills",
"transactionClass": "COLLECT",
"source": {
"externalAccount": {
"holderName": "harry",
"routingNumber": "011000015",
"accountNumberLast4": "3543",
"bankName": "FEDERAL RESERVE BANK",
"verification": {
"ofacStatus": "IGNORED",
"ofacStatusReason": "IGNORED",
"ofacStatusDate": "06/03/2024 06:25:42"
},
"type": "SAVINGS",
"holderType": "CORPORATE"
}
},
"destination": {
"account": {
"resourceName": "account",
"url": "/v1/customer/id/4005807/account/id/4004117",
"id": 4004117
}
},
"processDate": "06/03/2024 06:42:11",
"scheduleDate": "06/03/2024",
"status": "PROCESSING",
"statusReason": "Processing In Transit",
"statusDate": "06/03/2024 06:42:11",
"allowDuplicate": true,
"createdOn": "06/03/2024 06:30:03",
"createdBy": {
"userType": "API_USER",
"username": "ahrvoqa+66824029007114580323@prth.com",
"status": "ACTIVE"
},
"lastUpdatedOn": "06/03/2024 07:14:47",
"lastUpdatedBy": {
"userType": "SYSTEM",
"username": "SYSTEM",
"status": "ACTIVE"
},
"processingDetail": {
"traceNumber": "203521289718194",
"processingMode": "FORWARD",
"quickSettle": false,
"location": {
"resourceName": "location",
"url": "/v1/customer/id/4005807/location/id/63",
"id": 63
},
"companyName": "CROSSROADS$P",
"companyDescription": "8765432.1",
"authType": "WRITTEN",
"processedMode": "FORWARD",
"iin": "F243060"
},
"expectedCompletionDate": "06/03/2024"
}

Sample — ACH (one-time)
{
"resourceName": "transaction",
"url": "/v1/transaction/id/240072645",
"id": 240072645,
"externalId": "59261324117534842594333444044512617617338931",
"amount": "101.91",
"method": "ACH",
"type": "REGULAR",
"transactionClass": "COLLECT",
"purpose": "Deposit for transfer",
"source": {
"externalAccount": {
"holderName": "Jon Francis",
"routingNumber": "053101561",
"accountNumberLast4": "1110",
"bankName": "WELLS FARGO BANK",
"verification": {
"ofacStatus": "IGNORED",
"ofacStatusReason": "IGNORED",
"ofacStatusDate": "02/01/2023 11:58:08"
},
"type": "SAVINGS",
"holderType": "CONSUMER"
}
},
"destination": {
"account": {
"resourceName": "account",
"url": "/v1/customer/id/4000247/account/id/4000531",
"id": 4000531
}
},
"processDate": "02/01/2023 12:07:27",
"scheduleDate": "02/01/2023",
"status": "COMPLETED",
"statusReason": "PROCESSED_BY_SYSTEM",
"statusDate": "02/01/2023 12:28:11",
"allowDuplicate": true,
"createdOn": "02/01/2023 12:00:28",
"createdBy": {
"userType": "API_USER",
"username": "ahrvoqa+282693661957@prth.com",
"status": "ACTIVE"
},
"lastUpdatedOn": "02/01/2023 12:28:11",
"lastUpdatedBy": {
"userType": "SYSTEM",
"username": "SYSTEM",
"status": "ACTIVE"
},
"processingDetail": {
"traceNumber": "61121020002551",
"processingMode": "SAME_DAY",
"companyName": "CROSSROAD",
"companyDescription": "8295130101",
"authType": "WRITTEN",
"processedMode": "FORWARD",
"iin": "F243068"
},
"expectedCompletionDate": "02/01/2023"
}

Sample — ACH (reversal – SEND)
{
"resourceName": "transaction",
"url": "v1/transaction/id/230494496",
"id": 230494496,
"amount": "40.00",
"type": "REVERSAL",
"method": "ACH",
"purpose": "Reversal for 230494490",
"transactionClass": "SEND",
"source": { "account": { "resourceName": "account", "url": "/v1/customer/id/4226980/account/id/9915918", "id": 9915918 } },
"destination": { "externalAccount": { "resourceName": "externalAccount", "url": "/v1/customer/id/4226980/externalAccount/id/4020533", "id": 4020533 } },
"processDate": "08/15/2024 04:57:50",
"scheduleDate": "08/15/2024",
"status": "PROCESSING",
"statusReason": "Processing In Transit",
"statusDate": "08/15/2024 04:57:50",
"allowDuplicate": false,
"createdOn": "08/15/2024 04:56:19",
"createdBy": { "userType": "INTERNAL", "username": "DEFAULT_USER", "status": "ACTIVE" },
"lastUpdatedOn": "08/15/2024 04:57:50",
"lastUpdatedBy": { "userType": "SYSTEM", "username": "SYSTEM", "status": "ACTIVE" },
"processingDetail": {
"processingMode": "SAME_DAY",
"quickSettle": false,
"companyName": "Radhika Jassal",
"companyDescription": "REVERSAL",
"authType": "WRITTEN",
"memo": "Radhika Jassal*40.00",
"parent": { "resourceName": "transaction", "url": "/v1/transaction/id/230494490", "id": 230494490 }
}
}

Sample — ACH (reversal – COLLECT)
{
"resourceName": "transaction",
"url": "/v1/transaction/id/240072646",
"id": 240072646,
"amount": "101.91",
"method": "ACH",
"type": "REVERSAL",
"transactionClass": "COLLECT",
"purpose": "Reversal for 240072645",
"source": { "externalAccount": { "holderName": "Jon Francis", "routingNumber": "053101561", "accountNumberLast4": "1110", "bankName": "WELLS FARGO BANK", "verification": { "ofacStatus": "IGNORED", "ofacStatusReason": "IGNORED", "ofacStatusDate": "02/01/2023 11:58:08" }, "type": "SAVINGS", "holderType": "CONSUMER" } },
"destination": { "account": { "resourceName": "account", "url": "/v1/customer/id/4000247/account/id/4000531", "id": 4000531 } },
"processDate": "02/01/2023 12:07:27",
"scheduleDate": "02/01/2023",
"status": "COMPLETED",
"statusReason": "PROCESSED_BY_SYSTEM",
"statusDate": "02/01/2023 12:28:11",
"allowDuplicate": true,
"createdOn": "02/01/2023 12:00:28",
"createdBy": { "userType": "API_USER", "username": "ahrvoqa+282693661957@prth.com", "status": "ACTIVE" },
"lastUpdatedOn": "02/01/2023 12:28:11",
"lastUpdatedBy": { "userType": "SYSTEM", "username": "SYSTEM", "status": "ACTIVE" },
"processingDetail": {
"traceNumber": "61121020002551",
"processingMode": "SAME_DAY",
"companyName": "CROSSROAD",
"companyDescription": "REVERSAL",
"authType": "WRITTEN"
},
"expectedCompletionDate": "02/01/2023",
"parentTransactionId": 230007513
}

Sample — CARD (pre-existing)
{
"resourceName": "transaction",
"url": "/v1/transaction/id/14646",
"id": 14646,
"externalId": "EID188118842194616366200",
"amount": "100.00",
"method": "CARD",
"type": "REGULAR",
"transactionClass": "COLLECT",
"purpose": "Services",
"source": { "card": { "resourceName": "card", "url": "/v1/customer/id/4000018/card/id/529", "id": 529 } },
"destination": { "account": { "resourceName": "account", "url": "/v1/customer/id/4000018/account/id/4000407", "id": 4000407 } },
"scheduleDate": "12/01/2022",
"status": "PENDING",
"statusReason": "Transaction Processing is not enabled as MID is not assigned yet.",
"statusDate": "12/01/2022 10:26:45",
"allowDuplicate": true,
"createdOn": "12/01/2022 10:26:45",
"createdBy": { "username": "ahrvoqa+595409268639@prth.com", "status": "ACTIVE", "userType": "API_USER" },
"lastUpdatedOn": "12/01/2022 10:26:45",
"lastUpdatedBy": { "username": "ahrvoqa+595409268639@prth.com", "status": "ACTIVE", "userType": "API_USER" },
"processingDetail": {
"merchant": { "resourceName": "merchant", "url": "/v1/customer/id/4000018/merchant/id/4001995", "id": 4001995 },
"location": { "resourceName": "location", "url": "/v1/customer/id/4006646/location/id/126", "id": 126 },
"statementDescriptor": "services"
},
"batch": { "id": 6404 },
"expectedCompletionDate": "12/01/2022"
}

Sample — CARD (one-time)
{
"resourceName": "transaction",
"url": "v1/customer/id/4218605/transaction/id/230486398",
"id": 230486398,
"authCode": "PPS97d",
"amount": "200.00",
"pendingCaptureAmount": "0.00",
"amountDetails": {
"taxAmount": "0",
"tipAmount": "9.00",
"surchargeAmount": "55.89",
"originalAmount": "135.11"
},
"method": "CARD",
"type": "REGULAR",
"purpose": "AnPCP",
"transactionClass": "COLLECT",
"source": {
"card": {
"cardNumberLast4": "1843",
"expiryMonth": 10,
"expiryYear": 2025,
"brand": "VISA",
"billingAddress": { "addressLine1": "efhbg", "city": "fhdsf", "state": "AR", "zip": "78909" },
"cardType": "DEBIT",
"debitCard": { "regulated": true },
"holderName": "John Smith"
}
},
"destination": { "account": { "resourceName": "account", "url": "/v1/customer/id/4218605/account/id/9913756", "id": 9913756 } },
"processDate": "04/13/2024 06:45:13",
"scheduleDate": "04/13/2024",
"status": "CAPTURED",
"statusReason": "Authorization Successful",
"statusDate": "04/13/2024 06:45:12",
"allowDuplicate": true,
"createdOn": "04/13/2024 06:45:12",
"createdBy": { "userType": "CUSTOMER_API_USER", "username": "For APIs testing_4218605@ApiToken", "status": "ACTIVE" },
"lastUpdatedOn": "04/13/2024 06:45:12",
"lastUpdatedBy": { "userType": "CUSTOMER_API_USER", "username": "For APIs testing_4218605@ApiToken", "status": "ACTIVE" },
"processingDetail": {
"merchant": { "resourceName": "merchant", "url": "/v1/customer/id/4218605/merchant/id/4005163", "id": 4005163 },
"device": { "posId": "ps9220", "type": "MOBILE", "accountCaptureMethod": "MANUAL" },
"order": {
"invoice": {
"number": "601104043838334",
"discountRate": "0.05",
"discountAmount": "10.00",
"taxAmount": "15.00",
"taxRate": "0.08",
"taxExempt": false,
"shipmentDetail": {
"freightTaxRate": "0.05",
"destinationPostalCode": "12345",
"sourcePostalCode": "67890",
"dutyAmount": "5.00",
"freightAmount": "20.00",
"freightTaxAmount": "1.00",
"address": {
"country": "USA",
"addressLine1": "123MainSt",
"addressLine2": "Apt101",
"city": "New York",
"state": "ny",
"zip": "10001"
},
"shippingMethod": "12345"
},
"lineItem": [
{
"commodityCode": "ABCD1234567890",
"description": "ProductA",
"productCode": "PRODA",
"unitOfMeasure": "pcs",
"quantity": 5,
"unitCost": "10.00",
"discountRate": "0.10",
"discountAmount": "5.00",
"taxRate": "0.08",
"taxAmount": "4.00",
"dutyAmount": "0.50",
"extendedAmount": "45.00"
},
{
"commodityCode": "EFGH9876543210",
"description": "ProductB",
"productCode": "PRODB",
"unitOfMeasure": "pcs",
"quantity": 10,
"unitCost": "15.00",
"discountRate": "0.05",
"discountAmount": "7.50",
"taxRate": "0.08",
"taxAmount": "9.60",
"dutyAmount": "1.00",
"extendedAmount": "142.50"
}
],
"createdOn": "04/13/2024"
},
"statementDescriptor": "PRT*Thermal store-descriptor card"
},
"batch": { "id": 6406 }
},
"expectedCompletionDate": "04/13/2024",
"isAutoCapture": true
}

Sample — CARD (tokenized one-time)
{
"resourceName": "transaction",
"url": "/v1/transaction/id/15171",
"id": 15171,
"amount": "30.50",
"method": "CARD",
"type": "REGULAR",
"transactionClass": "COLLECT",
"purpose": "Collect funds",
"source": {
"card": {
"token": "eyJjYXJkVHlwZSI6IlVOS05PV04DciLCJjYXJkQnJhbmQiOiJWSVNBIn0=",
"cardNumberLast4": "0007",
"expiryMonth": 12,
"expiryYear": 2022,
"brand": "VISA",
"billingAddress": { "addressLine1": "234", "city": "vdfd", "state": "AL", "zip": "34343" },
"type": "UNKNOWN",
"holderName": "testname"
}
},
"destination": { "account": { "resourceName": "account", "url": "/v1/customer/id/4000018/account/id/4000407", "id": 4000407 } },
"scheduleDate": "12/01/2022",
"status": "PENDING",
"statusReason": "Transaction Processing is not enabled as MID is not assigned yet.",
"statusDate": "12/01/2022 11:27:01",
"processingDetail": {
"merchant": { "resourceName": "merchant", "url": "/v1/customer/id/4000018/merchant/id/4001995", "id": 4001995 },
"statementDescriptor": "services"
},
"batch": { "id": 6407 },
"expectedCompletionDate": "12/01/2022"
}

Sample — CHECK (SEND, PENDING)
{
"resourceName": "transaction",
"url": "/v1/transaction/id/4352",
"id": 4352,
"externalId": "E889455283737363",
"amount": "101.00",
"method": "CHECK",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "Services",
"status": "PENDING",
"statusReason": "Insufficient Balance to process SEND",
"source": {
"account": { "id": 4007387 },
"payorAddress": { "id": 1033550 }
},
"destination": { "address": { "id": 1033551 } },
"scheduleDate": "12/05/2022",
"processingDetail": {
"deliveryMode": "OVERNIGHT",
"remittanceInfo": [ { "Invoice Number": "sdf", "Amount": "sdf" } ],
"location": { "id": 126 }
}
}

Sample — CHECK (SEND, COMPLETED)
{
"resourceName": "transaction",
"url": "v1/transaction/id/247147",
"id": 247147,
"externalId": "67279071034046804075",
"amount": "10.15",
"method": "CHECK",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "ICLDebitAutoMatch",
"status": "COMPLETED",
"statusReason": "Processed by System",
"processDate": "05/31/2024 06:02:26",
"source": { "account": { "id": 4004399 } },
"destination": { "address": { "id": 1020610 } },
"linkedDocument": [
{ "id": 15631, "purpose": "CHECK_IMAGE", "document": { "type": "FRONT_CHECK_IMAGE", "name": "F2024...png" } },
{ "id": 15632, "purpose": "CHECK_IMAGE", "document": { "type": "BACK_CHECK_IMAGE", "name": "R2024...png" } }
],
"processingDetail": {
"deliveryMode": "OVERNIGHT",
"checkNumber": "2005",
"memo": "Service Fee May 2022",
"shippingStatus": "PRINTED"
}
}

Sample — WIRE (pre-existing external account)
{
"resourceName": "transaction",
"url": "v1/customer/id/4230014/transaction/id/230495672",
"id": 230495672,
"externalId": "26907982771157268292",
"amount": "100.00",
"method": "WIRE",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "Payment for Deposit",
"status": "COMPLETED",
"statusReason": "Processed by System",
"source": { "account": { "id": 4003762 } },
"destination": { "externalAccount": { "id": 4024469 } },
"processingDetail": {
"memo": "AS PER AGREEMENT",
"wireReference": "242667",
"payor": { "name": "Alex", "verification": { "ofacStatus": "UNDER_REVIEW" } }
}
}

Sample — WIRE (one-time external account)
{
"resourceName": "transaction",
"url": "v1/transaction/id/230001518",
"id": 230001518,
"amount": "5.00",
"method": "WIRE",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "payment",
"status": "SCHEDULED",
"statusReason": "On User Request",
"source": { "account": { "id": 4000693 } },
"destination": {
"externalAccount": {
"holderName": "Lola",
"accountNumberLast4": "2309",
"holderType": "CORPORATE",
"routingNumber": "011000015"
}
},
"scheduleDate": "07/16/2024",
"processingDetail": {
"payor": { "name": "Alex", "networkReference": "o4r9z7I3z8..." }
}
}

Sample — WIRE (tax payment, one-time)
{
"resourceName": "transaction",
"url": "v1/customer/id/4049305/transaction/id/230067280",
"id": 230067280,
"amount": "2100.00",
"amountDetails": { "taxAmount": "2000.00", "interestAmount": "50.00", "penaltyAmount": "50.00" },
"method": "WIRE",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "payment",
"status": "SCHEDULED",
"statusReason": "Approval Pending",
"source": { "account": { "id": 4034561 } },
"destination": { "externalAccount": { "holderName": "US TREAS SINGLE TX" } },
"processingDetail": {
"taxDetail": {
"taxAuthority": "IRS",
"tinLast4": "6732",
"taxpayerName": "ABC Company",
"taxType": "09404",
"taxYear": "24",
"taxMonth": "12"
}
},
"isTaxPayment": true
}

Sample — BOOK (system fee, COMPLETED)
{
"resourceName": "transaction",
"url": "v1/transaction/id/230059836",
"id": 230059836,
"amount": "50.00",
"method": "BOOK",
"type": "REGULAR",
"transactionClass": "SYSTEM_FEE",
"purpose": "INCOMING_ICL_DEBITS_NSF_FEE",
"status": "COMPLETED",
"statusReason": "PROCESSED_BY_SYSTEM",
"processInstantly": true,
"source": { "account": { "id": 4022241 } },
"destination": { "account": { "id": 4022240 } },
"processDate": "10/18/2023 09:31:37"
}

Sample — ACH (REFUND, scheduled)
{
"resourceName": "transaction",
"url": "/v1/transaction/id/17759",
"id": 17759,
"externalId": "EETYUIOLKN4132132",
"amount": "5.00",
"method": "ACH",
"type": "REFUND",
"transactionClass": "SEND",
"purpose": "Refund",
"status": "SCHEDULED",
"statusReason": "ON_CUSTOMER_REQUEST",
"source": { "account": { "id": 4001368 } },
"destination": { "externalAccount": { "holderName": "Light Yagami", "accountNumberLast4": "9720" } },
"processingDetail": {
"achRefundCompanyName": "AMEX LTD",
"achRefundCompanyDescription": "756766876",
"parent": { "id": 3317 }
},
"scheduleDate": "12/03/2022"
}

Sample — BOOK (PPI transfer, SCHEDULED)
{
"resourceName": "transaction",
"url": "v1/transaction/id/230085157",
"id": 230085157,
"externalId": "EID1881142194636620344",
"amount": "10.00",
"method": "BOOK",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "Deposit for transfer",
"status": "SCHEDULED",
"statusReason": "ON_USER_REQUEST",
"source": { "account": { "id": 4005086 } },
"destination": { "ppi": "oggy098@ppi" },
"scheduleDate": "05/09/2023"
}

Sample — INTERNATIONAL_WIRE (USD, pre-existing account)
{
"resourceName": "transaction",
"url": "v1/transaction/id/246332",
"id": 246332,
"externalId": "62891764195319754410",
"amount": "100.00",
"currency": "USD",
"method": "INTERNATIONAL_WIRE",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "Test International Wire",
"status": "COMPLETED",
"statusReason": "Processed by System",
"source": { "account": { "id": 4003762 } },
"destination": { "internationalExternalAccount": { "id": 4001936 } },
"processingDetail": { "memo": "AS PER AGREEMENT", "wireReference": "242669" }
}

Sample — INTERNATIONAL_WIRE (one-time, USD)
{
"resourceName": "transaction",
"url": "v1/transaction/id/246333",
"id": 246333,
"amount": "10.00",
"currency": "USD",
"method": "INTERNATIONAL_WIRE",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "For transfer",
"status": "PENDING",
"source": { "account": { "id": 4006648 } },
"destination": {
"internationalExternalAccount": {
"holderName": "Jon Francis",
"accountNumber": "0025759600202899",
"internationalRoutingCode": "AXIS0210002",
"swiftCode": "AXISINBE345",
"type": "CHECKING",
"holderType": "CONSUMER"
}
},
"processingDetail": {
"memo": "International transaction",
"location": { "id": 2061 },
"payor": { "name": "Kolly" }
}
}

Sample — VIRTUAL_CARD (customer contact)
{
"resourceName": "transaction",
"url": "v1/transaction/id/230089701",
"id": 230089701,
"externalId": "EID1881294361636632030",
"amount": "10.00",
"method": "VIRTUAL_CARD",
"type": "REGULAR",
"transactionClass": "SEND",
"purpose": "For transfer",
"status": "PROCESSING",
"source": { "account": { "id": 4006612 } },
"destination": {
"customer": { "id": 4011080 },
"email": "navneet.kaur_1607@prth.com"
},
"processingDetail": {
"virtualCard": { "id": 531 },
"location": { "id": 126 }
},
"processDate": "06/22/2023 17:49:58"
}

Retrieve Transaction — Complete Example Set

(Part 4 of 5 · examples 19 – 24)


Sample — CHECK (COMPLETED, COLLECT transaction)
{
"resourceName": "transaction",
"url": "v1/transaction/id/230552263",
"id": 230552263,
"amount": "3.95",
"method": "CHECK",
"type": "REGULAR",
"transactionClass": "COLLECT",
"purpose": "ok",
"destination": {
"account": {
"resourceName": "account",
"url": "/v1/customer/id/4257310/account/id/9938825",
"id": 9938825,
"nickName": ""
}
},
"processDate": "05/01/2025 10:02:19",
"scheduleDate": "05/01/2025",
"status": "COMPLETED",
"statusReason": "Processed by System",
"statusDate": "05/01/2025 10:05:49",
"linkedDocument": [
{
"id": 54246,
"purpose": "CHECK_DEPOSIT",
"status": "PENDING_VERIFICATION",
"document": {
"resourceName": "document",
"url": "/v1/document/id/4065567",
"id": 4065567,
"name": "Personal Check_110 (f).jpg",
"type": "CHECK_IMAGE_FRONT"
},
"linkedOn": "05/01/2025 10:02:07",
"linkedBy": {
"username": "DEFAULT_USER",
"status": "ACTIVE",
"userType": "INTERNAL"
}
},
{
"id": 54247,
"purpose": "CHECK_DEPOSIT",
"status": "PENDING_VERIFICATION",
"document": {
"resourceName": "document",
"url": "/v1/document/id/4065568",
"id": 4065568,
"name": "Personal Check_110 (b).jpg",
"type": "CHECK_IMAGE_BACK"
},
"linkedOn": "05/01/2025 10:02:07",
"linkedBy": {
"username": "DEFAULT_USER",
"status": "ACTIVE",
"userType": "INTERNAL"
}
},
{
"id": 54248,
"purpose": "CHECK_DEPOSIT",
"status": "PENDING_VERIFICATION",
"document": {
"resourceName": "document",
"url": "/v1/document/id/4065569",
"id": 4065569,
"name": "EndorsedPersonal Check_110 (f).jpg",
"type": "ENDORSED_CHECK_IMAGE_FRONT"
},
"linkedOn": "05/01/2025 10:02:07",
"linkedBy": {
"username": "DEFAULT_USER",
"status": "ACTIVE",
"userType": "INTERNAL"
}
},
{
"id": 54249,
"purpose": "CHECK_DEPOSIT",
"status": "PENDING_VERIFICATION",
"document": {
"resourceName": "document",
"url": "/v1/document/id/4065570",
"id": 4065570,
"name": "EndorsedPersonal Check_110 (b).jpg",
"type": "ENDORSED_CHECK_IMAGE_BACK"
},
"linkedOn": "05/01/2025 10:02:07",
"linkedBy": {
"username": "DEFAULT_USER",
"status": "ACTIVE",
"userType": "INTERNAL"
}
}
],
"createdOn": "05/01/2025 10:02:06",
"createdBy": { "userType": "INTERNAL", "username": "DEFAULT_USER", "status": "ACTIVE" },
"lastUpdatedOn": "05/01/2025 10:05:49",
"lastUpdatedBy": { "userType": "SYSTEM", "username": "SYSTEM", "status": "ACTIVE" },
"processingDetail": {
"quickSettle": false,
"checkType": "PERSONAL_CHECK",
"checkVerification": {
"status": "VERIFIED",
"statusReason": "Document verified.",
"checkDetail": {
"checkNumber": "602",
"accountNumber": "998777-6655",
"routingNumber": "121000015",
"checkAmount": "3.95"
}
},
"onUs": "998777-6655",
"auxiliaryOnUs": "602",
"routingNumber": "121000015"
},
"expectedCompletionDate": "05/01/2025",
"realizationDate": "05/01/2025 00:00:00",
"methodType": "CHECK"
}

Sample — CHECK (SEND, type EXTERNAL)
{
"resourceName": "transaction",
"url": "v1/transaction/id/230068106",
"id": 230068106,
"amount": "15.00",
"method": "CHECK",
"type": "EXTERNAL",
"transactionClass": "SEND",
"purpose": "ICLDebitAutoMatch",
"status": "SCHEDULED",
"statusReason": "On User Request",
"source": { "account": { "id": 4035159 } },
"destination": {
"address": { "id": 1209279 },
"payeeName": "Alic Ana"
},
"processingDetail": { "memo": "Test Payee Name1" },
"scheduleDate": "10/15/2024"
}

Sample — CARD (sale terminal, CAPTURED)
{
"resourceName": "transaction",
"url": "v1/customer/id/4230913/transaction/id/230514540",
"id": 230514540,
"authCode": "PPS716",
"amount": "57.00",
"method": "CARD",
"type": "REGULAR",
"purpose": "SaleTransaction",
"transactionClass": "COLLECT",
"status": "CAPTURED",
"statusReason": "Payment Captured Successfully",
"source": { "card": { "cardNumberLast4": "7380", "brand": "VISA" } },
"destination": { "account": { "id": 9917695 } },
"processingDetail": {
"merchant": { "id": 4007603 },
"location": { "id": 3005 },
"device": { "posId": "PPS716" },
"statementDescriptor": "Apple Fift-Collect",
"terminal": { "id": "90494FE0-5216-45A9-8D9A-5F3713660906" }
},
"expectedCompletionDate": "11/15/2024",
"isAutoCapture": true
}

Sample — CARD (auth terminal, UNCAPTURED)
{
"resourceName": "transaction",
"url": "v1/customer/id/4230913/transaction/id/230512224",
"id": 230512224,
"authCode": "PPS987",
"amount": "4565.00",
"method": "CARD",
"type": "REGULAR",
"transactionClass": "COLLECT",
"purpose": "dd",
"status": "UNCAPTURED",
"statusReason": "Authorization Successful",
"source": { "card": { "cardNumberLast4": "7380", "brand": "VISA" } },
"destination": { "account": { "id": 9917695 } },
"processingDetail": {
"merchant": { "id": 4007603 },
"location": { "id": 3005 },
"device": { "posId": "PPS987" },
"statementDescriptor": "Apple Fift-Collect",
"terminal": { "id": "90494FE0-5216-45A9-8D9A-5F3713660906" }
},
"pendingCaptureAmount": "4565.00",
"isAutoCapture": false
}

Sample — WIRE (COLLECT via third-party)
{
"resourceName": "transaction",
"url": "v1/customer/id/4006289/transaction/id/230008477",
"id": 230008477,
"amount": "10.00",
"method": "WIRE",
"type": "REGULAR",
"transactionClass": "COLLECT",
"purpose": "priority payroll",
"status": "SCHEDULED",
"statusReason": "On User Request",
"source": { "externalAccount": { "id": 4002390 } },
"destination": { "account": { "id": 4004883 } },
"processingDetail": { "memo": "yesno" },
"scheduleDate": "01/20/2025"
}

Sample — CARD (REFUND, original sale amount)
{
"resourceName": "transaction",
"url": "v1/transaction/id/230001888",
"id": 230001888,
"authCode": "PPS139",
"amount": "12.00",
"method": "CARD",
"type": "REFUND",
"transactionClass": "SEND",
"purpose": "AnPCP",
"status": "APPROVED",
"amountDetails": { "originalAmount": "10.00", "surchargeAmount": "2.00" },
"source": { "account": { "id": 4001138 } },
"destination": { "card": { "cardNumberLast4": "9903", "brand": "MASTERCARD" } },
"processingDetail": {
"merchant": { "id": 4000687 },
"location": { "id": 688 },
"parent": { "id": 230001886 }
}
}

OpenAPI Specification