Retrieve payment intent

GET

/payment-intents/:paymentIntentId

GET

/v1/payment-intents/:paymentIntentId

1 using RestSharp;
2 
3 var client = new RestClient("https://api.payroc.com/v1/payment-intents/1452");
4 var request = new RestRequest(Method.GET);
5 request.AddHeader("Authorization", "Bearer <token>");
6 IRestResponse response = client.Execute(request);

1 {
2   "paymentIntentType": "purchase",
3   "payment": {
4     "payer": "merchant",
5     "method": "hostedPaymentPage",
6     "status": "pendingPayment",
7     "frequency": {
8       "type": "singlePayment"
9     }
10   },
11   "paymentIntentId": "15387",
12   "costBreakdown": {
13     "items": [
14       {
15         "name": "TariffCosts",
16         "quantity": 1,
17         "unitCost": 999
18       }
19     ],
20     "customCharges": [
21       {
22         "name": "FleeceCharge",
23         "value": 500
24       }
25     ],
26     "shippingCost": 100
27   },
28   "subTotal": 100,
29   "tax": {
30     "isTaxExempt": false,
31     "taxAmount": 100
32   }
33 }

Use this method to retrieve a payment intent, including who is paying for the terminal order and how they are paying for the terminal order. Include the paymentIntentId that we sent you when you created the terminal order.

Authentication

AuthorizationBearer

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

Path parameters

paymentIntentIdstringRequired

Unique identifier that we assigned to the payment intent.

Response

Successful request. Returns the payment intent.

purchaseobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error