Retrieve payment | Payroc

using Payroc;
using System.Threading.Tasks;
using Payroc.BankTransferPayments.Payments;
namespace Usage;
public class Example
{
    public async Task Do() {
        var client = new BasePayrocClient(
            clientOptions: new ClientOptions {
                Environment = PayrocEnvironment.Production
            }
        );
        await client.BankTransferPayments.Payments.RetrieveAsync(
            new RetrievePaymentsRequest {
                PaymentId = "M2MJOG6O2Y"
            }
        );
    }
}

1	{
2	"paymentId": "M2MJOG6O2Y",
3	"processingTerminalId": "1234001",
4	"order": {
5	"amount": 4999,
6	"currency": "USD",
7	"orderId": "OrderRef6543",
8	"breakdown": {
9	"subtotal": 4347,
10	"taxes": [
11	{
12	"name": "Sales Tax",
13	"rate": 5,
14	"amount": 217
15	}
16	],
17	"tip": {
18	"type": "percentage",
19	"amount": 435,
20	"percentage": 10
21	}
22	},
23	"dateTime": "2024-07-02T15:30:00Z",
24	"description": "Large Pepperoni Pizza"
25	},
26	"bankAccount": {
27	"type": "ach",
28	"accountNumber": "****3159",
29	"nameOnAccount": "Sarah Hazel Hopper",
30	"routingNumber": "053200983",
31	"secCode": "web",
32	"secureToken": {
33	"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
34	"customerName": "Sarah Hazel Hopper",
35	"token": "296753123456",
36	"status": "notValidated",
37	"link": {
38	"rel": "self",
39	"method": "GET",
40	"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa"
41	}
42	},
43	"accountType": "checking"
44	},
45	"transactionResult": {
46	"type": "payment",
47	"status": "ready",
48	"currency": "USD",
49	"responseCode": "A",
50	"authorizedAmount": 4999,
51	"responseMessage": "NoError",
52	"processorResponseCode": "0"
53	},
54	"customer": {
55	"notificationLanguage": "en",
56	"contactMethods": [
57	{
58	"type": "email",
59	"value": "[email protected]"
60	}
61	]
62	},
63	"customFields": [
64	{
65	"name": "yourCustomField",
66	"value": "abc123"
67	}
68	]
69	}

Use this method to retrieve information about a bank transfer payment.

To retrieve a payment, you need its paymentId. Our gateway returned the paymentId in the response of the Create Payment method.

Note: If you don’t have the paymentId, use our List Payments method to search for the payment.

Our gateway returns the following information about the payment:

Order details, including the transaction amount and when it was processed.
Bank account details, including the customer’s name and account number.
Customer’s details, including the customer’s phone number.
Transaction details, including any refunds or re-presentments.

If the merchant saved the customer’s bank account details, our gateway returns a secureTokenID, which you can use to perform follow-on actions.

Use this method to retrieve information about a bank transfer payment. To retrieve a payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/create) method. Note: If you don’t have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/list) method to search for the payment. Our gateway returns the following information about the payment: - Order details, including the transaction amount and when it was processed. - Bank account details, including the customer’s name and account number. - Customer’s details, including the customer’s phone number. - Transaction details, including any refunds or re-presentments. If the merchant saved the customer’s bank account details, our gateway returns a secureTokenID, which you can use to perform follow-on actions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

paymentIdstringRequired=10 characters

Unique identifier that our gateway assigned to the payment.

Response

Successful request. Returns the specific payment.

paymentIdstring=10 characters

Unique identifier that we assigned to the payment.

processingTerminalIdstring4-50 characters

Unique identifier that we assigned to the terminal.

orderobject

Object that contains information about the transaction.

bankAccountobject

Polymorphic object that contains bank account information.
The value of the type field determines which variant you should use:

ach - Automated Clearing House (ACH) details
pad - Pre-authorized debit (PAD) details

Polymorphic object that contains bank account information. The value of the type field determines which variant you should use: - `ach` - Automated Clearing House (ACH) details - `pad` - Pre-authorized debit (PAD) details

transactionResultobjectRead-only

Object that contains information about the transaction.

customerobject or null

Object that contains information about the customer.

refundslist of objects or null

List of refunds issued against the payment.

returnslist of objects or null

List of returns issued against the payment.

representmentobject or null

List of re-presented payments linked to the return.

customFieldslist of objects or null

Array of customField objects.

Authentication

Path parameters

Response

Errors