Retrieve payment intent

Browse API reference

GET/payment-intents/{paymentIntentId}getPaymentIntent

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.

Parameters

Name	In	Type	Description
`paymentIntentId`Required	path	`string`	Unique identifier that we assigned to the payment intent.

Responses

Successful request. Returns the payment intent.

200 OK · application/json

{
  "costBreakdown": {
    "customCharges": [
      {
        "name": "FleeceCharge",
        "value": 500
      }
    ],
    "items": [
      {
        "name": "TariffCosts",
        "quantity": 1,
        "unitCost": 999
      }
    ],
    "shippingCost": 100
  },
  "payment": {
    "frequency": {
      "type": "singlePayment"
    },
    "method": "hostedPaymentPage",
    "payer": "merchant",
    "status": "pendingPayment"
  },
  "paymentIntentId": "15387",
  "paymentIntentType": "purchase",
  "subTotal": 100,
  "tax": {
    "isTaxExempt": false,
    "taxAmount": 100
  }
}

Response schema · 14 of 28 fields

option 1object
- costBreakdownobject
  Object that contains information about the items in the terminal order and the cost of the items.
  - customChargesobject[]
    List of additional charges for the order.1–10 items+2 more fields at deeper levels — see the full spec
  - itemsobject[]required
    Array of items objects.1–10 items+3 more fields at deeper levels — see the full spec
  - shippingCostinteger
    Cost of shipping the terminal order. The value is in the currency’s lowest denomination, for example, cents.0–999999
- paymentobjectrequired
  Object that contains information about how the payer is paying for the terminal order.
  - option 1object
    +6 more fields at deeper levels — see the full spec
  - option 2object
    +3 more fields at deeper levels — see the full spec
- paymentIntentIdstringrequired
  Unique identifier we assigned to the payment intent.
- paymentIntentTypestringrequired
  Type of payment intent.≤ 8 charspurchase
- subTotalinteger
  Total amount of the terminal order before tax. The value is in the currency’s lowest denomination, for example, cents. Note: You must send a value for this parameter if the payer is merchant.0–999999
- taxobject
  Object that contains the tax information for the terminal order.
  - isTaxExemptboolean
    Indicates if the terminal order is tax exempt. The default value is false. Note: If you send a value of false, send a value for the taxAmount parameter.
  - taxAmountinteger
    Amount of tax for the terminal order. The value is in the currency’s lowest denomination, for example, cents.0–999999

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Retrieve payment intent

Browse API reference

Parameters

Responses

Menu

Sign out

Talk to an engineer