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 · 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
    namestringrequired
    Name of the charge.1–50 chars
    valueintegerrequired
    Cost of the charge. The value is in the currency’s lowest denomination, for example, cents.0–999999
  - itemsobject[]required
    Array of items objects.1–10 items
    namestringrequired
    Name or brief description of the item.1–50 chars
    quantityintegerrequired
    Quantity of the item in the order.≥ 1
    unitCostintegerrequired
    Cost of the item. The value is in the currency’s lowest denomination, for example, cents.0–999999
  - 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
    statusstringrequired
    Status of the payment intent. The value is one of the following: pendingPayment We haven't received payment for the terminal order. pendingCancellation We haven't received payment for the terminal order, and we are going to cancel the terminal order unless we receive payment. successful We received payment for the terminal order. unsuccessful We attempted to take payment for a terminal order, but it was unsuccessful. cancelled We have canceled the terminal order as we didn't receive payment. Note: To receive notifications if we change the status of a payment intent, subscribe to our paymentIntent.status.changed event. For more information about how to subscribe to events, go to Event Subscriptions.≤ 19 charspendingPaymentpendingCancellationsuccessfulunsuccessfulcancelled
    frequencyobject
    Object that indicates whether the merchant pays for the terminal in a single payment or in multiple installments.
    numberOfInstallmentsinteger
    Number of monthly payments for the terminal order. The merchant can pay for their order over a minimum of two months or a maximum of six months.2–6
    typestringrequired
    Indicates whether the merchant wants to pay for the terminal order in one payment or in multiple installments. If the merchant wants to pay in installments, send a value for the numberOfInstallments parameter.≤ 13 charssinglePaymentinstallments
    methodstringrequired
    Method of payment for the terminal order. The value is one of the following: hostedPaymentPage We send a link to the merchant to pay for the terminal order. accountOnFile We use the merchant's payment details that we have stored to pay for the terminal order.≤ 17 charshostedPaymentPageaccountOnFile
    payerstringrequired
    Indicates who is paying for the terminal order. Send a value of merchant.≤ 12 charsmerchant
  - option 2object
    statusstringrequired
    Status of the payment intent. The value is one of the following: pendingPayment We haven't received payment for the terminal order. pendingCancellation We haven't received payment for the terminal order, and we are going to cancel the terminal order unless we receive payment. successful We received payment for the terminal order. unsuccessful We attempted to take payment for a terminal order, but it was unsuccessful. cancelled We have canceled the terminal order as we didn't receive payment. Note: To receive notifications if we change the status of a payment intent, subscribe to our paymentIntent.status.changed event. For more information about how to subscribe to events, go to Event Subscriptions.≤ 19 charspendingPaymentpendingCancellationsuccessfulunsuccessfulcancelled
    methodstringrequired
    Method of payment for the terminal order. The value is one of the following: accountOnFile We use the sales partner's account details that we have stored to pay for the order. residualOffset We use the sales partner's residuals to pay for the order.≤ 17 charsaccountOnFileresidualOffset
    payerstringrequired
    Indicates who is paying for the terminal order. Send a value of salesPartner.≤ 12 charssalesPartner
- 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