Create a test payment

This endpoint is for creating fake payments that can be used to test your integration with our system. After registering a member, payments can be generated for that member by providing the memberId that you specified during registration.

Request

Security:

JWT

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Request Body schema: application/json

locationId required	string Tyro Connect's identifier for the location.
memberId required	string The identifier of the member who should be associated with this payment. This value corresponds to the `origin.memberId` provided during member registration.
paymentType required	string The type of payment being made Enum: "PURCHASE" "REFUND" "CASHOUT" "OPEN_PRE_AUTH" "CLOSE_PRE_AUTH" "VOID"
paymentSource required	string The method used to make the payment Enum: "EFTPOS" "ONLINE"
goodsAndServicesAmount	number The amount paid for goods and services
tipAmount	number The amount paid as part of a tip
surchargeAmount	number The amount paid as part of a surcharge
cashoutAmount	number The amount paid as part of a cash withdrawal
useNewCard	boolean This will simulate the member registering a new card and will trigger corresponding event NEW_REGISTERED_CARD

Responses

201

Created

404

When you provide a value that we can't reconcile

post/payments/test

Request samples

Payload
curl
C#
Node.js

application/json

{"locationId": "tc-testlocation-2000",
"memberId": "some-member-id",
"paymentType": "PURCHASE",
"paymentSource": "EFTPOS",
"goodsAndServicesAmount": 100
}

Response samples

application/json

"Created"