Refresh payment session
PUT/v1/collections/payment-requests/:id/refresh-session
Refreshes the payment session token and returns the updated payment request. A refreshed payment session is valid for the remainder of the payment request's lifetime, at most 1 hour, and never outlives the request's expiresAt. This endpoint is only applicable for payment requests with an execution mode of HOSTED_PAGE or EMBEDDED, a status of UNPAID or PART_PAID, and an expiresAt still in the future. If the request does not meet these criteria, a bad request will be returned. The payer must have an email address on file to refresh the session for a crypto-enabled payment request.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 415
- 429
- 500
OK
Response Headers
Trace ID to provide when contacting Hubpay support
Bad Request
Response Headers
Trace ID to provide when contacting Hubpay support
Unauthorized
Response Headers
Trace ID to provide when contacting Hubpay support
Forbidden
Response Headers
Trace ID to provide when contacting Hubpay support
Not Found
Response Headers
Trace ID to provide when contacting Hubpay support
Method Not Allowed
Response Headers
Trace ID to provide when contacting Hubpay support
Unsupported Media Type
Response Headers
Trace ID to provide when contacting Hubpay support
Too Many Requests
Response Headers
Trace ID to provide when contacting Hubpay support
Internal Server Error
Response Headers
Trace ID to provide when contacting Hubpay support
