Pay.POS

🚧
Please note that the Pay.POS exchange payload may still be running on the legacy version. To enable the new version, please contact [email protected] and include your Merchant code.

Pay.POS exchange payload

With payments started on a Pay.POS device on Pay's application we can deliver the same payload as you would have get with the transaction:info API. How you respond to our exchange remains the same.

This exchange will provide a more detailed overview of the order and the exchange process. Therefore there is no need anymore to call one of our API's to retrieve the status of a payment.

An exchange includes all essential data in its body to process the request. It contains the following key elements:

Action: The event that triggered the exchange to your system.
ID: The unique identifier of the object being exchanged.
Status: The status of the Pay.POS transaction.

If we put all the keys together, the exchange will look as follow:

{
	"action": "new_ppt",
	"id": "EX-8186-6581-8342",
	"orderId": "51407209040X1f21",
	"serviceCode": "SL-4912-4753",
	"description": "",
	"reference": "",
	"ipAddress": null,
	"amount": {
		"value": "1",
		"currency": "EUR"
	},
	"amountConverted": {
		"value": "1",
		"currency": "EUR"
	},
	"amountPaid": {
		"value": "1",
		"currency": "EUR"
	},
	"amountRefunded": {
		"value": "0",
		"currency": "EUR"
	},
	"status": {
		"code": "100",
		"action": "PAID",
		"phase": "SUCCESS"
	},
	"paymentData": {
		"method": "creditcard",
		"customerKey": "563c53c8d6347a260d58dc20393bc00e",
		"customerId": "524322******6350",
		"customerName": null,
		"ipAddress": "144.178.192.171",
		"secureStatus": "",
		"paymentVerificationMethod": "17",
		"creditcard": {
			"number": "524322******6350",
			"expireMonth": null,
			"expireYear": "",
			"name": null
		}
	},
	"paymentMethod": {
		"id": "3069",
		"subId": "33046",
		"name": "SoftPos",
		"terminalCode": "TH-1384-6122"
	},
	"billingLineId": "3723",
	"integration": {
		"testMode": ""
	},
	"customer": {
		"firstName": null,
		"lastName": null,
		"type": "B",
		"birthDate": null,
		"language": "",
		"gender": null,
		"phone": null,
		"email": null,
		"ipAddress": "144.178.192.171",
		"trust": "0",
		"reference": "",
		"bankAccount": {
			"iban": null,
			"bic": null,
			"owner": null
		},
		"company": {
			"name": "",
			"coc": "",
			"vat": "",
			"countryCode": ""
		}
	},
	"order": {
		"countryCode": "NL",
		"deliveryDate": "",
		"invoiceDate": "",
		"deliveryAddress": {
			"firstName": null,
			"lastName": null,
			"streetName": null,
			"streetNumber": null,
			"streetNumberExtension": null,
			"zipCode": null,
			"city": null,
			"regionCode": null,
			"countryCode": null
		},
		"invoiceAddress": {
			"firstName": null,
			"lastName": null,
			"streetName": null,
			"streetNumber": null,
			"streetNumberExtension": null,
			"zipCode": null,
			"city": null,
			"regionCode": null,
			"countryCode": null
		},
		"products": []
	},
	"stats": {
		"info": "",
		"tool": "",
		"object": "",
		"extra1": "",
		"extra2": "",
		"extra3": "",
		"domainId": null
	},
	"transferData": [],
	"expiresAt": null,
	"createdAt": ""2026-05-27T09:02:30+02:00"",
	"createdBy": null,
	"modifiedAt": ""2026-05-27T09:02:30+02:00",
	"modifiedBy": "A-6614-7983",
	"deletedAt": null,
	"deletedBy": null
}

PaymentData

For each payment we return a paymentdata object, this object gives information about the customer that has done the payment.

For Pay.POS payments, the object looks like:

	},
	"paymentData": {
		"method": "creditcard",
		"customerKey": "563c53c8d6347a260d58dc20393bc00e",
		"customerId": "524322******6350",
		"customerName": null,
		"ipAddress": "144.178.192.171",
		"secureStatus": "",
		"paymentVerificationMethod": "17",
		"creditcard": {
			"number": "524322******6350",
			"expireMonth": null,
			"expireYear": "",
			"name": null
		}

Pay.POS legacy exchanges

The legacy format of our SoftPOS transactions look's like:

{
	"action": "new_ppt",
	"website_id": "3",
	"website_location_id": "1",
	"program_id": "248439",
	"payment_profile_id": "3069",
	"payment_method_id": "4",
	"payment_session_id": "3399368591",
	"promotor_id": "0",
	"tool": "",
	"info": "",
	"object": "",
	"domain_id": "0",
	"ip_address": "127.0.0.1",
	"pincode": "785576391",
	"amount": "0.01",
	"extra1": "",
	"extra2": "",
	"extra3": "",
	"transfer_data": "",
	"product_id": "0",
	"secret": "0",
	"order_id": "51000200023X1f44",
	"enduser_id": "0"
}