Update or execute actions on the Pay Request

This endpoint is for updating a Pay Request or executing actions on the Pay Request.

Request
Security:
JWT
path Parameters
payRequestId
required
string
header Parameters
Authorization
required
string
Default: Bearer {$$.env.access_token}
Request Body schema: application/json
object

The capture total can be provided if the capture method is MANUAL and the action is CAPTURE.

action
string

The action to perform

Enum: "CAPTURE" "VOID"
object

The total amount (in smallest currency unit). The total can be updated without performing an action.

Responses
200

The Pay Request response

400

When the provided payload is not valid.

404

When the provided payRequestId does not match a Pay Request stored in the system.

patch/pay/requests/{payRequestId}
Request samples
application/json
{
  • "action": "CAPTURE"
}
Response samples
application/json
{
  • "id": "string",
  • "paySecret": "string",
  • "locationId": "string",
  • "provider": {
    },
  • "origin": {
    },
  • "payMethod": {
    },
  • "capture": {
    },
  • "status": "AWAITING_PAYMENT_INPUT",
  • "supportedNetworks": [
    ],
  • "total": {
    },
  • "transactionResults": [
    ],
  • "threeDSecureDetails": {
    }
}
Copyright © Tyro Payments 2019-2024. All right reserved.