{
	"info": {
		"version": "v3",
		"title": "Customer APIs",
		"description": "Self-service REST API for merchant customers, using a Bearer token issued by the customer through their own portal account (distinct from the Merchant API's ZenPay-issued Basic/Api-Key credentials).",
		"x-swagger-net-version": "8.4.19.001",
		"contact": {
			"name": "ZenPay Integrations Team",
			"email": "integrations@zenithpayments.com.au",
			"url": "https://docs.zenithpayments.support"
		}
	},
	"paths": {
		"/v3/diagnostics/ping": {
			"get": {
				"tags": [
					"Diagnostics"
				],
				"summary": "Ping method to get the server date time and version information",
				"operationId": "Diagnostics_Ping",
				"responses": {
					"200": {
						"description": "Self check endpoing",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PingResponse"
								},
								"examples": {
									"server-diagnostics": {
										"summary": "Server diagnostics",
										"value": {
											"serverDateTime": "2026-09-19T18:10:23.2409872",
											"version": "v3.0",
											"timeZoneInfo": "Australian Eastern Standard Time",
											"buildVersion": "1.137.1.19365"
										}
									}
								}
							}
						}
					}
				},
				"security": [
					{
						"BearerAuth": []
					}
				]
			}
		},
		"/v3/{customerCode}/payments/{paymentReference}": {
			"get": {
				"tags": [
					"Payments"
				],
				"operationId": "Payments_GetPaymentByReference",
				"parameters": [
					{
						"schema": {
							"type": "string"
						},
						"name": "customerCode",
						"in": "path",
						"required": true
					},
					{
						"schema": {
							"type": "string"
						},
						"name": "paymentReference",
						"in": "path",
						"required": true
					}
				],
				"responses": {
					"200": {
						"description": "OK",
						"content": {
							"application/json": {
								"schema": {
									"description": "Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.",
									"type": "object"
								},
								"examples": {
									"payment-read-by-reference": {
										"summary": "Payment read by reference",
										"value": {
											"paymentReference": "247086",
											"uniquePaymentId": "v3-capture-1789805452955",
											"customerCode": "TB18780151",
											"customerName": "Ian Menethil",
											"customerReference": "9935442a-6930-428d-b6eb-fa969522e49a",
											"baseAmount": 1,
											"customerFee": 0,
											"fundsToMerchant": 1,
											"processedAmount": 1,
											"paymentAccount": "*****678",
											"paymentCard": "Bank_Account",
											"cardType": 4,
											"cardTypeString": "Bank Account",
											"paymentCardString": "Bank Account",
											"processingDate": "2026-09-19T18:10:56",
											"paymentStatus": 3,
											"paymentStatusString": "Successful",
											"settlementDate": "2026-09-23",
											"paymentMethod": 1,
											"paymentMethodString": "Bank Account",
											"processorReference": "PR.2420u",
											"isPaymentSettledToMerchant": false,
											"merchantName": "Menethil",
											"merchantCode": "1337",
											"isPaymentRetryScheduled": false,
											"processorRetryCount": 0,
											"isPaymentRecalled": false,
											"isPaymentRefunded": false,
											"cardCategory": "Bank Account",
											"paymentType": 1,
											"paymentTypeString": "Charge",
											"isPaymentChargeBacked": false,
											"paymentSource": 58,
											"paymentSourceString": "Cust.Api Payment",
											"hasPendingRefundRequest": false,
											"isPartialRefund": false,
											"refundedAmount": 0,
											"refundedCustomerFeeAmount": 0
										}
									}
								}
							}
						}
					}
				},
				"security": [
					{
						"BearerAuth": []
					}
				],
				"summary": "Get a payment by reference",
				"description": "Returns the payment for the specified customer and payment reference."
			}
		},
		"/v3/{customerCode}/uniquePaymentId/{uniquePaymentId}": {
			"get": {
				"tags": [
					"Payments"
				],
				"operationId": "Payments_GetPayment",
				"parameters": [
					{
						"schema": {
							"type": "string"
						},
						"name": "customerCode",
						"in": "path",
						"required": true
					},
					{
						"schema": {
							"type": "string"
						},
						"name": "uniquePaymentId",
						"in": "path",
						"required": true
					}
				],
				"responses": {
					"200": {
						"description": "OK",
						"content": {
							"application/json": {
								"schema": {
									"description": "Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.",
									"type": "object"
								},
								"examples": {
									"payment-read-by-unique-id": {
										"summary": "Payment read by unique id",
										"value": {
											"paymentReference": "247086",
											"uniquePaymentId": "v3-capture-1789805452955",
											"customerCode": "TB18780151",
											"customerName": "Ian Menethil",
											"customerReference": "9935442a-6930-428d-b6eb-fa969522e49a",
											"baseAmount": 1,
											"customerFee": 0,
											"fundsToMerchant": 1,
											"processedAmount": 1,
											"paymentAccount": "*****678",
											"paymentCard": "Bank_Account",
											"cardType": 4,
											"cardTypeString": "Bank Account",
											"paymentCardString": "Bank Account",
											"processingDate": "2026-09-19T18:10:56",
											"paymentStatus": 3,
											"paymentStatusString": "Successful",
											"settlementDate": "2026-09-23",
											"paymentMethod": 1,
											"paymentMethodString": "Bank Account",
											"processorReference": "PR.2420u",
											"isPaymentSettledToMerchant": false,
											"merchantName": "Menethil",
											"merchantCode": "1337",
											"isPaymentRetryScheduled": false,
											"processorRetryCount": 0,
											"isPaymentRecalled": false,
											"isPaymentRefunded": false,
											"cardCategory": "Bank Account",
											"paymentType": 1,
											"paymentTypeString": "Charge",
											"isPaymentChargeBacked": false,
											"paymentSource": 58,
											"paymentSourceString": "Cust.Api Payment",
											"hasPendingRefundRequest": false,
											"isPartialRefund": false,
											"refundedAmount": 0,
											"refundedCustomerFeeAmount": 0
										}
									}
								}
							}
						}
					}
				},
				"security": [
					{
						"BearerAuth": []
					}
				],
				"summary": "Get a payment by unique ID",
				"description": "Returns the payment for the specified customer and unique payment ID."
			}
		},
		"/v3/{customerCode}/payments": {
			"get": {
				"tags": [
					"Payments"
				],
				"summary": "Get all the payments",
				"operationId": "Payments_Get",
				"parameters": [
					{
						"schema": {
							"type": "string"
						},
						"name": "customerCode",
						"in": "path",
						"description": "Customer code",
						"required": true
					},
					{
						"schema": {
							"type": "string"
						},
						"name": "uniqueCustomerId",
						"in": "query",
						"description": "Unique Customer ID. This can be configured at the customer portal.",
						"required": false
					},
					{
						"schema": {
							"type": "string"
						},
						"name": "paymentReference",
						"in": "query",
						"description": "Payment reference",
						"required": false
					},
					{
						"schema": {
							"type": "string"
						},
						"name": "customerReference",
						"in": "query",
						"description": "Customer reference",
						"required": false
					},
					{
						"schema": {
							"type": "string"
						},
						"name": "uniquePaymentId",
						"in": "query",
						"description": "Unique payment id.",
						"required": false
					},
					{
						"schema": {
							"type": "string",
							"format": "date-time"
						},
						"name": "fromProcessedDate",
						"in": "query",
						"description": "From date",
						"required": false
					},
					{
						"schema": {
							"type": "string",
							"format": "date-time"
						},
						"name": "toProcessedDate",
						"in": "query",
						"description": "To date",
						"required": false
					},
					{
						"schema": {
							"type": "integer",
							"format": "int32",
							"default": 0
						},
						"name": "pageOffset",
						"in": "query",
						"description": "Record start",
						"required": false
					},
					{
						"schema": {
							"type": "integer",
							"format": "int32",
							"default": 20
						},
						"name": "pageLimit",
						"in": "query",
						"description": "Number of records",
						"required": false
					}
				],
				"responses": {
					"200": {
						"description": "OK",
						"content": {
							"application/json": {
								"schema": {
									"description": "Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.",
									"type": "object"
								},
								"examples": {
									"payments-listed": {
										"summary": "Payments listed",
										"value": {
											"items": [
												{
													"paymentReference": "221423",
													"customerCode": "TB18780151",
													"customerName": "ian menethil",
													"customerReference": "test6",
													"baseAmount": 6,
													"customerFee": 0,
													"fundsToMerchant": 6,
													"processedAmount": 6,
													"paymentAccount": "*****312",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2026-03-31T16:01:01",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2026-04-02",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1z0he",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0,
													"uniqueCustomerId": "DWYQK6PJCQ8U5EPA"
												},
												{
													"paymentReference": "221422",
													"customerCode": "TB18780151",
													"customerName": "ian menethil",
													"customerReference": "test5",
													"baseAmount": 5,
													"customerFee": 0,
													"fundsToMerchant": 5,
													"processedAmount": 5,
													"paymentAccount": "*****312",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2026-03-31T16:01:01",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2026-04-02",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1z0hd",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0,
													"uniqueCustomerId": "DWYQK6PJCQ8U5EPA"
												},
												{
													"paymentReference": "221421",
													"customerCode": "TB18780151",
													"customerName": "ian menethil",
													"customerReference": "4",
													"baseAmount": 4,
													"customerFee": 0,
													"fundsToMerchant": 4,
													"processedAmount": 4,
													"paymentAccount": "*****312",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2026-03-31T15:51:14",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2026-04-02",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1z0h2",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0,
													"uniqueCustomerId": "DWYQK6PJCQ8U5EPA"
												},
												{
													"paymentReference": "221420",
													"customerCode": "TB18780151",
													"customerName": "ian menethil",
													"customerReference": "x1",
													"baseAmount": 3,
													"customerFee": 0,
													"fundsToMerchant": 3,
													"processedAmount": 3,
													"paymentAccount": "*****312",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2026-03-31T15:51:14",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2026-04-02",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1z0h1",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0,
													"uniqueCustomerId": "DWYQK6PJCQ8U5EPA"
												},
												{
													"paymentReference": "221419",
													"customerCode": "TB18780151",
													"customerName": "ian menethil",
													"customerReference": "test",
													"additionalReference": "test2",
													"baseAmount": 2,
													"customerFee": 0,
													"fundsToMerchant": 2,
													"processedAmount": 2,
													"paymentAccount": "*****312",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2026-03-31T15:46:48",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2026-04-02",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1z0h0",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0,
													"uniqueCustomerId": "DWYQK6PJCQ8U5EPA"
												},
												{
													"paymentReference": "221412",
													"customerCode": "TB18780151",
													"customerName": "ian menethil",
													"customerReference": "testref",
													"additionalReference": "test",
													"baseAmount": 5,
													"customerFee": 0,
													"fundsToMerchant": 5,
													"processedAmount": 5,
													"paymentAccount": "*****312",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2026-03-31T14:21:00",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2026-04-02",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1z0fy",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0,
													"uniqueCustomerId": "DWYQK6PJCQ8U5EPA"
												},
												{
													"paymentReference": "74444",
													"customerCode": "TB18780151",
													"customerName": "Ian Menethil",
													"customerReference": "hello",
													"baseAmount": 10,
													"customerFee": 0,
													"fundsToMerchant": 10,
													"processedAmount": 10,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-09-10T07:01:00",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-09-12",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1g1lp",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 39,
													"paymentSourceString": "Api Tokenised Payment",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "74443",
													"uniquePaymentId": "b620653e-a68c-4654-8c5a-013786e298ff",
													"customerCode": "TB18780151",
													"customerName": "Ian Menethil",
													"customerReference": "3831f872-6440-4e68-a2a5-77308e6d3fa6",
													"oneOffPaymentReference": "Drive Account Avon Borders",
													"additionalReference": "SDD synthesizing",
													"baseAmount": 5,
													"customerFee": 0,
													"fundsToMerchant": 5,
													"processedAmount": 5,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-09-10T07:01:00",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-09-12",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1g1lo",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 58,
													"paymentSourceString": "Cust.Api Payment",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "74442",
													"customerCode": "TB18780151",
													"customerName": "Ian Menethil",
													"customerReference": "q1",
													"baseAmount": 2,
													"customerFee": 0,
													"fundsToMerchant": 2,
													"processedAmount": 2,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-09-09T23:55:13",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-09-12",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1fzgm",
													"isPaymentSettledToMerchant": false,
													"merchantName": "menethil",
													"merchantCode": "menethil",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "74441",
													"customerCode": "TB18780151",
													"customerName": "Elliot Alderson",
													"customerReference": "e2",
													"baseAmount": 2,
													"customerFee": 0,
													"fundsToMerchant": 2,
													"processedAmount": 2,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-09-09T23:46:13",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-09-12",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1fzgl",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "74440",
													"customerCode": "TB18780151",
													"customerName": "Ian Menethil",
													"customerReference": "asdq1",
													"baseAmount": 11,
													"customerFee": 0,
													"fundsToMerchant": 11,
													"processedAmount": 11,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-09-09T23:46:13",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-09-12",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1fzgk",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "74439",
													"uniquePaymentId": "dbedb999-917a-4e03-9e46-6383128102c4",
													"customerCode": "TB18780151",
													"customerName": "Ian Menethil",
													"customerReference": "9935442a-6930-428d-b6eb-fa969522e49a",
													"oneOffPaymentReference": "Licensed bypassing salmon Product",
													"additionalReference": "compress Representative Wooden hub SCSI",
													"baseAmount": 5,
													"customerFee": 0,
													"fundsToMerchant": 5,
													"processedAmount": 5,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-09-09T23:38:40",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-09-12",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1fzgj",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 58,
													"paymentSourceString": "Cust.Api Payment",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "74438",
													"customerCode": "TB18780151",
													"customerName": "Elliot Alderson",
													"customerReference": "pay2",
													"baseAmount": 5,
													"customerFee": 0,
													"fundsToMerchant": 5,
													"processedAmount": 5,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-09-09T23:24:00",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-09-12",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1fzgi",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "74437",
													"customerCode": "TB18780151",
													"customerName": "Ian Menethil",
													"customerReference": "123asd1",
													"additionalReference": "asd1",
													"baseAmount": 2,
													"customerFee": 0,
													"fundsToMerchant": 2,
													"processedAmount": 2,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-09-09T23:24:00",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-09-12",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1fzgh",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "73335",
													"customerCode": "TB18780151",
													"customerName": "Elliot Alderson",
													"customerReference": "Mr Robot - Bank Ref",
													"baseAmount": 2,
													"customerFee": 0,
													"fundsToMerchant": 2,
													"processedAmount": 2,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-08-20T17:01:25",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-08-22",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1exgm",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "73320",
													"customerCode": "TB18780151",
													"customerName": "Elliot Alderson",
													"customerReference": "Mr Robot - Bank Ref",
													"baseAmount": 2.01,
													"customerFee": 0,
													"fundsToMerchant": 2.01,
													"processedAmount": 2.01,
													"paymentAccount": "*****212",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-08-20T14:49:26",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-08-22",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1exfl",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "73319",
													"customerCode": "TB18780151",
													"customerName": "Elliot Alderson",
													"customerReference": "Mr Robot - Bank Ref",
													"baseAmount": 2.03,
													"customerFee": 0,
													"fundsToMerchant": 2.03,
													"processedAmount": 2.03,
													"paymentAccount": "*****212",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-08-20T14:49:26",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-08-22",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1exfk",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "73318",
													"customerCode": "TB18780151",
													"customerName": "Elliot Alderson",
													"customerReference": "Mr Robot - Bank Ref",
													"baseAmount": 2.03,
													"customerFee": 0,
													"fundsToMerchant": 2.03,
													"processedAmount": 2.03,
													"paymentAccount": "*****678",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-08-20T14:33:06",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-08-22",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1exfd",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Menethil",
													"merchantCode": "1337",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 0,
													"paymentSourceString": "Cust.WebPay",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "69067",
													"uniquePaymentId": "9ff866b7-9655-4a44-98a3-f743922c355b",
													"customerCode": "TB18780151",
													"customerName": "Ian Menethil",
													"customerReference": "9938f1dc-56a2-4f8d-a51c-c28c88a79e48",
													"oneOffPaymentReference": "forecast",
													"additionalReference": "Id id nobis alias alias voluptas sit est nisi.",
													"baseAmount": 825.06,
													"customerFee": 0,
													"fundsToMerchant": 825.06,
													"processedAmount": 825.06,
													"paymentAccount": "******596",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-06-16T18:26:57",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-06-19",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1cmvm",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Email Test 3",
													"merchantCode": "EmailT3",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 58,
													"paymentSourceString": "Cust.Api Payment",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												},
												{
													"paymentReference": "69066",
													"uniquePaymentId": "3274db14-a2bc-4109-8b75-5b987327cb9f",
													"customerCode": "TB18780151",
													"customerName": "Ian Menethil",
													"customerReference": "8c63c424-1640-4025-aaea-67426ae414e2",
													"oneOffPaymentReference": "definition",
													"additionalReference": "Architecto amet officia sit hic quia doloremque harum dolores autem.",
													"baseAmount": 172.86,
													"customerFee": 0,
													"fundsToMerchant": 172.86,
													"processedAmount": 172.86,
													"paymentAccount": "******596",
													"paymentCard": "Bank_Account",
													"cardType": 4,
													"cardTypeString": "Bank Account",
													"paymentCardString": "Bank Account",
													"processingDate": "2024-06-16T18:26:57",
													"paymentStatus": 3,
													"paymentStatusString": "Successful",
													"settlementDate": "2024-06-19",
													"paymentMethod": 1,
													"paymentMethodString": "Bank Account",
													"processorReference": "PR.1cmvl",
													"isPaymentSettledToMerchant": false,
													"merchantName": "Email Test 3",
													"merchantCode": "EmailT3",
													"isPaymentRetryScheduled": false,
													"processorRetryCount": 0,
													"isPaymentRecalled": false,
													"isPaymentRefunded": false,
													"cardCategory": "Bank Account",
													"paymentType": 1,
													"paymentTypeString": "Charge",
													"isPaymentChargeBacked": false,
													"paymentSource": 58,
													"paymentSourceString": "Cust.Api Payment",
													"hasPendingRefundRequest": false,
													"isPartialRefund": false,
													"refundedAmount": 0,
													"refundedCustomerFeeAmount": 0
												}
											],
											"itemCount": 136,
											"pageOffset": 0,
											"pageLimit": 20
										}
									}
								}
							}
						}
					}
				},
				"security": [
					{
						"BearerAuth": []
					}
				]
			},
			"post": {
				"tags": [
					"Payments"
				],
				"operationId": "Payments_Post",
				"parameters": [
					{
						"schema": {
							"type": "string"
						},
						"name": "customerCode",
						"in": "path",
						"required": true
					}
				],
				"responses": {
					"200": {
						"description": "OK",
						"content": {
							"application/json": {
								"schema": {
									"description": "Defines a command that asynchronously creates an {System.Net.Http.HttpResponseMessage}.",
									"type": "object"
								}
							}
						}
					},
					"201": {
						"links": {
							"GetPaymentByReference": {
								"operationId": "Payments_GetPaymentByReference",
								"parameters": {
									"customerCode": "$response.body#/customerCode",
									"paymentReference": "$response.body#/paymentReference"
								},
								"description": "Reads the same payment back by its gateway-assigned reference."
							},
							"GetPayment": {
								"operationId": "Payments_GetPayment",
								"parameters": {
									"customerCode": "$response.body#/customerCode",
									"uniquePaymentId": "$response.body#/uniquePaymentId"
								},
								"description": "Reads the same payment back by the uniquePaymentId the caller supplied at creation."
							}
						},
						"content": {
							"application/json": {
								"examples": {
									"payment-created": {
										"summary": "Payment created",
										"value": {
											"paymentReference": "247086",
											"uniquePaymentId": "v3-capture-1789805452955",
											"customerCode": "TB18780151",
											"customerName": "Ian Menethil",
											"customerReference": "9935442a-6930-428d-b6eb-fa969522e49a",
											"baseAmount": 1,
											"customerFee": 0,
											"fundsToMerchant": 0,
											"processedAmount": 1,
											"paymentAccount": "*****678",
											"cardType": 4,
											"cardTypeString": "Bank Account",
											"subCardType": 4,
											"subCardTypeString": "Bank Account",
											"processingDate": "2026-09-19T18:10:56",
											"paymentStatus": 3,
											"paymentStatusString": "Successful",
											"settlementDate": "2026-09-23",
											"processorReference": "PR.2420u",
											"isPaymentSettledToMerchant": false,
											"merchantName": "Menethil",
											"merchantCode": "1337",
											"isPaymentRetryScheduled": false,
											"processorRetryCount": 0,
											"isPaymentRecalled": false,
											"isPaymentRefunded": false,
											"paymentType": 1,
											"paymentTypeString": "Charge",
											"isPaymentChargeBacked": false,
											"paymentSource": 58,
											"paymentSourceString": "Cust.Api Payment",
											"hasPendingRefundRequest": false,
											"isPartialRefund": false,
											"refundedAmount": 0,
											"refundedCustomerFeeAmount": 0
										}
									}
								}
							}
						}
					},
					"300": {
						"content": {
							"application/json": {
								"examples": {
									"payment-id-resent": {
										"summary": "Payment id resent",
										"value": {
											"message": "The Payment unique id already exists."
										}
									}
								}
							}
						}
					}
				},
				"security": [
					{
						"BearerAuth": []
					}
				],
				"requestBody": {
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PaymentRequest"
							},
							"examples": {
								"payment-created": {
									"summary": "Payment created",
									"value": {
										"merchantCode": "1337",
										"customerReference": "9935442a-6930-428d-b6eb-fa969522e49a",
										"paymentAmount": 1,
										"uniquePaymentId": "v3-capture-1789805452955",
										"sendPaymentConfirmation": false
									}
								}
							}
						},
						"application/x-www-form-urlencoded": {
							"schema": {
								"$ref": "#/components/schemas/PaymentRequest"
							}
						}
					},
					"required": true
				},
				"summary": "Create a payment",
				"description": "Creates a payment from the supplied request payload."
			}
		}
	},
	"tags": [
		{
			"name": "Diagnostics",
			"description": "System Diagnostics"
		},
		{
			"name": "Payments"
		}
	],
	"openapi": "3.2.0",
	"servers": [
		{
			"url": "https://{subdomain}.{baseDomain}",
			"description": "Customer APIs — choose an environment prefix and brand domain",
			"variables": {
				"subdomain": {
					"default": "api.sandbox",
					"enum": [
						"api",
						"apiuat",
						"api.sandbox"
					],
					"description": "Environment prefix"
				},
				"baseDomain": {
					"default": "travelpay.com.au",
					"enum": [
						"travelpay.com.au",
						"b2bpay.com.au",
						"childcareeasypay.com.au",
						"schooleasypay.com.au",
						"rentalrewards.com.au",
						"zenpay.com.au",
						"thoroughbredpayments.com.au"
					],
					"description": "Brand domain"
				}
			}
		}
	],
	"components": {
		"schemas": {
			"PingResponse": {
				"description": "Ping result",
				"properties": {
					"serverDateTime": {
						"description": "Server Date Time",
						"type": "string",
						"format": "date-time"
					},
					"version": {
						"description": "API version",
						"type": "string"
					},
					"timeZoneInfo": {
						"description": "DateTime Time Zone",
						"type": "string"
					},
					"buildVersion": {
						"description": "Build version",
						"type": "string"
					}
				},
				"type": "object"
			},
			"PaymentRequest": {
				"required": [
					"merchantCode",
					"customerReference",
					"paymentAmount",
					"uniquePaymentId"
				],
				"properties": {
					"merchantCode": {
						"type": "string"
					},
					"customerReference": {
						"type": "string"
					},
					"paymentAmount": {
						"type": "number",
						"format": "double"
					},
					"uniquePaymentId": {
						"type": "string",
						"maxLength": 50
					},
					"oneOffPaymentReference": {
						"type": "string"
					},
					"additionalReference": {
						"type": "string"
					},
					"sendPaymentConfirmation": {
						"type": "boolean"
					},
					"uniqueCustomerId": {
						"description": "Unique Customer ID. This can be configured at the customer portal.",
						"type": "string",
						"maxLength": 20
					}
				},
				"type": "object"
			}
		},
		"securitySchemes": {
			"BearerAuth": {
				"type": "http",
				"scheme": "bearer"
			}
		}
	},
	"x-zp-conversion": {
		"converter": "@scalar/openapi-upgrader@0.4.3",
		"sourceHash": "sha256:93fecc1354e1e91f466f3fcb2ccb654d997cf3bca154e5aa980121a2996ceebd",
		"status": "ok"
	},
	"security": [
		{
			"BearerAuth": []
		}
	]
}