{ "item": [ { "name": "Notifications", "description": "Notifications API Objects.\n", "item": [ { "id": "c03d3c6a-5c98-4392-bde2-29ea5ef95cfc", "name": "Transaction update event", "request": { "name": "Transaction update event", "description": { "content": "This webhook will be sent when the status of all transaction types is updated - deposit, withdrawal or transfers.", "type": "text/plain" }, "url": { "path": [ "transactions", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"operationType\": \"Create\",\n \"transaction\": {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"type\": \"DEPOSIT\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"creationTime\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"PENDING\",\n \"paymentType\": \"BANK_TRANSFER\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"recipientReference\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "54a05505-80f0-459d-a728-65e1b7406af7", "name": "OK", "originalRequest": { "url": { "path": [ "transactions", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"operationType\": \"Create\",\n \"transaction\": {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"type\": \"DEPOSIT\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"creationTime\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"PENDING\",\n \"paymentType\": \"BANK_TRANSFER\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"recipientReference\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea2e1962-d2da-403e-967c-140bb8cc8fb9", "name": "Accepted", "originalRequest": { "url": { "path": [ "transactions", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"operationType\": \"Create\",\n \"transaction\": {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"type\": \"DEPOSIT\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"creationTime\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"PENDING\",\n \"paymentType\": \"BANK_TRANSFER\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"recipientReference\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26c37dd3-909b-40b1-ae50-d20fb4eab801", "name": "Bad Request", "originalRequest": { "url": { "path": [ "transactions", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"operationType\": \"Create\",\n \"transaction\": {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"type\": \"DEPOSIT\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"creationTime\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"PENDING\",\n \"paymentType\": \"BANK_TRANSFER\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"recipientReference\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8910d5ae-82ae-48b9-bd24-cc2108c120a9", "name": "Payment update event", "request": { "name": "Payment update event", "description": { "content": "Webhooks directly tied to Embedded Wallet payment object:\n\n* Transfer\n* Deposit\n* Withdrawal\n* Withdrawal Reversal\n* Refund\n* Purchase order\n\nPayment events are tied to change in each of these object and allows tracking the payment object changes.", "type": "text/plain" }, "url": { "path": [ "payments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"WITHDRAWAL_REVERSAL_UPDATE\",\n \"paymentId\": \"\",\n \"paymentCreationTimestamp\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"eventType\": \"TRANSFER_UPDATE\",\n \"status\": \"PROCESSING\",\n \"nextStatus\": [\n \"PROCESSING\",\n \"REFUNDED\"\n ],\n \"statusReason\": \"DW-DEPOSIT-ACCOUNT-NOT-FOUND\"\n },\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ff8409b5-3646-4abf-83ab-ed152c092bbb", "name": "OK", "originalRequest": { "url": { "path": [ "payments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"WITHDRAWAL_REVERSAL_UPDATE\",\n \"paymentId\": \"\",\n \"paymentCreationTimestamp\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"eventType\": \"TRANSFER_UPDATE\",\n \"status\": \"PROCESSING\",\n \"nextStatus\": [\n \"PROCESSING\",\n \"REFUNDED\"\n ],\n \"statusReason\": \"DW-DEPOSIT-ACCOUNT-NOT-FOUND\"\n },\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa4331d0-7379-43d1-b7fe-3ef4e8857d4e", "name": "Accepted", "originalRequest": { "url": { "path": [ "payments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"WITHDRAWAL_REVERSAL_UPDATE\",\n \"paymentId\": \"\",\n \"paymentCreationTimestamp\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"eventType\": \"TRANSFER_UPDATE\",\n \"status\": \"PROCESSING\",\n \"nextStatus\": [\n \"PROCESSING\",\n \"REFUNDED\"\n ],\n \"statusReason\": \"DW-DEPOSIT-ACCOUNT-NOT-FOUND\"\n },\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "870da40c-423c-497e-8793-3afc5d166e17", "name": "Bad Request", "originalRequest": { "url": { "path": [ "payments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"WITHDRAWAL_REVERSAL_UPDATE\",\n \"paymentId\": \"\",\n \"paymentCreationTimestamp\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"eventType\": \"TRANSFER_UPDATE\",\n \"status\": \"PROCESSING\",\n \"nextStatus\": [\n \"PROCESSING\",\n \"REFUNDED\"\n ],\n \"statusReason\": \"DW-DEPOSIT-ACCOUNT-NOT-FOUND\"\n },\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b143aa38-cc6e-4d0c-ba24-118ac2072398", "name": "Virtual Instrument Request Status Event", "request": { "name": "Virtual Instrument Request Status Event", "description": { "content": "Webhook for tracking virtual instrument issuing progress.\n\nThis webhook allows you to track the progress of issuing a virtual instrument (e.g., a virtual bank account).\n\nVirtual instruments are payment instruments linked to a wallet balance account. Currently, only virtual bank accounts are supported. These instruments simplify bank deposits and reduce the risk of misdirected transfers.\n\nThey are called virtual because they are owned by Paysafe and assigned to individual customers, but do not have a dedicated balance. Instead, they are linked to the wallet balance.\n\nThe type of virtual instrument depends on the customer's location and may include:\n\n* IBAN (SEPA_BANK_ACCOUNT)\n* UK bank account (US_BANK_ACCOUNT)\n* US bank account (UK_BANK_ACCOUNT)", "type": "text/plain" }, "url": { "path": [ "virtual-instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"VIRTUAL_INSTRUMENT_REQUEST_CREATED\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"related\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\",\n \"accountId\": \"\",\n \"status\": \"ACCEPTED\",\n \"statusReason\": \"\",\n \"virtualInstrumentId\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "88e36f62-09d3-4d51-9c73-f21dc8a27f6f", "name": "OK", "originalRequest": { "url": { "path": [ "virtual-instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"VIRTUAL_INSTRUMENT_REQUEST_CREATED\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"related\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\",\n \"accountId\": \"\",\n \"status\": \"ACCEPTED\",\n \"statusReason\": \"\",\n \"virtualInstrumentId\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f114044a-d3fd-4c4a-b427-ecf6c85ea11d", "name": "Accepted", "originalRequest": { "url": { "path": [ "virtual-instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"VIRTUAL_INSTRUMENT_REQUEST_CREATED\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"related\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\",\n \"accountId\": \"\",\n \"status\": \"ACCEPTED\",\n \"statusReason\": \"\",\n \"virtualInstrumentId\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87728692-27de-4498-931f-5686ecbd58c0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "virtual-instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"VIRTUAL_INSTRUMENT_REQUEST_CREATED\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"related\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\",\n \"accountId\": \"\",\n \"status\": \"ACCEPTED\",\n \"statusReason\": \"\",\n \"virtualInstrumentId\": \"\"\n },\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6574cee2-3259-41f5-af19-ae5bb205d9b7", "name": "Customer restriction update event", "request": { "name": "Customer restriction update event", "description": { "content": "When applying restrictions to a customer, the system has two distinct behaviours, depending on the type of restriction being placed:\n\n* All regulatory restrictions are applied immediately, e.g. Sanctions; for these type of restrictions, the Merchant will receive just the one webhook with operationType == 'UPDATE'.\n* Fraud related restrictions are synchronized between Paysafe and Merchant, as the customer could have pending operations on the Merchant's system. In this case:\n * Paysafe will first send a webhook with `operationType == 'SYNC'`; the restriction is not yet applied on Paysafe's side\n * Merchant must confirm the restriction by calling the restriction confirmation API; if the restriction is not confirmed within a time frame (e.g. 60sec), the restriction will be applied automatically;\n * When the restriction is applied on Paysafe side, a new webhook will be sent, where `operationType == 'UPDATE'`.\n \n* Webhooks with `operationType='NOTIFY'` can be sent to the Merchant with dueDate set to a date which defines when the restriction will be applied to the Merchant's customer. The Merchant needs to take the appropriate actions to prevent the restriction from applying to the customer until dueDate.", "type": "text/plain" }, "url": { "path": [ "customers", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"externalId\": \"\",\n \"restrictions\": [\n {\n \"name\": \"LOGIN\",\n \"reason\": \"DUPLICATE_ACCOUNT\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_ID\",\n \"SECOND_FORM_OF_ID\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"OTHER\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"PEP_DECLARATION\",\n \"COMPLETE_ONBOARDING\"\n ],\n \"creationTime\": \"\"\n }\n ]\n },\n \"operationType\": \"SYNC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1ee0e513-8472-4456-b063-27e428a25400", "name": "OK", "originalRequest": { "url": { "path": [ "customers", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"externalId\": \"\",\n \"restrictions\": [\n {\n \"name\": \"LOGIN\",\n \"reason\": \"DUPLICATE_ACCOUNT\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_ID\",\n \"SECOND_FORM_OF_ID\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"OTHER\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"PEP_DECLARATION\",\n \"COMPLETE_ONBOARDING\"\n ],\n \"creationTime\": \"\"\n }\n ]\n },\n \"operationType\": \"SYNC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f434f497-729d-4dd8-945c-8b044af770e2", "name": "Accepted", "originalRequest": { "url": { "path": [ "customers", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"externalId\": \"\",\n \"restrictions\": [\n {\n \"name\": \"LOGIN\",\n \"reason\": \"DUPLICATE_ACCOUNT\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_ID\",\n \"SECOND_FORM_OF_ID\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"OTHER\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"PEP_DECLARATION\",\n \"COMPLETE_ONBOARDING\"\n ],\n \"creationTime\": \"\"\n }\n ]\n },\n \"operationType\": \"SYNC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d63ff887-92b6-4f9b-b6a8-4db337bba668", "name": "Bad Request", "originalRequest": { "url": { "path": [ "customers", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"externalId\": \"\",\n \"restrictions\": [\n {\n \"name\": \"LOGIN\",\n \"reason\": \"DUPLICATE_ACCOUNT\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_ID\",\n \"SECOND_FORM_OF_ID\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"OTHER\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"PEP_DECLARATION\",\n \"COMPLETE_ONBOARDING\"\n ],\n \"creationTime\": \"\"\n }\n ]\n },\n \"operationType\": \"SYNC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cfd501b-107a-4fac-8c43-90e9c677eabe", "name": "Prepaid card status update event", "request": { "name": "Prepaid card status update event", "description": { "content": "This webhook will be sent when the card status is updated and when a card is created. The field `operationType` signifies the change that occurred.", "type": "text/plain" }, "url": { "path": [ "prepaid", "card", "status", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"oldStatus\": \"DIGITAL\",\n \"newStatus\": \"CANCELLED\",\n \"operationType\": \"UPDATE\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a8acc324-3072-49b2-ac97-cc5a49b3a535", "name": "OK", "originalRequest": { "url": { "path": [ "prepaid", "card", "status", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"oldStatus\": \"DIGITAL\",\n \"newStatus\": \"CANCELLED\",\n \"operationType\": \"UPDATE\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4822e28f-163f-4e32-82f2-deedee160051", "name": "Accepted", "originalRequest": { "url": { "path": [ "prepaid", "card", "status", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"oldStatus\": \"DIGITAL\",\n \"newStatus\": \"CANCELLED\",\n \"operationType\": \"UPDATE\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c2429ff-8073-48db-8b44-615941f13095", "name": "Bad Request", "originalRequest": { "url": { "path": [ "prepaid", "card", "status", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"oldStatus\": \"DIGITAL\",\n \"newStatus\": \"CANCELLED\",\n \"operationType\": \"UPDATE\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "880fe948-c211-4084-a160-d99d79e34aa5", "name": "Prepaid card tokenization event", "request": { "name": "Prepaid card tokenization event", "description": { "content": "This webhook will be sent when the card is tokenized by Google, Apple or a merchant website.", "type": "text/plain" }, "url": { "path": [ "prepaid", "card", "tokenization", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"walletType\": \"\",\n \"deviceMobileNumber\": \"\",\n \"deviceIp\": \"\",\n \"deviceId\": \"\",\n \"deviceType\": \"POS\",\n \"creatorStatus\": \"P\",\n \"lang\": \"\",\n \"activationMethod\": \"\",\n \"activationMethodData\": \"\",\n \"eventTimestamp\": \"\",\n \"enrollmentStatus\": \"TOKENIZATION_FAILED\",\n \"paymentTokenType\": \"CL\",\n \"paymentTokenId\": \"\",\n \"eventId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3fb0d927-3238-44b0-bb2a-a520e187202b", "name": "OK", "originalRequest": { "url": { "path": [ "prepaid", "card", "tokenization", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"walletType\": \"\",\n \"deviceMobileNumber\": \"\",\n \"deviceIp\": \"\",\n \"deviceId\": \"\",\n \"deviceType\": \"POS\",\n \"creatorStatus\": \"P\",\n \"lang\": \"\",\n \"activationMethod\": \"\",\n \"activationMethodData\": \"\",\n \"eventTimestamp\": \"\",\n \"enrollmentStatus\": \"TOKENIZATION_FAILED\",\n \"paymentTokenType\": \"CL\",\n \"paymentTokenId\": \"\",\n \"eventId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7902beb6-1a8d-44c6-915a-41e064da2194", "name": "Accepted", "originalRequest": { "url": { "path": [ "prepaid", "card", "tokenization", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"walletType\": \"\",\n \"deviceMobileNumber\": \"\",\n \"deviceIp\": \"\",\n \"deviceId\": \"\",\n \"deviceType\": \"POS\",\n \"creatorStatus\": \"P\",\n \"lang\": \"\",\n \"activationMethod\": \"\",\n \"activationMethodData\": \"\",\n \"eventTimestamp\": \"\",\n \"enrollmentStatus\": \"TOKENIZATION_FAILED\",\n \"paymentTokenType\": \"CL\",\n \"paymentTokenId\": \"\",\n \"eventId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7181df9c-4238-4d76-a6e9-5ad24c01e774", "name": "Bad Request", "originalRequest": { "url": { "path": [ "prepaid", "card", "tokenization", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"walletType\": \"\",\n \"deviceMobileNumber\": \"\",\n \"deviceIp\": \"\",\n \"deviceId\": \"\",\n \"deviceType\": \"POS\",\n \"creatorStatus\": \"P\",\n \"lang\": \"\",\n \"activationMethod\": \"\",\n \"activationMethodData\": \"\",\n \"eventTimestamp\": \"\",\n \"enrollmentStatus\": \"TOKENIZATION_FAILED\",\n \"paymentTokenType\": \"CL\",\n \"paymentTokenId\": \"\",\n \"eventId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a8836a3-2c69-4fc2-9a47-84af8e137ef8", "name": "Prepaid card token update event", "request": { "name": "Prepaid card token update event", "description": { "content": "This webhook will be sent when the card token is updated. A token update event occurs when the token associated with a card is updated due to changes in card details or security updates, ensuring seamless and secure transactions by automatically replacing the old token with a new one across platforms like Google Pay, Apple Pay, and merchant websites.", "type": "text/plain" }, "url": { "path": [ "prepaid", "card", "token", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"result\": \"\",\n \"tokenAction\": \"TOKEN_REISSUED\",\n \"eventId\": \"\",\n \"eventTimestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a540d5df-7d99-43eb-8e26-7059900ee394", "name": "OK", "originalRequest": { "url": { "path": [ "prepaid", "card", "token", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"result\": \"\",\n \"tokenAction\": \"TOKEN_REISSUED\",\n \"eventId\": \"\",\n \"eventTimestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "771c546b-3f60-4a3b-8114-f8cf56745ee2", "name": "Accepted", "originalRequest": { "url": { "path": [ "prepaid", "card", "token", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"result\": \"\",\n \"tokenAction\": \"TOKEN_REISSUED\",\n \"eventId\": \"\",\n \"eventTimestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58310b3a-fd82-4fde-9c37-220c60867c4d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "prepaid", "card", "token", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"result\": \"\",\n \"tokenAction\": \"TOKEN_REISSUED\",\n \"eventId\": \"\",\n \"eventTimestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ced283ea-4539-4a75-9b2c-02e43dd00e22", "name": "Prepaid card 3ds challenge event", "request": { "name": "Prepaid card 3ds challenge event", "description": { "content": "This webhook will be sent when card 3ds authentication process is initiated.", "type": "text/plain" }, "url": { "path": [ "prepaid", "card", "threedsecure", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"walletOperationId\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"auth3dsId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"timestamp\": \"\",\n \"merchantName\": \"\",\n \"lastFourDigits\": \"\",\n \"cardScheme\": \"VISA\",\n \"cardType\": \"VIRTUAL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "66abf523-850a-4deb-ba17-fabd281f1fdb", "name": "OK", "originalRequest": { "url": { "path": [ "prepaid", "card", "threedsecure", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"walletOperationId\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"auth3dsId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"timestamp\": \"\",\n \"merchantName\": \"\",\n \"lastFourDigits\": \"\",\n \"cardScheme\": \"VISA\",\n \"cardType\": \"VIRTUAL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a5e82b7-e4a2-4760-9b4e-b53462e5851a", "name": "Accepted", "originalRequest": { "url": { "path": [ "prepaid", "card", "threedsecure", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"walletOperationId\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"auth3dsId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"timestamp\": \"\",\n \"merchantName\": \"\",\n \"lastFourDigits\": \"\",\n \"cardScheme\": \"VISA\",\n \"cardType\": \"VIRTUAL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "654d31e2-c706-4bba-8850-5d5a19c9b839", "name": "Bad Request", "originalRequest": { "url": { "path": [ "prepaid", "card", "threedsecure", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"walletOperationId\": \"\",\n \"cardId\": \"\",\n \"customerId\": \"\",\n \"auth3dsId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"timestamp\": \"\",\n \"merchantName\": \"\",\n \"lastFourDigits\": \"\",\n \"cardScheme\": \"VISA\",\n \"cardType\": \"VIRTUAL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7014f05f-db2e-4ae7-9610-47ed1bda2ef6", "name": "Prepaid card bulk order event", "request": { "name": "Prepaid card bulk order event", "description": { "content": "This webhook will be sent when card bulk order is processed.", "type": "text/plain" }, "url": { "path": [ "prepaid", "card", "bulk", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"statusReason\": \"\",\n \"customerId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7353af0d-dcfc-486d-89cc-e12ff1a7632f", "name": "OK", "originalRequest": { "url": { "path": [ "prepaid", "card", "bulk", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"statusReason\": \"\",\n \"customerId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f81c970-79fb-4649-9f82-4f081f19b383", "name": "Accepted", "originalRequest": { "url": { "path": [ "prepaid", "card", "bulk", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"statusReason\": \"\",\n \"customerId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb27b09a-c1f0-4bce-b4fe-eafdbc3e81c4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "prepaid", "card", "bulk", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"statusReason\": \"\",\n \"customerId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd57f771-bcd4-44ec-8388-9cf5e1ca8c4d", "name": "Account update event", "request": { "name": "Account update event", "description": { "content": "The webhook is sent when there's an update on the customer account. The `operationType` signifies the change that occurred.\n\n> NOTE: For events with `operationType == IBAN_ASSIGNED`, Paysafe is not able to send the `iban` field in a webhook due to information security restrictions. To obtain the IBAN, the Merchant must call the Account Information endpoint.", "type": "text/plain" }, "url": { "path": [ "accounts", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"type\": \"IBAN_ASSIGNED\",\n \"timestamp\": \"\",\n \"externalId\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "616a6161-77f9-4370-b054-bfc1705f8454", "name": "OK", "originalRequest": { "url": { "path": [ "accounts", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"type\": \"IBAN_ASSIGNED\",\n \"timestamp\": \"\",\n \"externalId\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "27beddae-3fc5-4480-8794-623f021b430a", "name": "Accepted", "originalRequest": { "url": { "path": [ "accounts", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"type\": \"IBAN_ASSIGNED\",\n \"timestamp\": \"\",\n \"externalId\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5636274-814a-4f9f-a329-9553d86f4806", "name": "Bad Request", "originalRequest": { "url": { "path": [ "accounts", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"type\": \"IBAN_ASSIGNED\",\n \"timestamp\": \"\",\n \"externalId\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4439a512-979c-4546-ae30-dddc9f4aae77", "name": "Trigger notification resend", "request": { "name": "Trigger notification resend", "description": { "content": "Request re-sending of notifications (webhooks) that match certain criteria by creating a new notification resend task. After the task is created, all events that match the requested criteria will be enqueued for re-sending.", "type": "text/plain" }, "url": { "path": [ "notification-resend-tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8bb40f79-c507-4872-bb9f-647c487f8f2c", "name": "Created", "originalRequest": { "url": { "path": [ "notification-resend-tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"id\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"merchantRefNum\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ced5538-2c66-4a90-abd4-46ac58b7d32f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notification-resend-tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"fieldErrors\": [\n {\n \"field\": \"\",\n \"error\": \"\"\n },\n {\n \"field\": \"\",\n \"error\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9ed7479-4b7e-47fd-bde6-c2c405ef6c9f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "notification-resend-tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"fieldErrors\": [\n {\n \"field\": \"\",\n \"error\": \"\"\n },\n {\n \"field\": \"\",\n \"error\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7214cec7-0a30-4297-a6cb-f5c12343af27", "name": "Service Unavailable. Please try agian later.", "originalRequest": { "url": { "path": [ "notification-resend-tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"fieldErrors\": [\n {\n \"field\": \"\",\n \"error\": \"\"\n },\n {\n \"field\": \"\",\n \"error\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92d1dd1e-a757-46d7-a675-046c7e7bac13", "name": "Instrument Update Event", "request": { "name": "Instrument Update Event", "description": { "content": "Instrument update event. \nThe event is sent, when Instrument is updated.\nDue to confidentiality reasons the instrument sensitive data is hidden.", "type": "text/plain" }, "url": { "path": [ "instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"operationType\": \"Create\",\n \"instrument\": {\n \"instrumentType\": \"EMAIL\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b5485cd0-e362-4b06-814e-778237cb0d59", "name": "Created", "originalRequest": { "url": { "path": [ "instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"operationType\": \"Create\",\n \"instrument\": {\n \"instrumentType\": \"EMAIL\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bf47405-fcb6-4b36-a5bd-8221ceee1dc1", "name": "Kyc verification status event", "request": { "name": "Kyc verification status event", "description": { "content": "The webhook is sent when there's an update in the kyc verification result.", "type": "text/plain" }, "url": { "path": [ "kyc", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"customerId\": \"\",\n \"timestamp\": \"\",\n \"verificationStatus\": \"INCOMPLETE\",\n \"sessionId\": \"\",\n \"merchantRefNum\": \"\",\n \"externalId\": \"\",\n \"verificationDocuments\": [\n {\n \"category\": \"IDENTITY\",\n \"type\": \"CUS_CD\",\n \"status\": \"UPLOADED\",\n \"id\": \"\",\n \"subtype\": \"SOCIAL_SECURITY_ID\",\n \"statusReason\": \"FACE_MISMATCH\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"category\": \"ADDRESS\",\n \"type\": \"TR\",\n \"status\": \"CLOSED\",\n \"id\": \"\",\n \"subtype\": \"NATIONAL_ID\",\n \"statusReason\": \"90_DAY_OLD\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"electronicVerifications\": [\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n },\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n }\n ],\n \"sessionEvents\": [\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"sessionStatus\": \"CREATED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ba69815f-c405-46b0-937b-9dfefaed7f53", "name": "OK", "originalRequest": { "url": { "path": [ "kyc", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"customerId\": \"\",\n \"timestamp\": \"\",\n \"verificationStatus\": \"INCOMPLETE\",\n \"sessionId\": \"\",\n \"merchantRefNum\": \"\",\n \"externalId\": \"\",\n \"verificationDocuments\": [\n {\n \"category\": \"IDENTITY\",\n \"type\": \"CUS_CD\",\n \"status\": \"UPLOADED\",\n \"id\": \"\",\n \"subtype\": \"SOCIAL_SECURITY_ID\",\n \"statusReason\": \"FACE_MISMATCH\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"category\": \"ADDRESS\",\n \"type\": \"TR\",\n \"status\": \"CLOSED\",\n \"id\": \"\",\n \"subtype\": \"NATIONAL_ID\",\n \"statusReason\": \"90_DAY_OLD\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"electronicVerifications\": [\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n },\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n }\n ],\n \"sessionEvents\": [\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"sessionStatus\": \"CREATED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c2d5936-795c-46e0-9d84-a4157c66d198", "name": "Accepted", "originalRequest": { "url": { "path": [ "kyc", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"customerId\": \"\",\n \"timestamp\": \"\",\n \"verificationStatus\": \"INCOMPLETE\",\n \"sessionId\": \"\",\n \"merchantRefNum\": \"\",\n \"externalId\": \"\",\n \"verificationDocuments\": [\n {\n \"category\": \"IDENTITY\",\n \"type\": \"CUS_CD\",\n \"status\": \"UPLOADED\",\n \"id\": \"\",\n \"subtype\": \"SOCIAL_SECURITY_ID\",\n \"statusReason\": \"FACE_MISMATCH\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"category\": \"ADDRESS\",\n \"type\": \"TR\",\n \"status\": \"CLOSED\",\n \"id\": \"\",\n \"subtype\": \"NATIONAL_ID\",\n \"statusReason\": \"90_DAY_OLD\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"electronicVerifications\": [\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n },\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n }\n ],\n \"sessionEvents\": [\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"sessionStatus\": \"CREATED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2095fa50-5f3b-4dff-9f52-6432193829a7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "kyc", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"customerId\": \"\",\n \"timestamp\": \"\",\n \"verificationStatus\": \"INCOMPLETE\",\n \"sessionId\": \"\",\n \"merchantRefNum\": \"\",\n \"externalId\": \"\",\n \"verificationDocuments\": [\n {\n \"category\": \"IDENTITY\",\n \"type\": \"CUS_CD\",\n \"status\": \"UPLOADED\",\n \"id\": \"\",\n \"subtype\": \"SOCIAL_SECURITY_ID\",\n \"statusReason\": \"FACE_MISMATCH\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"category\": \"ADDRESS\",\n \"type\": \"TR\",\n \"status\": \"CLOSED\",\n \"id\": \"\",\n \"subtype\": \"NATIONAL_ID\",\n \"statusReason\": \"90_DAY_OLD\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"electronicVerifications\": [\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n },\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n }\n ],\n \"sessionEvents\": [\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"sessionStatus\": \"CREATED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67984613-e5bc-4bc1-b22f-cc063ba3c443", "name": "Payment instrument verification status event", "request": { "name": "Payment instrument verification status event", "description": { "content": "The webhook is sent when there's an update with the status of payment instrument verification session.", "type": "text/plain" }, "url": { "path": [ "piv", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"sessionId\": \"\",\n \"customerId\": \"\",\n \"sessionStatus\": \"ONGOING_VERIFICATION\",\n \"timestamp\": \"\",\n \"statusReason\": \"SESSION_EXPIRED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3ef699f2-b901-4213-9607-d6f627780b2b", "name": "OK", "originalRequest": { "url": { "path": [ "piv", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"sessionId\": \"\",\n \"customerId\": \"\",\n \"sessionStatus\": \"ONGOING_VERIFICATION\",\n \"timestamp\": \"\",\n \"statusReason\": \"SESSION_EXPIRED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62a54c7b-5a51-439a-9ab7-65b7a29bdb34", "name": "Customer Data Verification Event", "request": { "name": "Customer Data Verification Event", "description": { "content": "This webhook will be sent when a customer data verification process has been successfully initiated. It contains:\n * Customer data information.\n * The customer attribute being validated in the particular verification process.\n * The mechanism used to deliver the customer attribute verification information.\n * The value transmitted through the secure notification mechanism to confirm the specific customer attribute.\n * Creation and expiration time for the verification process.\n\nThis event is sent at least once for every initiated customer data verification process.", "type": "text/plain" }, "url": { "path": [ "customers", "data-verifications", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"verificationProcess\": {\n \"id\": \"\",\n \"attribute\": {\n \"type\": \"EMAIL\",\n \"value\": \"\"\n },\n \"notificationType\": {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\n \"target\": \"\"\n },\n \"flow\": \"PIN_RESET\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"value\": \"\",\n \"errorCode\": \"EMAIL_NOT_FOUND\"\n },\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "01041818-6991-4ea6-b1e7-a14e1f9c32e3", "name": "OK", "originalRequest": { "url": { "path": [ "customers", "data-verifications", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"verificationProcess\": {\n \"id\": \"\",\n \"attribute\": {\n \"type\": \"EMAIL\",\n \"value\": \"\"\n },\n \"notificationType\": {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\n \"target\": \"\"\n },\n \"flow\": \"PIN_RESET\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"value\": \"\",\n \"errorCode\": \"EMAIL_NOT_FOUND\"\n },\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55db1d12-0991-47bf-a833-a7599c571996", "name": "Accepted", "originalRequest": { "url": { "path": [ "customers", "data-verifications", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"verificationProcess\": {\n \"id\": \"\",\n \"attribute\": {\n \"type\": \"EMAIL\",\n \"value\": \"\"\n },\n \"notificationType\": {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\n \"target\": \"\"\n },\n \"flow\": \"PIN_RESET\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"value\": \"\",\n \"errorCode\": \"EMAIL_NOT_FOUND\"\n },\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c16e672-32a9-4f74-8f37-dcf7d026fa3d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "customers", "data-verifications", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"verificationProcess\": {\n \"id\": \"\",\n \"attribute\": {\n \"type\": \"EMAIL\",\n \"value\": \"\"\n },\n \"notificationType\": {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\n \"target\": \"\"\n },\n \"flow\": \"PIN_RESET\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"value\": \"\",\n \"errorCode\": \"EMAIL_NOT_FOUND\"\n },\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb49c649-b7ea-4a2d-ade2-a3009c521f7b", "name": "SCA Authentication Event", "request": { "name": "SCA Authentication Event", "description": { "content": "This webhook is triggered when an SCA process is needed to finalize a wallet operation. It includes the following details:\n * Customer data information.\n * The wallet operation subject to the SCA process.\n * The mechanism used to deliver the SCA authentication event details.\n * The value tied to the SCA authentication event attempt, which must be securely communicated.\n * The creation and expiration times of the SCA process.\n \n This event is sent at least once for each initiated SCA process.", "type": "text/plain" }, "url": { "path": [ "sca", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n },\n \"authenticationProcess\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"flow\": {\n \"type\": \"WALLET_CHECKOUT\",\n \"properties\": [\n {\n \"key\": \"SLIP_ID\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_ID\",\n \"value\": \"\"\n }\n ]\n },\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\"\n }\n },\n \"creationTime\": \"\",\n \"value\": \"\",\n \"expirationTime\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "080f6916-f20b-44e5-9685-3c6ffcce91f8", "name": "OK", "originalRequest": { "url": { "path": [ "sca", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n },\n \"authenticationProcess\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"flow\": {\n \"type\": \"WALLET_CHECKOUT\",\n \"properties\": [\n {\n \"key\": \"SLIP_ID\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_ID\",\n \"value\": \"\"\n }\n ]\n },\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\"\n }\n },\n \"creationTime\": \"\",\n \"value\": \"\",\n \"expirationTime\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05346138-f346-40df-923b-36c0b9df3439", "name": "Accepted", "originalRequest": { "url": { "path": [ "sca", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n },\n \"authenticationProcess\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"flow\": {\n \"type\": \"WALLET_CHECKOUT\",\n \"properties\": [\n {\n \"key\": \"SLIP_ID\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_ID\",\n \"value\": \"\"\n }\n ]\n },\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\"\n }\n },\n \"creationTime\": \"\",\n \"value\": \"\",\n \"expirationTime\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "999b6e36-b341-413a-8715-be878dfe31e4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "sca", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n },\n \"authenticationProcess\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"flow\": {\n \"type\": \"WALLET_CHECKOUT\",\n \"properties\": [\n {\n \"key\": \"SLIP_ID\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_ID\",\n \"value\": \"\"\n }\n ]\n },\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\"\n }\n },\n \"creationTime\": \"\",\n \"value\": \"\",\n \"expirationTime\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b63cbb03-32a8-434a-928f-e759de127278", "name": "Credentials Change Event", "request": { "name": "Credentials Change Event", "description": { "content": "This webhook will be sent when change of the customer credentials has occurred. It contains the customer information, type of the credentials change, customer information and customer identifiers (e.g. email, mobile, etc.).\n\nIt will be sent at least once.", "type": "text/plain" }, "url": { "path": [ "credentials", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n },\n \"credentialsDetails\": {\n \"customerIdentifiers\": {\n \"email\": {\n \"value\": \"\",\n \"verificationId\": \"\"\n },\n \"mobile\": {\n \"value\": \"\",\n \"verificationId\": \"\"\n }\n },\n \"type\": \"PASSWORD_RECOVERY\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "79496f52-7009-4ea8-a9f5-d9eb965b7f64", "name": "OK", "originalRequest": { "url": { "path": [ "credentials", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n },\n \"credentialsDetails\": {\n \"customerIdentifiers\": {\n \"email\": {\n \"value\": \"\",\n \"verificationId\": \"\"\n },\n \"mobile\": {\n \"value\": \"\",\n \"verificationId\": \"\"\n }\n },\n \"type\": \"PASSWORD_RECOVERY\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "517c83dc-9e7a-416d-b805-3b6390dca294", "name": "Customer Deactivation Event", "request": { "name": "Customer Deactivation Event", "description": { "content": "This webhook will be sent when customer deactivation request has been manually reviewed. It contains the customer information and the details related to the deactivation request.\n\nIt will be sent at least once.", "type": "text/plain" }, "url": { "path": [ "deactivations", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"deactivation\": {\n \"category\": \"CUSTOMER_INITIATED\",\n \"id\": \"\",\n \"reason\": \"OTHER\",\n \"status\": \"DECLINED\",\n \"feedback\": \"\",\n \"comment\": \"\",\n \"creationTime\": \"\",\n \"externalId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3619c1ee-d4b7-4b1c-bc16-2e7ec6031630", "name": "OK", "originalRequest": { "url": { "path": [ "deactivations", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"deactivation\": {\n \"category\": \"CUSTOMER_INITIATED\",\n \"id\": \"\",\n \"reason\": \"OTHER\",\n \"status\": \"DECLINED\",\n \"feedback\": \"\",\n \"comment\": \"\",\n \"creationTime\": \"\",\n \"externalId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "217a5d3a-0353-48e9-b98c-20c2d24134fd", "name": "Customer Profile Update Event", "request": { "name": "Customer Profile Update Event", "description": { "content": "This webhook is triggered whenever a profile update request is made. It includes the customer's information along with details about the changes made during the update.\n\nThe `changes` object in the request body is an array of objects representing individual profile changes. \n\n### Properties of a Change Object:\n\n* `field`: The flat path to the updated part of the user profile.\n* `status`: The status of the operation (`SUCCESS` or `FAIL`).\n* `oldValue`: The previous value of the updated field.\n* `newValue`: The desired value of the field after the update.\n* `errorMessages` *(optional)*: An array of error codes and descriptive messages.\n\n### Notes:\n\n* **Status Handling**:\n * `SUCCESS`: Update was successful, and `newValue` reflects the updated value in the profile.\n * `FAIL`: Update failed, and `newValue` is the intended value but was not applied.\n* **Error Details** (when `status` is `FAIL`):\n * `Error Code`: A code identifying the type of error.\n * `Description Message`: A detailed explanation of the error.\n\nIt will be sent at least once.", "type": "text/plain" }, "url": { "path": [ "profile", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n },\n \"changes\": [\n {\n \"field\": \"\",\n \"status\": \"SUCCESS\",\n \"oldValue\": \"\",\n \"newValue\": \"\",\n \"errorMessages\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"field\": \"\",\n \"status\": \"SUCCESS\",\n \"oldValue\": \"\",\n \"newValue\": \"\",\n \"errorMessages\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"eventType\": 173.61166457462218\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2543fe15-9844-4462-8483-06fa525ee0af", "name": "OK", "originalRequest": { "url": { "path": [ "profile", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"externalId\": \"\",\n \"title\": \"\"\n },\n \"changes\": [\n {\n \"field\": \"\",\n \"status\": \"SUCCESS\",\n \"oldValue\": \"\",\n \"newValue\": \"\",\n \"errorMessages\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"field\": \"\",\n \"status\": \"SUCCESS\",\n \"oldValue\": \"\",\n \"newValue\": \"\",\n \"errorMessages\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"eventType\": 173.61166457462218\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9dac361-6232-4c95-9e99-0965c02ec40a", "name": "Profile Management Event", "request": { "name": "Profile Management Event", "description": { "content": "This webhook will be sent when customer performs a profile management operation. It contains the customer information and the details related to the profile management operation.", "type": "text/plain" }, "url": { "path": [ "profile-management", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"GLOBAL_LOGOUT\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"content\": {\n \"eventType\": \"GLOBAL_LOGOUT\",\n \"status\": \"FAILED\",\n \"statusReason\": \"\",\n \"additionalFields\": [\n {\n \"key\": \"CUSTOMER_IP\",\n \"value\": \"\"\n },\n {\n \"key\": \"DEVICE_ID\",\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d6c62705-f8bf-4911-a6a0-8f379402ff8e", "name": "OK", "originalRequest": { "url": { "path": [ "profile-management", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"GLOBAL_LOGOUT\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"content\": {\n \"eventType\": \"GLOBAL_LOGOUT\",\n \"status\": \"FAILED\",\n \"statusReason\": \"\",\n \"additionalFields\": [\n {\n \"key\": \"CUSTOMER_IP\",\n \"value\": \"\"\n },\n {\n \"key\": \"DEVICE_ID\",\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af053633-e19a-43b2-86fe-d05a6bb59a67", "name": "Wallet Checkout event", "request": { "name": "Wallet Checkout event", "description": { "content": "This webhook is sent for Wallet Checkout session updates.\n\n* `checkout.completed` — The checkout flow has finished. The outcome is reflected in `session.payment.status` (for example `COMPLETED`, `FAILED`, or `CANCELLED` for a user-initiated cancellation).\n* `checkout.cancelled` — The session was cancelled by the merchant or system; `session.status` is `CANCELLED`.\n* `checkout.expired` — The session expired before completion.\n\n> **Note:** User cancellation results in `checkout.completed` with `payment.status: CANCELLED`. Merchant or system cancellations use `checkout.cancelled` with `session.status: CANCELLED`.", "type": "text/plain" }, "url": { "path": [ "wallet-checkout", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"checkout.expired\",\n \"session\": {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"receiver\": {\n \"customerId\": \"\"\n },\n \"status\": \"CANCELLED\",\n \"merchantRefNum\": \"\",\n \"boundSender\": {\n \"customerId\": \"\"\n },\n \"senderBoundAt\": \"\",\n \"paymentBoundAt\": \"\",\n \"completedAt\": \"\",\n \"payment\": {\n \"id\": \"\",\n \"status\": \"PREVIEW\",\n \"slipId\": \"\",\n \"failureReason\": \"\",\n \"cancelledBy\": \"user\",\n \"cancelledAt\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "14bdb5b5-d064-4edc-8c7e-c8f958e850b0", "name": "OK", "originalRequest": { "url": { "path": [ "wallet-checkout", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"checkout.expired\",\n \"session\": {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"receiver\": {\n \"customerId\": \"\"\n },\n \"status\": \"CANCELLED\",\n \"merchantRefNum\": \"\",\n \"boundSender\": {\n \"customerId\": \"\"\n },\n \"senderBoundAt\": \"\",\n \"paymentBoundAt\": \"\",\n \"completedAt\": \"\",\n \"payment\": {\n \"id\": \"\",\n \"status\": \"PREVIEW\",\n \"slipId\": \"\",\n \"failureReason\": \"\",\n \"cancelledBy\": \"user\",\n \"cancelledAt\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22045ea7-6004-464a-beac-6343a35e6c14", "name": "Accepted", "originalRequest": { "url": { "path": [ "wallet-checkout", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"checkout.expired\",\n \"session\": {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"receiver\": {\n \"customerId\": \"\"\n },\n \"status\": \"CANCELLED\",\n \"merchantRefNum\": \"\",\n \"boundSender\": {\n \"customerId\": \"\"\n },\n \"senderBoundAt\": \"\",\n \"paymentBoundAt\": \"\",\n \"completedAt\": \"\",\n \"payment\": {\n \"id\": \"\",\n \"status\": \"PREVIEW\",\n \"slipId\": \"\",\n \"failureReason\": \"\",\n \"cancelledBy\": \"user\",\n \"cancelledAt\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91315761-04cb-4270-a979-3e29b32e162d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "wallet-checkout", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "HMAC signature of the request", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"checkout.expired\",\n \"session\": {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"receiver\": {\n \"customerId\": \"\"\n },\n \"status\": \"CANCELLED\",\n \"merchantRefNum\": \"\",\n \"boundSender\": {\n \"customerId\": \"\"\n },\n \"senderBoundAt\": \"\",\n \"paymentBoundAt\": \"\",\n \"completedAt\": \"\",\n \"payment\": {\n \"id\": \"\",\n \"status\": \"PREVIEW\",\n \"slipId\": \"\",\n \"failureReason\": \"\",\n \"cancelledBy\": \"user\",\n \"cancelledAt\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://example.com/webhook/path/at/merchant/system" } ], "info": { "_postman_id": "0febc1de-da6b-422d-a98c-1e8534290a05", "name": "Webhooks API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## Introduction\n\nWebhooks allow the Merchant to track events happening in Paysafe Embedded wallet. The following object changes can be tracked using webhooks.\n\nIt is the Merchant's responsibility to:\n\n* expose API endpoints for webhook handling\n* configure the webhook root URL with Paysafe\n* ensure the availability of the endpoints to receive the webhooks\n\nClick [here](/docs/embedded-wallets/webhooks) to learn more about the Webhooks API.\n\nContact Support:\n Name: Paysafe\n Email: info@paysafe.com", "type": "text/plain" } } }