Create a Pay Request

This endpoint is used for creating a Pay Request. Your server should create a Pay Request as soon as the total payment amount is known. Once the Pay Request is created, given the terminal is not busy, or offline, the process to pay will be initialised.

Request

Security:

JWT

header Parameters

Authorization required	string Default: Bearer {$$.env.access_token}
Content-Type required	string Value: "application/json"

Request Body schema: application/json

mid required	string The merchant ID of the terminal as specified by the Tyro Account.
tid required	string The terminal ID of the Tyro Terminal.
required	object Contains information from the partner that created the Pay Request.
	object Configurable options for the terminal for this Pay Request.
required	object The terminal amounts (in smallest currency unit)

Responses

201

Created

400

When the provided payload is not valid.

403

When you don't have the right permissions to create a Pay Request for the provided mid.

404

When the provided mid is not found.

412

When the terminal is not paired.

post/pay-terminal/requests

Request samples

Payload
curl
C#
Node.js

application/json

{"mid": "123",
"tid": "456",
"origin": {"orderId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf444",
"transactionId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf444"
},
"total": {"goodsAndServicesAmount": 1000,
"cashoutAmount": 500,
"refundAmount": 0,
"currency": "AUD"
}
}

Response samples

application/json

{"id": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149",
"mid": "123",
"tid": "456",
"status": "AWAITING_INITIALISATION",
"origin": {"orderId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf444",
"transactionId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf444"
},
"options": {"integratedReceipt": true,
"receiptWidth": 60
},
"total": {"goodsAndServicesAmount": 1000,
"cashoutAmount": 500,
"refundAmount": 0,
"currency": "AUD"
}
}