Retrieve transaction | Payroc

Use this method to retrieve information about a transaction.

Note: To retrieve a transaction, you need its transactionId. If you don’t have the transactionId, use our List Transactions method to search for the transaction.

Our gateway returns the following information about the transaction:

Merchant and processing account that ran the transaction.
Transaction type, date, amount, and the payment method that the customer used.
Batch that contains the transaction, and authorization details for the transaction.
Processor that settled the transaction and the ACH deposit containing the transaction.

Use this method to retrieve information about a transaction. **Note:** To retrieve a transaction, you need its transactionId. If you don't have the transactionId, use our [List Transactions](https://docs.payroc.com/api/schema/reporting/settlement/list-transactions) method to search for the transaction. Our gateway returns the following information about the transaction: - Merchant and processing account that ran the transaction. - Transaction type, date, amount, and the payment method that the customer used. - Batch that contains the transaction, and authorization details for the transaction. - Processor that settled the transaction and the ACH deposit containing the transaction.

Path parameters

transactionIdintegerRequired

Unique identifier of the transaction.

Response

Successful request. Returns the requested transaction.

transactionIdinteger or null

Unique identifier that we assigned to the transaction.

typeenum or null

Indicates the type of transaction. The value is one of the following:

capture - Transaction is a sale.
return - Transaction is a refund.

Indicates the type of transaction. The value is one of the following: - `capture` - Transaction is a sale. - `return` - Transaction is a refund.

Allowed values:

datedate or null

Date of the transaction. The format of this value is YYYY-MM-DD.

amountinteger or null

Transaction amount. We return the value in the currency's lowest denomination, for example, cents.

entryMethodenum or null

Indicates how the merchant received the payment details.

createdDatedate or null

Date that we received the transaction. The format of this value is YYYY-MM-DD.

lastModifiedDatedate or null

Date that the transaction was last changed. The format of this value is YYYY-MM-DD.

statusenum or null

Indicates the status of the transaction. The value is one of the following:

fullSuspense – Merchant ran the transaction while their account was in full suspense.
heldAudited – We have moved a transaction from fullSuspense and placed it on hold.
heldReleasedAudited – We audited and released the transaction that we had previously held.
holdForSettlement30Days - We are holding the transaction for a maximum of 30 days.
holdForSettlementDuplicate - We held the transaction because the transaction may be a duplicate.
holdLongTerm - We are holding the transaction for an extended period.
paid – We have paid the transaction funds to the merchant.
paidByThirdParty - A third party has paid the transaction funds to the merchant.
partialRelease – We partially released the transaction funds.
pull - We pulled the transaction, and the merchant does not receive funds for the transaction.
release - We released the transaction that we previously held.
new – We have prepared the funds from the transaction to send to the merchant.
held – We held the transaction.
unknown – No transaction status available.

Indicates the status of the transaction. The value is one of the following: - `fullSuspense` – Merchant ran the transaction while their account was in full suspense. - `heldAudited` – We have moved a transaction from fullSuspense and placed it on hold. - `heldReleasedAudited` – We audited and released the transaction that we had previously held. - `holdForSettlement30Days` - We are holding the transaction for a maximum of 30 days. - `holdForSettlementDuplicate` - We held the transaction because the transaction may be a duplicate. - `holdLongTerm` - We are holding the transaction for an extended period. - `paid` – We have paid the transaction funds to the merchant. - `paidByThirdParty` - A third party has paid the transaction funds to the merchant. - `partialRelease` – We partially released the transaction funds. - `pull` - We pulled the transaction, and the merchant does not receive funds for the transaction. - `release` - We released the transaction that we previously held. - `new` – We have prepared the funds from the transaction to send to the merchant. - `held` – We held the transaction. - `unknown` – No transaction status available.

cashbackAmountinteger or null

Cashback amount. We return the value in the currency's lowest denomination, for example, cents.

interchangeobject or null

Object that contains information about the interchange fees for the transaction.

currencystring or null

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

Currency of the transaction. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.

merchantobject or null

Object that contains information about the merchant.

settledobject or null

Object that contains information about the settlement.

batchobject or null

Object that contains information about the batch. If we can't match a dispute to a batch, we don't return 'batch' object.

cardobject or null

Object that contains information about the card.

authorizationobject or null

Object that contains information about the authorization.

Errors

Indicates the status of the transaction. The value is one of the following:

fullSuspense – Merchant ran the transaction while their account was in full suspense.
heldAudited – We have moved a transaction from fullSuspense and placed it on hold.
heldReleasedAudited – We audited and released the transaction that we had previously held.
holdForSettlement30Days - We are holding the transaction for a maximum of 30 days.
holdForSettlementDuplicate - We held the transaction because the transaction may be a duplicate.
holdLongTerm - We are holding the transaction for an extended period.
paid – We have paid the transaction funds to the merchant.
paidByThirdParty - A third party has paid the transaction funds to the merchant.
partialRelease – We partially released the transaction funds.
pull - We pulled the transaction, and the merchant does not receive funds for the transaction.
release - We released the transaction that we previously held.
new – We have prepared the funds from the transaction to send to the merchant.
held – We held the transaction.
unknown – No transaction status available.

1	import requests
2
3	url = "https://api.payroc.com/v1/transactions/442233"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"transactionId": 442233,
3	"type": "capture",
4	"date": "2024-07-02",
5	"amount": 4999,
6	"entryMethod": "ecommerce",
7	"createdDate": "2024-07-02",
8	"lastModifiedDate": "2024-07-02",
9	"status": "paid",
10	"cashbackAmount": 0,
11	"interchange": {
12	"basisPoint": 0,
13	"transactionFee": 0
14	},
15	"currency": "USD",
16	"merchant": {
17	"merchantId": "4525644354",
18	"doingBusinessAs": "Pizza Doe",
19	"processingAccountId": 38765,
20	"link": {
21	"rel": "processingAccount",
22	"method": "get",
23	"href": "https://api.payroc.com/v1/processing-accounts/38765"
24	}
25	},
26	"settled": {
27	"settledBy": "3rd party",
28	"achDate": "2024-07-02",
29	"achDepositId": 99,
30	"link": {
31	"rel": "achDeposit",
32	"method": "get",
33	"href": "https://api.payroc.com/v1/ach-deposits/99"
34	}
35	},
36	"batch": {
37	"batchId": 12,
38	"date": "2024-07-02",
39	"cycle": "am",
40	"link": {
41	"rel": "batch",
42	"method": "get",
43	"href": "https://api.payroc.com/v1/batches/12"
44	}
45	},
46	"card": {
47	"cardNumber": "453985******7062",
48	"type": "visa",
49	"cvvPresenceIndicator": true,
50	"avsRequest": true,
51	"avsResponse": ""
52	},
53	"authorization": {
54	"authorizationId": 303101,
55	"code": "A1B2C3",
56	"amount": 4999,
57	"avsResponseCode": "",
58	"link": {
59	"rel": "authorization",
60	"method": "get",
61	"href": "https://api.payroc.com/v1/authorizations/303101"
62	}
63	}
64	}

Path parameters

Headers

Response

Errors