--- updatedAt: 2025-05-28T09:45:42.000Z agentTools: projectIndex: https://docs.payplus.co.il/llms.txt --- # Transaction Callback Response In every successful transaction, if a callback URL is set in your account, The system will send you all the transaction details that have been successfully charged or refunded. payment_request_uid will be sent just if the transaction made through your payment page. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "PayPlus - API Documentation - Production", "version": "1.0" }, "tags": [ { "name": "Transactions" } ], "servers": [ { "url": "https://restapi.payplus.co.il/api/v1.0/", "description": "Production" }, { "url": "https://restapidev.payplus.co.il/api/v1.0/", "description": "Staging" } ], "security": [ {} ], "paths": { "/YOURDOMAIN/YOURENDPOINT": { "get": { "tags": [ "Transactions" ], "summary": "Transaction Callback Response", "description": "In every successful transaction, if a callback URL is set in your account, The system will send you all the transaction details that have been successfully charged or refunded. payment_request_uid will be sent just if the transaction made through your payment page.", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n\"transaction_type\": \"Charge\",\n\"transaction\": {\n\"uid\": \"dcb11c1e7-a1231-37cf-6311-f5111eeb69c7\",\n\"payment_request_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"number\": \"fd138\",\n\"type\": \"internal_page\",\n\"date\": \"2021-01-21 12:32:52\",\n\"status_code\": \"000\",\n\"amount\": 1,\n\"currency\": \"ILS\",\n\"credit_terms\": \"regular\",\n\"payments\": {\n\"number_of_payments\": 1,\n\"first_payment_amount\": 0,\n\"rest_payments_amount\": 0\n},\n\"secure3D\": {\n\"status\": false,\n\"tracking\": null\n},\n\"approval_number\": \"002341\",\n\"voucher_number\": \"15-901-901\",\n\"more_info\": \"Some Info\",\n\"more_info_1\": \"Additional 1\",\n\"more_info_2\": \"Additional 2\",\n\"more_info_3\": \"Additional 3\",\n\"more_info_4\": \"Additional 4\",\n\"more_info_5\": \"Additional 5\",\n\"recurring_charge_information\": {\n\"recurring_uid\": \"dca25774-c98b-4dc6-9024-2e8b358d3bb9\",\n\"charge_uid\": \"9ba8e867-0526-4458-be6e-e38b4e174d7c\"\n}\n},\n\"data\": {\n\"customer_uid\": \"3bcc6b2d-b35a-62e1-72c1-318a79bfd1be\",\n\"terminal_uid\": \"6500833f-cd32-4f52-7364-1e0db24f13ee\",\n\"cashier_uid\": \"3232141c-1e11-2db6-afaf-25b4301a6acd\",\n\"items\": [\n{\n\"amount_pay\": 1,\n\"discount_amount\": 0,\n\"discount_type\": null,\n\"discount_value\": 0,\n\"quantity\": 1,\n\"quantity_price\": 1,\n\"product_uid\": \"14312ecc-ed90-49f2-823a-a9620e7410d1\",\n\"name\": \"מנוי שנתי\"\n}\n],\n\"card_information\": {\n\"card_holder_name\": \"Moshe Cohen\",\n\"four_digits\": \"6134\",\n\"expiry_month\": \"09\",\n\"expiry_year\": \"24\",\n\"clearing_id\": 6,\n\"brand_id\": 8,\n\"issuer_id\": 6,\n\"card_foreign\": 99,\n\"card_bin\": \"375510\",\n\"identification_number\": \"123456789\"\n},\n\"hash_data\": \"ewogICAgImVtYWlsIjogdGVzdGVtYWlsQGRvbWFpbi5jb20sCiAgICAibmFtZSI6ICJMaW9yIEVsLVByb2Zlc3NvciIsCiAgICAidmF0X251bWJlciI6ICIwMzYyMjAwNDQiLAogICAgInBob25lIjogIjk3MjU0NDMxNjI5NSIKfQ==\"\n},\n\"invoice\": {\n\"uuid\": \"65ad5633-2242-4b1d-8e0a-887db1319d6f\",\n\"docu_number\": \"90191\",\n\"original_url\": \"https://invoice.company.co.il/front/documents/get/17d2201b-1313-43ee-b9d1-0569ffad7951\",\n\"copy_url\": \"https://invoice.company.co.il/front/documents/get/17d2201b-1313-43ee-b9d1-0569ffad7951/copy\",\n\"integrator_name\": \"Invoice Company\",\n\"status\": \"Success\",\n\"brand_name\": \"PayPlus External Brand Name\"\n}\n}" } }, "schema": { "type": "object", "properties": { "transaction_type": { "type": "string", "example": "Charge" }, "transaction": { "type": "object", "properties": { "uid": { "type": "string", "example": "dcb11c1e7-a1231-37cf-6311-f5111eeb69c7" }, "payment_request_uid": { "type": "string", "example": "ef76432c-769a-43a6-ba7a-6f70272539d8" }, "number": { "type": "string", "example": "fd138" }, "type": { "type": "string", "example": "internal_page" }, "date": { "type": "string", "example": "2021-01-21 12:32:52" }, "status_code": { "type": "string", "example": "000" }, "amount": { "type": "number" }, "currency": { "type": "string", "example": "ILS" }, "credit_terms": { "type": "string", "example": "regular" }, "payments": { "type": "object", "properties": { "number_of_payments": { "type": "integer", "example": 1, "default": 0 }, "first_payment_amount": { "type": "integer", "example": 0, "default": 0 }, "rest_payments_amount": { "type": "integer", "example": 0, "default": 0 } } }, "secure3D": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "tracking": {} } }, "approval_number": { "type": "string", "example": "002341" }, "voucher_number": { "type": "string", "example": "15-901-901" }, "more_info": { "type": "string", "example": "Some Info" }, "more_info_1": { "type": "string", "example": "Additional 1" }, "more_info_2": { "type": "string", "example": "Additional 2" }, "more_info_3": { "type": "string", "example": "Additional 3" }, "more_info_4": { "type": "string", "example": "Additional 4" }, "more_info_5": { "type": "string", "example": "Additional 5" }, "recurring_charge_information": { "type": "object", "properties": { "recurring_uid": { "type": "string", "example": "dca25774-c98b-4dc6-9024-2e8b358d3bb9" }, "charge_uid": { "type": "string", "example": "9ba8e867-0526-4458-be6e-e38b4e174d7c" } } } } }, "data": { "type": "object", "properties": { "customer_uid": { "type": "string", "example": "3bcc6b2d-b35a-62e1-72c1-318a79bfd1be" }, "terminal_uid": { "type": "string", "example": "6500833f-cd32-4f52-7364-1e0db24f13ee" }, "cashier_uid": { "type": "string", "example": "3232141c-1e11-2db6-afaf-25b4301a6acd" }, "items": { "type": "array", "items": { "type": "object", "properties": { "amount_pay": { "type": "integer", "example": 1, "default": 0 }, "discount_amount": { "type": "integer", "example": 0, "default": 0 }, "discount_type": {}, "discount_value": { "type": "integer", "example": 0, "default": 0 }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "quantity_price": { "type": "integer", "example": 1, "default": 0 }, "product_uid": { "type": "string", "example": "14312ecc-ed90-49f2-823a-a9620e7410d1" }, "name": { "type": "string", "example": "מנוי שנתי" } } } }, "card_information": { "type": "object", "properties": { "card_holder_name": { "type": "string", "example": "Moshe Cohen" }, "four_digits": { "type": "string", "example": "6134" }, "expiry_month": { "type": "string", "example": "09" }, "expiry_year": { "type": "string", "example": "24" }, "clearing_id": { "type": "integer", "example": 6, "default": 0 }, "brand_id": { "type": "integer", "example": 8, "default": 0 }, "issuer_id": { "type": "integer", "example": 6, "default": 0 }, "card_foreign": { "type": "integer", "example": 99, "default": 0 }, "card_bin": { "type": "string", "example": "375510" }, "identification_number": { "type": "string", "example": "123456789" } } }, "hash_data": { "type": "string", "example": "ewogICAgImVtYWlsIjogdGVzdGVtYWlsQGRvbWFpbi5jb20sCiAgICAibmFtZSI6ICJMaW9yIEVsLVByb2Zlc3NvciIsCiAgICAidmF0X251bWJlciI6ICIwMzYyMjAwNDQiLAogICAgInBob25lIjogIjk3MjU0NDMxNjI5NSIKfQ==" } } }, "invoice": { "type": "object", "properties": { "uuid": { "type": "string", "example": "65ad5633-2242-4b1d-8e0a-887db1319d6f" }, "docu_number": { "type": "string", "example": "90191" }, "original_url": { "type": "string", "example": "https://invoice.company.co.il/front/documents/get/17d2201b-1313-43ee-b9d1-0569ffad7951" }, "copy_url": { "type": "string", "example": "https://invoice.company.co.il/front/documents/get/17d2201b-1313-43ee-b9d1-0569ffad7951/copy" }, "integrator_name": { "type": "string", "example": "Invoice Company" }, "status": { "type": "string", "example": "Success" }, "brand_name": { "type": "string", "example": "PayPlus External Brand Name" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```