{ "item": [ { "name": "Restrictions", "description": "Restriction related entities\n", "item": [ { "id": "795b129a-2c3f-47bf-b0d8-0fc5215bc38d", "name": "Place a Restriction", "request": { "name": "Place a Restriction", "description": { "content": "Allows Partner to place a restriction on customer wallet operations.\n\nThe restriction reason is automatically set to 'MERCHANT_REQUEST'.\nThe restriction required action is automatically set to `CONTACT_CUSTOMER_SERVICE`. \n\nThe response returns the remaining restriction of the customer.\n\nPlacing a restriction will prevent the customer from performing certain actions in the wallet, like withdrawal or deposit or a transfer. Please note that this API will limit the types of restrictions that can be placed.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"OUTGOING_TRANSACTIONS\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a1127b74-de65-4227-a266-a10068d01061", "name": "Created", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"OUTGOING_TRANSACTIONS\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"restrictions\": [\n {\n \"name\": \"LOGIN\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"BANK_ACCOUNT_VERIFICATION\",\n \"NO_REMEDIATION\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"INCOMING_TRANSACTIONS_AND_SEND_MONEY\",\n \"reason\": \"CONFIRM_TXN_ACTIVITY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"PEP_DECLARATION\",\n \"NATIONALITY\"\n ],\n \"creationTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3a66ba9-14de-45c3-92a5-57c73224d384", "name": "Bad Request", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"OUTGOING_TRANSACTIONS\"\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": "8e11494b-83c3-4a98-926f-28ec7e91c118", "name": "Not Found", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"OUTGOING_TRANSACTIONS\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "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": "c853bf8e-0d27-45b8-bc7c-996d7f2c28ee", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"OUTGOING_TRANSACTIONS\"\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "864daeb5-93f8-4037-8fb2-e437e3562a32", "name": "Lift All Restrictions", "request": { "name": "Lift All Restrictions", "description": { "content": "Drops all restrictions placed by the partner.\n\nThe response returns the remaining restriction of the customer.\n\n> Note! Please note, that even if all restrictions placed by the Merchant are lifted, there still might be active restrictions set by Paysafe, which cannot be removed by the Partner via the API.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3c0869c3-1db1-4028-a5e7-071ff5fb6517", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"restrictions\": [\n {\n \"name\": \"LOGIN\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"BANK_ACCOUNT_VERIFICATION\",\n \"NO_REMEDIATION\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"INCOMING_TRANSACTIONS_AND_SEND_MONEY\",\n \"reason\": \"CONFIRM_TXN_ACTIVITY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"PEP_DECLARATION\",\n \"NATIONALITY\"\n ],\n \"creationTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f120009-2624-4f4f-9da4-01ecddfbad82", "name": "Not Found", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "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": "71d01c14-76b5-4732-ace2-856711c22fe7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b69b5366-f827-442b-9a5c-8672496618f2", "name": "Get Customer Restrictions", "request": { "name": "Get Customer Restrictions", "description": { "content": "Returns active restrictions placed on a customer.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8cea8091-5184-4548-8c79-8189184b2e07", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"restrictions\": [\n {\n \"name\": \"LOGIN\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"BANK_ACCOUNT_VERIFICATION\",\n \"NO_REMEDIATION\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"INCOMING_TRANSACTIONS_AND_SEND_MONEY\",\n \"reason\": \"CONFIRM_TXN_ACTIVITY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"PEP_DECLARATION\",\n \"NATIONALITY\"\n ],\n \"creationTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6133f79-7a34-4fe7-938d-56c21c2fe986", "name": "Not Found", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "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": "1cee82d0-4595-43c1-bff4-dfcb5c994c88", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer on which the restriction is placed.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2733927-79b8-483d-84e8-3836a01ba64e", "name": "Lift Single Partner Restriction", "request": { "name": "Lift Single Partner Restriction", "description": { "content": "Remove restriction placed by the merchant.\n\nThe response returns the removed restriction.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "restrictions", ":restrictionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "restrictionId", "disabled": false, "description": { "content": "(Required) Restriction Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "81f3c49e-9243-4f03-b91d-6810b83a17f9", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions", ":restrictionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Restriction Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "restrictionId" }, { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS\",\n \"reason\": \"CONFIRM_TXN_ACTIVITY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_AD\",\n \"KYC_VERIFICATION\"\n ],\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c1a076e-0ea6-41a5-8470-b2b4c3d3cb19", "name": "Not Found", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions", ":restrictionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Restriction Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "restrictionId" }, { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "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": "8cee5911-b6b8-4b80-b417-251f20a399ae", "name": "Deleting a restriction, which is not placed by the partner.", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions", ":restrictionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Restriction Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "restrictionId" }, { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "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": "f263c5bf-b896-417d-9e57-3247a22a7d90", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "customers", ":customerId", "restrictions", ":restrictionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Restriction Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "restrictionId" }, { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Instruments", "description": "Instrument management API\n", "item": [ { "id": "63ed311f-812c-4f1b-b1f7-1eba94168fef", "name": "Get wallet payment instruments", "request": { "name": "Get wallet payment instruments", "description": { "content": "Retrieve list of active instruments for the customer.\n\nFor cards, the PAN will be returned masked in the format 5xxxxxxxxxxx2922.\nFor bank accounts, the IBAN will be returned masked in the format NL94xxxxxxxxxxx464\nand the bank account number will be returned masked in the format 77xxxxx464.\n\n\n> This API is deprecated! Use the alternative `/customers/{customerId}/instruments` instead.", "type": "text/plain" }, "url": { "path": [ "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Id of the customer to fetch instruments for", "type": "text/plain" }, "key": "customerId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fb2386dd-669d-41bd-b0e0-e757563b6ad7", "name": "OK", "originalRequest": { "url": { "path": [ "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Id of the customer to fetch instruments for", "type": "text/plain" }, "key": "customerId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"instrumentType\": \"PH_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"US_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "265e6efe-35b2-4930-ba3b-2cddf5fbefc8", "name": "Get wallet payment instruments (new)", "request": { "name": "Get wallet payment instruments (new)", "description": { "content": "Retrieve list of active instruments for the customer.\n\nFor cards, the PAN will be returned masked in the format 5xxxxxxxxxxx2922.\nFor bank accounts, the IBAN will be returned masked in the format NL94xxxxxxxxxxx464\nand the bank account number will be returned masked in the format 77xxxxx464.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Id of the customer to fetch instruments for", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "370d7388-4f0a-4a04-ae60-459fd251cc1b", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer to fetch instruments for", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"instrumentType\": \"PH_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"US_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd83c40a-8859-45ac-a49d-4d6f74870bd4", "name": "Get payment instrument", "request": { "name": "Get payment instrument", "description": { "content": "Returns single instrument with specified identifier.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) The customer id to which the instruments belong", "type": "text/plain" } }, { "type": "any", "value": "US_BANK_ACCOUNT", "key": "instrumentType", "disabled": false, "description": { "content": "(Required) The type of instrument (This can only be one of SEPA_BANK_ACCOUNT,UK_BANK_ACCOUNT,US_BANK_ACCOUNT,CCI_BANK_ACCOUNT,BR_BANK_ACCOUNT,PH_BANK_ACCOUNT,CLABE_BANK_ACCOUNT,CARD,QR_CODE)", "type": "text/plain" } }, { "type": "any", "value": "", "key": "instrumentId", "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d01d0faa-d9ea-4971-9cb4-15d08f42120b", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer id to which the instruments belong", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The type of instrument (This can only be one of SEPA_BANK_ACCOUNT,UK_BANK_ACCOUNT,US_BANK_ACCOUNT,CCI_BANK_ACCOUNT,BR_BANK_ACCOUNT,PH_BANK_ACCOUNT,CLABE_BANK_ACCOUNT,CARD,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "US_BANK_ACCOUNT", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e8c8422-284d-4009-ae03-b4a6594fc440", "name": "Delete payment instrument", "request": { "name": "Delete payment instrument", "description": { "content": "Removes specific payment instrument.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) The customer id to which the instruments belong", "type": "text/plain" } }, { "type": "any", "value": "US_BANK_ACCOUNT", "key": "instrumentType", "disabled": false, "description": { "content": "(Required) The type of instrument (This can only be one of SEPA_BANK_ACCOUNT,UK_BANK_ACCOUNT,US_BANK_ACCOUNT,CCI_BANK_ACCOUNT,BR_BANK_ACCOUNT,PH_BANK_ACCOUNT,CLABE_BANK_ACCOUNT,CARD,QR_CODE)", "type": "text/plain" } }, { "type": "any", "value": "", "key": "instrumentId", "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "85a623b7-f5d9-4841-94ff-40be363299cb", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer id to which the instruments belong", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The type of instrument (This can only be one of SEPA_BANK_ACCOUNT,UK_BANK_ACCOUNT,US_BANK_ACCOUNT,CCI_BANK_ACCOUNT,BR_BANK_ACCOUNT,PH_BANK_ACCOUNT,CLABE_BANK_ACCOUNT,CARD,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "US_BANK_ACCOUNT", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "307a34c3-c5e5-4b93-8d34-6c74174866a4", "name": "Get Rapid Transfer banks", "request": { "name": "Get Rapid Transfer banks", "description": { "content": "Returns list of supported Rapid Transfer Banks for specific country.", "type": "text/plain" }, "url": { "path": [ "rapidtransferbanks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO-3166 Alpha 2 country code.", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3711f5bd-f168-4f18-b269-5065699d547c", "name": "OK", "originalRequest": { "url": { "path": [ "rapidtransferbanks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO-3166 Alpha 2 country code.", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rapidTransferBanks\": [\n {\n \"id\": \"\",\n \"isAccountRequiredBeforeInitialization\": true,\n \"country\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"isAccountRequiredBeforeInitialization\": true,\n \"country\": \"\",\n \"name\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebdf7ed8-a8ed-4b4f-980c-d1888aa15443", "name": "Create Instrument Verification Session", "request": { "name": "Create Instrument Verification Session", "description": { "content": "Creates new instrument verification session. The result of successful verification is a `VERIFIED` instrument, that can be used for withdrawal or deposit operations.\n\nRequired Parameters:\n\n* **instrumentType** - Currently `US_BANK_ACCOUNT` is supported.\n* **returnUrl** - should contain the location to where the customer must be redirected after completing the required actions in Paysafe hosted UI.\n\nThe response contains:\n\n* **id** - the session identifier\n* **redirectUrl** - unique instrument verification redirect url associated with this session. The url contains Paysafe hosted UI, that carries the user through the account selection and verification process.\n* **secureCode** - unique secure code, that provides authentication for the session. This must be passed as query parameter attached to the redirect link.\n\nТhe status of the session can be tracked using [Get Instrument Verification API](/api/embedded-wallets/business/1.0.0/wallet/get-instrument-verification).\n", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) The wallet customer id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"returnUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c8c3b54f-5b47-43d9-80a7-07dacc274633", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"returnUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\",\n \"redirectUrl\": \"\",\n \"returnUrl\": \"\",\n \"sessionStatus\": \"ACTIVE\",\n \"instrument\": {\n \"id\": \"\",\n \"instrumentType\": \"CARD\"\n },\n \"statusReason\": \"UNSUPPORTED_BANK\",\n \"secureCode\": \"\",\n \"secureCodeMethod\": \"sha512\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b6545f7-16e3-48eb-8fc0-5eabe8475aff", "name": "Validation failed.", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"returnUrl\": \"\"\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": "d89c26d7-ca64-4ba7-98da-0300bdfd4e66", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"returnUrl\": \"\"\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c7805cb-9e7c-4bc8-a697-19e87b7dc800", "name": "Get Instrument Verifications for Customer", "request": { "name": "Get Instrument Verifications for Customer", "description": { "content": "Returns a list instrument verification sessions for customer.\nThe list does not return the secure code so it can not be used to build redirect URL.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter Instrument Verification by status. (This can only be one of ACTIVE,ONGOING_VERIFICATION,AWAITING_USER_INPUT,COMPLETED,FAILED)", "type": "text/plain" }, "key": "sessionStatus", "value": "ACTIVE" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) The wallet customer id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "26a51c2a-3013-42e7-afe2-66721064aee9", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter Instrument Verification by status. (This can only be one of ACTIVE,ONGOING_VERIFICATION,AWAITING_USER_INPUT,COMPLETED,FAILED)", "type": "text/plain" }, "key": "sessionStatus", "value": "ACTIVE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentVerifications\": [\n {\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"redirectUrl\": \"\",\n \"returnUrl\": \"\",\n \"sessionStatus\": \"AWAITING_USER_INPUT\",\n \"instrument\": {\n \"id\": \"\",\n \"instrumentType\": \"CARD\"\n },\n \"statusReason\": \"USER_INTERACTION_ERROR\"\n },\n {\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"instrumentType\": \"CARD\",\n \"redirectUrl\": \"\",\n \"returnUrl\": \"\",\n \"sessionStatus\": \"ACTIVE\",\n \"instrument\": {\n \"id\": \"\",\n \"instrumentType\": \"CARD\"\n },\n \"statusReason\": \"USER_INTERACTION_ERROR\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94425009-ff4a-4e9d-b8a2-1ea499e03661", "name": "Not Found", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter Instrument Verification by status. (This can only be one of ACTIVE,ONGOING_VERIFICATION,AWAITING_USER_INPUT,COMPLETED,FAILED)", "type": "text/plain" }, "key": "sessionStatus", "value": "ACTIVE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "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": "43454aac-d7e6-4d3d-a044-1d4a4f314e8f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter Instrument Verification by status. (This can only be one of ACTIVE,ONGOING_VERIFICATION,AWAITING_USER_INPUT,COMPLETED,FAILED)", "type": "text/plain" }, "key": "sessionStatus", "value": "ACTIVE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6841ca2c-327f-43ce-b3be-fdd8d3bcc4b0", "name": "Get Instrument Verification", "request": { "name": "Get Instrument Verification", "description": { "content": "Returns previously created instrument verification session.", "type": "text/plain" }, "url": { "path": [ "customers", ":customerId", "instrument-verifications", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "064cd7aa-dac2-43c7-b01d-9ecfff534f88", "name": "OK", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\",\n \"redirectUrl\": \"\",\n \"returnUrl\": \"\",\n \"sessionStatus\": \"ACTIVE\",\n \"instrument\": {\n \"id\": \"\",\n \"instrumentType\": \"CARD\"\n },\n \"statusReason\": \"UNSUPPORTED_BANK\",\n \"secureCode\": \"\",\n \"secureCodeMethod\": \"sha512\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb7c278d-13d6-4a77-9813-a68306691991", "name": "Not Found", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "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": "ca9d6635-7e01-429b-a56f-1d8eb2e1adc0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "customers", ":customerId", "instrument-verifications", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Authorizations", "description": "Authorization history related functionality.\n", "item": [ { "id": "57cc4b74-de47-4cfd-8bce-91ab8fc74156", "name": "Retrieve authorizations", "request": { "name": "Retrieve authorizations", "description": { "content": "**(In Development)**\n\nRetrieve authorizations for an account, ordered by creationTime descending.\n\n> Note: `accountId` must be provided when calling this endpoint. If is missing, HTTP 400 will be returned.", "type": "text/plain" }, "url": { "path": [ "authorizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creation time before", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dffeaab8-d90f-452c-9cf2-a82789285fc6", "name": "OK", "originalRequest": { "url": { "path": [ "authorizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creation time before", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"authorizations\": [\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"DEBIT\",\n \"status\": \"REVERSED\",\n \"cardId\": \"\",\n \"cardPresence\": \"NOT_PRESENT\",\n \"slipId\": \"\",\n \"challenge\": \"ONLINE\",\n \"cardholderPresence\": \"UNKNOWN\",\n \"netAmount\": \"\",\n \"netCurrency\": \"\",\n \"customerAmount\": \"\",\n \"customerCurrency\": \"\",\n \"transactionAmount\": \"\",\n \"transactionCurrency\": \"\",\n \"cardAmount\": \"\",\n \"cardCurrency\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"type\": \"QUASI_CASH\",\n \"statusReason\": \"\",\n \"panEntryMethod\": \"MAGNETIC_STRIPE_FALLBACK\",\n \"merchantName\": \"\",\n \"merchantCity\": \"\",\n \"merchantCountry\": \"\",\n \"merchantState\": \"\",\n \"mcc\": \"\",\n \"mobileWallet\": \"\",\n \"responseCode\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"DECLINED\",\n \"cardId\": \"\",\n \"cardPresence\": \"UNKNOWN\",\n \"slipId\": \"\",\n \"challenge\": \"UNKNOWN\",\n \"cardholderPresence\": \"NOT_PRESENT_ECOMMERCE\",\n \"netAmount\": \"\",\n \"netCurrency\": \"\",\n \"customerAmount\": \"\",\n \"customerCurrency\": \"\",\n \"transactionAmount\": \"\",\n \"transactionCurrency\": \"\",\n \"cardAmount\": \"\",\n \"cardCurrency\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"type\": \"TOKENIZATION_ACTIVATION_CODE\",\n \"statusReason\": \"\",\n \"panEntryMethod\": \"CREDENTIALS_ON_FILE\",\n \"merchantName\": \"\",\n \"merchantCity\": \"\",\n \"merchantCountry\": \"\",\n \"merchantState\": \"\",\n \"mcc\": \"\",\n \"mobileWallet\": \"\",\n \"responseCode\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "326b1e96-966a-473b-b414-468c5d1bb7d9", "name": "Bad request", "originalRequest": { "url": { "path": [ "authorizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creation time before", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "5e1dc92b-9184-4af0-bbe2-4b377864d04d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "authorizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creation time before", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "f8a5f721-54b5-4324-b903-919434a4d1ab", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "authorizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creation time before", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "b4c0ef08-364f-488e-9ed8-c9d3dd7878e2", "name": "Retrieve single authorization", "request": { "name": "Retrieve single authorization", "description": { "content": "**(In Development)**\n\nRetrieve details on a authorization with the specified id. List of authorizations can be fetched by calling `/accounts/{account-id}/authorizations`.", "type": "text/plain" }, "url": { "path": [ "authorizations", ":authorizationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "authorizationId", "disabled": false, "description": { "content": "(Required) Authorization id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "447e70fc-0583-4d8b-8c27-07d66e658bab", "name": "OK", "originalRequest": { "url": { "path": [ "authorizations", ":authorizationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization id", "type": "text/plain" }, "type": "any", "value": "", "key": "authorizationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"DEBIT\",\n \"status\": \"DECLINED\",\n \"cardId\": \"\",\n \"cardPresence\": \"UNKNOWN\",\n \"slipId\": \"\",\n \"challenge\": \"ONLINE\",\n \"cardholderPresence\": \"NOT_PRESENT_UNSPECIFIED\",\n \"netAmount\": \"\",\n \"netCurrency\": \"\",\n \"customerAmount\": \"\",\n \"customerCurrency\": \"\",\n \"transactionAmount\": \"\",\n \"transactionCurrency\": \"\",\n \"cardAmount\": \"\",\n \"cardCurrency\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"type\": \"TOKENIZATION_COMPLETE\",\n \"statusReason\": \"\",\n \"panEntryMethod\": \"MAGNETIC_STRIPE_CONTACTLESS\",\n \"merchantName\": \"\",\n \"merchantCity\": \"\",\n \"merchantCountry\": \"\",\n \"merchantState\": \"\",\n \"mcc\": \"\",\n \"mobileWallet\": \"\",\n \"responseCode\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76bc9ec3-3a3b-415b-a023-337e5117aca4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "authorizations", ":authorizationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization id", "type": "text/plain" }, "type": "any", "value": "", "key": "authorizationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "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": "c2e3a843-fe71-4a1e-843a-ee8078f07e47", "name": "Not found", "originalRequest": { "url": { "path": [ "authorizations", ":authorizationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization id", "type": "text/plain" }, "type": "any", "value": "", "key": "authorizationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "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": "20e3c256-7e8b-4534-b512-848403f3c26d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "authorizations", ":authorizationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization id", "type": "text/plain" }, "type": "any", "value": "", "key": "authorizationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "7bdcc701-64cb-4175-a00c-66e63dfba8df", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "authorizations", ":authorizationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization id", "type": "text/plain" }, "type": "any", "value": "", "key": "authorizationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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 } } ] }, { "name": "Transactions", "description": "Transaction history related functionality.\n", "item": [ { "id": "6b58f8f6-240c-49d7-9c97-510f8949df98", "name": "Retrieve transactions", "request": { "name": "Retrieve transactions", "description": { "content": "Retrieve transactions for an account, ordered by creationTime descending.\n\n> Note: Either `accountId` or `merchantRefNum` must be provided when calling this endpoint. If both are missing, HTTP 400 will be returned.\n\n> Note: As transfers are processed asynchronously, **until the transfer is processed**, calling this endpoint with `merchantRefNum` will return an empty result.", "type": "text/plain" }, "url": { "path": [ "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Filter transactions by merchant's reference number", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creationType after", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3bf07a62-9c76-4327-9fed-e7adb7eb493a", "name": "OK", "originalRequest": { "url": { "path": [ "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Filter transactions by merchant's reference number", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creationType after", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactions\": [\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"DEBIT\",\n \"status\": \"DECLINED\",\n \"type\": \"TRANSACTION_FEE\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"paymentType\": \"CARD\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"GOOGLE_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"REGULAR\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"US_BANK_ACCOUNT\"\n }\n },\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"REFUNDED\",\n \"type\": \"WITHDRAWAL\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\",\n \"paymentType\": \"PAGO_EFECTIVO\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"CARD_FEE\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"SAMSUNG_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"REGULAR\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"PH_BANK_ACCOUNT\"\n }\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "665065af-530a-40e0-b9ea-a6670bef617c", "name": "Bad request", "originalRequest": { "url": { "path": [ "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Filter transactions by merchant's reference number", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creationType after", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "b2f0f1f7-3499-4c00-873c-7d5e47f0508f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Filter transactions by merchant's reference number", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creationType after", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "04370ffc-a866-4510-810a-e5166a877095", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Filter transactions by merchant's reference number", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Filter by creation time", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by creationType after", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Filter by status", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Filter by card ID", "type": "text/plain" }, "key": "cardId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "078b4ad3-1a59-4317-989b-9c5f3f4dcaa1", "name": "Retrieve single transaction", "request": { "name": "Retrieve single transaction", "description": { "content": "Retrieve details on a transaction with the specified id. List of transactions can be fetched by calling the `/transactions` endpoint. To retrieve the details of a card authorization by id, the `Retrieve Single Authorization` endpoint should be used - `/authorizations/{authorizationId}`.", "type": "text/plain" }, "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Transaction id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "24d20c81-59b8-438f-9338-77d0f40b9271", "name": "OK", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transaction id", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"COMPLETED\",\n \"type\": \"CURRENCY_EXCHANGE\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"US_BANK_ACCOUNT\",\n \"paymentType\": \"PAGO_EFECTIVO\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"ATM_FEE\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"SAMSUNG_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"GMONEY\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a35f1af-158f-45b2-b713-896bfcd1f1db", "name": "Bad request", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transaction id", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "5a075fde-9db5-4d88-b1e8-6ceec8fcae9c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transaction id", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "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": "9feb36e8-5bcf-489d-bae8-89d92fdc7d7f", "name": "Not found", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transaction id", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "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": "5a0d2cfd-b7f8-4e47-ae60-6da170ed856e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transaction id", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "2adc0813-5161-467d-8ab6-f15962ca5e0a", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transaction id", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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 } } ] }, { "name": "Deposits", "description": "Deposit APIs.\n", "item": [] }, { "name": "Transfers", "description": "Internal Transfer of Funds.\n", "item": [ { "id": "e33176d3-ecd6-4b56-a937-b1ef9c069a09", "name": "Create Authorization Hold", "request": { "name": "Create Authorization Hold", "description": { "content": "**(In Development)**\n\nAuthorization holds API allows balance blocking for transfer operations.\nThis allows for ensuring balance is available when a transfer is ordered and avoids `balance not enough` failures.\n\nCreate a new authorization hold, to reserve balance for transfer of funds.\n\nIf `expiresOn` is not defined the authorization hold blocks funds indefinitely.", "type": "text/plain" }, "url": { "path": [ "authorization-holds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"createdOn\": \"\",\n \"expiresOn\": \"\",\n \"status\": \"EXPIRED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6d3bc1cf-e922-4868-ac39-fdd0a525e42d", "name": "Created", "originalRequest": { "url": { "path": [ "authorization-holds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"createdOn\": \"\",\n \"expiresOn\": \"\",\n \"status\": \"EXPIRED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"accountId\": \"\",\n \"createdOn\": \"\",\n \"expiresOn\": \"\",\n \"status\": \"ACTIVE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdb0e3f8-9075-4a76-9e3b-c3439e3503f5", "name": "Unable to process request due to validation or other errors.", "originalRequest": { "url": { "path": [ "authorization-holds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"createdOn\": \"\",\n \"expiresOn\": \"\",\n \"status\": \"EXPIRED\"\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bceecc51-53f7-446a-9fbd-0416baaa12f1", "name": "Get Authorization Holds", "request": { "name": "Get Authorization Holds", "description": { "content": "**(In Development)**\n\nAuthorization holds API allows balance blocking for transfer operations.\nThis allows for ensuring balance is available when a transfer is ordered and avoids `balance not enough` failures.\n\nRetrieve list of active authorization holds only.", "type": "text/plain" }, "url": { "path": [ "authorization-holds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Filter by Customer ID", "type": "text/plain" }, "key": "customerId", "value": "" }, { "disabled": false, "description": { "content": "Filter by Account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Limit number of results", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Offset results by the specified number", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bddb4add-4827-489b-b234-db58307c38b5", "name": "OK", "originalRequest": { "url": { "path": [ "authorization-holds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Filter by Customer ID", "type": "text/plain" }, "key": "customerId", "value": "" }, { "disabled": false, "description": { "content": "Filter by Account ID", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Limit number of results", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Offset results by the specified number", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"authorizationHolds\": [\n {\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"accountId\": \"\",\n \"createdOn\": \"\",\n \"expiresOn\": \"\",\n \"status\": \"RELEASED\"\n },\n {\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"accountId\": \"\",\n \"createdOn\": \"\",\n \"expiresOn\": \"\",\n \"status\": \"EXPIRED\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "346e475f-85f9-423a-8dbf-ebd802e14ab3", "name": "Get Authorization Hold", "request": { "name": "Get Authorization Hold", "description": { "content": "**(In Development)**\n\nAuthorization holds API allows balance blocking for transfer operations.\nThis allows for ensuring balance is available when a transfer is ordered and avoids `balance not enough` failures. \n\nRetrieve details on an authorization hold by ID.", "type": "text/plain" }, "url": { "path": [ "authorization-holds", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Authorization hold id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "adc25204-cf1e-4261-b45b-27218c480e29", "name": "OK", "originalRequest": { "url": { "path": [ "authorization-holds", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization hold id.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"accountId\": \"\",\n \"createdOn\": \"\",\n \"expiresOn\": \"\",\n \"status\": \"ACTIVE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0898d286-9c09-4319-ad7b-6a01ab7e4e14", "name": "Not Found", "originalRequest": { "url": { "path": [ "authorization-holds", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization hold id.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79ee383f-d6d1-4609-8489-62b68022370d", "name": "Expire Authorization Hold", "request": { "name": "Expire Authorization Hold", "description": { "content": "**(In Development)**\n\nAuthorization holds API allows balance blocking for transfer operations.\nThis allows for ensuring balance is available when a transfer is ordered and avoids `balance not enough` failures.\n\nCancel an authorisation hold.", "type": "text/plain" }, "url": { "path": [ "authorization-holds", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Authorization hold id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "6eb1e22b-f7ae-4047-aaef-ed1554a41f0c", "name": "OK", "originalRequest": { "url": { "path": [ "authorization-holds", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization hold id.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"customerId\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"accountId\": \"\",\n \"createdOn\": \"\",\n \"expiresOn\": \"\",\n \"status\": \"ACTIVE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c6b6542-12e4-4928-af29-5d2a13439aef", "name": "Not Found", "originalRequest": { "url": { "path": [ "authorization-holds", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Authorization hold id.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52da1992-5c2f-4db2-a4a7-fc74e85cce2f", "name": "Transfer funds to wallet recipient", "request": { "name": "Transfer funds to wallet recipient", "description": { "content": "## Introduction\n\nA transfer is the movement of funds between two wallet accounts. \nEach transfer consists of two transactions.\n\n* `TRANSFER_OUT` - debit transaction for moving money from sender customer balance\n* `TRANSFER_IN` - credit transaction for moving money into the recipient customer's balance\n\nThere are two types of participants in a transfer:\n\n* Customer wallets - regular users onboarded on embedded wallets solution\n* Merchant wallets - wallets belonging to the merchant.\n\nThese types of participants are treated differently from a regulatory perspective but used the same way for performing transfers.\n\nFor performing a transfer you need the following parameters:\n\n * `amount` - the amount in minor units\n * `currencyCode` - must match the sending account currency\n * `sender.customerId` - wallet customer id of the sender\n * `sender.accountId` - wallet account id of the sender account\n * `recipient.customerId` - wallet customer id of the recipient\n * `recipient.accountId` - wallet customer id of the recipient\n\nOptional parameters:\n\n * `fee` (**optional**) - (**In Development**) fee collected by the merchant for this transfer. The fee is always collected in sending account currency.\n\n\n## Currency conversion\n\nThe transfer currency must always match the sender account currency. By default, the recipient account also must be in the same currency. \n\n> Currency conversion is not explicitly enabled. For currency conversion during transfers, contact a Paysafe sales representative.\n\n## Customer-to-merchant transfer\n\nSet **recipient** field to the **Merchant customer id and account id**. These are set up during merchant onboarding.\nSet **sender** field to the respective customer id and account id that you want to charge.\n\n## Merchant-to-customer transfer\n\nSet **sender** field to the **Merchant customer id and account id**. These are setup during merchant onboarding.\nSet **recipient** field to the respective customer id and account id to whom you want transfer funds.\n\n## Customer-to-customer transfer\n\nSet **sender** and **recipient** fields with the respective customer and account ids of the transfer participants.\n\n## Transfer Async behavior\n\nThe transfers are executed asynchronously. \n\n* the response will contain the submitted information, without the `deviceInfo`,`risk`, and `customerIp` properties\n* the response will not contain transactions, since they are not yet created\n* Merchant must wait for the webhook for this transaction to confirm the final status of the operation - successful or not.\n* Until the webhook is received, the Merchant can query the transfer using the Transactions endpoint, using merchantRefNum. While the transfer is still in the queue, an empty response will be returned.\n\n## Merchant Fee collection\n\n**(In Development)**\n\nA fee can be collected by the merchant for the transfer. The `fee` parameter is passed in minor units and is always collected in sending account currency.\n\nFees are collected in preconfigured merchant fee collection account in the corresponding fee currency.\n", "type": "text/plain" }, "url": { "path": [ "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) HMAC", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customerIp\": \"\",\n \"fee\": \"\",\n \"risk\": {\n \"customerRiskRating\": \"\",\n \"isScaPerformed\": \"\",\n \"isCustomerIPTrusted\": \"\",\n \"isBeneficiaryTrusted\": \"\",\n \"authentication\": {\n \"threeDResult\": \"\",\n \"eci\": \"\",\n \"cavv\": \"\"\n }\n },\n \"reason\": \"PEER_TRANSFER\",\n \"reasonDescription\": \"\",\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"PURCHASE\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9b0e20f3-da85-444b-ade1-15d7acbed666", "name": "Accepted", "originalRequest": { "url": { "path": [ "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) HMAC", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customerIp\": \"\",\n \"fee\": \"\",\n \"risk\": {\n \"customerRiskRating\": \"\",\n \"isScaPerformed\": \"\",\n \"isCustomerIPTrusted\": \"\",\n \"isBeneficiaryTrusted\": \"\",\n \"authentication\": {\n \"threeDResult\": \"\",\n \"eci\": \"\",\n \"cavv\": \"\"\n }\n },\n \"reason\": \"PEER_TRANSFER\",\n \"reasonDescription\": \"\",\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"PURCHASE\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"slipId\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"DEBIT\",\n \"status\": \"FAILED\",\n \"type\": \"REFUND\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"paymentType\": \"BANK_TRANSFER\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"CARD_FEE\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"SAMSUNG_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"GMONEY\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\"\n }\n }\n ]\n },\n \"recipient\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"slipId\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"DEBIT\",\n \"status\": \"PENDING\",\n \"type\": \"PREPAID_CARD\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"paymentType\": \"PAGO_EFECTIVO\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"REFUND\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"APPLE_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"REGULAR\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\"\n }\n }\n ]\n },\n \"merchantRefNum\": \"\",\n \"fee\": \"\",\n \"reason\": \"CRYPTO_SELL\",\n \"reasonDescription\": \"\",\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"MERCHANT_FEE\",\n \"description\": \"\"\n },\n \"id\": \"\",\n \"slipId\": \"\",\n \"merchant\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"slipId\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"REFUNDED\",\n \"type\": \"PAYSAFE_FEE\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"PH_BANK_ACCOUNT\",\n \"paymentType\": \"BANK_TRANSFER\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"WALLET_CHECKOUT\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"APPLE_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"REGULAR\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n }\n }\n ]\n },\n \"status\": \"CANCELLED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33047dbf-01c4-4139-8f84-6ee0a97f5200", "name": "Bad Request", "originalRequest": { "url": { "path": [ "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) HMAC", "type": "text/plain" }, "key": "Signature", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customerIp\": \"\",\n \"fee\": \"\",\n \"risk\": {\n \"customerRiskRating\": \"\",\n \"isScaPerformed\": \"\",\n \"isCustomerIPTrusted\": \"\",\n \"isBeneficiaryTrusted\": \"\",\n \"authentication\": {\n \"threeDResult\": \"\",\n \"eci\": \"\",\n \"cavv\": \"\"\n }\n },\n \"reason\": \"PEER_TRANSFER\",\n \"reasonDescription\": \"\",\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"PURCHASE\",\n \"description\": \"\"\n }\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af46ad07-41eb-471d-addb-8f55fc5cbdfb", "name": "Get transfer by merchantRefNum", "request": { "name": "Get transfer by merchantRefNum", "description": { "content": "(In Development)\n\nReturn a the transfer associated with specific merchantRefNum.\nYou can use this API to get the transfer progress.", "type": "text/plain" }, "url": { "path": [ "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The merchantRefNum associated with the transfer.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Limit number of results", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Offset results by the specified number", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9ad9fe18-1db9-4aa9-88db-94177ebbd24b", "name": "OK", "originalRequest": { "url": { "path": [ "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The merchantRefNum associated with the transfer.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Limit number of results", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "Offset results by the specified number", "type": "text/plain" }, "key": "offset", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"slipId\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"DEBIT\",\n \"status\": \"REFUNDED\",\n \"type\": \"TRANSFER_OUT\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"paymentType\": \"TRANSFER\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"ATM_FEE\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"SAMSUNG_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"REGULAR\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\"\n }\n }\n ]\n },\n \"recipient\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"slipId\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"CANCELLED\",\n \"type\": \"PAYSAFE_FEE\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"paymentType\": \"CARD\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"CRYPTO_SELL\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"SAMSUNG_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"REGULAR\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n }\n }\n ]\n },\n \"merchantRefNum\": \"\",\n \"fee\": \"\",\n \"reason\": \"PEER_TRANSFER\",\n \"reasonDescription\": \"\",\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"CARD_FEE\",\n \"description\": \"\"\n },\n \"id\": \"\",\n \"slipId\": \"\",\n \"merchant\": {\n \"accountId\": \"\",\n \"customerId\": \"\",\n \"slipId\": \"\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"DEBIT\",\n \"status\": \"PENDING\",\n \"type\": \"TRANSACTION_FEE\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"fee\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"lastChangeDate\": \"\",\n \"instrumentId\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"paymentType\": \"BANK_TRANSFER\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"DEPOSIT\",\n \"description\": \"\"\n },\n \"cardPaymentDetails\": {\n \"cardId\": \"\",\n \"mobileWalletType\": \"GOOGLE_PAY\",\n \"obfuscatedCardNumber\": \"\",\n \"merchantDetails\": {\n \"name\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\"\n },\n \"mcc\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"paymentAmount\": \"\",\n \"paymentAmountCurrencyCode\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"GMONEY\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"PH_BANK_ACCOUNT\"\n }\n }\n ]\n },\n \"status\": \"CANCELLED\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Notifications", "description": "Notifications API Objects.\n", "item": [ { "id": "437a54b9-35de-4693-97b1-20d0d65ffeca", "name": "Create a Notification resend task", "request": { "name": "Create a Notification resend task", "description": { "content": "Create a new Notification resend task. This background task will trigger re-send of web hook notifications by client specified criteria.", "type": "text/plain" }, "url": { "path": [ "notifications", "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 \"status\": \"FINISHED\",\n \"merchantRefNum\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"merchantRefNums\": [\n \"\",\n \"\"\n ],\n \"notificationsToResend\": \"\",\n \"notificationsResent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2e1ea39b-f48b-4a48-89a7-c8261ba6714c", "name": "Created", "originalRequest": { "url": { "path": [ "notifications", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"FINISHED\",\n \"merchantRefNum\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"merchantRefNums\": [\n \"\",\n \"\"\n ],\n \"notificationsToResend\": \"\",\n \"notificationsResent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"eventType\": \"CARD_BULK_ORDER\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"status\": \"CANCELLED\",\n \"merchantRefNum\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"merchantRefNums\": [\n \"\",\n \"\"\n ],\n \"notificationsToResend\": \"\",\n \"notificationsResent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e342033d-8ee0-4c91-a811-eb49697b7d61", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notifications", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"FINISHED\",\n \"merchantRefNum\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"merchantRefNums\": [\n \"\",\n \"\"\n ],\n \"notificationsToResend\": \"\",\n \"notificationsResent\": \"\"\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": "d0432b2b-5ff6-4189-8078-cbe61109dbff", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "notifications", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"FINISHED\",\n \"merchantRefNum\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"merchantRefNums\": [\n \"\",\n \"\"\n ],\n \"notificationsToResend\": \"\",\n \"notificationsResent\": \"\"\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": "5138c2ba-0dc0-43bb-a966-e78fb9c12948", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "notifications", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"THREE_D_SECURE\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"FINISHED\",\n \"merchantRefNum\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"merchantRefNums\": [\n \"\",\n \"\"\n ],\n \"notificationsToResend\": \"\",\n \"notificationsResent\": \"\"\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": "2c77ab7d-0edd-4f9c-8e02-4a85c9a179f6", "name": "Get Resend Notifications Task", "request": { "name": "Get Resend Notifications Task", "description": { "content": "Get the status of the Webhook Job.", "type": "text/plain" }, "url": { "path": [ "notifications", "tasks", ":taskId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "taskId", "disabled": false, "description": { "content": "(Required) The Job ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a1271be3-baa8-4ab2-aeaf-533105d070e7", "name": "OK", "originalRequest": { "url": { "path": [ "notifications", "tasks", ":taskId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The Job ID", "type": "text/plain" }, "type": "any", "value": "", "key": "taskId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"eventType\": \"CARD_BULK_ORDER\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"status\": \"CANCELLED\",\n \"merchantRefNum\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"merchantRefNums\": [\n \"\",\n \"\"\n ],\n \"notificationsToResend\": \"\",\n \"notificationsResent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08a56b91-d1b3-4efb-8305-980f8d6bfdcf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notifications", "tasks", ":taskId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The Job ID", "type": "text/plain" }, "type": "any", "value": "", "key": "taskId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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": "4bd5a6ec-e7ba-4335-9769-2effd6d2fa15", "name": "Not found", "originalRequest": { "url": { "path": [ "notifications", "tasks", ":taskId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The Job ID", "type": "text/plain" }, "type": "any", "value": "", "key": "taskId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "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": "361d93a9-765a-4c37-a38d-80800d1131cf", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "notifications", "tasks", ":taskId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The Job ID", "type": "text/plain" }, "type": "any", "value": "", "key": "taskId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Exchange", "description": "Currency Exchange API.\n", "item": [ { "id": "3ec425f8-7cf5-43cd-9ed6-0950fc785339", "name": "Create FX Rate Quote", "request": { "name": "Create FX Rate Quote", "description": { "content": "(In Development)\n\nCreate currency exchange rate quote for specific currency to specific target currency from Paysafe.\n\nThere are two type of exchange operations that can be triggered usint this quote:\n\n* Currency conversion inside customer account\n* Currency conversion during transfer operation between two customer, where currency do not match\n\nThe quote can be passed as parameter during currency conversion and allows predictable behavior of the operation. Each quote is valid for specific time. If expired quote is passed the currency conversion will fail.\n\n> Note ! The exchange rate includes the respective Paysafe fees. It should be noted, that because of the way Paysafe applies the fee some rounding might internlly cause minor difference in the actual conversion output. Usually this would be in customer benefit.", "type": "text/plain" }, "url": { "path": [ "fxrate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceCurrency\": \"\",\n \"targetCurrency\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "63e8c8d9-8379-44ad-a7ba-5b076bba1206", "name": "OK", "originalRequest": { "url": { "path": [ "fxrate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceCurrency\": \"\",\n \"targetCurrency\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"fxRate\": \"\",\n \"sender\": \"\",\n \"sourceCurrency\": \"\",\n \"targetCurrency\": \"\",\n \"recipient\": \"\",\n \"id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cb4ef0f-a14c-4ab9-8c5d-e9d843c4b301", "name": "Get FX Rate Quote", "request": { "name": "Get FX Rate Quote", "description": { "content": "(In Development)\n\nGet get exchange rate quote.\n\nThe quote must be created using `POST /fxrate` API.\nUse the quote when currency exchange operation is required to have predictable exchange rate applied.\nEach quote is only valid for certain period of time. If the quote passed is expired the transaction will be rejected.\nIf quote is not passed Paysafe will apply the latest exchange rate, that will be availabe at transaction time.\n\n> Note! Since exchange rate quotes expire, they will be available only for 30 days. Older quotes will not be kept in the system.", "type": "text/plain" }, "url": { "path": [ "fxrate", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Exchange rate quote id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "49921e6c-ef74-4864-8dcc-9ec72e37d3db", "name": "OK", "originalRequest": { "url": { "path": [ "fxrate", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Exchange rate quote id", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"fxRate\": \"\",\n \"sender\": \"\",\n \"sourceCurrency\": \"\",\n \"targetCurrency\": \"\",\n \"recipient\": \"\",\n \"id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Customer Verification", "description": "Customer Verification API.\n", "item": [ { "id": "276bc2f0-8e42-4156-afeb-9ac81bafafdc", "name": "Get KYC verification status", "request": { "name": "Get KYC verification status", "description": { "content": "Get Customer Verification Status", "type": "text/plain" }, "url": { "path": [ "kyc", "customers", ":customerId", "verification-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1c3b4d4f-d931-48fe-8298-9e23311cee46", "name": "200", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "verification-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"kycVerificationStatus\": \"INCOMPLETE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60168555-fbd4-4b66-adab-d8e31a37ef2b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "verification-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "72996969-6591-4974-bfb3-1d5ed52cf918", "name": "Not Found", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "verification-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "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": "e53b7052-9fce-4a0a-82e2-b5dae6275d7a", "name": "Create a KYC session", "request": { "name": "Create a KYC session", "description": { "content": "Merchant creates a KYC session for their customer", "type": "text/plain" }, "url": { "path": [ "kyc", "customers", ":customerId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5552fcd2-2b7f-4885-a678-af76d6134b7f", "name": "Created", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"INITIATED\",\n \"redirectUrl\": \"\",\n \"sessionEvents\": [\n {\n \"name\": \"PROVIDER_SESSION_END\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"verificationDocuments\": [\n {\n \"category\": \"ADDITIONAL_VERIFICATION\",\n \"type\": \"SSC\",\n \"status\": \"APPROVED\",\n \"id\": \"\",\n \"subtype\": \"SERVICES_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 \"category\": \"ADDRESS\",\n \"type\": \"CUS_CD\",\n \"status\": \"IN_REVIEW\",\n \"id\": \"\",\n \"subtype\": \"MULTI_PURPOSE_ID\",\n \"statusReason\": \"DOCUMENT_NOT_PROVIDED\",\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\": \"ADDRESS_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\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "146773ee-c687-491e-9598-646e564eb66f", "name": "Bad Request. Provided data is invalid.", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\"\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": "2de15280-b9fa-4cde-a6b4-d938004bb27d", "name": "Not Found", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "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": "2c9ff5f0-c303-4748-b02b-2931d5c1bf38", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\"\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6ee1eb8-323f-4602-bec7-74e3e667c048", "name": "Get all customer sessions", "request": { "name": "Get all customer sessions", "description": { "content": "Retrieve all customer sessions", "type": "text/plain" }, "url": { "path": [ "kyc", "customers", ":customerId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "03f64a16-6d85-4727-99ad-b67e0ee495cf", "name": "OK", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the requested number of records to return. Max = 50. Default = 10.", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "This is the requested starting position of the response entries, where 0 is the first record. Default = 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Merchant's Paysafe wallet customer id", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"sessions\": [\n {\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"INITIATED\",\n \"redirectUrl\": \"\",\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 \"verificationDocuments\": [\n {\n \"category\": \"ADDRESS\",\n \"type\": \"SENC\",\n \"status\": \"APPROVED\",\n \"id\": \"\",\n \"subtype\": \"CUS_PD\",\n \"statusReason\": \"ENVELOPE\",\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\": \"ADDITIONAL_VERIFICATION\",\n \"type\": \"LOAP\",\n \"status\": \"IN_REVIEW\",\n \"id\": \"\",\n \"subtype\": \"CUS_LTC\",\n \"statusReason\": \"NAME_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 \"electronicVerifications\": [\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 \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"INVALID\"\n },\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n }\n ]\n },\n {\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"CREATED\",\n \"redirectUrl\": \"\",\n \"sessionEvents\": [\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"verificationDocuments\": [\n {\n \"category\": \"ADDITIONAL_VERIFICATION\",\n \"type\": \"ID_CARD\",\n \"status\": \"UPLOADED\",\n \"id\": \"\",\n \"subtype\": \"MILITARY_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\": \"IDENTITY\",\n \"type\": \"STUC\",\n \"status\": \"DECLINED\",\n \"id\": \"\",\n \"subtype\": \"PASSPORT_CARD_ID\",\n \"statusReason\": \"DOB_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 \"electronicVerifications\": [\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"INVALID\"\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\": \"INVALID\"\n },\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"INVALID\"\n }\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d206042d-f838-43e1-b481-cb29b874528c", "name": "Get customer session by session Id", "request": { "name": "Get customer session by session Id", "description": { "content": "Get Customer Verification Session", "type": "text/plain" }, "url": { "path": [ "kyc", "customers", ":customerId", "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "158eeff9-5874-407b-8b4d-c4290aec2e98", "name": "OK", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"INITIATED\",\n \"redirectUrl\": \"\",\n \"sessionEvents\": [\n {\n \"name\": \"PROVIDER_SESSION_END\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"verificationDocuments\": [\n {\n \"category\": \"ADDITIONAL_VERIFICATION\",\n \"type\": \"SSC\",\n \"status\": \"APPROVED\",\n \"id\": \"\",\n \"subtype\": \"SERVICES_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 \"category\": \"ADDRESS\",\n \"type\": \"CUS_CD\",\n \"status\": \"IN_REVIEW\",\n \"id\": \"\",\n \"subtype\": \"MULTI_PURPOSE_ID\",\n \"statusReason\": \"DOCUMENT_NOT_PROVIDED\",\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\": \"ADDRESS_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\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d799697a-8551-4e0d-bc64-e16720cd72e0", "name": "Not Found", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "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": "ffdc56e8-46c4-430f-a2bf-75f1cb54209b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "kyc", "customers", ":customerId", "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Strong Customer Authentication", "description": "Strong Customer Authentication API.\n", "item": [ { "id": "8f852894-5e74-4982-933d-5fe9793c4208", "name": "Submit an Outsourced SCA Attempt", "request": { "name": "Submit an Outsourced SCA Attempt", "description": { "content": "Submits an Outsourced authentication attempt for a Strong Customer Authentication (SCA) event.\n\nOnce an SCA process for a specific wallet operation is initiated and active (i.e., not expired or failed), and\nthe challenge has been received, the user has a limited number of attempts to complete it (e.g., verify the OTP\ncode sent via SMS), as defined by `allowableAttempts`. Each new authentication attempt increments the\n`currentAttempts` count until it reaches the predefined limit. When the limit is reached, no further\nauthentication attempts for the same process are accepted and are automatically denied. There is no cooldown\nperiod, and the SCA process is marked as failed. To retry the authentication, a new SCA process must be started,\nand the user can attempt the authentication again. The process status is always determined by the most recent\nverification attempt, regardless of what happened in previous attempts (e.g., the process will be marked as\nfailed if the last attempt failed, even if earlier attempts were successful).\n\nMore details can be found in [Strong Customer Authentication](/docs/embedded-wallets/strong-customer-authentication).", "type": "text/plain" }, "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "eventId", "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "78aa088a-2796-4dd5-9443-70fce7e3e4a6", "name": "Created", "originalRequest": { "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"EMBEDDED\",\n \"verification\": {\n \"method\": \"PASSKEYS\",\n \"channel\": \"AUTHENTICATOR\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n \"currentAttempts\": \"\",\n \"allowableAttempts\": \"\",\n \"status\": \"REJECTED\",\n \"creationTime\": \"\",\n \"statusReason\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53731e30-ce03-45fc-b073-b81ddb7c2fe3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\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": "436b585c-5f9c-4f43-9189-86ff53c2d24e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "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": "2b5a2990-1ef1-4e50-ad6e-bdd636617b97", "name": "Not Found", "originalRequest": { "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "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": "48aded09-5fe6-4701-946d-8b535e3e628f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "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": "7d79eb33-bcba-4024-b329-8ff7554e6d4f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "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": "35fc6e2f-c2c4-4c2f-8e90-60e9fa681a0d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\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": "510a9254-9ec9-4b12-ab0f-e4434919abab", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "sca", "events", ":eventId", "attempts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the SCA event, associated with the current event attempt.", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"PUSH_NOTIFICATION\"\n },\n \"status\": \"VERIFIED\",\n \"statusReason\": \"\"\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 } } ] } ], "auth": { "type": "basic", "basic": [ { "type": "any", "value": "{{basicAuthUsername}}", "key": "username" }, { "type": "any", "value": "{{basicAuthPassword}}", "key": "password" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.paysafe.com/digitalwallets/v1" } ], "info": { "_postman_id": "fe9f9d95-902f-4e58-ba89-557264ee33aa", "name": "Wallet API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## Introduction\n\nThe Wallet API allows you to create and manage digital wallets for your customers.\n\nClick [here](/docs/embedded-wallets/getting-started) to learn more about Embedded Wallet APIs.\n\nContact Support:\n Name: Paysafe\n Email: info@paysafe.com", "type": "text/plain" } } }