{ "item": [ { "name": "Wallets", "description": "Customer wallets are managed by the Merchant. This includes the responsibility of\ncreating new wallets when needed, updating customer details whenever these change\nin the Merchant's platform in a timely manner, and deactivating the Paysafe DW\nwhen a customer de-registers the Merchant's platform.\n", "item": [ { "id": "841ed83f-64f4-466a-8179-e57c9e3e06a2", "name": "Create a new wallet for a customer", "request": { "name": "Create a new wallet for a customer", "description": { "content": "Create a new wallet for a customer.", "type": "text/plain" }, "url": { "path": [ "v2", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\"\n },\n {\n \"currencyCode\": \"\"\n }\n ],\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FOOD_AND_BEVERAGE_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8d62ef79-573b-4135-be91-c440d325b0cd", "name": "Created.", "originalRequest": { "url": { "path": [ "v2", "wallets" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\"\n },\n {\n \"currencyCode\": \"\"\n }\n ],\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FOOD_AND_BEVERAGE_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"QR_CODE\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"US_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"CARD\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n }\n ],\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"BETTING_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"id\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"restrictions\": [\n {\n \"name\": \"OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS\",\n \"reason\": \"COMPLIANCE\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SETUP_PIN\",\n \"WAIT\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"INCOMING_TRANSACTIONS_AND_SEND_MONEY\",\n \"reason\": \"COMPLIANCE\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_AD\",\n \"CONTACT_CUSTOMER_SERVICE\"\n ],\n \"creationTime\": \"\"\n }\n ],\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"PH_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"LOW_MENTAL_CAPACITY\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"serviceLevel\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eeb3843-e524-463b-b909-8a21922495af", "name": "Validation failed.", "originalRequest": { "url": { "path": [ "v2", "wallets" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\"\n },\n {\n \"currencyCode\": \"\"\n }\n ],\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FOOD_AND_BEVERAGE_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\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": "86f67c07-3f99-44f3-8652-911290987f73", "name": "Unauthorized request.", "originalRequest": { "url": { "path": [ "v2", "wallets" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\"\n },\n {\n \"currencyCode\": \"\"\n }\n ],\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FOOD_AND_BEVERAGE_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\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": "14edf5ba-9e35-45cc-81b6-b65f3f640caa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "wallets" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\"\n },\n {\n \"currencyCode\": \"\"\n }\n ],\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FOOD_AND_BEVERAGE_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\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": "796d5756-71a7-491a-a44a-fea845b6491e", "name": "Conflict. Check body for details.", "originalRequest": { "url": { "path": [ "v2", "wallets" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\"\n },\n {\n \"currencyCode\": \"\"\n }\n ],\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FOOD_AND_BEVERAGE_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "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": "a8d84d1d-5f14-4850-a813-96872be8f02a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "wallets" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\"\n },\n {\n \"currencyCode\": \"\"\n }\n ],\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FOOD_AND_BEVERAGE_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\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": "de248f7d-d1a1-4e4b-95ef-0c97580d26cf", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "wallets" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\"\n },\n {\n \"currencyCode\": \"\"\n }\n ],\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"customer\": {\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FOOD_AND_BEVERAGE_INDUSTRY\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n },\n \"termsAndConditionsAccepted\": \"\"\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": "4e2b0e6d-4308-4f05-8b6c-fafca4b7c1d5", "name": "Retrieve details on customer wallet", "request": { "name": "Retrieve details on customer wallet", "description": { "content": "Get a customer by ID.\n\nReturns CustomerPerson.", "type": "text/plain" }, "url": { "path": [ "v2", "customer-persons", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9a29e32d-896c-4d0f-b518-80e58b0a53b3", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FREELANCER_SELF_EMPLOYED\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"id\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"restrictions\": [\n {\n \"name\": \"OTHER\",\n \"reason\": \"CLOSE_ACCOUNT\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_ID\",\n \"BANK_ACCOUNT_VERIFICATION\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"LOGIN\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_SSN_CARD\",\n \"NO_REMEDIATION\"\n ],\n \"creationTime\": \"\"\n }\n ],\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"US_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"FRAUDULENT_LOCATION\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\"\n },\n \"userCategory\": \"\",\n \"serviceLevel\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57322950-351c-4962-aaf5-d26204dd5e1e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05d9d81f-4784-46c1-864d-b26f7fab4e0b", "name": "Update customer information", "request": { "name": "Update customer information", "description": { "content": "## Introduction\n\nUpdate customer personal information.\n\nCustomer details updates must be reflected on the Paysafe side, for regulatory purposes.\n\nUpdating the following customer details might result in customer restriction and require new KYC Verification.\n\n* firstName, lastName - re-trigger KYC verification\n* address1, address2, city, state, zip - re-trigger address verification of KYC process\n\nTo update the following details, the customer must be non-KYC verified. If the customer is KYC verified, you cannot update these details:\n\n* birthDate\n\n## Change Of Customer Country\n\nChanging customer country requires moving the customer account from one country jurisdiction to another.\nIt impacts both accounting and compliance handling.\n\nThe process of account migration has the following prerequisites.\n\n* Customer accounts must have zero balance\n* Customer must provide address located in the new country\n* Base account currency in the new country must be specified upon migration.\n* One account must be provided for the initial migration. Additional accounts might be added using the Accounts API.\n* The customer accounts in the old country would be deactivated\n* KYC address verification information must be passed for the new address.\n If not passed the account might be restricted, until the address verification is performed.\n\n> Customer transaction history and verified instruments remain after the account migration.\n\nFor changing the customer country, you should use `customer-persons` **PATCH** request and pass all the required parameters for complying with the requirements above.\n\n---\n**PATCH** `https://api.paysafe.com/digitalwallets/v2/customer-persons/{customerId}`\n\n```json title=\"Change customer country\" lineNumbers\n{\n \"address1\": \"23 Four Str\",\n \"city\": \"London\",\n \"zip\": \"E17 033\",\n \"countryCode\": \"GB\",\n \"accounts\": [{\n \"currencyCode\": \"GBP\"\n }\n ]\n}\n```\n---", "type": "text/plain" }, "url": { "path": [ "v2", "customer-persons", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"title\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"state\": \"\",\n \"countryCode\": \"\",\n \"birthDate\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"TRANSPORTATION_SERVICES\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"LOW_MENTAL_CAPACITY\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"userCategory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "005ae745-78db-4ea5-bf00-d027f6aa6bad", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"title\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"state\": \"\",\n \"countryCode\": \"\",\n \"birthDate\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"TRANSPORTATION_SERVICES\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"LOW_MENTAL_CAPACITY\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"userCategory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address1\": \"\",\n \"birthDate\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"email\": \"\",\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"occupation\": \"FREELANCER_SELF_EMPLOYED\",\n \"registrationIp\": \"\",\n \"zip\": \"\",\n \"id\": \"\",\n \"type\": \"PERSON\",\n \"registrationDate\": \"\",\n \"restrictions\": [\n {\n \"name\": \"OTHER\",\n \"reason\": \"CLOSE_ACCOUNT\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_ID\",\n \"BANK_ACCOUNT_VERIFICATION\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"LOGIN\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"SUBMIT_SSN_CARD\",\n \"NO_REMEDIATION\"\n ],\n \"creationTime\": \"\"\n }\n ],\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"US_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n }\n ],\n \"title\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"nationality\": \"\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"FRAUDULENT_LOCATION\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\"\n },\n \"userCategory\": \"\",\n \"serviceLevel\": \"\",\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c6336e-17b9-45fb-bd39-7c75f1ef0af0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"title\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"state\": \"\",\n \"countryCode\": \"\",\n \"birthDate\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"TRANSPORTATION_SERVICES\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"LOW_MENTAL_CAPACITY\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"userCategory\": \"\"\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": "e9a7119b-465e-4b0a-b640-08da17afc30e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"title\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"state\": \"\",\n \"countryCode\": \"\",\n \"birthDate\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"TRANSPORTATION_SERVICES\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"LOW_MENTAL_CAPACITY\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"userCategory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac2dea4b-35a0-411d-8d1e-45b57613826a", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"title\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"state\": \"\",\n \"countryCode\": \"\",\n \"birthDate\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"TRANSPORTATION_SERVICES\",\n \"vulnerabilities\": [\n \"POOR_LANGUAGE_SKILLS\",\n \"LOW_MENTAL_CAPACITY\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"userCategory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b63439ca-6764-4930-97c6-d6f960ba4a58", "name": "Notify of External Customer Data Change", "request": { "name": "Notify of External Customer Data Change", "description": { "content": "For risk and compliance reasons Embedded Wallets system needs to be notified of details regarding customer changes happening outside of the wallet system.\n\nSuch information allows us to minimize the risks of money loss in cases of fraud or account takeover.\n\nPartners are required to implement all the required notifications when using the Embedded Wallets solution.", "type": "text/plain" }, "url": { "path": [ "v2", "customer-persons", ":customerId", "change-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"changeType\": \"PASSWORD_CHANGED\",\n \"changeTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8366ba23-2ba3-44c4-a289-92a87668fdcd", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "change-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"changeType\": \"PASSWORD_CHANGED\",\n \"changeTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "995c2a01-4ae3-4c8e-854a-9b407f3fb307", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "change-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"changeType\": \"PASSWORD_CHANGED\",\n \"changeTime\": \"\"\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": "9b2540e7-99a9-41dc-81e1-09186133b4a2", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "change-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"changeType\": \"PASSWORD_CHANGED\",\n \"changeTime\": \"\"\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": "0ebeb57e-1a26-49be-8afe-e5a2c68d6c89", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "change-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"changeType\": \"PASSWORD_CHANGED\",\n \"changeTime\": \"\"\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": "07436f52-3ec2-43c0-974e-56239a534008", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "change-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"changeType\": \"PASSWORD_CHANGED\",\n \"changeTime\": \"\"\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": "1fdb9838-b8a3-4087-bf65-6c431428484a", "name": "Retrieve details on customer wallet by attribute type and value", "request": { "name": "Retrieve details on customer wallet by attribute type and value", "description": { "content": "Retrieves a customer's information using an attribute field to perform the search.\nPossible attribute types are `EMAIL` and `MOBILE`.\n\nBy default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.\n", "type": "text/plain" }, "url": { "path": [ "v2", "customer-persons", ":attributeType", ":attributeValue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "By default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.", "type": "text/plain" }, "key": "include", "value": "ACCOUNTS" }, { "disabled": false, "description": { "content": "By default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.", "type": "text/plain" }, "key": "include", "value": "PREFERENCES" } ], "variable": [ { "type": "any", "value": "CUSTOMER_ID", "key": "attributeType", "disabled": false, "description": { "content": "(Required) The type of attribute to search by a customer.\n- `EMAIL` - represents the customer's email address used for identification.\n- `MOBILE` - represents the customer's mobile number used for identification.\n- `CUSTOMER_ID` - represents the customer id used for identification. (This can only be one of EMAIL,MOBILE,CUSTOMER_ID)", "type": "text/plain" } }, { "type": "any", "value": "", "key": "attributeValue", "disabled": false, "description": { "content": "(Required) The value of the attribute to search by a customer.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5853eebe-031b-488d-8350-439d98280641", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":attributeType", ":attributeValue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "By default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.", "type": "text/plain" }, "key": "include", "value": "PREFERENCES" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The type of attribute to search by a customer.\n- `EMAIL` - represents the customer's email address used for identification.\n- `MOBILE` - represents the customer's mobile number used for identification.\n- `CUSTOMER_ID` - represents the customer id used for identification. (This can only be one of EMAIL,MOBILE,CUSTOMER_ID)", "type": "text/plain" }, "type": "any", "value": "CUSTOMER_ID", "key": "attributeType" }, { "disabled": false, "description": { "content": "(Required) The value of the attribute to search by a customer.", "type": "text/plain" }, "type": "any", "value": "", "key": "attributeValue" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"id\": \"\",\n \"title\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"CHARITY_AND_NON_PROFIT_SERVICES\",\n \"vulnerabilities\": [\n \"PHYSICAL_DISABILITY\",\n \"POOR_LANGUAGE_SKILLS\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"userCategory\": \"\",\n \"serviceLevel\": \"\",\n \"externalId\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"\",\n \"restrictions\": [\n {\n \"id\": \"\",\n \"name\": \"OTHER\",\n \"reason\": \"UNDER_18\",\n \"requiredActions\": [\n \"PEP_DECLARATION\",\n \"KYC_VERIFICATION\"\n ],\n \"lastChangeDate\": \"\",\n \"activationTime\": \"\",\n \"dueDate\": \"\",\n \"creationTime\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"CRYPTO_TRANSACTIONS\",\n \"reason\": \"RISK_CONTROLS\",\n \"requiredActions\": [\n \"COMPLETE_ONBOARDING\",\n \"NO_REMEDIATION\"\n ],\n \"lastChangeDate\": \"\",\n \"activationTime\": \"\",\n \"dueDate\": \"\",\n \"creationTime\": \"\"\n }\n ],\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"QR_CODE\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"US_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"EMAIL\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"EMAIL\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"US_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n }\n ],\n \"incompleteAttributes\": [\n \"NATIONALITY\",\n \"NATIONALITY\"\n ],\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n },\n \"auth\": {\n \"access_token\": \"\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"\",\n \"refresh_token\": \"\",\n \"refresh_expires_in\": \"\",\n \"id_token\": \"\",\n \"scope\": \"\"\n },\n \"customerVulnerabilities\": {\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\n },\n \"registrationIp\": \"\",\n \"registrationDate\": \"\",\n \"kycInfo\": {\n \"documentType\": \"\",\n \"documentNumber\": \"\"\n }\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"id\": \"\",\n \"title\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"ENTERTAINMENT_MEDIA\",\n \"vulnerabilities\": [\n \"PHYSICAL_DISABILITY\",\n \"CARING_RESPONSIBILITIES\"\n ],\n \"additionalAttributes\": {\n \"key_0\": \"\"\n },\n \"userCategory\": \"\",\n \"serviceLevel\": \"\",\n \"externalId\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"\",\n \"restrictions\": [\n {\n \"id\": \"\",\n \"name\": \"INCOMING_TRANSACTIONS_AND_SEND_MONEY\",\n \"reason\": \"T_C_ABUSE\",\n \"requiredActions\": [\n \"SUBMIT_AD\",\n \"MANUAL_REVIEW\"\n ],\n \"lastChangeDate\": \"\",\n \"activationTime\": \"\",\n \"dueDate\": \"\",\n \"creationTime\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"ALL_TRANSACTIONS\",\n \"reason\": \"T_C_ABUSE\",\n \"requiredActions\": [\n \"OTHER\",\n \"OTHER\"\n ],\n \"lastChangeDate\": \"\",\n \"activationTime\": \"\",\n \"dueDate\": \"\",\n \"creationTime\": \"\"\n }\n ],\n \"accounts\": [\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"US_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"CARD\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"CARD\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n }\n ],\n \"incompleteAttributes\": [\n \"NATIONALITY\",\n \"NATIONALITY\"\n ],\n \"preferences\": {\n \"marketing\": {\n \"receivePushNotifications\": \"\",\n \"receiveMarketingEmails\": \"\",\n \"receiveMarketingSms\": \"\",\n \"receiveSocialAds\": \"\",\n \"receiveTargetedAds\": \"\",\n \"receiveThirdPartyAds\": \"\"\n },\n \"data\": {\n \"consentForTargetedAds\": \"\",\n \"consentForAnalytics\": \"\",\n \"consentForPerformanceTracking\": \"\"\n }\n },\n \"auth\": {\n \"access_token\": \"\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"\",\n \"refresh_token\": \"\",\n \"refresh_expires_in\": \"\",\n \"id_token\": \"\",\n \"scope\": \"\"\n },\n \"customerVulnerabilities\": {\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\n },\n \"registrationIp\": \"\",\n \"registrationDate\": \"\",\n \"kycInfo\": {\n \"documentType\": \"\",\n \"documentNumber\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab1f19a2-ac29-4204-a665-429c9873d9ad", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":attributeType", ":attributeValue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "By default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.", "type": "text/plain" }, "key": "include", "value": "PREFERENCES" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The type of attribute to search by a customer.\n- `EMAIL` - represents the customer's email address used for identification.\n- `MOBILE` - represents the customer's mobile number used for identification.\n- `CUSTOMER_ID` - represents the customer id used for identification. (This can only be one of EMAIL,MOBILE,CUSTOMER_ID)", "type": "text/plain" }, "type": "any", "value": "CUSTOMER_ID", "key": "attributeType" }, { "disabled": false, "description": { "content": "(Required) The value of the attribute to search by a customer.", "type": "text/plain" }, "type": "any", "value": "", "key": "attributeValue" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "92afe6d4-2acf-4bbf-bb95-9d31fd15f4c4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":attributeType", ":attributeValue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "By default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.", "type": "text/plain" }, "key": "include", "value": "PREFERENCES" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The type of attribute to search by a customer.\n- `EMAIL` - represents the customer's email address used for identification.\n- `MOBILE` - represents the customer's mobile number used for identification.\n- `CUSTOMER_ID` - represents the customer id used for identification. (This can only be one of EMAIL,MOBILE,CUSTOMER_ID)", "type": "text/plain" }, "type": "any", "value": "CUSTOMER_ID", "key": "attributeType" }, { "disabled": false, "description": { "content": "(Required) The value of the attribute to search by a customer.", "type": "text/plain" }, "type": "any", "value": "", "key": "attributeValue" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "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": "f0354c7a-1e36-475f-ab44-468e0933fa16", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":attributeType", ":attributeValue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "By default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.", "type": "text/plain" }, "key": "include", "value": "PREFERENCES" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The type of attribute to search by a customer.\n- `EMAIL` - represents the customer's email address used for identification.\n- `MOBILE` - represents the customer's mobile number used for identification.\n- `CUSTOMER_ID` - represents the customer id used for identification. (This can only be one of EMAIL,MOBILE,CUSTOMER_ID)", "type": "text/plain" }, "type": "any", "value": "CUSTOMER_ID", "key": "attributeType" }, { "disabled": false, "description": { "content": "(Required) The value of the attribute to search by a customer.", "type": "text/plain" }, "type": "any", "value": "", "key": "attributeValue" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "e59c27ef-3061-4456-88fd-520eb9e36e9f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":attributeType", ":attributeValue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "By default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.", "type": "text/plain" }, "key": "include", "value": "PREFERENCES" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The type of attribute to search by a customer.\n- `EMAIL` - represents the customer's email address used for identification.\n- `MOBILE` - represents the customer's mobile number used for identification.\n- `CUSTOMER_ID` - represents the customer id used for identification. (This can only be one of EMAIL,MOBILE,CUSTOMER_ID)", "type": "text/plain" }, "type": "any", "value": "CUSTOMER_ID", "key": "attributeType" }, { "disabled": false, "description": { "content": "(Required) The value of the attribute to search by a customer.", "type": "text/plain" }, "type": "any", "value": "", "key": "attributeValue" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "6fea09d4-c309-4002-9820-ccd6365216a4", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":attributeType", ":attributeValue" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "By default limited information is returned in the response. \nUse include parameter to add additional information such as:\n\n- `ACCOUNTS` - Includes account balance information for the customer, such as currency and current balance.\n- `RESTRICTIONS` - Provides details about any restrictions applied to the customer, including reasons and required actions.\n- `ADDRESS` - Adds the customer's address information, including city, state, postal code, and country.\n- `CONTACTINFO` - Includes the customer's contact details, such as email and mobile phone number.\n- `INCOMPLETE_ONBOARDING_ATTRIBUTES` - Lists not completed attributes required for full customer onboarding.\n- `PREFERENCES` - Includes user-defined preferences related to data consent and marketing communication.\n- `VULNERABILITIES` - Includes customer vulnerability indicators grouped by health, competence, and life, and additional support needs.\n- `SERVICE_LEVEL` - Provides the customer's service level information.\n- `KYC_INFO` - Adds KYC verification details, such as document type and document name.", "type": "text/plain" }, "key": "include", "value": "PREFERENCES" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The type of attribute to search by a customer.\n- `EMAIL` - represents the customer's email address used for identification.\n- `MOBILE` - represents the customer's mobile number used for identification.\n- `CUSTOMER_ID` - represents the customer id used for identification. (This can only be one of EMAIL,MOBILE,CUSTOMER_ID)", "type": "text/plain" }, "type": "any", "value": "CUSTOMER_ID", "key": "attributeType" }, { "disabled": false, "description": { "content": "(Required) The value of the attribute to search by a customer.", "type": "text/plain" }, "type": "any", "value": "", "key": "attributeValue" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "8bc30900-8798-44e9-9191-6b23e24f0b21", "name": "Get available currencies for a customer", "request": { "name": "Get available currencies for a customer", "description": { "content": "Get available currencies for a customer in alphabetic code as specified by ISO 4217", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4b1b01a5-e426-49cc-bbb7-0c79933f485b", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"availableCurrencies\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75cd427b-66e9-422b-aec2-7df5f67ce83c", "name": "Get Customer Deactivation Requests", "request": { "name": "Get Customer Deactivation Requests", "description": { "content": "Returns all deactivation requests for a customer.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "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) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8fe0a789-acfd-4bec-bb67-bf13bd60e6be", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "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) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"deactivations\": [\n {\n \"category\": \"MERCHANT_INITIATED\",\n \"id\": \"\",\n \"reason\": \"OTHER\",\n \"status\": \"DECLINED\",\n \"customerId\": \"\",\n \"feedback\": \"\",\n \"comment\": \"\",\n \"creationTime\": \"\",\n \"externalId\": \"\"\n },\n {\n \"category\": \"MERCHANT_INITIATED\",\n \"id\": \"\",\n \"reason\": \"T_C_ABUSE\",\n \"status\": \"APPROVED\",\n \"customerId\": \"\",\n \"feedback\": \"\",\n \"comment\": \"\",\n \"creationTime\": \"\",\n \"externalId\": \"\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d2e47b-9321-4959-a3e1-4e3d080f44b4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "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) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "63b24866-db41-4e17-9eb6-0c7ccf34e7b5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "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) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "5709b087-bbe7-4c26-8662-7f26075105b0", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "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) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "89c42ba7-fae0-40a4-b349-30989730c881", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "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) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "917045ae-52d3-4d62-a0fa-1f20011bc2b3", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "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) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "dce3ba21-4bd7-4080-bfab-548ef279769f", "name": "Request Customer Deactivation", "request": { "name": "Request Customer Deactivation", "description": { "content": "Allows Partner to request customer deactivation. All customer wallets are eligible for deactivation as long as the following criteria are met:\n * customer wallet has exactly zero balance\n * no pending transactions\n * no active restrictions with reason Compliance added by Paysafe - restrictions should be resolved prior to being eligible for deactivation.\n\nOne of the mandatory fields for customer deactivations is the deactivation category. Possible values are:\n - `CUSTOMER_INITIATED`\n - `MERCHANT_INITIATED`\n\nThe reason for customer deactivation is also a mandatory field. Some of the possible values are:\n - `FRAUD`\n - `INACTIVITY`\n - `T_C_ABUSE`\n - `NO_SERVICE_COUNTRY`\n - `OTHER`\n\nAll possible values can be seen bellow.\n\nUpon requesting a customer deactivation, the customer will be restricted for All Transactions and the deactivation request will be posted for manual review by our team. If the deactivation is approved, the customer will be restricted for Login. Otherwise, the restriction for All Transactions will be lifted. In both cases, the Partner will receive a webhook with the deactivation outcome and additional information if applicable. For more information regarding the webhook, please refer to the official webhook documentation.\n\nThe response returns the deactivation request. If there is an existing customer deactivation request in `MANUAL_REVIEW` status, the API will return 409 Conflict.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"reason\": \"FRAUD\",\n \"feedback\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6fcc1ab8-ecca-4b9a-830e-992345e25771", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"reason\": \"FRAUD\",\n \"feedback\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"id\": \"\",\n \"reason\": \"INACTIVITY\",\n \"status\": \"MANUAL_REVIEW\",\n \"customerId\": \"\",\n \"feedback\": \"\",\n \"comment\": \"\",\n \"creationTime\": \"\",\n \"externalId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dec3285d-562b-4d94-967d-7ec522368780", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"reason\": \"FRAUD\",\n \"feedback\": \"\"\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": "55b5b49b-9698-4a0c-9418-a5cf32caf628", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"reason\": \"FRAUD\",\n \"feedback\": \"\"\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": "c4dc1aec-14a6-4244-be66-3685a299868f", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"reason\": \"FRAUD\",\n \"feedback\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "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": "4d0c1021-3099-420b-a05c-a892e8bb2c15", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"reason\": \"FRAUD\",\n \"feedback\": \"\"\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": "acbe68bc-e1b9-4afe-9b88-8af7dd373801", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"reason\": \"FRAUD\",\n \"feedback\": \"\"\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": "d7dde573-4216-4406-b166-f8b56fbfc1a6", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deactivations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"category\": \"MERCHANT_INITIATED\",\n \"reason\": \"FRAUD\",\n \"feedback\": \"\"\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 } } ] }, { "name": "Credentials Management", "description": "REST APIs for managing customer credentials.\n", "item": [ { "id": "27e59a39-7644-45de-a0ba-dfc47a614d87", "name": "Initiate a Customer Credentials Management Process", "request": { "name": "Initiate a Customer Credentials Management Process", "description": { "content": "Initiates Customer Credentials Management process. Based on the provided `flow` and `returnUrl`, a `redirectUrl` will be returned to where the customer must be redirected in order to complete the operation:\n* `returnUrl` - should contain the location where the customer will be redirected after completing the required actions in Paysafe hosted UI. It must be on a Paysafe-whitelisted partner domain.\n* `redirectUrl` - redirect url associated with this session. The url contains Paysafe hosted UI, that carries the user through the credentials setup process. It has a short expiration time and will not be usable after it expires.\n\nThe Paysafe Hosted UI guides the customer through the management of the wallet credentials step by step. After successfully finishing the process the customer is being redirected back to the provided `returnUrl`. \nThe behavior of the Paysafe Hosted UI changes depending on the flow attribute: \n* `PASSWORD_SETUP` / `PIN_SETUP` - the customer completes the credentials setup process and is automatically logged in upon successful completion.\n* `PASSWORD_RESET` / `PIN_RESET` - the customer completes the credentials reset process and, after being redirected to the partner's `returnUrl`, must manually log in.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"flow\": \"PIN_SETUP\",\n \"returnUrl\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"language\": \"en\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0049d26d-dab2-4bee-843f-f086c83aafe2", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"flow\": \"PIN_SETUP\",\n \"returnUrl\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"language\": \"en\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"flow\": \"PASSWORD_RESET\",\n \"redirectUrl\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"en\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7011fc05-70c2-4a91-822d-027f472dde25", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"flow\": \"PIN_SETUP\",\n \"returnUrl\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"language\": \"en\"\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": "e3e1f62c-c475-441a-8c64-1e9cb7801ae2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"flow\": \"PIN_SETUP\",\n \"returnUrl\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"language\": \"en\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "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": "5fb46cd0-facc-49cb-baa4-d028c538ab69", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"flow\": \"PIN_SETUP\",\n \"returnUrl\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"language\": \"en\"\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": "a661f675-3cd6-4928-b869-c464cfd066e3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"flow\": \"PIN_SETUP\",\n \"returnUrl\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"language\": \"en\"\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": "c800b717-acca-400a-a1d1-c43896a050fb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"flow\": \"PIN_SETUP\",\n \"returnUrl\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"language\": \"en\"\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": "80d90724-4646-418e-8e73-6a4bb47e5670", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"flow\": \"PIN_SETUP\",\n \"returnUrl\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"language\": \"en\"\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 } } ] }, { "name": "Contact Information", "description": "Contact Information APIs.\n", "item": [ { "id": "66c7ff3c-1412-4d1e-b423-b3762efabc86", "name": "Update Contact Info", "request": { "name": "Update Contact Info", "description": { "content": "This API enables B2B operators to securely and efficiently update a customer's `email address` or `mobile number` on their behalf, focusing on data integrity and robust error handling to prevent unauthorized access.\n\n**Optional Customer Data Verification Flow:**\n\nFor brands that require a customer data verification step, the client should have independently **initiated** and **submitted** the verification process successfully. The resulting `verificationId` must be passed to this API to correlate the contact information update with the completed verification.\n\n* **Initiate a customer data verification process** on the front end by specifying `flow=WALLET_UPDATE` and selecting the specific attribute to change, such as `email address` or `mobile number`.\n* **Submit a customer data verification attempt** tied to the existing process, using the value sent through the secure notification channel to confirm the chosen attribute.\n* Provide the `verificationId` returned from the verification process as an optional field in this request to securely link the contact information update to the completed verification.\n\nThe key considerations when updating the contact info are as follows:\n\n* **Single Contact Policy**: Each user profile can have only one email address and one mobile number at any given time.\n* **Primary Designation**: The specified email and mobile number are treated as the primary contact details.\n* **Verification Requirement**: Only verified contact information can be updated in the user’s profile; unverified details are not allowed.\n* **Uniqueness**: Each email and mobile number must be unique across accounts, preventing duplicate registrations.\n* **Reassignment of Old Contact**: When a contact detail is updated, the previous one is marked as removed and cannot be used by other users until it is totally removed. A request to the operations team is needed to totally remove the attribute, making it available for future registrations.", "type": "text/plain" }, "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"verificationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "77a37e33-dc04-491b-b54a-eccd41f0a94c", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"verificationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"customerId\": \"\",\n \"type\": \"MOBILE\",\n \"value\": \"\",\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dcbc5e3-c8d0-4d56-9d39-9137df5d8ecc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"verificationId\": \"\"\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": "117c5040-284c-402f-9753-f49f718784e8", "name": "Conflict. Check body for details.", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"verificationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "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": "32df5eee-cadd-4d9e-a9ea-9bbc59d080ae", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"verificationId\": \"\"\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": "9b3ba4e5-4769-4a5f-8ba3-2f7353cc85ec", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"verificationId\": \"\"\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": "71f84f4f-9128-447a-bc52-f86853e6e57a", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"verificationId\": \"\"\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": "0e6aeafe-3fed-464f-a885-4df2e95d2715", "name": "Get All Contact Info", "request": { "name": "Get All Contact Info", "description": { "content": "The API returns a list of all contact information attributes, along with associated metadata such as `type`, `status`, and the `creation date` of when the contact info was added to the customer profile.", "type": "text/plain" }, "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The type of extended contact information attribute. (This can only be one of EMAIL,MOBILE)", "type": "text/plain" }, "key": "type", "value": "MOBILE" }, { "disabled": false, "description": { "content": "The status of the extended contact information attribute. (This can only be one of VERIFIED,NOT_VERIFIED)", "type": "text/plain" }, "key": "status", "value": "NOT_VERIFIED" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c577f03a-fe96-443d-a44d-b81a970b9399", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The type of extended contact information attribute. (This can only be one of EMAIL,MOBILE)", "type": "text/plain" }, "key": "type", "value": "MOBILE" }, { "disabled": false, "description": { "content": "The status of the extended contact information attribute. (This can only be one of VERIFIED,NOT_VERIFIED)", "type": "text/plain" }, "key": "status", "value": "NOT_VERIFIED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contactInfo\": [\n {\n \"customerId\": \"\",\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"customerId\": \"\",\n \"type\": \"EMAIL\",\n \"value\": \"\",\n \"status\": \"NOT_VERIFIED\",\n \"creationTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aab39943-556a-4999-8bc3-182a41180a75", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The type of extended contact information attribute. (This can only be one of EMAIL,MOBILE)", "type": "text/plain" }, "key": "type", "value": "MOBILE" }, { "disabled": false, "description": { "content": "The status of the extended contact information attribute. (This can only be one of VERIFIED,NOT_VERIFIED)", "type": "text/plain" }, "key": "status", "value": "NOT_VERIFIED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "2bd898ee-a2bf-43dd-9862-11ae459099e6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The type of extended contact information attribute. (This can only be one of EMAIL,MOBILE)", "type": "text/plain" }, "key": "type", "value": "MOBILE" }, { "disabled": false, "description": { "content": "The status of the extended contact information attribute. (This can only be one of VERIFIED,NOT_VERIFIED)", "type": "text/plain" }, "key": "status", "value": "NOT_VERIFIED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "685166ce-53ca-4c95-b6d5-f69d971ce675", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "contact-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The type of extended contact information attribute. (This can only be one of EMAIL,MOBILE)", "type": "text/plain" }, "key": "type", "value": "MOBILE" }, { "disabled": false, "description": { "content": "The status of the extended contact information attribute. (This can only be one of VERIFIED,NOT_VERIFIED)", "type": "text/plain" }, "key": "status", "value": "NOT_VERIFIED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "Vulnerabilities", "description": "Customer vulnerability APIs for B2B operators.\n", "item": [ { "id": "bba44b39-b35c-4f62-8738-846594585bcd", "name": "Update Customer Vulnerabilities", "request": { "name": "Update Customer Vulnerabilities", "description": { "content": "This API enables B2B operators to update a customer's recorded vulnerabilities on their behalf, offering a straightforward way to manage the recorded indicators related to health, competence, and life circumstances, and any additional support needs. These vulnerabilities are organized into distinct categories:\n\n* **Health**: Manage and track indicators for physical disability, low mental capacity, and gambling addiction, helping ensure the service can respond with appropriate care where those circumstances may increase susceptibility to harm.\n* **Competence**: Manage and track indicators for finance management, reading and writing, language, and digital skills, helping ensure the service can adapt where those factors affect how the customer uses products and services.\n* **Life**: Manage and track indicators for caring responsibilities and location-based risk, helping ensure life circumstances and environment are taken into account in line with regulatory expectations for vulnerable customers.\n\nThe API provides methods to update individual categories or fields without impacting others, but the request will only be accepted if at least one property is modified.", "type": "text/plain" }, "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a71cf7b6-045f-4e35-861b-73f90ee60258", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ff5495c-2281-4b32-8f18-fc2f60314342", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\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": "f63e06e3-c7f0-47f9-bfe8-d8a3308c533f", "name": "Unauthorized request.", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\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": "27ff00e5-c5a1-4508-87d2-80a670dc6c8c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\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": "39641287-8f5c-4a05-87c0-160956708a60", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\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": "8eb60c0b-f1fc-40e7-a690-993be7daaabe", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\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": "d6b4acf2-135c-4487-bd16-61f6eb5dee64", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\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": "025e5fae-c68d-4731-82ac-196c1599b28b", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\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": "1a0bb723-b86b-441e-865f-2d8011c054a8", "name": "Get Customer Vulnerabilities", "request": { "name": "Get Customer Vulnerabilities", "description": { "content": "This API enables B2B operators to view a customer's recorded vulnerabilities on their behalf, offering a straightforward way to understand the recorded indicators related to health, competence, and life circumstances, and any additional support needs. These vulnerabilities are organized into distinct categories:\n\n* **Health**: View indicators for physical disability, low mental capacity, and gambling addiction, which help the service understand where health circumstances may increase susceptibility to harm.\n* **Competence**: View indicators for finance management, reading and writing, language, and digital skills, which help the service understand where capability affects how the customer uses products and services.\n* **Life**: View indicators for caring responsibilities and location-based risk, which help the service understand life circumstances and environment for vulnerable customers.", "type": "text/plain" }, "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6d1a18b1-b177-48bf-989d-a9e2e55f36c5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"health\": {\n \"physicalDisability\": \"\",\n \"lowMentalCapacity\": \"\",\n \"gamblingAddiction\": \"\"\n },\n \"competence\": {\n \"financeManagement\": \"\",\n \"poorLiteracy\": \"\",\n \"poorLanguageSkills\": \"\",\n \"poorDigitalSkills\": \"\"\n },\n \"life\": {\n \"caringResponsibilities\": \"\",\n \"fraudulentLocation\": \"\"\n },\n \"additionalSupportNeeds\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a8a8f3-eb2e-4c38-8702-94d7c99fe0d1", "name": "Unauthorized request.", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "6e84ce82-51f5-4a26-a8bf-24b13804d613", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "945f48bd-83be-4878-80c8-5c7b39d905d7", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "6b5497fc-0f4c-4326-b8d8-1534155e5c3b", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "a942af86-a6c1-4c04-b140-deee55d162f9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "46c359c8-64a9-4461-859e-077bcfbabadb", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customer-persons", ":customerId", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "Accounts", "description": "Every wallet has one or more accounts associated with it - one for every currency that the customer has funds in.\n", "item": [ { "id": "0b37a0e1-8730-47f1-9401-225b09f58a55", "name": "Get wallet accounts", "request": { "name": "Get wallet accounts", "description": { "content": "Get accounts", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Get account for specific currency", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7a8d7fbf-ab2c-4dbd-b862-c78ba7217ef9", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Get account for specific currency", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"QR_CODE\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n },\n {\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"CARD\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "383bb273-28b9-423b-8fad-ee2818b77624", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Get account for specific currency", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "ee8e321a-0043-4f55-b82f-1e14adfee335", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Get account for specific currency", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "e09dfb53-b241-4b83-86e0-93d58b449ce5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Get account for specific currency", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "c3f71102-9b73-4c4a-baf4-a5c256a962f0", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Get account for specific currency", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "e05cb5ed-c8bf-4d8f-9429-bee32a78ff54", "name": "Create wallet account", "request": { "name": "Create wallet account", "description": { "content": "Create a new account. The following parameters are required for account creation.\n\n * currencyCode", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "80b916f5-3d86-4c03-9a4b-26f7e7445352", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"US_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9846a46-61ea-41cd-845a-8e94ccfd5666", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\"\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": "4ff18396-5b39-4834-a1d8-895eee2d4e7a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\"\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": "877cf4e8-0890-4ae7-bc09-ed1ff5a47bd7", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\"\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": "f1bf5166-a437-4c16-8397-21a86c60dd9f", "name": "Get single wallet account", "request": { "name": "Get single wallet account", "description": { "content": "Retrieve the account with the provided id.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "accountId", "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "616d8a32-0ad6-4ba1-999a-323e4d00c68a", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"totalBalance\": \"\",\n \"availableBalance\": \"\",\n \"instruments\": [\n {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFIED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n }\n ],\n \"virtualInstruments\": [\n {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n {\n \"id\": \"\",\n \"instrumentType\": \"US_BANK_ACCOUNT\"\n }\n ],\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7854c0bd-0243-41ef-9c0a-1e79168f9c38", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "1db0260b-25c5-429d-ac3b-9da0f88352dc", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "830aed92-c02b-40f3-b5d6-28c85ec91f12", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "0b956b87-3ceb-414a-8f4b-e838ff0b7a9f", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "Customer Verification", "description": "Customer Verification APIs.\n", "item": [ { "id": "ee7323f1-02c7-40de-98a2-d77fa254ae41", "name": "Get KYC verification status", "request": { "name": "Get KYC verification status", "description": { "content": "Get KYC Verification Status", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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": "b29243c4-72b0-49dd-b1f8-b98cd2f74b04", "name": "KYC Verification Status for customer", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "901ad561-fe59-4c34-9e67-28ed40438593", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "993f0fc4-b4d1-4cc3-b65c-e3238590dfdf", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "b3efb53f-e60f-4553-82f9-01fba12de3ad", "name": "Create a KYC session", "request": { "name": "Create a KYC session", "description": { "content": "\n\nMerchant creates a KYC session for their customer\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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": "564803d5-1b19-472b-9a9a-254cf31cb8ae", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"verificationDocuments\": [\n {\n \"category\": \"ADDRESS\",\n \"type\": \"SSC\",\n \"status\": \"APPROVED\",\n \"id\": \"\",\n \"subtype\": \"OTHER_ID\",\n \"statusReason\": \"SELFIE_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 \"category\": \"ADDRESS\",\n \"type\": \"CUSTOM\",\n \"status\": \"APPROVED\",\n \"id\": \"\",\n \"subtype\": \"REGULAR_DRIVING_LICENSE\",\n \"statusReason\": \"THIRD_PARTY_WARNING\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"electronicVerifications\": [\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"INVALID\"\n }\n ]\n },\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"INVALID\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd027ae5-5212-4021-9f83-214c7ed4a302", "name": "Bad Request. Provided data is invalid.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "8eeef78a-e345-4277-9959-8a286cf4cede", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "919d8ede-2bc9-42ec-96e2-792e76f8a545", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "04cdad6f-0ab9-492c-8d32-44547c6e8346", "name": "Get all customer sessions", "request": { "name": "Get all customer sessions", "description": { "content": "\n\nRetrieve all customer sessions\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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": "14e5dfa3-bf73-42f1-8dd8-193e5cf8daaf", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"CREATED\",\n \"redirectUrl\": \"\",\n \"sessionEvents\": [\n {\n \"name\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"verificationDocuments\": [\n {\n \"category\": \"ADDRESS\",\n \"type\": \"STUC\",\n \"status\": \"APPROVED\",\n \"id\": \"\",\n \"subtype\": \"CITIZENSHIP_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 \"category\": \"ADDRESS\",\n \"type\": \"CUS_PD\",\n \"status\": \"DECLINED\",\n \"id\": \"\",\n \"subtype\": \"TAX_ID\",\n \"statusReason\": \"ADDRES_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\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"INVALID\"\n }\n ]\n }\n ]\n },\n {\n \"merchantRefNum\": \"\",\n \"returnUrl\": \"\",\n \"language\": \"\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externalId\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"FAILED\",\n \"redirectUrl\": \"\",\n \"sessionEvents\": [\n {\n \"name\": \"SSN_ATTESTATION\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"PROVIDER_SESSION_END\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"verificationDocuments\": [\n {\n \"category\": \"IDENTITY\",\n \"type\": \"SEL\",\n \"status\": \"DECLINED\",\n \"id\": \"\",\n \"subtype\": \"PROFESSIONAL_ID\",\n \"statusReason\": \"FULL_CC\",\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\": \"DRIVING_LICENSE\",\n \"status\": \"CLOSED\",\n \"id\": \"\",\n \"subtype\": \"SOCIAL_SECURITY_ID\",\n \"statusReason\": \"NO_DOB_ON_DOC\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"electronicVerifications\": [\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"INVALID\"\n }\n ]\n },\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"VALID\"\n }\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "552a7161-61d9-41a5-bfb3-bce7d935f0ca", "name": "Get customer session by session Id", "request": { "name": "Get customer session by session Id", "description": { "content": "\n\nGet Customer Verification Session\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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": "69d3c123-62f3-4c28-8dbc-992d15576812", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"BIOMETRIC_CONSENT\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n },\n {\n \"name\": \"PROVIDER_SESSION_INITIATED\",\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"verificationDocuments\": [\n {\n \"category\": \"ADDRESS\",\n \"type\": \"SSC\",\n \"status\": \"APPROVED\",\n \"id\": \"\",\n \"subtype\": \"OTHER_ID\",\n \"statusReason\": \"SELFIE_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 \"category\": \"ADDRESS\",\n \"type\": \"CUSTOM\",\n \"status\": \"APPROVED\",\n \"id\": \"\",\n \"subtype\": \"REGULAR_DRIVING_LICENSE\",\n \"statusReason\": \"THIRD_PARTY_WARNING\",\n \"attributes\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dob\": \"\",\n \"addressLine\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"issuingCountry\": \"\",\n \"issueDate\": \"\",\n \"documentExpiry\": \"\",\n \"subdivision\": \"\",\n \"faceMatch\": \"\"\n },\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n }\n }\n ],\n \"electronicVerifications\": [\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"INVALID\"\n }\n ]\n },\n {\n \"kycProviderDetails\": {\n \"kycProvider\": \"\"\n },\n \"results\": [\n {\n \"name\": \"ID_MATCH\",\n \"value\": \"VALID\"\n },\n {\n \"name\": \"ADDRESS_MATCH\",\n \"value\": \"INVALID\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97ffd134-3e58-427e-9402-831c24b10af5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "1b8413a8-535b-4b4b-953e-4adcb0926841", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "kyc", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "Restrictions", "description": "Restriction related entities.\n", "item": [ { "id": "84c6616e-90fb-4c19-bbfc-b5c2c90accb6", "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": [ "v2", "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": "e8080897-76d1-4d73-bb91-755bece55ec5", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"CARD_DEPOSITS\",\n \"reason\": \"SCA\",\n \"id\": \"\",\n \"requiredActions\": [\n \"NATIONALITY\",\n \"COMPLETE_ONBOARDING\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"LOGIN\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"KYC_VERIFICATION\",\n \"SUBMIT_ID\"\n ],\n \"creationTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7bb411b-c742-45a7-b0af-22eed87a65cf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "30ebc2e2-88eb-49b4-a1d8-346b94b4f5cc", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "4a965c77-6c20-4407-a620-68be913f3287", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "1d2077b3-45ab-4e65-bf42-cba5851a4cf8", "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": [ "v2", "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": "65f0af15-3a63-4438-86cd-9be49432f14a", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"restrictions\": [\n {\n \"name\": \"CARD_DEPOSITS\",\n \"reason\": \"SCA\",\n \"id\": \"\",\n \"requiredActions\": [\n \"NATIONALITY\",\n \"COMPLETE_ONBOARDING\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"LOGIN\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"KYC_VERIFICATION\",\n \"SUBMIT_ID\"\n ],\n \"creationTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acd23867-9dca-4056-80b2-15066704c443", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "0a0b3d96-2cd3-4e2b-a0b6-49c62ec0c043", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "46b941eb-a1f2-4575-85c1-641098f74bf0", "name": "Get Customer Restrictions", "request": { "name": "Get Customer Restrictions", "description": { "content": "Returns active restrictions placed on a customer.", "type": "text/plain" }, "url": { "path": [ "v2", "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": "7fbe6e11-6fdf-45d4-8ea1-e34287bae6d3", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"restrictions\": [\n {\n \"name\": \"CARD_DEPOSITS\",\n \"reason\": \"SCA\",\n \"id\": \"\",\n \"requiredActions\": [\n \"NATIONALITY\",\n \"COMPLETE_ONBOARDING\"\n ],\n \"creationTime\": \"\"\n },\n {\n \"name\": \"LOGIN\",\n \"reason\": \"NO_SERVICE_COUNTRY\",\n \"id\": \"\",\n \"requiredActions\": [\n \"KYC_VERIFICATION\",\n \"SUBMIT_ID\"\n ],\n \"creationTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "115bec93-48b9-4374-935b-f5b21dee9461", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "28a701a2-1b55-4794-9d96-bf721a97654f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "6fc57f25-ac8b-4e89-acb3-dda265f97365", "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": [ "v2", "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": "8db49a96-cb23-4503-b7c3-4e9f022c5853", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS\",\n \"reason\": \"SCA\",\n \"id\": \"\",\n \"requiredActions\": [\n \"WAIT\",\n \"SUBMIT_SSN_CARD\"\n ],\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "084ba30d-04cc-4a08-a497-200cd8d5f895", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "dc730499-383b-41ca-a666-228fd4ce0541", "name": "Deleting a restriction, which is not placed by the partner.", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "f66d1261-9207-4c86-b29a-f4ba38484e5b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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 APIs.\n", "item": [ { "id": "85270432-fa8a-4fb7-93c0-c3af34687042", "name": "Get Payment Instruments", "request": { "name": "Get Payment Instruments", "description": { "content": "Retrieve list of active instruments for the customer.\n\nIt returns one of the following instrument objects:\n\n - SEPA Bank Account\n - UK Bank Account\n - US Bank Account\n - CCI Bank Account\n - Card\n\nYou can filter out the response by instrument type or payment option.\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.\nSupported instrument types are dependent on the customer country and enabled payment options.\n\nThe instruments can be used for Deposit and Withdrawal operations.\nOnly **VERIFIED** instruments can be used for withdrawal.\n\nInstrument verification can be done by the following means:\n\n - Bank wire (SEPA, Faster Payments) deposit using the instrument\n - Manual, by submitting bank statement to Paysafe team\n - Paysafe instrument verification flow via third party provider.\n\nAll this instrument verification flows confirm, that the owner of the instrument and the wallet is the same.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Instrument type filter. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "CARD" }, { "disabled": false, "description": { "content": "Payment option filter. (This can only be one of RAPID_TRANSFER,BANK_TRANSFER,OFFLINE_BANK_TRANSFER,CARD,PAYSAFECASH,PAYSAFECARD,PAGO_EFECTIVO,MBWAY,INTERAC_ETRANSFER,KLARNA,SKRILL)", "type": "text/plain" }, "key": "paymentOption", "value": "RAPID_TRANSFER" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c908d714-c70a-4e59-99ac-22e486d6aebd", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Instrument type filter. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "CARD" }, { "disabled": false, "description": { "content": "Payment option filter. (This can only be one of RAPID_TRANSFER,BANK_TRANSFER,OFFLINE_BANK_TRANSFER,CARD,PAYSAFECASH,PAYSAFECARD,PAGO_EFECTIVO,MBWAY,INTERAC_ETRANSFER,KLARNA,SKRILL)", "type": "text/plain" }, "key": "paymentOption", "value": "RAPID_TRANSFER" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"instrumentType\": \"EMAIL\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n },\n {\n \"instrumentType\": \"EMAIL\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b375223-2baf-4b4f-b757-1bcd2b05e21a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Instrument type filter. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "CARD" }, { "disabled": false, "description": { "content": "Payment option filter. (This can only be one of RAPID_TRANSFER,BANK_TRANSFER,OFFLINE_BANK_TRANSFER,CARD,PAYSAFECASH,PAYSAFECARD,PAGO_EFECTIVO,MBWAY,INTERAC_ETRANSFER,KLARNA,SKRILL)", "type": "text/plain" }, "key": "paymentOption", "value": "RAPID_TRANSFER" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "33961b89-972c-4621-8eef-740be959c765", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Instrument type filter. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "CARD" }, { "disabled": false, "description": { "content": "Payment option filter. (This can only be one of RAPID_TRANSFER,BANK_TRANSFER,OFFLINE_BANK_TRANSFER,CARD,PAYSAFECASH,PAYSAFECARD,PAGO_EFECTIVO,MBWAY,INTERAC_ETRANSFER,KLARNA,SKRILL)", "type": "text/plain" }, "key": "paymentOption", "value": "RAPID_TRANSFER" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "ff992d12-579f-4caa-b6bc-1ed53484ff82", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Instrument type filter. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "CARD" }, { "disabled": false, "description": { "content": "Payment option filter. (This can only be one of RAPID_TRANSFER,BANK_TRANSFER,OFFLINE_BANK_TRANSFER,CARD,PAYSAFECASH,PAYSAFECARD,PAGO_EFECTIVO,MBWAY,INTERAC_ETRANSFER,KLARNA,SKRILL)", "type": "text/plain" }, "key": "paymentOption", "value": "RAPID_TRANSFER" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "132eb333-0454-4dbb-afde-6924493d37f7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Instrument type filter. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "CARD" }, { "disabled": false, "description": { "content": "Payment option filter. (This can only be one of RAPID_TRANSFER,BANK_TRANSFER,OFFLINE_BANK_TRANSFER,CARD,PAYSAFECASH,PAYSAFECARD,PAGO_EFECTIVO,MBWAY,INTERAC_ETRANSFER,KLARNA,SKRILL)", "type": "text/plain" }, "key": "paymentOption", "value": "RAPID_TRANSFER" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "afb7c9e5-0232-4be3-9d17-0a29cc7196ca", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Instrument type filter. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "CARD" }, { "disabled": false, "description": { "content": "Payment option filter. (This can only be one of RAPID_TRANSFER,BANK_TRANSFER,OFFLINE_BANK_TRANSFER,CARD,PAYSAFECASH,PAYSAFECARD,PAGO_EFECTIVO,MBWAY,INTERAC_ETRANSFER,KLARNA,SKRILL)", "type": "text/plain" }, "key": "paymentOption", "value": "RAPID_TRANSFER" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "362530f2-a63a-4c26-828b-78f3b3bca285", "name": "Add Payment Instrument", "request": { "name": "Add Payment Instrument", "description": { "content": "Add Payment Instrument.\nNormally, the instrument is created in UNVERIFIED state and can not be used for **withdrawals**.\nAn exception is when **externallyVerified** is used and the instrument can be created in VERIFIED status.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "83b927dd-b303-42c4-9f60-95df48545313", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47296765-b3f0-4233-a143-254ba3d7c87b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\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": "9fc693a1-5e59-43c6-989f-8f018f8bc31d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\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": "2c2d9409-c593-495d-862c-8846c576f27d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "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": "e2edc8f6-ef4a-41fc-bee7-5a98baf7bf86", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\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": "0c8fbc4f-209a-4227-9f2c-d3d9637f5512", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\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": "dd2a9433-6a7c-4d51-98c2-8d3d5f4c6e4b", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "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": "da75c491-395c-491d-a0c6-f13e776138af", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\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": "0e2fb648-ee9d-4846-81de-8e67e6e04b30", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"VERIFICATION_REQUIRED\",\n \"creationTime\": \"\"\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": "db80e29c-5943-4590-9e9b-690987cc7651", "name": "Get Payment Instrument", "request": { "name": "Get Payment Instrument", "description": { "content": "Returns single instrument with specific type and identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "CARD", "key": "instrumentType", "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,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": "7103ae3b-ae73-4e08-96fa-3c80a020bef5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3db10786-b236-4784-9c5e-09699938639b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "333b67ab-6c8a-4da3-bd37-4a7647360c61", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "820f580c-35f5-4c79-957b-38243df5cfdf", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "76bc404d-da0c-4d8a-a9c7-89775f261e81", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "c0f249b5-b488-489e-a461-4fd38ac1422e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "b73b165f-8b4e-466c-9d15-7a42b54a25fd", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "82b24b23-88dd-4b5d-8bd6-8b4b44f07765", "name": "Delete Single Payment Instrument", "request": { "name": "Delete Single Payment Instrument", "description": { "content": "Removes specific payment instrument.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "CARD", "key": "instrumentType", "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,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": "85e1c33e-4c95-4671-b167-49dd9fc4d736", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"id\": \"\",\n \"customerId\": \"\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39d83f3a-703e-4fb4-a1ef-a656a63e79e8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "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": "7e035d23-becd-4cf0-a263-4d26b10f37c0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "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": "8e360c5a-e094-47a3-99d4-768a3d1a14be", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "ae0c652a-f770-4ec3-8e96-926749c24100", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "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": "82af1b93-4ddf-4a69-9ed2-f639ae377009", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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" }, { "id": "0ae58ed6-0375-4b83-a6b5-772b4692ab9d", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instruments", ":instrumentType", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "disabled": false, "description": { "content": "(Required) Instrument type. (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,EMAIL,QR_CODE)", "type": "text/plain" }, "type": "any", "value": "CARD", "key": "instrumentType" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "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": "ffd57ec6-14ad-4d1d-afe8-9a875ee6b540", "name": "Start Instrument Verification Session", "request": { "name": "Start 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*.\n", "type": "text/plain" }, "url": { "path": [ "v2", "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": "4aee2b66-5c95-4469-bcf0-73ef8afa299f", "name": "The instrument verification session object, that contains a redirect URL where the User should be redirected to, \nto complete the payment instrument verification process.", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"QR_CODE\",\n \"redirectUrl\": \"\",\n \"returnUrl\": \"\",\n \"sessionStatus\": \"FAILED\",\n \"instrument\": {\n \"id\": \"\",\n \"instrumentType\": \"CARD\"\n },\n \"statusReason\": \"INSTRUMENT_NOT_UNIQUE\",\n \"secureCode\": \"\",\n \"secureCodeMethod\": \"sha512\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ab6c0f1-a5a7-4f44-9499-074d99ef4afd", "name": "Validation failed.", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "751e8874-6098-4623-826a-99b1a0aedd0c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "8e9d2a2c-89e0-4c69-b70c-c1ea6d7103e8", "name": "Get Instrument Verification Sessions", "request": { "name": "Get Instrument Verification Sessions", "description": { "content": "Returns a list of instrument verification sessions for the customer. \nThe list does not return the secure code so it can not be used to build redirect URL.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "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" }, { "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) The wallet customer id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0161e102-8c95-49f1-bae4-6e0b9c7b3837", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "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" }, { "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) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"FAILED\",\n \"instrument\": {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"statusReason\": \"INSTRUMENT_NOT_UNIQUE\"\n },\n {\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"instrumentType\": \"CLABE_BANK_ACCOUNT\",\n \"redirectUrl\": \"\",\n \"returnUrl\": \"\",\n \"sessionStatus\": \"ACTIVE\",\n \"instrument\": {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n \"statusReason\": \"INSTRUMENT_NOT_UNIQUE\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81cd3390-ff33-4ce0-b585-5be11250da66", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "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" }, { "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) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "9bae9f28-8198-4149-b930-344cde766cfc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instrument-verifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "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" }, { "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) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "bfd852a0-eb28-4d47-80c3-7459e2910a22", "name": "Get Single Instrument Verification Session", "request": { "name": "Get Single Instrument Verification Session", "description": { "content": "Returns previously created instrument verification session.", "type": "text/plain" }, "url": { "path": [ "v2", "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) The generated ID of the Instrument Verification Session, when it was created.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bfd97cec-fe7e-47df-8132-0f902836fc6e", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instrument-verifications", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The generated ID of the Instrument Verification Session, when it was created.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"instrumentType\": \"QR_CODE\",\n \"redirectUrl\": \"\",\n \"returnUrl\": \"\",\n \"sessionStatus\": \"FAILED\",\n \"instrument\": {\n \"id\": \"\",\n \"instrumentType\": \"CARD\"\n },\n \"statusReason\": \"INSTRUMENT_NOT_UNIQUE\",\n \"secureCode\": \"\",\n \"secureCodeMethod\": \"sha512\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea77b55a-08f0-4712-b18c-1918665e6068", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instrument-verifications", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The generated ID of the Instrument Verification Session, when it was created.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "6e68ed31-9e29-435c-81de-d75dc3b30f06", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "instrument-verifications", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The generated ID of the Instrument Verification Session, when it was created.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "2d9414a7-dcce-480c-b42a-938ebd648ddc", "name": "Get Card Verification Information.", "request": { "name": "Get Card Verification Information.", "description": { "content": "Returns instrument verification details for cards.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "verification-info", "CARD", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer id.", "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": "1c954e7b-ba62-453c-b122-9aea2400c55b", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verification-info", "CARD", ":instrumentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the instrument", "type": "text/plain" }, "type": "any", "value": "", "key": "instrumentId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"verificationPattern\": \"\",\n \"verificationType\": \"VERIFICATION_CODE\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1e582e4-20fe-49fd-903d-440c56520512", "name": "Verify Card", "request": { "name": "Verify Card", "description": { "content": "Perform card verification using verification code from previous successful transactions.\nThe verification is required if either forced by risk and compliance or the card lifetime limit is reached.\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD" ], "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 \"verificationCode\": \"6431\",\n \"instrumentId\": \"\",\n \"verificationType\": \"VERIFICATION_CODE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "82b48185-a667-44bf-84c1-2461c54f0c3d", "name": "The instrument verification allows tracking the verification outcome.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"6431\",\n \"instrumentId\": \"\",\n \"verificationType\": \"VERIFICATION_CODE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"id\": \"\",\n \"instrumentId\": \"\",\n \"status\": \"COMPLETED\",\n \"verificationCode\": \"1310\",\n \"verificationType\": \"VERIFICATION_CODE\",\n \"statusReason\": \"VERIFICATION_ATTEMPT_EXCEEDED\",\n \"instrumentType\": \"CARD\",\n \"remainingAttempts\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e7e37ac-8f66-4d85-b12e-7280287e28e9", "name": "Validation failed.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"6431\",\n \"instrumentId\": \"\",\n \"verificationType\": \"VERIFICATION_CODE\"\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": "2514ed94-3fa4-4e56-911a-83dbe9b0b48f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD" ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"6431\",\n \"instrumentId\": \"\",\n \"verificationType\": \"VERIFICATION_CODE\"\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": "88e3bdd8-b410-4801-9ce2-5665ad6225dc", "name": "Get Card Verifications", "request": { "name": "Get Card Verifications", "description": { "content": "Returns a list of card verification attempts for the customer.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD" ], "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": "Id of card being verified.", "type": "text/plain" }, "key": "instrumentId", "value": "" }, { "disabled": false, "description": { "content": "Card verification status. (This can only be one of COMPLETED,FAILED)", "type": "text/plain" }, "key": "status", "value": "FAILED" } ], "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": "a188d1a9-14a3-43e4-8970-c72e2e5059b6", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD" ], "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": "Id of card being verified.", "type": "text/plain" }, "key": "instrumentId", "value": "" }, { "disabled": false, "description": { "content": "Card verification status. (This can only be one of COMPLETED,FAILED)", "type": "text/plain" }, "key": "status", "value": "FAILED" } ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"cardVerifications\": [\n {\n \"creationTime\": \"\",\n \"id\": \"\",\n \"instrumentId\": \"\",\n \"status\": \"COMPLETED\",\n \"verificationCode\": \"0998\",\n \"verificationType\": \"VERIFICATION_CODE\",\n \"statusReason\": \"INVALID_CODE\",\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"remainingAttempts\": \"\"\n },\n {\n \"creationTime\": \"\",\n \"id\": \"\",\n \"instrumentId\": \"\",\n \"status\": \"COMPLETED\",\n \"verificationCode\": \"0862\",\n \"verificationType\": \"VERIFICATION_CODE\",\n \"statusReason\": \"VERIFICATION_ATTEMPT_24H_EXCEEDED\",\n \"instrumentType\": \"PH_BANK_ACCOUNT\",\n \"remainingAttempts\": \"\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9f6cf55-582f-4f9a-a15c-6eca5e82a7bb", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD" ], "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": "Id of card being verified.", "type": "text/plain" }, "key": "instrumentId", "value": "" }, { "disabled": false, "description": { "content": "Card verification status. (This can only be one of COMPLETED,FAILED)", "type": "text/plain" }, "key": "status", "value": "FAILED" } ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "896a6736-1456-4b0f-b801-fa5407041eaa", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD" ], "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": "Id of card being verified.", "type": "text/plain" }, "key": "instrumentId", "value": "" }, { "disabled": false, "description": { "content": "Card verification status. (This can only be one of COMPLETED,FAILED)", "type": "text/plain" }, "key": "status", "value": "FAILED" } ], "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "707866dd-1718-4e58-b4f3-60f83f478b3a", "name": "Get Single Card Verification", "request": { "name": "Get Single Card Verification", "description": { "content": "Returns card verification attempt information.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD", ":verificationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "verificationId", "disabled": false, "description": { "content": "(Required) Verification attempt id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2cacf970-a9f4-48e0-b577-64506afb8d88", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD", ":verificationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Verification attempt id.", "type": "text/plain" }, "type": "any", "value": "", "key": "verificationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"id\": \"\",\n \"instrumentId\": \"\",\n \"status\": \"COMPLETED\",\n \"verificationCode\": \"1310\",\n \"verificationType\": \"VERIFICATION_CODE\",\n \"statusReason\": \"VERIFICATION_ATTEMPT_EXCEEDED\",\n \"instrumentType\": \"CARD\",\n \"remainingAttempts\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bf6576a-2fc7-4ea0-b03c-e15924929a1f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD", ":verificationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Verification attempt id.", "type": "text/plain" }, "type": "any", "value": "", "key": "verificationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "ab306c8c-76ae-4371-9008-4439142d2881", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "verifications", "CARD", ":verificationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Verification attempt id.", "type": "text/plain" }, "type": "any", "value": "", "key": "verificationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "Virtual Instruments", "description": "Virtual Instruments APIs. \n", "item": [ { "id": "b9250b30-b5f6-43ec-803e-bf08a124d901", "name": "Get Supported Virtual Instrument Types", "request": { "name": "Get Supported Virtual Instrument Types", "description": { "content": "Returns the supported virtual instrument types for the specific account.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId", "virtual-instrument-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "accountId", "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f1351625-2343-4f13-bc65-938e81945600", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId", "virtual-instrument-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentType\": [\n \"UK_BANK_ACCOUNT\",\n \"UK_BANK_ACCOUNT\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aafd51ef-1e0f-407a-8347-065da67f8857", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId", "virtual-instrument-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "11338462-f81e-42a9-bd92-4ab567c1dc09", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId", "virtual-instrument-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "2619c514-8e14-475a-9752-f2156be46d37", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId", "virtual-instrument-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "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": "12039c13-a8c3-4521-b3da-f447fbad53dc", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId", "virtual-instrument-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "8e6b1fa6-9d29-4ab6-96b5-8a04b6314c67", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId", "virtual-instrument-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "d6e83471-71ec-4aa9-8a55-5aff050aba22", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "accounts", ":accountId", "virtual-instrument-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Account id.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "a12edb80-d622-4296-aa5d-ab45aab14362", "name": "Get Virtual Instrument Requests", "request": { "name": "Get Virtual Instrument Requests", "description": { "content": "Retrieve the virtual instrument request of a customer. The virtual instuments can be obtained using the accounts API.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Balance account id.", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Instrument type.", "type": "text/plain" }, "key": "instrumentType", "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" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7ae2e504-93e2-4002-8897-37618d7580a6", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Balance account id.", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Instrument type.", "type": "text/plain" }, "key": "instrumentType", "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" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"virtualInstrumentRequestStatuses\": [\n {\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"requestDate\": \"\",\n \"status\": \"PENDING\",\n \"id\": \"\",\n \"lastChangeDate\": \"\",\n \"accountId\": \"\",\n \"statusReason\": \"\",\n \"virtualInstrumentId\": \"\"\n },\n {\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"requestDate\": \"\",\n \"status\": \"ACCEPTED\",\n \"id\": \"\",\n \"lastChangeDate\": \"\",\n \"accountId\": \"\",\n \"statusReason\": \"\",\n \"virtualInstrumentId\": \"\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e499d69-5eb9-4372-b8c0-92376d39191a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Balance account id.", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Instrument type.", "type": "text/plain" }, "key": "instrumentType", "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" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "cd34e18f-c095-4e35-8e8f-9e65417b0f52", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Balance account id.", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Instrument type.", "type": "text/plain" }, "key": "instrumentType", "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" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "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": "2ff963e5-9a6a-4cc6-946f-469b99aef405", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Balance account id.", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Instrument type.", "type": "text/plain" }, "key": "instrumentType", "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" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "a5b7a63c-1cdb-4468-adf9-271a02ec1ea2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Balance account id.", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Instrument type.", "type": "text/plain" }, "key": "instrumentType", "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" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "6b5a97f1-f5ad-45ee-b67e-a370f163f129", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Balance account id.", "type": "text/plain" }, "key": "accountId", "value": "" }, { "disabled": false, "description": { "content": "Instrument type.", "type": "text/plain" }, "key": "instrumentType", "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" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "2ac47405-e1b6-4349-8e9e-e306c31fdb20", "name": "Request Virtual Instrument", "request": { "name": "Request Virtual Instrument", "description": { "content": "Request assignment of new virtual instrument to existing balance account.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) 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\": \"UK_BANK_ACCOUNT\",\n \"accountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9ec4e2e3-9239-4306-9c05-77b2808f46d6", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"accountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\",\n \"requestDate\": \"\",\n \"status\": \"FAILED\",\n \"id\": \"\",\n \"lastChangeDate\": \"\",\n \"accountId\": \"\",\n \"statusReason\": \"\",\n \"virtualInstrumentId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a71c257-b4c1-4bcc-9bcb-c4bc1e2c14c6", "name": "Get Virtual Instrument Requests", "request": { "name": "Get Virtual Instrument Requests", "description": { "content": "Retrieves single virtual instrument request.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests", ":virtualInstrumentRequestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "virtualInstrumentRequestId", "disabled": false, "description": { "content": "(Required) Virtual instrument request id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "817e22a3-49dc-4d2a-b7a0-075a58c151e1", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests", ":virtualInstrumentRequestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Virtual instrument request id", "type": "text/plain" }, "type": "any", "value": "", "key": "virtualInstrumentRequestId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instrumentType\": \"IBAN_BANK_ACCOUNT\",\n \"requestDate\": \"\",\n \"status\": \"FAILED\",\n \"id\": \"\",\n \"lastChangeDate\": \"\",\n \"accountId\": \"\",\n \"statusReason\": \"\",\n \"virtualInstrumentId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6ca785c-381a-4f5b-9e57-556db0921572", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests", ":virtualInstrumentRequestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Virtual instrument request id", "type": "text/plain" }, "type": "any", "value": "", "key": "virtualInstrumentRequestId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "6b212a3f-dc25-46dc-bace-bb5d8e959d7f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests", ":virtualInstrumentRequestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Virtual instrument request id", "type": "text/plain" }, "type": "any", "value": "", "key": "virtualInstrumentRequestId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "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": "822c8ee3-9d1d-4c73-9613-6c048ec7e575", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests", ":virtualInstrumentRequestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Virtual instrument request id", "type": "text/plain" }, "type": "any", "value": "", "key": "virtualInstrumentRequestId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "bcae9863-9c80-4c30-8e42-5dea1d86410b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests", ":virtualInstrumentRequestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Virtual instrument request id", "type": "text/plain" }, "type": "any", "value": "", "key": "virtualInstrumentRequestId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "9e4844d1-c2a1-4b97-8412-711be626c992", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "virtual-instrument-requests", ":virtualInstrumentRequestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Virtual instrument request id", "type": "text/plain" }, "type": "any", "value": "", "key": "virtualInstrumentRequestId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "Authorizations", "description": "Authorization history related functionality.\n", "item": [ { "id": "69f4e91e-928d-4a39-98dd-b82024a03f4d", "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": [ "v2", "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": "09fd0473-86b0-4fe8-a04b-c97f1f4086c4", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"SETTLED\",\n \"cardId\": \"\",\n \"cardPresence\": \"UNKNOWN\",\n \"slipId\": \"\",\n \"challenge\": \"PIN\",\n \"cardholderPresence\": \"NOT_PRESENT_INSTALLMENT\",\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\": \"BALANCE_INQUIRY\",\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 },\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"REVERSED\",\n \"cardId\": \"\",\n \"cardPresence\": \"UNKNOWN\",\n \"slipId\": \"\",\n \"challenge\": \"ONLINE\",\n \"cardholderPresence\": \"NOT_PRESENT_PHONE_ORDER\",\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\": \"CREDIT_PAYMENT_TRANSACTION\",\n \"statusReason\": \"\",\n \"panEntryMethod\": \"EMV_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 }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d0f9e8f-df44-401b-9ee3-8aa77a52d4b6", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "b640b7e3-b06c-4dfc-8a70-84774d911846", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "e15bfae7-9a0c-4d7c-82d3-91df5400ee20", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "8362c00b-9cc5-4347-acd0-78a8c758a4fa", "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}/v2/authorizations`.", "type": "text/plain" }, "url": { "path": [ "v2", "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": "4a5be430-92ad-4e8e-b969-237afea8c4d3", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"CREDIT\",\n \"status\": \"SETTLED_RELEASE_FAIL\",\n \"cardId\": \"\",\n \"cardPresence\": \"NOT_PRESENT\",\n \"slipId\": \"\",\n \"challenge\": \"BIOGRAPHIC\",\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\": \"PIN_UNBLOCK\",\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": "a3d7e413-bea1-4f16-98f2-d66957e7ffa6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "db59ff91-cc16-4a09-9aa0-1c2f1d14b64a", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "97d5fbc7-d7c6-4e99-926f-dac11cf9c0a8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "0785696e-0424-46cd-8122-584ff2dfa802", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "4a043573-0b46-4e01-9fb5-676edf44b319", "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": [ "v2", "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": "2c0a26e8-23bf-494c-b5f9-bb99a304945e", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"REFUNDED\",\n \"type\": \"STANDALONE_FEE\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\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 \"paymentType\": \"INTERAC_ETRANSFER\",\n \"statusReason\": \"\",\n \"merchantRefNum\": \"\",\n \"balance\": \"\",\n \"recipientReference\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"PAYOUT\",\n \"description\": \"\"\n },\n \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"GMONEY\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"CARD\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentReason\": \"POINTS\"\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentReason\": \"POINTS\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"slipId\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"direction\": \"DEBIT\",\n \"status\": \"CANCELLED\",\n \"type\": \"REFUND\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\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 \"paymentType\": \"CARD\",\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 \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"GMONEY\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentReason\": \"POINTS\"\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentReason\": \"POINTS\"\n }\n ]\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e25c4708-c68d-4c1e-a639-b797690d4f2c", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "acbf46e1-0808-460a-9321-c3de27665cd6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "34211834-f4d8-48ca-aa42-80a1a20d770b", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "437198bf-a52c-4488-b030-a63ae54454f4", "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 `/v2/transactions`. To retrieve the details of a card authorization by id, the `Retrieve Single Authorization` endpoint should be used - `/v2/authorizations/{authorizationId}`.", "type": "text/plain" }, "url": { "path": [ "v2", "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": "c49ea392-b3aa-4a3f-b809-5475c5a9a514", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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\": \"DEBIT\",\n \"status\": \"FAILED\",\n \"type\": \"STANDALONE_FEE\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\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 \"paymentType\": \"BANK_TRANSFER\",\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 \"peerDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"peerType\": \"GMONEY\"\n },\n \"instrumentDetails\": {\n \"instrumentId\": \"\",\n \"instrumentType\": \"PH_BANK_ACCOUNT\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentReason\": \"POINTS\"\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentReason\": \"POINTS\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ca8a762-3855-41f9-8736-1daa7fe480e2", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "bc40d9f8-8279-4df1-b898-725a169af2a8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "240ab388-47f9-4e69-9fe5-eb4061d18343", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "250bbaaa-7d8d-44ac-b24c-d9fad544cd70", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "d7a28158-9b58-4ee1-9fac-564a8515f185", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": [ { "id": "b63a29dc-584a-404d-99e4-ad0e80b3cc59", "name": "Get Deposit Options", "request": { "name": "Get Deposit Options", "description": { "content": "Returns list of deposit options.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "deposits", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "74a54635-cb05-43bb-a061-ddd8a160a84d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"paymentOption\": \"KLARNA\",\n \"type\": \"FIRST_PARTY\",\n \"instrumentTypes\": [\n \"PH_BANK_ACCOUNT\",\n \"SEPA_BANK_ACCOUNT\"\n ],\n \"paymentOptionSettings\": {\n \"paymentOption\": \"KLARNA\"\n }\n },\n {\n \"paymentOption\": \"MBWAY\",\n \"type\": \"FIRST_PARTY\",\n \"instrumentTypes\": [\n \"BR_BANK_ACCOUNT\",\n \"US_BANK_ACCOUNT\"\n ],\n \"paymentOptionSettings\": {\n \"paymentOption\": \"KLARNA\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a1eba21-2cf8-4a0d-8767-64b75efa4b68", "name": "Get Paysafecash locations", "request": { "name": "Get Paysafecash locations", "description": { "content": "Returns a list of physical locations where Paysafecash can be used", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "deposits", "options", "PAYSAFECASH", "locations" ], "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": "(Required) ", "type": "text/plain" }, "key": "latitude", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "longitude", "value": "" }, { "disabled": false, "description": { "content": "In meters.", "type": "text/plain" }, "key": "radius", "value": "1000" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "edd8a92a-6d11-4c85-812d-73002f48f4a8", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits", "options", "PAYSAFECASH", "locations" ], "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": "(Required) ", "type": "text/plain" }, "key": "latitude", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "longitude", "value": "" }, { "disabled": false, "description": { "content": "In meters.", "type": "text/plain" }, "key": "radius", "value": "1000" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"name\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"address\": \"\",\n \"city\": \"\"\n },\n {\n \"name\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"address\": \"\",\n \"city\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a7c9fa2-1c5e-4f47-8505-bd1ffcffde1f", "name": "Create deposit", "request": { "name": "Create deposit", "description": { "content": "Create deposit for the customer passed in the request path. \n\nDeposits are created in `PREVIEW` state.\n\nThe following parameters are required:\n\n* currency - deposit currency\n* amount - deposit amount in currency minor units\n* paymentOption - deposit payment option must be one of the available payment options provided by `GET /v2/customers/{customerId}/deposits/options`\n* deviceInfo - should provide valid appType and profiling session id.\n\nOptional parameters:\n* merchantRefNum - should be provided by the partner to match with objects in his backend system. \n* paymentInstrumentReference - provide reference to existing verified payment instrument provided by `GET /v1/customers/{customerId}/instruments`\n\nDeposits in **PREVIEW** state do not create actual transaction in Paysafe Wallet system. It allows to check deposit parameters and display the fees.\n\nTo move the payment forward you must request status change using `POST /v2/customers/{customerId}/deposits/{depositId}/status`. This will perform the required validations and move the deposit in `PENDING` state. This will create a `PENDING` transaction that can be screened and executed.\n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nTo confirm the deposit for execution use `POST /v2/deposits/{id}/status`:\n \n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "deposits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Id of the customer.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentOption\": \"SKRILL\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n },\n {\n \"key\": \"SAVE_INSTRUMENT\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "776e7051-854f-407d-9b32-da808cba6e2b", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentOption\": \"SKRILL\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n },\n {\n \"key\": \"SAVE_INSTRUMENT\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"PROCESSING\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"QR_CODE\"\n },\n \"merchantRefNum\": \"\",\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"PAYMENT_CONFIRMATION\",\n \"value\": \"\"\n },\n {\n \"key\": \"SAVE_RECIPIENT\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"PREVIEW\"\n ],\n \"action\": \"NONE\",\n \"redirectUrl\": {\n \"rel\": \"REDIRECT_PAYMENT\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n \"paymentOption\": \"OFFLINE_BANK_TRANSFER\",\n \"refundable\": \"\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"QR_CODE\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYSAFECASH_BARCODE_VALUE\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYSAFECASH_BARCODE_TYPE\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d65b9861-2787-46e9-a911-1faf7c0ed121", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentOption\": \"SKRILL\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n },\n {\n \"key\": \"SAVE_INSTRUMENT\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\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" }, { "id": "4c2ff277-156b-4ecf-84e3-3a2e87e00404", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentOption\": \"SKRILL\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"MOBILE_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n },\n {\n \"key\": \"SAVE_INSTRUMENT\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5447de2c-d412-4cf0-aed3-37a09a830d27", "name": "Get Deposits", "request": { "name": "Get Deposits", "description": { "content": "You can use this API to get the deposits for the customer specified in the request path.\n\nIt returns the last 10 deposits by default.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "deposits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Funding transaction Id.", "type": "text/plain" }, "key": "fundingTransactionId", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Id of the customer.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "59934940-a300-4be8-9cd4-09eee0f9c714", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Funding transaction Id.", "type": "text/plain" }, "key": "fundingTransactionId", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Id of the customer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"deposits\": [\n {\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"REFUNDED\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"PENDING\"\n ],\n \"action\": \"NONE\",\n \"redirectUrl\": {\n \"rel\": \"REDIRECT_PAYMENT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n \"paymentOption\": \"OFFLINE_BANK_TRANSFER\",\n \"refundable\": \"\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"QR_CODE\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYSAFECASH_BARCODE_VALUE\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYSAFECASH_BARCODE_VALUE\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n {\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"REFUNDED\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"BR_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"PAYMENT_CONFIRMATION\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"FAILED\",\n \"FAILED\"\n ],\n \"action\": \"NONE\",\n \"redirectUrl\": {\n \"rel\": \"REDIRECT_PAYMENT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n \"paymentOption\": \"OFFLINE_BANK_TRANSFER\",\n \"refundable\": \"\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"QR_CODE\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\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": "285865f7-2914-4295-92f5-fe3660e980f4", "name": "Get Deposit", "request": { "name": "Get Deposit", "description": { "content": "Get specified deposit using the deposit Id. The deposit id is generated during the PREVIEW.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "depositId", "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "34507297-b4f4-4b31-bcf8-bacac7052284", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"PROCESSING\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"QR_CODE\"\n },\n \"merchantRefNum\": \"\",\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"PAYMENT_CONFIRMATION\",\n \"value\": \"\"\n },\n {\n \"key\": \"SAVE_RECIPIENT\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"PREVIEW\"\n ],\n \"action\": \"NONE\",\n \"redirectUrl\": {\n \"rel\": \"REDIRECT_PAYMENT\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n \"paymentOption\": \"OFFLINE_BANK_TRANSFER\",\n \"refundable\": \"\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"QR_CODE\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYSAFECASH_BARCODE_VALUE\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYSAFECASH_BARCODE_TYPE\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b162dfcc-5833-4727-84aa-4042c1a877e1", "name": "Process Deposit", "request": { "name": "Process Deposit", "description": { "content": "Request deposit status update.\n\nDeposits are created in `PREVIEW` state.\nDeposits in **PREVIEW** state do not create actual transaction in Paysafe Wallet system. It allows to check deposit parameters and display the fees.\n\nTo move the payment forward you must request status change using `POST /v2/customers/{customerId}/deposits/{depositId}/status`. This will perform the required validations and move the deposit in `PENDING` state.\n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nTo confirm the deposit for execution use `POST /v2/customers/{customerId}/deposits/{depositId}/status`:\n\n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "deposits", ":depositId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "depositId", "disabled": false, "description": { "content": "(Required) Deposit Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"CANCELLED\",\n \"paymentProperties\": [\n {\n \"key\": \"SAVE_RECIPIENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"paymentInstrument\": {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9ba1e2fe-b100-44fc-8324-ea433abfd759", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits", ":depositId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" }, { "disabled": false, "description": { "content": "(Required) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"CANCELLED\",\n \"paymentProperties\": [\n {\n \"key\": \"SAVE_RECIPIENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"paymentInstrument\": {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"PROCESSING\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"QR_CODE\"\n },\n \"merchantRefNum\": \"\",\n \"returnUrls\": [\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"POST\"\n },\n {\n \"rel\": \"DEFAULT\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"paymentProperties\": [\n {\n \"key\": \"PAYMENT_CONFIRMATION\",\n \"value\": \"\"\n },\n {\n \"key\": \"SAVE_RECIPIENT\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"PREVIEW\"\n ],\n \"action\": \"NONE\",\n \"redirectUrl\": {\n \"rel\": \"REDIRECT_PAYMENT\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n \"paymentOption\": \"OFFLINE_BANK_TRANSFER\",\n \"refundable\": \"\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"QR_CODE\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYSAFECASH_BARCODE_VALUE\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYSAFECASH_BARCODE_TYPE\",\n \"value\": \"\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e918b2e5-de1c-4b16-95c7-33c02e67b7d3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits", ":depositId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" }, { "disabled": false, "description": { "content": "(Required) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"CANCELLED\",\n \"paymentProperties\": [\n {\n \"key\": \"SAVE_RECIPIENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"paymentInstrument\": {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\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" }, { "id": "c9c62f09-7ae1-4430-991d-bdef65ed226c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "deposits", ":depositId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" }, { "disabled": false, "description": { "content": "(Required) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"CANCELLED\",\n \"paymentProperties\": [\n {\n \"key\": \"SAVE_RECIPIENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"paymentInstrument\": {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"UNVERIFIED\",\n \"creationTime\": \"\"\n }\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Withdrawals", "description": "Withdrawal APIs.\n", "item": [ { "id": "dd43bb28-45dd-4220-a8f9-637504b39452", "name": "Get Withdrawal Options", "request": { "name": "Get Withdrawal Options", "description": { "content": "Returns list of available withdrawal options.\n\nAdd `type` query parameter to find available `THIRDT_PARTY` withdrawal options.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Withdrawal type. (This can only be one of THIRD_PARTY,FIRST_PARTY)", "type": "text/plain" }, "key": "type", "value": "FIRST_PARTY" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9d702689-5ee5-4320-b345-a33acf23a9b4", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Withdrawal type. (This can only be one of THIRD_PARTY,FIRST_PARTY)", "type": "text/plain" }, "key": "type", "value": "FIRST_PARTY" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"paymentOption\": \"KLARNA\",\n \"type\": \"FIRST_PARTY\",\n \"instrumentTypes\": [\n \"PH_BANK_ACCOUNT\",\n \"SEPA_BANK_ACCOUNT\"\n ],\n \"paymentOptionSettings\": {\n \"paymentOption\": \"KLARNA\"\n }\n },\n {\n \"paymentOption\": \"MBWAY\",\n \"type\": \"FIRST_PARTY\",\n \"instrumentTypes\": [\n \"BR_BANK_ACCOUNT\",\n \"US_BANK_ACCOUNT\"\n ],\n \"paymentOptionSettings\": {\n \"paymentOption\": \"KLARNA\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "148ed4e9-220f-420c-bf05-fa6ed582d085", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Withdrawal type. (This can only be one of THIRD_PARTY,FIRST_PARTY)", "type": "text/plain" }, "key": "type", "value": "FIRST_PARTY" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fcdef84-bf91-4d39-85e8-dab13142e841", "name": "Create Withdrawal", "request": { "name": "Create Withdrawal", "description": { "content": "Create withdrawal for the current customer. \n\nWithdrawals are created in `PREVIEW` state.\n\nThe following parameters are required:\n\n* currency - withdrawal currency\n* amount - withdrawal amount in currency minor units\n* paymentOption - withdrawal payment option must be one of the available payment options provided by `GET /profile/withdrawals/options`\n* paymentInstrumentReference - provide reference to existing verified payment instrument provided by `GET /profile/instruments`\n* deviceInfo - should provide valide appType and profiling session id.\n\nOptional parameters:\n* merchantRefNum - should be provided by the partner if he desires to match with objects in his backend system. \n\nWithdrawals in **PREVIEW** state do not create actual transaction in Paysafe Wallet system. It allows to check withdrawal parameters and display the fees.\n\nTo move the payment forward you must request status change using `POST /profile/withdrawals/{withdrawalId}/status`. This will perform the required validations and move the withdrawal in `PENDING` state.\n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nTo confirm the withdrawal for execution use `POST /profile/withdrawals/{withdrawalId}/status`:\n\n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentOption\": \"PAYSAFECASH\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"paymentProperties\": [\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c784e856-9e35-4c94-b76c-87408b155fea", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentOption\": \"PAYSAFECASH\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"paymentProperties\": [\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"CANCELLED\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"QR_CODE\"\n },\n \"merchantRefNum\": \"\",\n \"paymentProperties\": [\n {\n \"key\": \"PAYMENT_CONFIRMATION\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARRIER\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"PROCESSING\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"EMBEDDED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentOption\": \"PAYSAFECARD\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62d4b5a8-e1bf-465c-99e7-513eb9b78535", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentOption\": \"PAYSAFECASH\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"paymentProperties\": [\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\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" }, { "id": "7cddfcb5-348c-4917-913c-e85e809e6757", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) 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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"paymentOption\": \"PAYSAFECASH\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"paymentProperties\": [\n {\n \"key\": \"PHONE_NUMBER\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06fb6781-0a13-422f-8255-202e65ec34fa", "name": "Get Withdrawals", "request": { "name": "Get Withdrawals", "description": { "content": "You can use this API to get the withdrawals for the current customer.\n\nIt returns the last 10 withdrwals by default.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "694bc3a5-c613-47cb-9713-2908e89f2a84", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"withdrawals\": [\n {\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"PENDING\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"CARD\"\n },\n \"merchantRefNum\": \"\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_CONFIRMATION\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PROCESSING\",\n \"PENDING\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentOption\": \"PAGO_EFECTIVO\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"EMAIL\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYSAFECASH_BARCODE_TYPE\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYSAFECASH_BARCODE_TYPE\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n {\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\"\n },\n \"merchantRefNum\": \"\",\n \"paymentProperties\": [\n {\n \"key\": \"SAVE_RECIPIENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"ACCEPTED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"EMBEDDED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"AUTHENTICATOR\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentOption\": \"OFFLINE_BANK_TRANSFER\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"UK_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYSAFECASH_BARCODE_TYPE\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYSAFECASH_BARCODE_VALUE\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34ea77db-350f-4d3d-ba60-73ea65cb202d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f35fec8-0f21-4c26-8814-7e9d31648631", "name": "Get Withdrawal", "request": { "name": "Get Withdrawal", "description": { "content": "Get specified withdrawal using the withdrawal Id. The withdrawal id is generated during the PREVIEW.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "withdrawalId", "disabled": false, "description": { "content": "(Required) The unique id of the withdrawal.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7e57ced3-068c-465b-8316-5dbd028bca5f", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique id of the withdrawal.", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"CANCELLED\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"QR_CODE\"\n },\n \"merchantRefNum\": \"\",\n \"paymentProperties\": [\n {\n \"key\": \"PAYMENT_CONFIRMATION\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARRIER\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"PROCESSING\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"EMBEDDED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentOption\": \"PAYSAFECARD\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "592ab8a0-96be-4f38-b542-92e5cdda4ce1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique id of the withdrawal.", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" }, { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47ecd279-1fa6-4aeb-8091-778dc483268d", "name": "Process Withdrawal", "request": { "name": "Process Withdrawal", "description": { "content": "Request withdrawal status update.\n\nWithdrawals are created in `PREVIEW` state.\nWithdrawals in **PREVIEW** state do not create actual transaction in Paysafe Wallet system. It allows to check withdrawal parameters and display the fees.\n\nTo move the payment forward you must request status change using `POST /profile/withdrawals/{withdrawalId}/status`. This will perform the required validations and move the withdrawal in `PENDING` state.\n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nTo confirm the withdrawal for execution use `POST /profile/withdrawals/{withdrawalId}/status`:\n\n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", ":withdrawalId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "withdrawalId", "disabled": false, "description": { "content": "(Required) The unique id of the withdrawal.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"PROCESSING\",\n \"paymentProperties\": [\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARRIER\",\n \"value\": \"\"\n }\n ],\n \"paymentInstrument\": {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n },\n \"recipient\": {\n \"paymentInstrument\": {\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"label\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"BUSINESS\",\n \"birthDate\": \"\"\n },\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7ccbe462-8e4e-4354-b448-e8a17a847539", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", ":withdrawalId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique id of the withdrawal.", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" }, { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"PROCESSING\",\n \"paymentProperties\": [\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARRIER\",\n \"value\": \"\"\n }\n ],\n \"paymentInstrument\": {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n },\n \"recipient\": {\n \"paymentInstrument\": {\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"label\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"BUSINESS\",\n \"birthDate\": \"\"\n },\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"status\": \"CANCELLED\",\n \"paymentInstrumentReference\": {\n \"id\": \"\",\n \"instrumentType\": \"QR_CODE\"\n },\n \"merchantRefNum\": \"\",\n \"paymentProperties\": [\n {\n \"key\": \"PAYMENT_CONFIRMATION\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARRIER\",\n \"value\": \"\"\n }\n ],\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"PROCESSING\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"EMBEDDED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentOption\": \"PAYSAFECARD\",\n \"instrumentValidationRules\": [\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n },\n {\n \"instrumentType\": \"BR_BANK_ACCOUNT\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n },\n {\n \"fieldName\": \"\",\n \"validations\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"regexp\": \"\",\n \"type\": \"REGEXP\"\n }\n ]\n }\n ]\n }\n ],\n \"paymentDetails\": [\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n },\n {\n \"key\": \"PAYMENT_RAIL\",\n \"value\": \"\"\n }\n ],\n \"type\": \"FIRST_PARTY\",\n \"description\": \"\",\n \"recipientReference\": \"\",\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eceb9fbf-d76b-4708-baa5-be64d29bf619", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", ":withdrawalId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique id of the withdrawal.", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" }, { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"PROCESSING\",\n \"paymentProperties\": [\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARRIER\",\n \"value\": \"\"\n }\n ],\n \"paymentInstrument\": {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n },\n \"recipient\": {\n \"paymentInstrument\": {\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"label\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"BUSINESS\",\n \"birthDate\": \"\"\n },\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\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" }, { "id": "199dbfc7-032c-4e50-a018-6fad1212699b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "withdrawals", ":withdrawalId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique id of the withdrawal.", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" }, { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"PROCESSING\",\n \"paymentProperties\": [\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARRIER\",\n \"value\": \"\"\n }\n ],\n \"paymentInstrument\": {\n \"instrumentType\": \"SEPA_BANK_ACCOUNT\",\n \"externallyVerified\": false,\n \"status\": \"REJECTED\",\n \"creationTime\": \"\"\n },\n \"recipient\": {\n \"paymentInstrument\": {\n \"instrumentType\": \"UK_BANK_ACCOUNT\"\n },\n \"label\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"BUSINESS\",\n \"birthDate\": \"\"\n },\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06bbbddc-a690-4e51-a8ea-0b7002845540", "name": "Get Withdrawal Reversals", "request": { "name": "Get Withdrawal Reversals", "description": { "content": "Returns withdrawal reversals for specific withdrawal.\n\nWithdrawal reversal operation supported by limited payment options, where the withdrawal is reversed and the withdrawal amount is returned back to the customer account.\nExamples:\n * ACH Return for FIRST PARTY or THIRD PARTY ACH withdrawal. \n * Bank withdrawal through LPM that is considered completed, but not actually executed by the provider.\n\nIn both cases the withdrawal was reported as completed to the customer.\nThe reversal returns the whole (or partial) amount back and keeps reference to the original withdrawal.\n\n> Withdrawal reversals are executed in cases withdrawal is rejected by the recipient payment provider.", "type": "text/plain" }, "url": { "path": [ "v2", "withdrawals", ":withdrawalId", "reversals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "withdrawalId", "disabled": false, "description": { "content": "(Required) Withdrawal Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a23b6432-640c-40d2-a5cb-1defb6cefed7", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "withdrawals", ":withdrawalId", "reversals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Withdrawal Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "withdrawalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"withdrawalReversals\": [\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"creationTime\": \"\",\n \"status\": \"PREVIEW\",\n \"paymentOption\": \"SKRILL\",\n \"merchantRefNum\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"slipId\": \"\",\n \"withdrawalId\": \"\",\n \"fundingTransactionId\": \"\",\n \"reversalTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"COMPLETED\",\n \"ACCEPTED\"\n ]\n },\n {\n \"id\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"creationTime\": \"\",\n \"status\": \"FAILED\",\n \"paymentOption\": \"PAGO_EFECTIVO\",\n \"merchantRefNum\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"slipId\": \"\",\n \"withdrawalId\": \"\",\n \"fundingTransactionId\": \"\",\n \"reversalTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"ACCEPTED\",\n \"ACCEPTED\"\n ]\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc97c5da-6dfe-4649-bad1-ec8d4954a7f6", "name": "Get Withdrawal Reversal", "request": { "name": "Get Withdrawal Reversal", "description": { "content": "Withdrawal reversal operation supported by limited payment options, where withdrawal reversed and withdrawal amount it returned back to the customer acount.\nExamples:\n * ACH Return for FIRST PARTY or THIRD PARTY ACH withdrawal. \n * Bank withdrawal through LPM that is considered completed, but not actually executed by the provider.\n\nIn both cases the withdrawal was reported as completed to the customer.\nThe reversal returns the whole (or partial) amount back and keeps reference to the original withdrawal.\n\nReturns spefic reversal by `reversalId`.", "type": "text/plain" }, "url": { "path": [ "v2", "withdrawal-reversals", ":reversalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "reversalId", "disabled": false, "description": { "content": "(Required) Reversal Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c9c0cdb9-af13-40db-af51-54030a2db635", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "withdrawal-reversals", ":reversalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Reversal Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "reversalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"creationTime\": \"\",\n \"status\": \"COMPLETED\",\n \"paymentOption\": \"RAPID_TRANSFER\",\n \"merchantRefNum\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"slipId\": \"\",\n \"withdrawalId\": \"\",\n \"fundingTransactionId\": \"\",\n \"reversalTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"FAILED\",\n \"PREVIEW\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a9bc68e-ad9a-4bb8-847f-9f01813f17b3", "name": "Get Withdrawal Recipients", "request": { "name": "Get Withdrawal Recipients", "description": { "content": "Returns list of withdrawal recipients for a customer.\n\nEach recipient has a state (ACTIVE, INACTIVE) and only ACTIVE recipients can be used for third-party withdrawals.\n\nBy default, only ACTIVE recipients are returned by the API.\n\nUse `instrumentType` to get only recipients with the specific payment instrument.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "recipients" ], "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": "Recipient status. If not specified only ACTIVE recipients are returned. (This can only be one of ACTIVE,INACTIVE)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Recipient instrument type. If not specified should return all . (This can only be one of SEPA_BANK_ACCOUNT,UK_BANK_ACCOUNT,US_BANK_ACCOUNT,CCI_BANK_ACCOUNT,PHONE_NUMBER,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "SEPA_BANK_ACCOUNT" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0e24bc24-4da4-4f84-a1bd-d6b8c2de8aae", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "recipients" ], "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": "Recipient status. If not specified only ACTIVE recipients are returned. (This can only be one of ACTIVE,INACTIVE)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Recipient instrument type. If not specified should return all . (This can only be one of SEPA_BANK_ACCOUNT,UK_BANK_ACCOUNT,US_BANK_ACCOUNT,CCI_BANK_ACCOUNT,PHONE_NUMBER,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "SEPA_BANK_ACCOUNT" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"recipients\": [\n {\n \"creationTime\": \"\",\n \"id\": \"\",\n \"paymentInstrument\": {\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"id\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"label\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"INDIVIDUAL\",\n \"birthDate\": \"\"\n },\n {\n \"creationTime\": \"\",\n \"id\": \"\",\n \"paymentInstrument\": {\n \"instrumentType\": \"QR_CODE\",\n \"id\": \"\"\n },\n \"status\": \"INACTIVE\",\n \"label\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"INDIVIDUAL\",\n \"birthDate\": \"\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f57a5d9d-9c39-4f31-a261-7a80e5bdfe15", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "recipients" ], "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": "Recipient status. If not specified only ACTIVE recipients are returned. (This can only be one of ACTIVE,INACTIVE)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Recipient instrument type. If not specified should return all . (This can only be one of SEPA_BANK_ACCOUNT,UK_BANK_ACCOUNT,US_BANK_ACCOUNT,CCI_BANK_ACCOUNT,PHONE_NUMBER,QR_CODE)", "type": "text/plain" }, "key": "instrumentType", "value": "SEPA_BANK_ACCOUNT" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70dafbf6-4a1d-4b33-87ab-2168dbf3fa25", "name": "Get Withdrawal Recipient", "request": { "name": "Get Withdrawal Recipient", "description": { "content": "Returns single third-party withdrawal recipient.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "recipients", ":recipientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "recipientId", "disabled": false, "description": { "content": "(Required) Recipient Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "65d4500c-b360-4a74-a127-898e28535c9a", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "recipients", ":recipientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Recipient Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"id\": \"\",\n \"paymentInstrument\": {\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"id\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"label\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"BUSINESS\",\n \"birthDate\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9cc3add-2f88-4270-802c-b3a8467c4eaa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "recipients", ":recipientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Recipient Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afcd308d-c5a8-4555-9c00-e70ee33615db", "name": "Deactivate Withdrawal Recipient", "request": { "name": "Deactivate Withdrawal Recipient", "description": { "content": "Deactivates recipient for future withdrawals.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "recipients", ":recipientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "recipientId", "disabled": false, "description": { "content": "(Required) Recipient Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "c2789b8a-e3ce-4790-b998-2222ecdde764", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "recipients", ":recipientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Recipient Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"id\": \"\",\n \"paymentInstrument\": {\n \"instrumentType\": \"CCI_BANK_ACCOUNT\",\n \"id\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"label\": \"\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"address\": {\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"address1\": \"\",\n \"stateProvince\": \"\",\n \"address2\": \"\"\n },\n \"contactInfo\": {\n \"mobile\": \"\",\n \"email\": \"\"\n },\n \"type\": \"BUSINESS\",\n \"birthDate\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e01a198-8268-41d2-91eb-a4a73886fe66", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "recipients", ":recipientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Recipient Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Refunds", "description": "Refund APIs.\n", "item": [ { "id": "96b7d824-095f-4a9b-a0fc-31f244a4f477", "name": "Get Refunds", "request": { "name": "Get Refunds", "description": { "content": " Returns specific refunds for given deposit.", "type": "text/plain" }, "url": { "path": [ "v2", "deposits", ":depositId", "refunds", ":refundId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "depositId", "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "refundId", "disabled": false, "description": { "content": "(Required) Refund Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c8bc21f0-49ef-4276-af7a-478d0414decc", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "deposits", ":depositId", "refunds", ":refundId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" }, { "disabled": false, "description": { "content": "(Required) Refund Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "refundId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"paymentOption\": \"MBWAY\",\n \"status\": \"PENDING\",\n \"merchantRefNum\": \"\",\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"refundTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"REFUNDED\",\n \"PENDING\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2f8d3fc-e2bc-44c9-b447-5849cb00d1bb", "name": "Create Refund", "request": { "name": "Create Refund", "description": { "content": "\n\nCreate a deposit refund request.\nNot all deposit payment options are refundable.\nRefunds are supported for the following deposit payment options:\n\n * BANK_TRANSFER\n * CARD\n\nAdditionally, a refund requires completing the deposit and completing the internal reconciliation process.\nThe **refundable** flag allows us to track if a deposit is refundable.\n\nRefund criteria:\n\n* Deposit status must be COMPLETED \n* Deposit must have **refundable** flag set to `true`.\n* One refund per deposit is allowed.\n* The wallet account funding the refund must have the required refund amount\n* Refund is only forwarded back to the instrument associated with the deposit\n* Refund amount is up to the deposit amount (partial refund is possible).\n* Refund currency is the same as the deposit currency\n\nRefunds are created in a PREVIEW state. It establishes the Refund resource and validates the refund parameters.\n\nTo move the payment forward you must request a status change using `POST /v2/deposits/{depositId}/refunds/{refundId}/status`. This will move the refund to `PENDING` state. \n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nTo confirm the refund for execution use `POST /v2/deposits/{depositId}/refunds/{refundId}/status`:\n \n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\nPoll for status or leverage webhooks to track the refund progress.\n\n> To navigate to a deposit based on `transactionId` from transaction history use `GET /v2/customers/{customerId}/deposits?fundingTransaction={transactionId}`, which returns a deposit object for a specific transaction.", "type": "text/plain" }, "url": { "path": [ "v2", "deposits", ":depositId", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "depositId", "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "52953e26-26d3-445d-b312-9bd8e61bee62", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "deposits", ":depositId", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"paymentOption\": \"MBWAY\",\n \"status\": \"PENDING\",\n \"merchantRefNum\": \"\",\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"refundTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"REFUNDED\",\n \"PENDING\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bad66bce-7b91-4168-9312-8006f73d01d7", "name": "Conflict. Various cases where the conditions for Refund are not met.", "originalRequest": { "url": { "path": [ "v2", "deposits", ":depositId", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae14a4bd-606a-42aa-a57c-b86f4390142c", "name": "Get Refunds", "request": { "name": "Get Refunds", "description": { "content": " Returns all refunds for the given deposit.", "type": "text/plain" }, "url": { "path": [ "v2", "deposits", ":depositId", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "depositId", "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b1fe70dc-e82c-461c-80a9-a6e81e153e01", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "deposits", ":depositId", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"refunds\": [\n {\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"paymentOption\": \"RAPID_TRANSFER\",\n \"status\": \"PROCESSING\",\n \"merchantRefNum\": \"\",\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"refundTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"COMPLETED\",\n \"SCHEDULED\"\n ]\n },\n {\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"paymentOption\": \"OFFLINE_BANK_TRANSFER\",\n \"status\": \"SCHEDULED\",\n \"merchantRefNum\": \"\",\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"refundTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"SCHEDULED\",\n \"PREVIEW\"\n ]\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "255cd0a2-770e-4076-8aeb-cfa9a3ba7035", "name": "Process Refund", "request": { "name": "Process Refund", "description": { "content": "\n\nRefunds are created in PREVIEW state. It creates the Refund resource and validates the refund parameters.\n\nTo move the payment forward you must request status change using `POST /v2/deposits/{depositId}/refunds/{refundId}/status`. This will move the refund in `PENDING` state. \n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nTo confirm the refund for execution use `POST /v2/deposits/{depositId}/refunds/{refundId}/status`:\n \n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\n\nPoll for status or leverage webhooks for track the refund progress.\n", "type": "text/plain" }, "url": { "path": [ "v2", "deposits", ":depositId", "refunds", ":refundId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "depositId", "disabled": false, "description": { "content": "(Required) Deposit Id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "refundId", "disabled": false, "description": { "content": "(Required) Refund Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"PROCESSING\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "971daf1b-6f74-4fee-99cf-6f86cfe80a1e", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "deposits", ":depositId", "refunds", ":refundId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" }, { "disabled": false, "description": { "content": "(Required) Refund Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "refundId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"PROCESSING\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"\",\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"customerId\": \"\",\n \"id\": \"\",\n \"paymentOption\": \"MBWAY\",\n \"status\": \"PENDING\",\n \"merchantRefNum\": \"\",\n \"slipId\": \"\",\n \"fundingTransactionId\": \"\",\n \"refundTransactionId\": \"\",\n \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"nextStatus\": [\n \"REFUNDED\",\n \"PENDING\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "748789db-ccc3-4d35-99d9-773175698d94", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "deposits", ":depositId", "refunds", ":refundId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Deposit Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "depositId" }, { "disabled": false, "description": { "content": "(Required) Refund Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "refundId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"PROCESSING\"\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 } } ] }, { "name": "Transfers", "description": "Internal Transfer of Funds.\n", "item": [ { "id": "d92925ef-4094-4a66-bc75-703b9a5bb8ad", "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.\nIt allows peer to peer transfer to another wallet user.\nTransfer requires the following parameters:\n\n * `amount` - the amount in minor units\n * `currencyCode` - currency of the amount\n * `email` or `customerId` of the recipient\n * `deviceInfo` - device profiling information\n\nFor successful transfer the following conditions must be met:\n * Customer should have enough balance in the requested currency\n * Recipient customer must exist in the system and must not be restricted\n \n## Transfer Execution\n\nTransfer is created in `PREVIEW` state, which can be used to determine the recipient and FX amount (if applicable).\n\nTo move forward the execution you should usе the `POST /v2/customers/{customerId}/transfers/{transferId}/status` to prepare the transfer for execution.\n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nThis will create a `PENDING` transaction and associate it with the transfer. All limits and other checks will be performed.\n\nTo confirm the transfer for execution `POST /v2/customers/{customerId}/transfers/{transferId}/status`:\n \n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\n\nThe transfers are executed asynchronously. Check the transfer status for details.\n\n## Using transfers for local currency exchange\n\nIf customer want to exchange currency between his accounts, he must provide FX Quote parameter and skip the recipient parameter.\n\nThe following conditions must be met:\n* have account in the `targetCurrency` of the FX Quote\n* enough balance in the `sourceCurrency` \n\n## Merchant Fee collection\n\nA fee can be collected by the merchant for each successful transfer. \nFees are collected in a preconfigured merchant fee collection account in the corresponding fee currency.\n\n### The recipient merchant account for the fees can be determined using one of the following approaches:\n\n- **Fee in the Same Currency as the Main Transfer**\nThe fee is transferred to the merchant account in the same currency as `currencyCode`.\nBoth `recipientCurrency` and `merchantAccountId` parameters must be omitted.\n\n- **Fee in a Specified Currency**\nThe fee is transferred to the merchant account in the currency defined by the `recipientCurrency` parameter.\nIf `currencyCode` is different, currency conversion will be applied.\n**Use Case:** Suitable for merchants who want to consolidate funds in a specific currency, avoiding segmentation across multiple accounts.\n\n- **Fee in a Specified Account**\nThe fee is transferred to a specific merchant account identified by the `merchantAccountId` parameter.\n**Use Case:** Suitable for merchants who have multiple accounts in the same currency and `recipientCurrency` cannot uniquely identify the desired recipient account.\n\n\nSupported fee payment reasons are `SENDER_FEE` and `RECIPIENT_FEE`.\n|`SENDER_FEE` |`RECIPIENT_FEE` |\n|-------------------------------------------------|--------------------------------------|\n|Fee amount is added on top of the request amount.| Fee is deducted from request amount. |\n|Sender is charged. | Recipient is charged. |\n\n## Discounts\n\nDiscounts represent discount contributions to the funds transferred to a wallet recipient. These contributions can be for example from Loyalty Points, Voucher, etc.\nThey include a redemption part which indicates whether the downstream business domain is responsible for debiting the customer's loyalty rewards.\n\n### The discount sender can be determined by:\n- **customerId**\nDiscount will be sent from the same customer currency account as the discount currency.\n- **accountId**\nDiscount will be sent from the specified customer account.\n- **currency**\nDiscount will be sent from the customer account in the specified currency. If the discount currency is different, a conversion will be applied.\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Wallet customer identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"transferDetails\": {\n \"reason\": \"CHEQUE_WITHDRAWAL\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1958092976154614475629\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bac78033-d482-4317-8748-7446577c2226", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Wallet customer identifier.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"transferDetails\": {\n \"reason\": \"CHEQUE_WITHDRAWAL\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1958092976154614475629\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"SCHEDULED\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+332974539\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7291 966\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"COMPLETED\",\n \"COMPLETED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f795672-f7b7-4c87-969b-5b7671f47b32", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Wallet customer identifier.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"transferDetails\": {\n \"reason\": \"CHEQUE_WITHDRAWAL\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1958092976154614475629\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\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" }, { "id": "5e08cdfc-424b-4b80-9a0e-5c2f0bb19cb4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Wallet customer identifier.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"transferDetails\": {\n \"reason\": \"CHEQUE_WITHDRAWAL\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1958092976154614475629\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "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": "9535795e-0358-4416-b6f5-3ecf04fef8d0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Wallet customer identifier.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"transferDetails\": {\n \"reason\": \"CHEQUE_WITHDRAWAL\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1958092976154614475629\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"API\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"currency\": \"\"\n },\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ],\n \"fees\": [\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n },\n {\n \"amount\": 0,\n \"paymentReason\": \"OTHER_FEE\",\n \"currency\": \"\",\n \"merchantId\": \"\",\n \"recipientCurrency\": \"\",\n \"merchantAccountId\": \"\"\n }\n ]\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa935ab1-1fe2-4da1-a60b-a0a11367528c", "name": "Get Outbound Transfers", "request": { "name": "Get Outbound Transfers", "description": { "content": "You can use this API to get the outbound transfers for the given customer.\nIt returns the last 10 transfers by default.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Wallet customer identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1f8d8b60-5a8e-4f27-a0ba-44eb3f3e514f", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Wallet customer identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"PREVIEW\",\n \"transferDetails\": {\n \"reason\": \"INACTIVITY_FEE\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+64654 50760599124187\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+571 924325837\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"PROCESSING\",\n \"ACCEPTED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"OUTSOURCED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"PUSH_NOTIFICATION\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n },\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"REFUNDED\",\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+77545641\\f84793078407\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+75897911065664\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"REFUNDED\",\n \"ACCEPTED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"EMBEDDED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"OTP\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\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": "9d9b05bc-6137-4929-b6e1-f856f9af1d71", "name": "Creates fee transfer", "request": { "name": "Creates fee transfer", "description": { "content": "## Introduction\n\nA fee transfer is special kind of transfer that is used to standalone fees that are not attached to particular transaction.\nYou can't add fees to those transfers and you can't use this endpoint for creating currency exchange transfers.\nFee transfer will result in transaction with STANDALONE_FEE type\nFollowing parameters are required.\n * `amount` - the amount in minor units\n * `currencyCode` - currency of the amount\n * `email` or `customerId` of the recipient\n * `transferReason` - reason for transfer\n\nFor successful transfer the following conditions must be met:\n * Customer should have enough balance in the requested currency and must not be restricted for outgoing transactions\n * Recipient customer must exist in the system and must not be restricted\n\n## Fee Transfer Execution\n\nFee transfers must be created using this endpoint and processed with other endpoint.\nTransfer is created in `PREVIEW` state.\n\nTo move forward the execution you should usе the `POST /v2/customers/{customerId}/transfers/{transferId}/status` .\n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nThis will create a `PENDING` transaction and associate it with the transfer.\n\nTo confirm the transfer for execution `POST /v2/customers/{customerId}/transfers/{transferId}/status`:\n\n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "transfers", "fees" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+47409585 625604953215990\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5b576fee-cf3b-440b-ab09-6b61fd921cf9", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers", "fees" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+47409585 625604953215990\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\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 \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"SCHEDULED\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+332974539\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7291 966\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"COMPLETED\",\n \"COMPLETED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b98d770-b293-4d98-b973-b2bc35dcce75", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers", "fees" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+47409585 625604953215990\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\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" }, { "id": "b1b04b51-51d7-47f2-8aa4-38bd389bf1a9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers", "fees" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+47409585 625604953215990\"\n },\n \"merchantRefNum\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\",\n \"customerIp\": \"\"\n },\n \"fxQuote\": \"\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\n \"description\": \"\"\n }\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a132749b-433e-429e-a358-e473c06f8e21", "name": "Get Outbound Transfer", "request": { "name": "Get Outbound Transfer", "description": { "content": "Get specified outbound transfer using the transfer Id. The transfer id is generated during the PREVIEW.\nYou can use this API to get the transfer progress.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transferId", "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "439f3aac-e435-4493-bfd3-c7ec40930658", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" }, "type": "any", "value": "", "key": "transferId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"SCHEDULED\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+332974539\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7291 966\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"COMPLETED\",\n \"COMPLETED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be093c31-f29d-450a-b923-bc10b83fe40e", "name": "Process Transfer", "request": { "name": "Process Transfer", "description": { "content": "Request transfer state update.\n\nTransfer is created in `PREVIEW` state, which can be used to determine the recipient and FX amount (if applicable).\n\nTo move forward the execution you should usе the `POST /v2/customers/{customerId}/transfers/{transferId}/status` to prepare the transfer for execution.\n\n```json\n{\n \"status\": \"PENDING\"\n}\n```\n\nThis will create a `PENDING` transaction and associate it with the transfer. All limits and other checks will be performed.\n\nTo confirm the transfer for execution `POST /v2/customers/{customerId}/transfers/{transferId}/status`:\n\n```json\n{\n \"status\": \"PROCESSING\"\n}\n```\n\nThe transfers are executed asynchronously. Check the transfer status for details.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "transfers", ":transferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transferId", "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"SCHEDULED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7dbc06b5-65c4-4ce6-afeb-8962759a23d6", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers", ":transferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" }, "type": "any", "value": "", "key": "transferId" }, { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"SCHEDULED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"SCHEDULED\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+332974539\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7291 966\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"COMPLETED\",\n \"COMPLETED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50d69ae3-659e-44c3-a2e8-271d387e7668", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "transfers", ":transferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" }, "type": "any", "value": "", "key": "transferId" }, { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"SCHEDULED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n },\n {\n \"key\": \"CARD_CVV\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\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": "89235788-5de9-42e7-9ca5-1d9b65b265bb", "name": "Get Inbound Transfers", "request": { "name": "Get Inbound Transfers", "description": { "content": "You can use this API to get the inbound transfers for the given customer.\nIt returns the last 10 transfers by default.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "inbound-transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "52b23a4e-09dd-45c7-826a-40f281c1e22c", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "inbound-transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"PREVIEW\",\n \"transferDetails\": {\n \"reason\": \"INACTIVITY_FEE\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+64654 50760599124187\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+571 924325837\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"PROCESSING\",\n \"ACCEPTED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"OUTSOURCED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"PUSH_NOTIFICATION\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n },\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"REFUNDED\",\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+77545641\\f84793078407\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+75897911065664\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"REFUNDED\",\n \"ACCEPTED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"EMBEDDED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"OTP\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\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": "3a9368da-3cb4-4604-ae21-424b9ca145b2", "name": "Get Inbound Transfer", "request": { "name": "Get Inbound Transfer", "description": { "content": "Get specified inbound transfer using the transfer Id.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "inbound-transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transferId", "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "021f10a0-bef4-476c-8406-2d3383173570", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "inbound-transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" }, "type": "any", "value": "", "key": "transferId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"SCHEDULED\",\n \"transferDetails\": {\n \"reason\": \"DISPUTE_FEE\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+332974539\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7291 966\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"COMPLETED\",\n \"COMPLETED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ab6c36-d5c6-4b79-93e4-3bb442cb8788", "name": "Not Found.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "inbound-transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transfer id.", "type": "text/plain" }, "type": "any", "value": "", "key": "transferId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "8dc1c446-96af-4b92-841e-0d541b7c5c7e", "name": "Create Batch Transfer", "request": { "name": "Create Batch Transfer", "description": { "content": "Create batch transfer. Common fields (merchantRefNum, currencyCode, transferDetails, deviceInfo) apply to the batch; each item in `transfers` specifies amount and recipient.\nPer-item `currencyCode` may be omitted when it matches the batch-level `currencyCode`.\nMaximum allowed transfer items in the request body is 20. Maximum allowed transfer items in a batch is 100.\nTransfers in the batch can be added later using `POST /v2/customers/{customerId}/batch-transfers/{batchTransferId}/transfers` API.\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) The customer ID (sender) for all transfers in the batch.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56731654817639586348\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+082509\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6451077109 80601683416\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+453708\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+63317584495836155460572\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+5878851995 7398584224541498\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+293320668825\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+975100　9910386253811\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9147 19444848\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+982359830637\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+304293\\r6054248931580\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+93492589786　137016010021873\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+13204315495779600\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+61754401565 4503189632569018\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+39\\t61293471\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8143122158\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8102940 80\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+967297734146\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+778 5254576354546436\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7263531469516\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ],\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "03ff8198-3aba-42bf-96f5-fa7b4f481289", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for all transfers in the batch.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56731654817639586348\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+082509\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6451077109 80601683416\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+453708\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+63317584495836155460572\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+5878851995 7398584224541498\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+293320668825\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+975100　9910386253811\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9147 19444848\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+982359830637\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+304293\\r6054248931580\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+93492589786　137016010021873\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+13204315495779600\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+61754401565 4503189632569018\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+39\\t61293471\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8143122158\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8102940 80\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+967297734146\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+778 5254576354546436\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7263531469516\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ],\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"status\": \"REFUNDED\",\n \"summary\": {\n \"statuses\": {\n \"PREVIEW\": \"\",\n \"PENDING\": \"\",\n \"PROCESSING\": \"\",\n \"COMPLETED\": \"\",\n \"FAILED\": \"\",\n \"SCHEDULED\": \"\",\n \"ACCEPTED\": \"\",\n \"CANCELLED\": \"\",\n \"REFUNDED\": \"\"\n },\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 \"amounts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n ]\n },\n \"transferDetails\": {\n \"reason\": \"BONUS\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"PROCESSING\",\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0717 8248239834621\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+38
4017407281984964\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"FAILED\",\n \"ACCEPTED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"CANCELLED\",\n \"transferDetails\": {\n \"reason\": \"CRYPTO_BUY\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+37021᠎6729\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+524487245218595363697220\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"CANCELLED\",\n \"SCHEDULED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"OUTSOURCED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n }\n }\n ],\n \"updatedTime\": \"\",\n \"merchantRefNum\": \"\",\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"PUSH_NOTIFICATION\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PIN\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"nextStatus\": [\n \"FAILED\",\n \"REFUNDED\"\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13bfb12-d322-491d-9769-54d57d3978db", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for all transfers in the batch.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56731654817639586348\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+082509\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6451077109 80601683416\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+453708\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+63317584495836155460572\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+5878851995 7398584224541498\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+293320668825\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+975100　9910386253811\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9147 19444848\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+982359830637\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+304293\\r6054248931580\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+93492589786　137016010021873\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+13204315495779600\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+61754401565 4503189632569018\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+39\\t61293471\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8143122158\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8102940 80\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+967297734146\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+778 5254576354546436\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7263531469516\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ],\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"fieldErrors\": [\n {\n \"field\": \"\",\n \"error\": \"\"\n },\n {\n \"field\": \"\",\n \"error\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b29bd935-b2a3-493e-a119-830b9b5afd52", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for all transfers in the batch.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56731654817639586348\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+082509\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6451077109 80601683416\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+453708\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+63317584495836155460572\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+5878851995 7398584224541498\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+293320668825\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+975100　9910386253811\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9147 19444848\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+982359830637\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+304293\\r6054248931580\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+93492589786　137016010021873\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+13204315495779600\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+61754401565 4503189632569018\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+39\\t61293471\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8143122158\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8102940 80\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+967297734146\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+778 5254576354546436\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7263531469516\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ],\n \"merchantRefNum\": \"\"\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": "e8b18d25-2cff-4c57-b7b9-8dd76956544d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for all transfers in the batch.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56731654817639586348\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+082509\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6451077109 80601683416\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+453708\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+63317584495836155460572\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+5878851995 7398584224541498\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+293320668825\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+975100　9910386253811\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9147 19444848\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+982359830637\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+304293\\r6054248931580\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+93492589786　137016010021873\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+13204315495779600\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+61754401565 4503189632569018\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+39\\t61293471\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8143122158\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8102940 80\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+967297734146\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+778 5254576354546436\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7263531469516\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ],\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "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": "0134584a-c9ed-4c08-b0a8-4d0dc66d00ca", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for all transfers in the batch.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56731654817639586348\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+082509\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6451077109 80601683416\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+453708\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+63317584495836155460572\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+5878851995 7398584224541498\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+293320668825\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+975100　9910386253811\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9147 19444848\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+982359830637\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+304293\\r6054248931580\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+93492589786　137016010021873\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+13204315495779600\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+61754401565 4503189632569018\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+39\\t61293471\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8143122158\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8102940 80\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+967297734146\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+778 5254576354546436\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7263531469516\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ],\n \"merchantRefNum\": \"\"\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": "a9ef4396-78b2-4a81-a764-7b1574c633a5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for all transfers in the batch.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56731654817639586348\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+082509\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6451077109 80601683416\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+453708\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+63317584495836155460572\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+5878851995 7398584224541498\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+293320668825\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+975100　9910386253811\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9147 19444848\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+982359830637\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+304293\\r6054248931580\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+93492589786　137016010021873\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+13204315495779600\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+61754401565 4503189632569018\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+39\\t61293471\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8143122158\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8102940 80\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+967297734146\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+778 5254576354546436\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7263531469516\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ],\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"fieldErrors\": [\n {\n \"field\": \"\",\n \"error\": \"\"\n },\n {\n \"field\": \"\",\n \"error\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb05bfa5-bbb9-47e5-ab84-90908b76918e", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for all transfers in the batch.", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"\",\n \"deviceInfo\": {\n \"appType\": \"WEB_APP\",\n \"threatMetrixSessionId\": \"\",\n \"deviceId\": \"\"\n },\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56731654817639586348\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+082509\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6451077109 80601683416\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+453708\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+63317584495836155460572\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+5878851995 7398584224541498\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+293320668825\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+975100　9910386253811\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9147 19444848\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+982359830637\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+304293\\r6054248931580\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+93492589786　137016010021873\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+13204315495779600\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+61754401565 4503189632569018\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+39\\t61293471\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8143122158\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8102940 80\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+967297734146\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+778 5254576354546436\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7263531469516\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ],\n \"merchantRefNum\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"fieldErrors\": [\n {\n \"field\": \"\",\n \"error\": \"\"\n },\n {\n \"field\": \"\",\n \"error\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a272ec9-eed3-4fdc-b3af-655c1a0df421", "name": "Get Batch Transfers", "request": { "name": "Get Batch Transfers", "description": { "content": "Returns a paginated list of batch transfers for the customer. Results can be filtered by date range and status.\nEntries do not include `transfers` array while `summary` still reflects all transfers in that batch; use `GET /v2/customers/{customerId}/batch-transfers/{batchTransferId}` for the full transfer list.\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "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 by creation time (inclusive).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Upper bound on batch `creationTime`, inclusive: only batches with `creationTime <= endDate` are returned.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfers.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6b18793f-fca4-49c6-b9ab-b1f560a009ab", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "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 by creation time (inclusive).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Upper bound on batch `creationTime`, inclusive: only batches with `creationTime <= endDate` are returned.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfers.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"batch-transfers\": [\n {\n \"id\": \"\",\n \"creationTime\": \"\",\n \"updatedTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"COMPLETED\",\n \"summary\": {\n \"statuses\": {\n \"PREVIEW\": \"\",\n \"PENDING\": \"\",\n \"PROCESSING\": \"\",\n \"COMPLETED\": \"\",\n \"FAILED\": \"\",\n \"SCHEDULED\": \"\",\n \"ACCEPTED\": \"\",\n \"CANCELLED\": \"\",\n \"REFUNDED\": \"\"\n },\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 \"amounts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n ]\n },\n \"transferDetails\": {\n \"reason\": \"REFUND\",\n \"description\": \"\"\n },\n \"merchantRefNum\": \"\",\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"EMBEDDED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"nextStatus\": [\n \"PREVIEW\",\n \"SCHEDULED\"\n ]\n },\n {\n \"id\": \"\",\n \"creationTime\": \"\",\n \"updatedTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"SCHEDULED\",\n \"summary\": {\n \"statuses\": {\n \"PREVIEW\": \"\",\n \"PENDING\": \"\",\n \"PROCESSING\": \"\",\n \"COMPLETED\": \"\",\n \"FAILED\": \"\",\n \"SCHEDULED\": \"\",\n \"ACCEPTED\": \"\",\n \"CANCELLED\": \"\",\n \"REFUNDED\": \"\"\n },\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 \"amounts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n ]\n },\n \"transferDetails\": {\n \"reason\": \"CURRENCY_EXCHANGE\",\n \"description\": \"\"\n },\n \"merchantRefNum\": \"\",\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"OTP\",\n \"channel\": \"AUTHENTICATOR\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"nextStatus\": [\n \"SCHEDULED\",\n \"ACCEPTED\"\n ]\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bf2f3f4-dcf8-44be-967f-978186449bbd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "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 by creation time (inclusive).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Upper bound on batch `creationTime`, inclusive: only batches with `creationTime <= endDate` are returned.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfers.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "ef76cb59-3695-446d-9381-2c12bb346189", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "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 by creation time (inclusive).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Upper bound on batch `creationTime`, inclusive: only batches with `creationTime <= endDate` are returned.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfers.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "da9a211f-8ba4-48ca-b770-3946036b8150", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "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 by creation time (inclusive).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Upper bound on batch `creationTime`, inclusive: only batches with `creationTime <= endDate` are returned.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfers.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "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": "10ae146c-fbdb-4073-acef-cca17d8c9996", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "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 by creation time (inclusive).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Upper bound on batch `creationTime`, inclusive: only batches with `creationTime <= endDate` are returned.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfers.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "b9943372-2776-4c84-b784-3ce0dd2d2e57", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "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 by creation time (inclusive).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Upper bound on batch `creationTime`, inclusive: only batches with `creationTime <= endDate` are returned.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfers.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "65df8a41-e838-44d7-9ae6-5ca30b27adbe", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers" ], "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 by creation time (inclusive).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Upper bound on batch `creationTime`, inclusive: only batches with `creationTime <= endDate` are returned.", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfers.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "3f840e48-89f4-46b3-8004-517fd3917852", "name": "Get Batch Transfer", "request": { "name": "Get Batch Transfer", "description": { "content": "Retrieves a single batch transfer by ID for the given customer. Response includes a paginated list of transfers in the batch.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId" ], "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) The customer ID (sender) for the batch transfer.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "batchTransferId", "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "46925dd7-5d2e-46aa-b300-3e1d97768a6b", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId" ], "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) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"status\": \"REFUNDED\",\n \"summary\": {\n \"statuses\": {\n \"PREVIEW\": \"\",\n \"PENDING\": \"\",\n \"PROCESSING\": \"\",\n \"COMPLETED\": \"\",\n \"FAILED\": \"\",\n \"SCHEDULED\": \"\",\n \"ACCEPTED\": \"\",\n \"CANCELLED\": \"\",\n \"REFUNDED\": \"\"\n },\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 \"amounts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n ]\n },\n \"transferDetails\": {\n \"reason\": \"BONUS\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"PROCESSING\",\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0717 8248239834621\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+38
4017407281984964\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"FAILED\",\n \"ACCEPTED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"CANCELLED\",\n \"transferDetails\": {\n \"reason\": \"CRYPTO_BUY\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+37021᠎6729\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+524487245218595363697220\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"CANCELLED\",\n \"SCHEDULED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"OUTSOURCED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n }\n }\n ],\n \"updatedTime\": \"\",\n \"merchantRefNum\": \"\",\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"PUSH_NOTIFICATION\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PIN\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"nextStatus\": [\n \"FAILED\",\n \"REFUNDED\"\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b04b9fa-0a2f-4117-afef-f1995685373b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId" ], "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) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "3c43434f-0fbd-4680-bb66-1d5ba9248724", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId" ], "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) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "27f13323-5550-4ce0-8a88-da85163598e8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId" ], "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) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "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": "2be4d32c-f99f-4ded-bde4-7b88657ca1ab", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId" ], "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) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "9a2c5ebb-8e8e-41be-892e-0e6eb402734f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId" ], "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) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "d7ae4b3a-7bef-41a3-a16c-cafaee1b8000", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId" ], "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) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "42b6842c-b0e1-469e-b653-97b27979ed3f", "name": "Add Batch Transfers", "request": { "name": "Add Batch Transfers", "description": { "content": "Add or replace transfers in an existing batch. Accepts either JSON or CSV.\n**JSON**: Request body contains a list of transfers (amount, recipient; optional `currencyCode` when it matches the batch currency, optional `merchantRefNum` per item).\nTransfers without a matching `merchantRefNum` are added to the batch. When a transfer item includes `merchantRefNum` that matches an existing transfer in the batch, that existing transfer is replaced.\n**CSV**: Request body is UTF-8 CSV with header row `type,recipient,amount,currency,reference,reason,description`. Recipient `type` is `email` or `mobile`; `recipient` is the email or phone number; `reference`, `reason`, and `description` are optional.\nMaximum count of transfer items in request body is 20.\nResponse is the BatchTransfer structure updated with the added or replaced transfers. To get full list of transfers in the batch use `GET /v2/customers/{customerId}/batch-transfers/{batchTransferId}`\nBatch Transfer can be updated only if it is in PREVIEW status and is not expired.\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "batchTransferId", "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1188261022257\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+391 6\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7᠎173769\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6052640476434635363862\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56218 8796425757242\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6043317458\\t94\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0940713 9509031708505129\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8070373281446754241936\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+65642045621983832173\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6881195\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1023099 522\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+837380882055919845666\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+05040659452 04189468\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+66 88327639550368\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+21042\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+06884680\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+659574 06280925210\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1887015742969\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+72248621096277042431\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9840409\\r36391486929\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3f3e7e66-a23d-413f-9686-0e48cb06fd15", "name": "OK. Returns the BatchTransfer updated with the added or replaced transfers.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1188261022257\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+391 6\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7᠎173769\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6052640476434635363862\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56218 8796425757242\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6043317458\\t94\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0940713 9509031708505129\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8070373281446754241936\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+65642045621983832173\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6881195\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1023099 522\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+837380882055919845666\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+05040659452 04189468\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+66 88327639550368\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+21042\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+06884680\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+659574 06280925210\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1887015742969\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+72248621096277042431\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9840409\\r36391486929\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"id\": \"\",\n \"status\": \"REFUNDED\",\n \"summary\": {\n \"statuses\": {\n \"PREVIEW\": \"\",\n \"PENDING\": \"\",\n \"PROCESSING\": \"\",\n \"COMPLETED\": \"\",\n \"FAILED\": \"\",\n \"SCHEDULED\": \"\",\n \"ACCEPTED\": \"\",\n \"CANCELLED\": \"\",\n \"REFUNDED\": \"\"\n },\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 \"amounts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n ]\n },\n \"transferDetails\": {\n \"reason\": \"BONUS\",\n \"description\": \"\"\n },\n \"transfers\": [\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"PROCESSING\",\n \"transferDetails\": {\n \"reason\": \"TRADING_PAIR\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0717 8248239834621\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+38
4017407281984964\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"FAILED\",\n \"ACCEPTED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"creationTime\": \"\",\n \"currencyCode\": \"\",\n \"id\": \"\",\n \"status\": \"CANCELLED\",\n \"transferDetails\": {\n \"reason\": \"CRYPTO_BUY\",\n \"description\": \"\"\n },\n \"recipient\": {\n \"customerId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+37021᠎6729\"\n },\n \"merchantRefNum\": \"\",\n \"fxQuote\": \"\",\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 \"expirationTime\": \"\",\n \"statusReason\": \"\",\n \"sender\": {\n \"customerId\": \"\",\n \"accountId\": \"\",\n \"fullName\": \"\",\n \"email\": \"\",\n \"mobile\": \"+524487245218595363697220\"\n },\n \"slipId\": \"\",\n \"fxAmount\": {\n \"amount\": \"\",\n \"rate\": \"\",\n \"currency\": \"\"\n },\n \"nextStatus\": [\n \"CANCELLED\",\n \"SCHEDULED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"OUTSOURCED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n }\n }\n ],\n \"updatedTime\": \"\",\n \"merchantRefNum\": \"\",\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PIN\",\n \"channel\": \"PUSH_NOTIFICATION\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PIN\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"nextStatus\": [\n \"FAILED\",\n \"REFUNDED\"\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1731668e-80f7-4608-9573-b53e0cdbe7df", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1188261022257\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+391 6\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7᠎173769\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6052640476434635363862\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56218 8796425757242\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6043317458\\t94\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0940713 9509031708505129\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8070373281446754241936\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+65642045621983832173\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6881195\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1023099 522\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+837380882055919845666\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+05040659452 04189468\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+66 88327639550368\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+21042\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+06884680\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+659574 06280925210\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1887015742969\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+72248621096277042431\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9840409\\r36391486929\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\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" }, { "id": "f515fae0-ee4b-48a8-8829-ff7c9ab4acd6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1188261022257\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+391 6\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7᠎173769\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6052640476434635363862\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56218 8796425757242\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6043317458\\t94\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0940713 9509031708505129\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8070373281446754241936\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+65642045621983832173\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6881195\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1023099 522\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+837380882055919845666\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+05040659452 04189468\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+66 88327639550368\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+21042\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+06884680\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+659574 06280925210\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1887015742969\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+72248621096277042431\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9840409\\r36391486929\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ]\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": "80c95b5e-b3d5-454e-a59d-43d53a49191e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1188261022257\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+391 6\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7᠎173769\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6052640476434635363862\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56218 8796425757242\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6043317458\\t94\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0940713 9509031708505129\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8070373281446754241936\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+65642045621983832173\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6881195\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1023099 522\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+837380882055919845666\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+05040659452 04189468\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+66 88327639550368\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+21042\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+06884680\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+659574 06280925210\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1887015742969\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+72248621096277042431\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9840409\\r36391486929\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "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": "0ed142ff-9294-4d4e-92d7-89add1459189", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1188261022257\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+391 6\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7᠎173769\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6052640476434635363862\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56218 8796425757242\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6043317458\\t94\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0940713 9509031708505129\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8070373281446754241936\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+65642045621983832173\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6881195\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1023099 522\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+837380882055919845666\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+05040659452 04189468\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+66 88327639550368\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+21042\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+06884680\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+659574 06280925210\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1887015742969\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+72248621096277042431\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9840409\\r36391486929\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ]\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": "64d6be37-0af0-4454-b609-a51171620671", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1188261022257\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+391 6\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7᠎173769\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6052640476434635363862\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56218 8796425757242\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6043317458\\t94\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0940713 9509031708505129\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8070373281446754241936\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+65642045621983832173\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6881195\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1023099 522\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+837380882055919845666\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+05040659452 04189468\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+66 88327639550368\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+21042\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+06884680\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+659574 06280925210\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1887015742969\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+72248621096277042431\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9840409\\r36391486929\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ]\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": "500f51fc-0e3b-4dea-97c5-26b93040d6d4", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transfers\": [\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1188261022257\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+391 6\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+7᠎173769\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6052640476434635363862\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+56218 8796425757242\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6043317458\\t94\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+0940713 9509031708505129\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+8070373281446754241936\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+65642045621983832173\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+6881195\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1023099 522\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+837380882055919845666\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+05040659452 04189468\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+66 88327639550368\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+21042\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+06884680\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+659574 06280925210\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+1887015742969\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+72248621096277042431\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n },\n {\n \"amount\": \"\",\n \"recipient\": {\n \"customerId\": \"\",\n \"email\": \"\",\n \"mobile\": \"+9840409\\r36391486929\"\n },\n \"currencyCode\": \"\",\n \"merchantRefNum\": \"\"\n }\n ]\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": "de3d7ba0-8590-4e2d-b303-1fdcaa320cc4", "name": "Update Batch Transfer Status", "request": { "name": "Update Batch Transfer Status", "description": { "content": "Updates the status of a batch transfer. To prepare the batch for execution you should use `POST /v2/customers/{customerId}/batch-transfers/{batchTransferId}/status`\n\n```json\n{\n\"status\": \"PENDING\"\n}\n```\n\nThis will update the status of the batch to `PENDING` and you won't be able to modify the transfers in the batch anymore. All balance checks will be performed.\n\nTo confirm the batch for execution `POST /v2/customers/{customerId}/batch-transfers/{batchTransferId}/status`:\n\n```json\n{\n\"status\": \"PROCESSING\"\n}\n```\n\nRequest is accepted asynchronously; response is 202 Accepted with the BatchTransfer.\nTo check the batch status and details use `GET /v2/customers/{customerId}/batch-transfers/{batchTransferId}`.\n\nMoving the batch to `PROCESSING` may require Strong Customer Authentication (SCA). When the 202 response body has `action: SCA`, complete SCA using your existing outsourced SCA flow, then call this endpoint again with `status: PROCESSING` and `scaDetails` containing the `eventId` and `walletOperationId` returned in that response.\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "batchTransferId", "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5b6da0af-b78b-462e-9be0-d927e6ac81a8", "name": "Accepted. Returns the BatchTransfer with the updated status.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"creationTime\": \"\",\n \"updatedTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"SCHEDULED\",\n \"summary\": {\n \"statuses\": {\n \"PREVIEW\": \"\",\n \"PENDING\": \"\",\n \"PROCESSING\": \"\",\n \"COMPLETED\": \"\",\n \"FAILED\": \"\",\n \"SCHEDULED\": \"\",\n \"ACCEPTED\": \"\",\n \"CANCELLED\": \"\",\n \"REFUNDED\": \"\"\n },\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 \"amounts\": [\n {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n ]\n },\n \"transferDetails\": {\n \"reason\": \"WITHDRAWAL\",\n \"description\": \"\"\n },\n \"merchantRefNum\": \"\",\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"PUSH_NOTIFICATION\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"nextStatus\": [\n \"REFUNDED\",\n \"COMPLETED\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "256a577a-adcb-41a8-88fd-ea0f14d266fd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\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" }, { "id": "bfca4235-1036-475b-b8d0-902bf10e1a76", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\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": "2082c0dd-0997-4e1b-a128-8b708d27452d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "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": "09e5cd74-08a0-4f7e-8574-eb9d733bc98d", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\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": "9fe484b5-34fc-4ffd-a8ee-19e0d7879e9a", "name": "Conflict. The batch transfer cannot be updated (for example, invalid status transition or batch not in an allowed state).", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "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": "a173737c-1ac5-47ea-af5d-3385347cf411", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\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": "0bdd7f21-7059-4e94-847c-3e71c5bda230", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "batch-transfers", ":batchTransferId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The customer ID (sender) for the batch transfer.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The batch transfer ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "batchTransferId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACCEPTED\",\n \"paymentProperties\": [\n {\n \"key\": \"CARD_SAVE_INSTRUMENT\",\n \"value\": \"\"\n },\n {\n \"key\": \"VERIFICATION_OF_PAYEE\",\n \"value\": \"\"\n }\n ],\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\"\n }\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 } } ] }, { "name": "Payment Events", "description": "Payment Events API.\n", "item": [ { "id": "76fe0981-90c7-42bb-b150-91ad9f6c3567", "name": "Get Payment Event", "request": { "name": "Get Payment Event", "description": { "content": "Returns single payment event.", "type": "text/plain" }, "url": { "path": [ "v2", "payment-events", ":eventId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "eventId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "97df81e9-b2a8-491f-b19e-7e5ed1cc4748", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "payment-events", ":eventId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"WITHDRAWAL_UPDATE\",\n \"paymentId\": \"\",\n \"paymentCreationTimestamp\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"links\": [\n {\n \"rel\": \"related\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"eventType\": \"TRANSFER_UPDATE\",\n \"status\": \"COMPLETED\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"PENDING\"\n ],\n \"statusReason\": \"TRANSFER_GENERAL_ERROR\"\n },\n \"merchantRefNum\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b8e5c60-b55f-4ea2-92e5-1a2f87c85fe4", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "payment-events", ":eventId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "eventId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "c6157893-092e-477c-8645-fb5701025138", "name": "Get Payment Events", "request": { "name": "Get Payment Events", "description": { "content": "Get payment events associated with given payment.", "type": "text/plain" }, "url": { "path": [ "v2", "payment-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Id of the payment.", "type": "text/plain" }, "key": "paymentId", "value": "" }, { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dac99f9d-5698-4058-a85a-a133edebd1af", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "payment-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Id of the payment.", "type": "text/plain" }, "key": "paymentId", "value": "" }, { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentEvents\": [\n {\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"DEPOSIT_UPDATE\",\n \"paymentId\": \"\",\n \"paymentCreationTimestamp\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"related\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"eventType\": \"TRANSFER_UPDATE\",\n \"status\": \"FAILED\",\n \"nextStatus\": [\n \"PREVIEW\",\n \"SCHEDULED\"\n ],\n \"statusReason\": \"DW-BANK-DECLINE\"\n },\n \"merchantRefNum\": \"\"\n },\n {\n \"id\": \"\",\n \"timestamp\": \"\",\n \"eventType\": \"WITHDRAWAL_UPDATE\",\n \"paymentId\": \"\",\n \"paymentCreationTimestamp\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"externalId\": \"\"\n },\n \"links\": [\n {\n \"rel\": \"related\",\n \"href\": \"\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"related\",\n \"href\": \"\",\n \"method\": \"GET\"\n }\n ],\n \"content\": {\n \"eventType\": \"TRANSFER_UPDATE\",\n \"status\": \"SCHEDULED\",\n \"nextStatus\": [\n \"FAILED\",\n \"COMPLETED\"\n ],\n \"statusReason\": \"SCA_RETRY_REQUIRED\"\n },\n \"merchantRefNum\": \"\"\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a51413aa-84b3-4376-b751-a35ba469ce13", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "payment-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Id of the payment.", "type": "text/plain" }, "key": "paymentId", "value": "" }, { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "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" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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 } } ] }, { "name": "Notifications", "description": "Notifications API Objects.\n", "item": [ { "id": "40134146-1529-4067-8c24-5758d12c2fa2", "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": [ "v2", "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\": \"KYC\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"IN_PROGRESS\",\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": "f28a40da-c35a-4dcf-9496-b2e0735a6707", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"KYC\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"IN_PROGRESS\",\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\": \"KYC\",\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": "1cb0982b-ab48-45b6-a565-c9bc32c1c98a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"KYC\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"IN_PROGRESS\",\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": "ac73c725-5023-4807-91b9-a3d242fac39b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"KYC\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"IN_PROGRESS\",\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": "9971f045-0329-4e52-bdb7-6a7f88dd2216", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"KYC\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"status\": \"IN_PROGRESS\",\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": "eb6e38a3-175e-4229-b5ca-8efb99532ec3", "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": [ "v2", "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": "24de3ca5-29f9-492d-8f3f-40ba40497ca5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"eventType\": \"KYC\",\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": "ff63bdae-bafd-4d94-93a7-fb884d1e7e0c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "d34b9f19-4dcf-41b8-9ee5-901d6f066c17", "name": "Not found", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "097e6025-4e2b-4f7c-b984-7a130e6080cb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "c988216b-265e-4f23-a0f1-eaed8aed218b", "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 using 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 internally cause minor difference in the actual conversion output. Usually this would be in customer benefit.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "fxrate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceCurrency\": \"\",\n \"targetCurrency\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b91d2b73-c7fa-411e-8474-e7ed151ed203", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "fxrate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceCurrency\": \"\",\n \"targetCurrency\": \"\"\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 \"sourceCurrency\": \"\",\n \"targetCurrency\": \"\",\n \"id\": \"\",\n \"sender\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "520f5e20-48ee-4848-9af1-111b2194a6cf", "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 /v2/customers/{customerId}/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": [ "v2", "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": "8fef11cf-8a4e-4563-b367-80f008d7226b", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"fxRate\": \"\",\n \"sourceCurrency\": \"\",\n \"targetCurrency\": \"\",\n \"id\": \"\",\n \"sender\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Features", "description": "Features API.\n", "item": [ { "id": "1b727f6b-920c-4bf3-9024-298ea1c0ee48", "name": "Get Wallet Features", "request": { "name": "Get Wallet Features", "description": { "content": "\nReturns the feature configuration for the embedded wallet system.\nEach capability can be controlled at the country (state) level.\n\nThe following capabilities are exposed:\n\n- ONBOARDING - Onboarding for new customers\n- DEPOSIT - Customer deposit\n- WITHDRAWAL - Customer withdrawal\n- PREPAID_CARD - Issuing and using prepaid cards\n- P2P_TRANSFER - Peer to Peer transfers between customers\n\nThe feature state depends on the specific partner contract agreements and rollout state.\n", "type": "text/plain" }, "url": { "path": [ "v2", "features" ], "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": "ISO-3166 Alpha 2", "type": "text/plain" }, "key": "countryCode", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c3388017-8902-474a-8a83-f1bbdf109737", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "features" ], "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": "ISO-3166 Alpha 2", "type": "text/plain" }, "key": "countryCode", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"features\": [\n {\n \"name\": \"WITHDRAWAL\",\n \"enabled\": true,\n \"scope\": [\n {\n \"countryCode\": \"\",\n \"states\": [\n \"\",\n \"\"\n ]\n },\n {\n \"countryCode\": \"\",\n \"states\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"name\": \"ONBOARDING\",\n \"enabled\": true,\n \"scope\": [\n {\n \"countryCode\": \"\",\n \"states\": [\n \"\",\n \"\"\n ]\n },\n {\n \"countryCode\": \"\",\n \"states\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc24880b-59fa-4ead-9d6a-44cc2994c7ac", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "features" ], "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": "ISO-3166 Alpha 2", "type": "text/plain" }, "key": "countryCode", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "98c6e605-9445-445f-aec2-eaf3ab6b7bb6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "features" ], "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": "ISO-3166 Alpha 2", "type": "text/plain" }, "key": "countryCode", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "e6e24e78-0ab7-45c3-806b-0b6c96fa7341", "name": "Service Unavailable. Please try again later.", "originalRequest": { "url": { "path": [ "v2", "features" ], "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": "ISO-3166 Alpha 2", "type": "text/plain" }, "key": "countryCode", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "Strong Customer Authentication", "description": "Strong Customer Authentication API.\n", "item": [ { "id": "b420b16e-a45b-4557-806a-a83fa853ab16", "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": [ "v2", "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\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\n \"statusReason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fe571931-4277-4ce8-aa9e-d6bc188b2331", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\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\": \"OUTSOURCED\",\n \"verification\": {\n \"method\": \"OTP\",\n \"channel\": \"SMS\",\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": "ca3eebfb-fabb-473b-b888-bf14453436ec", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\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": "2b4155ea-bee8-448f-9a26-c9a045fa2b5b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\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": "a7997589-b25e-4e23-b595-eb7b76562536", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\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": "b80eb5b2-4980-4f45-b15f-bbda2960335a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\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": "8cfd3201-fbc0-41fd-8009-12bd51bf903a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\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": "76b27aa9-7a86-4c06-880e-23d33fcbbb79", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\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": "d3f322ee-7a44-4d4c-bd50-af5c04cdabd5", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v2", "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletOperationId\": \"\",\n \"verification\": {\n \"method\": \"BIOMETRIC\",\n \"channel\": \"AUTHENTICATOR\"\n },\n \"status\": \"FAILED\",\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 } } ] }, { "name": "Purchase Orders", "description": "", "item": [ { "id": "611b7f78-7bb3-4add-b4a5-2f9e40e6063d", "name": "Get Customer's Purchase Orders", "request": { "name": "Get Customer's Purchase Orders", "description": { "content": "You can use this API to get the purchase orders for the current customer.\n\nIt returns the last 10 purchase orders by default.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "394527e5-28e5-48e7-8b9e-8a280f6f040e", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"purchaseOrders\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"recipient\": {\n \"externalId\": \"\",\n \"fullName\": \"\",\n \"type\": \"MERCHANT\"\n },\n \"merchantRefNum\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"ACCEPTED\",\n \"purchaseOrderDetails\": {\n \"serviceCode\": \"\",\n \"provider\": \"PAGO_EFECTIVO\",\n \"category\": \"PURCHASE\",\n \"description\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n },\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 \"statusReason\": \"\",\n \"slipId\": \"\",\n \"nextStatus\": [\n \"COMPLETED\",\n \"SCHEDULED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"OUTSOURCED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"SMS\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"PUSH_NOTIFICATION\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"discountDetails\": {\n \"maxDiscounts\": \"\",\n \"availablePoints\": {\n \"id\": \"\",\n \"name\": \"\",\n \"attributes\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"balance\": \"\"\n },\n \"options\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"recipient\": {\n \"externalId\": \"\",\n \"fullName\": \"\",\n \"type\": \"MERCHANT\"\n },\n \"merchantRefNum\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"ACCEPTED\",\n \"purchaseOrderDetails\": {\n \"serviceCode\": \"\",\n \"provider\": \"PAGO_EFECTIVO\",\n \"category\": \"PURCHASE\",\n \"description\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n },\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 \"statusReason\": \"\",\n \"slipId\": \"\",\n \"nextStatus\": [\n \"PROCESSING\",\n \"REFUNDED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"HYBRID\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSKEYS\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"discountDetails\": {\n \"maxDiscounts\": \"\",\n \"availablePoints\": {\n \"id\": \"\",\n \"name\": \"\",\n \"attributes\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"balance\": \"\"\n },\n \"options\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"numberOfRecords\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e859664c-e5f8-4e87-b0fb-3efb23ce5e1c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "ff75583c-b823-4f1c-af7a-083267a7e22d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "288aee3e-ce29-4a3b-b148-584bea802a91", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "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": "53887c8b-c1fb-4286-9f84-fa7a56038d33", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "b05fc64e-566c-47db-86b6-3eac0c65a736", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "ab534374-a550-4540-98fb-1912f2d510fd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "bafe3046-ff21-4664-b9dc-0bf44aaac064", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system.", "type": "text/plain" }, "key": "merchantRefNum", "value": "" }, { "disabled": false, "description": { "content": "Filter purchase orders by external service reference (`purchaseOrderDetails.serviceCode`, for example a CIP code). When omitted, all matching purchase orders are returned regardless of service code.", "type": "text/plain" }, "key": "serviceCode", "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": "Payment slip", "type": "text/plain" }, "key": "slipId", "value": "" }, { "disabled": false, "description": { "content": "Payment status filter (This can only be one of PREVIEW,PENDING,PROCESSING,COMPLETED,FAILED,SCHEDULED,ACCEPTED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "ACCEPTED" } ], "variable": [ { "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: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "ae421fd9-7256-4db1-a196-3efb91b299d3", "name": "Get Purchase Order", "request": { "name": "Get Purchase Order", "description": { "content": "Get specified purchase order using the purchase order id. The purchase order id is generated during the PREVIEW.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "customerId", "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "purchaseOrderId", "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ea383897-6999-4859-8353-b862017e2289", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"recipient\": {\n \"externalId\": \"\",\n \"fullName\": \"\",\n \"type\": \"MERCHANT\"\n },\n \"merchantRefNum\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\",\n \"status\": \"COMPLETED\",\n \"purchaseOrderDetails\": {\n \"serviceCode\": \"\",\n \"provider\": \"PAGO_EFECTIVO\",\n \"category\": \"PURCHASE\",\n \"description\": \"\",\n \"creationTime\": \"\",\n \"expirationTime\": \"\"\n },\n \"paymentFunding\": {\n \"wallet\": {\n \"amount\": \"\",\n \"currencyCode\": \"\"\n },\n \"discounts\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n },\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 \"statusReason\": \"\",\n \"slipId\": \"\",\n \"nextStatus\": [\n \"REFUNDED\",\n \"CANCELLED\"\n ],\n \"action\": \"NONE\",\n \"scaDetails\": {\n \"eventId\": \"\",\n \"walletOperationId\": \"\",\n \"authenticationMode\": \"OUTSOURCED\",\n \"creationTime\": \"\",\n \"availableVerifications\": [\n {\n \"method\": \"PASSWORD\",\n \"channel\": \"REDIRECT\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n },\n {\n \"method\": \"OTP\",\n \"channel\": \"EMAIL\",\n \"target\": \"\",\n \"action\": {\n \"language\": \"en\",\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\"\n }\n }\n ],\n \"expirationTime\": \"\"\n },\n \"discountDetails\": {\n \"maxDiscounts\": \"\",\n \"availablePoints\": {\n \"id\": \"\",\n \"name\": \"\",\n \"attributes\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"balance\": \"\"\n },\n \"options\": [\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"VOUCHER\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"amount\": \"\",\n \"currencyCode\": \"\",\n \"type\": \"POINTS\",\n \"redemption\": {\n \"reference\": \"\",\n \"displayName\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8c3b07b-b8cd-4593-8291-c07658f231b0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "32a79664-c8c0-4681-a2a1-9bdf7fcc6c05", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "9da2bec2-ce49-47f0-a009-226d68d8bc96", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "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": "3307d581-bf89-4ff3-a573-4a90ac76218c", "name": "Purchase order with the requested id was not found.", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "89f4d461-db5b-45fc-baf0-24596a607f62", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "de39e48e-2f3d-4358-9ef1-12b43f783813", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "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": "1959504b-e879-4cc9-8a35-85abcfcfb681", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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": "73e961f3-8052-4f2c-887d-c93554bfbdde", "name": "Service Unavailable", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerId", "purchase-orders", ":purchaseOrderId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Customer Id.", "type": "text/plain" }, "type": "any", "value": "", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) Purchase order id returned when the purchase order was created in PREVIEW.", "type": "text/plain" }, "type": "any", "value": "", "key": "purchaseOrderId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "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 } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.paysafe.com/digitalwallets" } ], "info": { "_postman_id": "36238f27-5633-4480-99b9-55dc1f6b0bd0", "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" } } }