On This Page
REST Example: Processing a Refund with Level III Data
Request
{ "clientReferenceInformation": { "code": "Simple Refund Invoice" }, "processingInformation": { "purchaseLevel": "3" }, "orderInformation": { "amountDetails": { "totalAmount": "112.00", "currency": "GBP", "taxAmount": "18.67" }, "billTo": { "firstName": "Buyer", "lastName": "OfGoods", "company": { "name": "Acme Inc" }, "address1": "1 High Street", "locality": "Belfast", "postalCode": "BT1 2AB", "country": "UK", "email": "[email protected]" }, "lineItems": [ { "productName": "Widgets", "productSku": "WID1", "quantity": "7", "unitPrice": "10.00", "unitOfMeasure": "EA", "totalAmount": "70.00", "taxAmount": "14.00", "taxRate": "20.00", "taxTypeCode": "S" }, { "productName": "Freight", "productSku": "ABC123", "quantity": "1", "unitPrice": "23.33", "unitOfMeasure": "EA", "totalAmount": "23.33", "taxAmount": "4.67", "taxRate": "20.00", "taxTypeCode": "S" } ], "invoiceDetails": { "purchaseOrderNumber": "PO21122", "purchaseOrderDate": "20220601", "costCenter": "WE21122", "invoiceDate": "20220601000000", "supplierOrderReference": "ACME1234" } }, "buyerInformation": { "merchantCustomerId": "TESTBBREFACD21122", "vatRegistrationNumber": "GB123421100" }, "merchantInformation": { "merchantDescriptor": { "name": "Widgets Inc", "contact": "02890491491", "address1": "1 Main Street", "locality": "Belfast", "country": "UK", "postalCode": "BT1 2AB" }, "vatRegistrationNumber": "GB987654321" } }
Successful Response
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/refunds/6799463712606276304953/voids" }, "self": { "method": "GET", "href": "/pts/v2/refunds/6799463712606276304953" } }, "clientReferenceInformation": { "code": "Simple Sale Invoice" }, "id": "6799463712606276304953", "orderInformation": { "invoiceDetails": { "level3TransmissionStatus": "Y" }, "amountDetails": { "currency": "GBP" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "processorInformation": { "approvalCode": "888888", "responseCode": "100" }, "reconciliationId": "70383210IFKZFMTP", "refundAmountDetails": { "currency": "GBP", "refundAmount": "112.00" }, "status": "PENDING", "submitTimeUtc": "2023-03-27T19:46:11Z" }