{ "info": { "_postman_id": "37eeae29-f3f4-4e34-afee-30c0de3fcd49", "name": "BVNK API Endpoints", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "The BVNK API is designed to facilitate seamless and secure transactions including payments, channels, and digital wallet transactions." }, "item": [ { "name": "Customers", "description": "", "item": [ { "name": "Agreements", "description": "", "item": [ { "id": "bb3ce154-8a28-41d0-bb84-508d8b75ad4c", "name": "Create Agreement Signing Session", "request": { "name": "Create Agreement Signing Session", "description": { "content": "\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Create agreement session for a company customer:**\n1. **Create agreement session for a company customer**\n\n**Create agreement session for an individual customer:**\n1. **Create agreement session for an individual customer**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*" }, "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerType\": \"COMPANY\",\n \"countryCode\": \"GB\",\n \"useCase\": \"EMBEDDED_FIAT_ACCOUNTS\"\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "b2fb613b-5f4d-4205-9c8f-f39e59ed5b5a", "name": "Agreement session created successfully", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerType\": \"INDIVIDUAL\",\n \"countryCode\": \"\",\n \"useCase\": \"EMBEDDED_STABLECOIN_WALLETS\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reference\": \"\",\n \"status\": \"DECLINED\",\n \"customerType\": \"\",\n \"useCase\": \"\",\n \"countryCode\": \"\",\n \"expiresOn\": \"\",\n \"agreements\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"status\": \"\",\n \"privacyPolicyName\": \"\",\n \"privacyPolicyDescription\": \"\",\n \"privacyPolicyUrl\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"status\": \"\",\n \"privacyPolicyName\": \"\",\n \"privacyPolicyDescription\": \"\",\n \"privacyPolicyUrl\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2f72ced-b30a-40c8-94ee-b87ad5481bce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerType\": \"INDIVIDUAL\",\n \"countryCode\": \"\",\n \"useCase\": \"EMBEDDED_STABLECOIN_WALLETS\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2d9310c-bdfb-44a0-af6f-2f058660613a", "name": "Retrieve Agreement Session Status", "request": { "name": "Retrieve Agreement Session Status", "description": { "content": "Returns the current status of an agreement session using its reference ID.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "example", "key": "reference", "disabled": false, "description": { "content": "(Required) The unique identifier of the agreement session to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cc197948-3ce0-4162-8988-2748412ce916", "name": "Agreement session data retrieved", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reference\": \"\",\n \"status\": \"DECLINED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d60e295-6b7f-4e81-a269-5832cd00e17f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8850d38c-1dd4-477f-bcc2-165d0097012f", "name": "Update Agreement Session Status", "request": { "name": "Update Agreement Session Status", "description": { "content": "Updates the signing status of an agreement session. Typically used after user submission to mark the session as SIGNED or DECLINED.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "example", "key": "reference", "disabled": false, "description": { "content": "(Required) The unique identifier of the agreement session to update.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"SIGNED\",\n \"ipAddress\": \"192.168.1.1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1dbffafa-1c4a-40ac-b4b8-b93ebe665078", "name": "Agreement session status was successfully updated.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"DECLINED\",\n \"ipAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64e101f8-fcc7-45fc-ab91-6b0ef273828e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "agreement", "sessions", ":reference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"DECLINED\",\n \"ipAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Customers", "description": "", "item": [ { "id": "986a1df3-fe30-481e-80c3-444b9759c7c7", "name": "Create Customer", "request": { "name": "Create Customer", "description": { "content": "Creates an Embedded Partner Customer account. The customer can be 'Individual' or 'Company'.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Create a Limited Liability Company customer:**\n1. **Create a Limited Liability Company customer**\n Use case: Registering a UK-based LLC for business payments and crypto transactions.\n\n**Company payload:**\n1. **Company payload**\n\n**Create an Individual customer:**\n1. **Create an Individual customer (basic use case)**\n Use case: Registering an individual for personal crypto payments and wallet management.\n\n**Individual payload:**\n1. **Individual payload**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"company\",\n \"signedAgreementSessionReference\": \"78eedde1-2402-4a59-8bbd-ccecb6d612d1\",\n \"company\": {\n \"name\": \"UK Ltd Version 2.0\",\n \"description\": \"Number 1 customer, be super nice.\",\n \"entityType\": \"LIMITED_LIABILITY_COMPANY\",\n \"taxResidenceCountryCode\": \"DE\",\n \"taxNumber\": \"12-34567890\",\n \"registrationNumber\": \"1849203\",\n \"industryReference\": \"0a184641-30e2-4414-871f-3db1c683900e\",\n \"monthlyExpectedVolumesReference\": \"e1a6f510-1337-4000-a3c2-111111111111\",\n \"address\": {\n \"addressLine1\": \"221B Baker Street\",\n \"city\": \"London\",\n \"postalCode\": \"NW1 6XE\",\n \"countryCode\": \"GB\"\n },\n \"cdd\": {\n \"intendedUseOfAccount\": \"PAYROLL\",\n \"pepStatus\": \"NOT_PEP\",\n \"expectedMonthlyVolume\": {\n \"amount\": \"50000.00\",\n \"currency\": \"EUR\"\n }\n },\n \"operationalAddress\": {\n \"addressLine1\": \"Unter den Linden 77\",\n \"city\": \"Berlin\",\n \"postalCode\": \"10117\",\n \"countryCode\": \"DE\"\n },\n \"incorporationDate\": \"2001-12-31\",\n \"businessOperationsStartDate\": \"2020-12-31\",\n \"website\": \"https://www.health-music.com\",\n \"reliance\": {\n \"attestation\": {\n \"riskScore\": \"LOW\",\n \"eddCompleted\": true\n }\n },\n \"associates\": [\n {\n \"person\": {\n \"firstName\": \"J.\",\n \"lastName\": \"Health\",\n \"dateOfBirth\": \"1978-11-29\",\n \"nationality\": \"US\",\n \"birthCountryCode\": \"US\",\n \"address\": {\n \"addressLine1\": \"1313 Webfoot Street\",\n \"city\": \"Duckburg\",\n \"postalCode\": \"12345\",\n \"stateCode\": \"CA\",\n \"countryCode\": \"US\"\n },\n \"reliance\": {\n \"identityDocumentMetadata\": {\n \"type\": \"PASSPORT\",\n \"number\": \"987654321\",\n \"expiryDate\": \"2031-01-01\",\n \"issueDate\": \"2021-01-01\",\n \"issuingCountryCode\": \"GB\",\n \"kycTimestamp\": \"2025-11-20T15:30:45.123Z\"\n },\n \"biometricLiveness\": {\n \"livenessTimestamp\": \"2025-11-20T15:30:45.123Z\"\n },\n \"addressVerification\": {\n \"type\": \"DOC\"\n },\n \"attestation\": {\n \"riskScore\": \"LOW\",\n \"eddCompleted\": true\n }\n },\n \"contactInfo\": {\n \"emailAddress\": \"johnny@heilung.de\",\n \"phoneNumber\": \"+1234567890\"\n },\n \"taxIdentification\": {\n \"number\": \"345-56-357\",\n \"taxResidenceCountryCode\": \"GB\"\n },\n \"ownership\": {\n \"type\": \"DIRECT\",\n \"percentage\": 100\n }\n },\n \"titles\": [\n \"ACCOUNT_REPRESENTATIVE\",\n \"DIRECTOR\"\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "183a21db-c276-439a-98df-38bc04d3068f", "name": "Successful operation", "originalRequest": { "url": { "path": [ "platform", "v1", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"company\",\n \"company\": {\n \"name\": \"\",\n \"entityType\": \"TRUST\",\n \"taxResidenceCountryCode\": \"\",\n \"registrationNumber\": \"\",\n \"industryReference\": \"\",\n \"monthlyExpectedVolumesReference\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"associates\": [\n {\n \"person\": {\n \"firstName\": \"zz\",\n \"lastName\": \"OXk}~yZO,r\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"contactInfo\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"birthCountryCode\": \"\",\n \"nationality\": \"\",\n \"taxIdentification\": {\n \"number\": \"\",\n \"taxResidenceCountryCode\": \"\"\n },\n \"ownership\": {\n \"type\": \"DIRECT\",\n \"percentage\": \"\"\n },\n \"reliance\": {\n \"identityDocumentMetadata\": {\n \"type\": \"PASSPORT\",\n \"number\": \"\",\n \"issuingCountryCode\": \"\",\n \"kycTimestamp\": \"\",\n \"expiryDate\": \"\",\n \"issueDate\": \"\"\n },\n \"biometricLiveness\": {\n \"livenessTimestamp\": \"\"\n },\n \"addressVerification\": {\n \"type\": \"DOC\"\n },\n \"attestation\": {\n \"riskScore\": \"MEDIUM\",\n \"eddCompleted\": true\n }\n }\n },\n \"titles\": [\n \"ACCOUNT_REPRESENTATIVE\",\n \"DIRECTOR\"\n ]\n },\n {\n \"person\": {\n \"firstName\": \"a]S\",\n \"lastName\": \"mgB]l.y+f)\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"contactInfo\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"birthCountryCode\": \"\",\n \"nationality\": \"\",\n \"taxIdentification\": {\n \"number\": \"\",\n \"taxResidenceCountryCode\": \"\"\n },\n \"ownership\": {\n \"type\": \"DIRECT\",\n \"percentage\": \"\"\n },\n \"reliance\": {\n \"identityDocumentMetadata\": {\n \"type\": \"OTHER\",\n \"number\": \"\",\n \"issuingCountryCode\": \"\",\n \"kycTimestamp\": \"\",\n \"expiryDate\": \"\",\n \"issueDate\": \"\"\n },\n \"biometricLiveness\": {\n \"livenessTimestamp\": \"\"\n },\n \"addressVerification\": {\n \"type\": \"DOC\"\n },\n \"attestation\": {\n \"riskScore\": \"MEDIUM\",\n \"eddCompleted\": false\n }\n }\n },\n \"titles\": [\n \"BUSINESS_OWNER\",\n \"ACCOUNT_REPRESENTATIVE\"\n ]\n }\n ],\n \"description\": \"\",\n \"taxNumber\": \"\",\n \"industryNaceCode\": \"\",\n \"industryNaicsCode\": \"\",\n \"cdd\": {\n \"pepStatus\": \"FORMER_PEP_2_YEARS\",\n \"intendedUseOfAccount\": \"TREASURY_MANAGEMENT\",\n \"expectedMonthlyVolume\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"operationalAddress\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"incorporationDate\": \"\",\n \"businessOperationsStartDate\": \"\",\n \"website\": \"\",\n \"reliance\": {\n \"attestation\": {\n \"riskScore\": \"MEDIUM\",\n \"eddCompleted\": true\n }\n }\n },\n \"signedAgreementSessionReference\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reference\": \"\",\n \"status\": \"PENDING\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af4f9b64-ae96-474b-9c53-86bbf3d53964", "name": "Bad request", "originalRequest": { "url": { "path": [ "platform", "v1", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"company\",\n \"company\": {\n \"name\": \"\",\n \"entityType\": \"TRUST\",\n \"taxResidenceCountryCode\": \"\",\n \"registrationNumber\": \"\",\n \"industryReference\": \"\",\n \"monthlyExpectedVolumesReference\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"associates\": [\n {\n \"person\": {\n \"firstName\": \"zz\",\n \"lastName\": \"OXk}~yZO,r\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"contactInfo\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"birthCountryCode\": \"\",\n \"nationality\": \"\",\n \"taxIdentification\": {\n \"number\": \"\",\n \"taxResidenceCountryCode\": \"\"\n },\n \"ownership\": {\n \"type\": \"DIRECT\",\n \"percentage\": \"\"\n },\n \"reliance\": {\n \"identityDocumentMetadata\": {\n \"type\": \"PASSPORT\",\n \"number\": \"\",\n \"issuingCountryCode\": \"\",\n \"kycTimestamp\": \"\",\n \"expiryDate\": \"\",\n \"issueDate\": \"\"\n },\n \"biometricLiveness\": {\n \"livenessTimestamp\": \"\"\n },\n \"addressVerification\": {\n \"type\": \"DOC\"\n },\n \"attestation\": {\n \"riskScore\": \"MEDIUM\",\n \"eddCompleted\": true\n }\n }\n },\n \"titles\": [\n \"ACCOUNT_REPRESENTATIVE\",\n \"DIRECTOR\"\n ]\n },\n {\n \"person\": {\n \"firstName\": \"a]S\",\n \"lastName\": \"mgB]l.y+f)\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"contactInfo\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"birthCountryCode\": \"\",\n \"nationality\": \"\",\n \"taxIdentification\": {\n \"number\": \"\",\n \"taxResidenceCountryCode\": \"\"\n },\n \"ownership\": {\n \"type\": \"DIRECT\",\n \"percentage\": \"\"\n },\n \"reliance\": {\n \"identityDocumentMetadata\": {\n \"type\": \"OTHER\",\n \"number\": \"\",\n \"issuingCountryCode\": \"\",\n \"kycTimestamp\": \"\",\n \"expiryDate\": \"\",\n \"issueDate\": \"\"\n },\n \"biometricLiveness\": {\n \"livenessTimestamp\": \"\"\n },\n \"addressVerification\": {\n \"type\": \"DOC\"\n },\n \"attestation\": {\n \"riskScore\": \"MEDIUM\",\n \"eddCompleted\": false\n }\n }\n },\n \"titles\": [\n \"BUSINESS_OWNER\",\n \"ACCOUNT_REPRESENTATIVE\"\n ]\n }\n ],\n \"description\": \"\",\n \"taxNumber\": \"\",\n \"industryNaceCode\": \"\",\n \"industryNaicsCode\": \"\",\n \"cdd\": {\n \"pepStatus\": \"FORMER_PEP_2_YEARS\",\n \"intendedUseOfAccount\": \"TREASURY_MANAGEMENT\",\n \"expectedMonthlyVolume\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"operationalAddress\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"incorporationDate\": \"\",\n \"businessOperationsStartDate\": \"\",\n \"website\": \"\",\n \"reliance\": {\n \"attestation\": {\n \"riskScore\": \"MEDIUM\",\n \"eddCompleted\": true\n }\n }\n },\n \"signedAgreementSessionReference\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"errors\": {\n \"commodo_b9\": [\n \"\",\n \"\"\n ],\n \"dolor_1e0\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"errors\": {\n \"deserunt_bd\": [\n \"\",\n \"\"\n ],\n \"elit_3__\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c7cdcbb-05fd-4e6b-a72f-b0962d5317da", "name": "List Customers", "request": { "name": "List Customers", "description": { "content": "Retrieves the full list of Customers.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (starts from `0`)", "type": "text/plain" }, "key": "page", "value": "0" }, { "disabled": false, "description": { "content": "Page size (max is `100`)", "type": "text/plain" }, "key": "size", "value": "10" }, { "disabled": false, "description": { "content": "Name of the customer to fetch", "type": "text/plain" }, "key": "name", "value": "Customer-1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b47d4e3b-075f-43b0-a41e-7019290e3424", "name": "successful operation", "originalRequest": { "url": { "path": [ "platform", "v1", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (starts from `0`)", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Page size (max is `100`)", "type": "text/plain" }, "key": "size", "value": "" }, { "disabled": false, "description": { "content": "Name of the customer to fetch", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"reference\": \"\",\n \"status\": \"VERIFIED\",\n \"type\": \"COMPANY\",\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"reference\": \"\",\n \"status\": \"REJECTED\",\n \"type\": \"COMPANY\",\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"page\": {\n \"size\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\",\n \"number\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ca25e14-4075-466a-9eb8-53170673f50c", "name": "Get Customer", "request": { "name": "Get Customer", "description": {}, "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "example", "key": "customerReference", "disabled": false, "description": { "content": "(Required) Customer reference", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b664a5e5-a538-45fa-8f13-f283340c09f1", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reference\": \"\",\n \"status\": \"PENDING\",\n \"type\": \"COMPANY\",\n \"company\": {\n \"name\": \"\",\n \"description\": \"\",\n \"taxResidenceCountryCode\": \"\",\n \"registrationNumber\": \"\",\n \"industry\": {\n \"reference\": \"\",\n \"name\": \"\"\n },\n \"monthlyExpectedVolumes\": {\n \"reference\": \"\",\n \"name\": \"\",\n \"min\": \"\",\n \"max\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"representative\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"birthCountryCode\": \"\",\n \"nationality\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f506469-1993-44bb-830c-997413499c82", "name": "Bad Request", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7dcc8ce-6ba3-49ba-9cb5-6735c5da748d", "name": "The specified resource was not found", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5584c32b-0604-4ecf-a692-1c121f16d74b", "name": "Update Customer", "request": { "name": "Update Customer", "description": { "content": "Updates customer information for individual customers. You can update contact information (email and phone), address details, and date of birth.\n\nOnly include the fields in your request that you want to update.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "0a184641-30e2-4414-871f-3db1c683900e", "key": "customerReference", "disabled": false, "description": { "content": "(Required) The unique identifier of the customer whose record will be updated. This must be a valid customer in the platform.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"externalReference\": \"test-ref-123\",\n \"individual\": {\n \"contactInfo\": {\n \"emailAddress\": \"test@example.com\",\n \"phoneNumber\": \"+1234567890\"\n },\n \"dateOfBirth\": \"1990-01-01\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d59d475f-6c40-45c6-9909-003303f0dfda", "name": "Successfully updated customer details", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"externalReference\": \"\",\n \"individual\": {\n \"contactInfo\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"dateOfBirth\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reference\": \"\",\n \"status\": \"INFO_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ab34cad-fc1e-4cde-8065-bb8d3c3c7f8e", "name": "Bad request - validation failed or invalid data provided", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"externalReference\": \"\",\n \"individual\": {\n \"contactInfo\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"dateOfBirth\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"Bad Request\",\n \"content\": {\n \"application/json\": {\n \"schema\": {}\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "920bf9fe-22ab-41f3-949d-0c12d9dd92f9", "name": "Unauthorized - invalid or missing API credentials", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"externalReference\": \"\",\n \"individual\": {\n \"contactInfo\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"dateOfBirth\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "942d67b9-af36-4385-9c6c-0efb28118a1f", "name": "The specified resource was not found", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"externalReference\": \"\",\n \"individual\": {\n \"contactInfo\": {\n \"emailAddress\": \"\",\n \"phoneNumber\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"dateOfBirth\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a1f9a79-a755-401e-9116-f5c4679dc8d8", "name": "List Required Information", "request": { "name": "List Required Information", "description": { "content": "Retrieves detailed information about what documents and data are required for customer onboarding when their status is `INFO_REQUIRED`. This endpoint provides specific requirements for documents, questionnaires, and additional data needed to complete the onboarding process.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", ":customerReference", "info-required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "0a184641-30e2-4414-871f-3db1c683900e", "key": "customerReference", "disabled": false, "description": { "content": "(Required) Unique identifier of the customer in the UUID format.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "eda7e60f-9dd6-48eb-b248-eda88179bbc2", "name": "Successful operation", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference", "info-required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"REJECTED\",\n \"infoRequired\": {\n \"documents\": [\n {\n \"docSetType\": \"SELFIE\",\n \"types\": [\n \"RESIDENCE_PERMIT\",\n \"UTILITY_BILL\"\n ]\n },\n {\n \"docSetType\": \"IDENTITY\",\n \"types\": [\n \"UTILITY_BILL\",\n \"SELFIE\"\n ]\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "143b1580-9c3b-40f4-b0cf-4f4a4b61a1b0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference", "info-required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23050736-79dd-4c24-9e18-5ebf64e55a6f", "name": "The specified resource was not found", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference", "info-required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ec17c18-17c8-4a38-ae99-a383b36abca3", "name": "Upload Documents to Customer", "request": { "name": "Upload Documents to Customer", "description": { "content": "Attach one or more documents to a customer's profile. This can be either a company customer (with optional linkage to a specific associate) or an individual customer. Files must be base64-encoded before submission.\n\n- For company-level documents, omit `customerPersonReference`.\n- For associate-level documents, provide the `customerPersonReference`.\n- The customer must be in `INFO_REQUIRED` status.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", ":customerReference", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "123e4567-e89b-12d3-a456-426614174000", "key": "customerReference", "disabled": false, "description": { "content": "(Required) The unique identifier of the customer to whom the documents will be attached. Must be in `INFO_REQUIRED` status.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"type\": \"\",\n \"name\": \"\",\n \"countryCode\": \"\",\n \"externalReference\": \"\",\n \"content\": \"\",\n \"customerPersonReference\": \"\",\n \"subType\": \"\",\n \"description\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"\",\n \"countryCode\": \"\",\n \"externalReference\": \"\",\n \"content\": \"\",\n \"customerPersonReference\": \"\",\n \"subType\": \"\",\n \"description\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "73d76f34-59b5-4cf0-b461-ee72aa4f51e1", "name": "Documents accepted and queued for upload.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference", "documents" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"type\": \"\",\n \"name\": \"\",\n \"countryCode\": \"\",\n \"externalReference\": \"\",\n \"content\": \"\",\n \"customerPersonReference\": \"\",\n \"subType\": \"\",\n \"description\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"\",\n \"countryCode\": \"\",\n \"externalReference\": \"\",\n \"content\": \"\",\n \"customerPersonReference\": \"\",\n \"subType\": \"\",\n \"description\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reference\": \"\",\n \"externalReference\": \"\",\n \"status\": \"INIT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e99d9742-6205-403e-91de-e5d07af8f9ce", "name": "Bad request ā€” missing or invalid data.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference", "documents" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"type\": \"\",\n \"name\": \"\",\n \"countryCode\": \"\",\n \"externalReference\": \"\",\n \"content\": \"\",\n \"customerPersonReference\": \"\",\n \"subType\": \"\",\n \"description\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"\",\n \"countryCode\": \"\",\n \"externalReference\": \"\",\n \"content\": \"\",\n \"customerPersonReference\": \"\",\n \"subType\": \"\",\n \"description\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"BAD_REQUEST\",\n \"message\": \"\",\n \"details\": {\n \"errors\": {\n \"irure7\": [\n \"\",\n \"\"\n ],\n \"nostruda\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f87f443-eb33-4a8b-a1d6-df001b2685d6", "name": "List Industries", "request": { "name": "List Industries", "description": { "content": "Retrieves a definitive list of industries and sub-industries, which can be included in the payload when creating a customer.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "accounts", "industries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b2bb3c3e-8b18-4c89-ad5e-4c88673881c4", "name": "successful operation", "originalRequest": { "url": { "path": [ "platform", "v1", "accounts", "industries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"reference\": \"\",\n \"name\": \"\",\n \"children\": [\n {\n \"reference\": \"\",\n \"name\": \"\"\n },\n {\n \"reference\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"reference\": \"\",\n \"name\": \"\",\n \"children\": [\n {\n \"reference\": \"\",\n \"name\": \"\"\n },\n {\n \"reference\": \"\",\n \"name\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a3c4384-db9c-40fc-8bcc-7b5769c61acd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "v1", "accounts", "industries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52b8b96e-6071-4c55-8029-e0864b2f6314", "name": "List Monthly Expected Volumes", "request": { "name": "List Monthly Expected Volumes", "description": { "content": "Retrieves a definitive list of Expected Monthly Volume values, which can be included in the payload when creating a customer.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "accounts", "monthly-expected-volumes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "82fa8543-833f-4c0b-8b91-77a10b43f308", "name": "successful operation", "originalRequest": { "url": { "path": [ "platform", "v1", "accounts", "monthly-expected-volumes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"reference\": \"\",\n \"name\": \"\",\n \"min\": \"\",\n \"max\": \"\"\n },\n {\n \"reference\": \"\",\n \"name\": \"\",\n \"min\": \"\",\n \"max\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "109a613f-e2b5-4044-94e9-95dce0066b49", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "v1", "accounts", "monthly-expected-volumes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Manage Documents", "description": "", "item": [ { "id": "7d7f0924-390d-413c-a20e-83a4e86c6a45", "name": "Get Customer Documents", "request": { "name": "Get Customer Documents", "description": { "content": "Retrieves the details of the specific document added for the Customer. If no parameters are specified, retrieves the array of available documents.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Customer reference", "type": "text/plain" }, "key": "customerReference", "value": "0a184641-30e2-4414-871f-3db1c683900e" }, { "disabled": false, "description": { "content": "External document tracking ID", "type": "text/plain" }, "key": "externalReference", "value": "501e87bb-24d7-4008-a249-f485512b8a14" }, { "disabled": false, "description": { "content": "Customer reference", "type": "text/plain" }, "key": "name", "value": "J_Kaldwin_Passport.pdf" }, { "disabled": false, "description": { "content": "Document type", "type": "text/plain" }, "key": "type", "value": "PASSPORT" }, { "disabled": false, "description": { "content": "Subtype of document", "type": "text/plain" }, "key": "subtype", "value": "FRONT_SIDE" }, { "disabled": false, "description": { "content": "Initial status of the document upload", "type": "text/plain" }, "key": "status", "value": "DECLINED" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2c3888b2-6a21-4721-918d-86a5fae980cf", "name": "successful operation", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Customer reference", "type": "text/plain" }, "key": "customerReference", "value": "" }, { "disabled": false, "description": { "content": "External document tracking ID", "type": "text/plain" }, "key": "externalReference", "value": "" }, { "disabled": false, "description": { "content": "Customer reference", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "Document type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Subtype of document", "type": "text/plain" }, "key": "subtype", "value": "" }, { "disabled": false, "description": { "content": "Initial status of the document upload", "type": "text/plain" }, "key": "status", "value": "DECLINED" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"reference\": \"\",\n \"externalReference\": \"\",\n \"customerReference\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"countryCode\": \"\",\n \"country\": \"\",\n \"status\": \"PENDING\",\n \"customerPersonReference\": \"\",\n \"accountReference\": \"\",\n \"subType\": \"\",\n \"description\": \"\"\n },\n {\n \"reference\": \"\",\n \"externalReference\": \"\",\n \"customerReference\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"countryCode\": \"\",\n \"country\": \"\",\n \"status\": \"INIT\",\n \"customerPersonReference\": \"\",\n \"accountReference\": \"\",\n \"subType\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65d8bda9-34cd-41ba-9852-2610a99bce1b", "name": "The specified resource was not found", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Customer reference", "type": "text/plain" }, "key": "customerReference", "value": "" }, { "disabled": false, "description": { "content": "External document tracking ID", "type": "text/plain" }, "key": "externalReference", "value": "" }, { "disabled": false, "description": { "content": "Customer reference", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": false, "description": { "content": "Document type", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": false, "description": { "content": "Subtype of document", "type": "text/plain" }, "key": "subtype", "value": "" }, { "disabled": false, "description": { "content": "Initial status of the document upload", "type": "text/plain" }, "key": "status", "value": "DECLINED" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "352a03ae-dffc-4d44-ab66-05eccd15935a", "name": "Get document download URL", "request": { "name": "Get Document Download URL", "description": { "content": "Retrieves a temporary URL for document download.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", "documents", ":documentReference", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "0a184641-30e2-4414-871f-3db1c683900e", "key": "documentReference", "disabled": false, "description": { "content": "(Required) Internal document identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "667bac19-f1e6-4e50-a673-b44a6abea767", "name": "successful operation", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "documents", ":documentReference", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4243fccb-0659-47d2-806b-4d0c1767e155", "name": "The specified resource was not found", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "documents", ":documentReference", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c5b9981-4f85-4cec-abe1-d340a7ec1d9d", "name": "Remove a document", "request": { "name": "Remove a Document", "description": { "content": "Deletes a specified document from a Customer's profile.", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", "documents", ":documentReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "0a184641-30e2-4414-871f-3db1c683900e", "key": "documentReference", "disabled": false, "description": { "content": "(Required) Internal document identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "97422d4b-1bc9-4f05-a149-348924b83a80", "name": "No Content", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "documents", ":documentReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6e519c4-52dd-4ba5-94b0-e4bae7df8e9d", "name": "The specified resource was not found", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "documents", ":documentReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "Onboarding", "description": "", "item": [ { "id": "792811d4-9c8f-4834-8c28-00c8d48d1813", "name": "Fetch Country Codes", "request": { "name": "Fetch Country Codes", "description": { "content": "Fetch list of all countries and associated ISO codes.", "type": "text/plain" }, "url": { "path": [ "api", "country" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "135" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3a7ad999-7d44-471a-b171-9649afcefd25", "name": "Successful operation", "originalRequest": { "url": { "path": [ "api", "country" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"allowRegistration\": \"\",\n \"code\": \"\",\n \"defaultCurrency\": \"\",\n \"documents\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"required\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"required\": \"\"\n }\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"minimumOrderValue\": \"\",\n \"limitValue\": \"\",\n \"minimumTransferValue\": \"\",\n \"minimumPartnerValue\": \"\",\n \"requireProofOfPayment\": \"\",\n \"supportInstantTransfer\": \"\",\n \"unverifiedMaximum\": \"\",\n \"orderMinimumValue\": \"\",\n \"transferMinimumValue\": \"\",\n \"withdrawalMaximum\": \"\",\n \"withdrawalThreshold\": \"\"\n },\n \"region\": \"\"\n },\n {\n \"allowRegistration\": \"\",\n \"code\": \"\",\n \"defaultCurrency\": \"\",\n \"documents\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"required\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"required\": \"\"\n }\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"minimumOrderValue\": \"\",\n \"limitValue\": \"\",\n \"minimumTransferValue\": \"\",\n \"minimumPartnerValue\": \"\",\n \"requireProofOfPayment\": \"\",\n \"supportInstantTransfer\": \"\",\n \"unverifiedMaximum\": \"\",\n \"orderMinimumValue\": \"\",\n \"transferMinimumValue\": \"\",\n \"withdrawalMaximum\": \"\",\n \"withdrawalThreshold\": \"\"\n },\n \"region\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "601a8795-389e-4d40-a909-178003109063", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "country" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a259168-81e4-42b2-a3f8-d84baeaa38f4", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "country" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3228578f-3a1b-4901-913b-abeb3b42d796", "name": "Fetch Agreements", "request": { "name": "Fetch Agreements", "description": { "content": "Fetch all required agreement documents needed to onboard an Embedded Partner Merchant.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "agreement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of product, currently only `embedded`.", "type": "text/plain" }, "key": "product", "value": "embedded" }, { "disabled": false, "description": { "content": "ISO country code for the correct agreeements", "type": "text/plain" }, "key": "country", "value": "GB" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "063ca75b-587e-4e44-9bb0-7ff05129af52", "name": "Successful operation", "originalRequest": { "url": { "path": [ "api", "v1", "agreement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of product, currently only `embedded`.", "type": "text/plain" }, "key": "product", "value": "" }, { "disabled": false, "description": { "content": "ISO country code for the correct agreeements", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"declinable\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"privacyPolicyDescription\": \"\",\n \"privacyPolicyName\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"reference\": \"\",\n \"url\": \"\"\n },\n {\n \"declinable\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"privacyPolicyDescription\": \"\",\n \"privacyPolicyName\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"reference\": \"\",\n \"url\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26dead22-2d74-4e97-b34e-a3aa3da0889c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "agreement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of product, currently only `embedded`.", "type": "text/plain" }, "key": "product", "value": "" }, { "disabled": false, "description": { "content": "ISO country code for the correct agreeements", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aef4ff67-bf41-4d82-91a6-9e96f575b216", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v1", "agreement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of product, currently only `embedded`.", "type": "text/plain" }, "key": "product", "value": "" }, { "disabled": false, "description": { "content": "ISO country code for the correct agreeements", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Integrate Questionnaires", "description": "", "item": [ { "id": "f509030c-5c0d-4963-98e4-81c2d65a6087", "name": "Get Questionnaire Definition", "request": { "name": "Get Questionnaire Definition", "description": { "content": "Fetches quiestionnaire schemas with questions, answer types, option lists. You can render the questionnaire in your UI. \n\n Questionnaires include the following sections:
  • **Nature of Business**: mandatory details related to company operations)
  • **Document Requirements**: key compliance documents
", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", "questionnaire", "definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "One or several questionnaire identifiers. Each code covers [Baseline](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses#/baseline-requirements) and [Industry-specific](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses#/vertical-specific-requirements) requirements.", "type": "text/plain" }, "key": "codes", "value": "financialServicesQuestionnaireFull" }, { "disabled": false, "description": { "content": "One or several questionnaire identifiers. Each code covers [Baseline](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses#/baseline-requirements) and [Industry-specific](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses#/vertical-specific-requirements) requirements.", "type": "text/plain" }, "key": "codes", "value": "financialServicesQuestionnaireFull" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8ccb983a-821b-439c-997f-0014cf79627c", "name": "Array of questionnaire schema objects.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "questionnaire", "definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "One or several questionnaire identifiers. Each code covers [Baseline](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses#/baseline-requirements) and [Industry-specific](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses#/vertical-specific-requirements) requirements.", "type": "text/plain" }, "key": "codes", "value": "financialServicesQuestionnaireFull" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"eddQuestionnaire\",\n \"title\": \"\",\n \"sections\": [\n {\n \"code\": \"\",\n \"title\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"title\": \"\",\n \"type\": \"textInput\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"title\": \"\",\n \"type\": \"selectDropdown\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"code\": \"\",\n \"title\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"title\": \"\",\n \"type\": \"textInput\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"title\": \"\",\n \"type\": \"textArea\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"description\": \"\"\n },\n {\n \"code\": \"otherQuestionnaireFull\",\n \"title\": \"\",\n \"sections\": [\n {\n \"code\": \"\",\n \"title\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"title\": \"\",\n \"type\": \"fileAttachment\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"title\": \"\",\n \"type\": \"textInput\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"code\": \"\",\n \"title\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"title\": \"\",\n \"type\": \"textInput\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"title\": \"\",\n \"type\": \"fileAttachment\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\",\n \"score\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"description\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e1415c2-59d4-4d68-92f6-2242fa35288c", "name": "Invalid or missing `codes` parameter.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "questionnaire", "definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "One or several questionnaire identifiers. Each code covers [Baseline](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses#/baseline-requirements) and [Industry-specific](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses#/vertical-specific-requirements) requirements.", "type": "text/plain" }, "key": "codes", "value": "financialServicesQuestionnaireFull" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95c15c47-12cc-47f9-9be5-1e10eac87168", "name": "Submit Questionnaire", "request": { "name": "Submit Questionnaire", "description": { "content": "Submit questionnaire answers provided by EPCs. BVNK validates completeness asynchronously and transitions the customer to the next onboarding state when all required answers are present. In case some answers are missing, BVNK specifies them and waits for all the answers to be submitted", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", ":customerReference", "questionnaires" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "52ec68a9-1ff1-4b7c-a8b5-0630de484e42", "key": "customerReference", "disabled": false, "description": { "content": "(Required) Unique EPC reference (UUID or other immutable identifier) returned when the customer was created.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"gamblingQuestionnaireFull\",\n \"sections\": [\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "054d82cb-ace3-481f-8469-29de1c81c5ef", "name": "Submission accepted.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference", "questionnaires" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"gamblingQuestionnaireFull\",\n \"sections\": [\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f82ae2-a198-492b-96e7-0359a99c2d8a", "name": "Validation error (e.g., unknown codes, missing required answers).", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference", "questionnaires" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"gamblingQuestionnaireFull\",\n \"sections\": [\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3cca970c-6973-413a-b0db-06d192f0d95f", "name": "Customer reference not found.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", ":customerReference", "questionnaires" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"gamblingQuestionnaireFull\",\n \"sections\": [\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a901d46-cd16-4475-98b2-ca334cc85b91", "name": "Search Questionnaire Submissions", "request": { "name": "Search Questionnaire Submissions", "description": { "content": "Returns previously submitted questionnaire answer sets matching the supplied filters", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "customers", "questionnaires" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) EPC customer reference used when the questionnaire was submitted.", "type": "text/plain" }, "key": "customerReference", "value": "example" }, { "disabled": false, "description": { "content": "One or more questionnaire codes to include (comma-separated).", "type": "text/plain" }, "key": "codes", "value": "financialServicesQuestionnaireFull" }, { "disabled": false, "description": { "content": "One or more questionnaire codes to include (comma-separated).", "type": "text/plain" }, "key": "codes", "value": "otherQuestionnaireFull" }, { "disabled": false, "description": { "content": "One or more validation states to filter by.", "type": "text/plain" }, "key": "statuses", "value": "OK" }, { "disabled": false, "description": { "content": "One or more validation states to filter by.", "type": "text/plain" }, "key": "statuses", "value": "NOK" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4db79790-cffd-4657-b6ec-42c45a124df5", "name": "Array of questionnaire submissions that meet the criteria.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "questionnaires" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) EPC customer reference used when the questionnaire was submitted.", "type": "text/plain" }, "key": "customerReference", "value": "" }, { "disabled": false, "description": { "content": "One or more questionnaire codes to include (comma-separated).", "type": "text/plain" }, "key": "codes", "value": "otherQuestionnaireFull" }, { "disabled": false, "description": { "content": "One or more validation states to filter by.", "type": "text/plain" }, "key": "statuses", "value": "NOK" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"customerReference\": \"\",\n \"questionnaireCode\": \"fintechsQuestionnaireFull\",\n \"status\": \"INIT\",\n \"submittedDate\": \"\",\n \"sections\": [\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"customerReference\": \"\",\n \"questionnaireCode\": \"eddQuestionnaire\",\n \"status\": \"NOK\",\n \"submittedDate\": \"\",\n \"sections\": [\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"items\": [\n {\n \"code\": \"\",\n \"value\": \"\"\n },\n {\n \"code\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0aeb28f-9f03-4919-a921-c2f11f47f3d4", "name": "Missing `customerReference` parameter.", "originalRequest": { "url": { "path": [ "platform", "v1", "customers", "questionnaires" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) EPC customer reference used when the questionnaire was submitted.", "type": "text/plain" }, "key": "customerReference", "value": "" }, { "disabled": false, "description": { "content": "One or more questionnaire codes to include (comma-separated).", "type": "text/plain" }, "key": "codes", "value": "otherQuestionnaireFull" }, { "disabled": false, "description": { "content": "One or more validation states to filter by.", "type": "text/plain" }, "key": "statuses", "value": "NOK" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "Wallets", "description": "", "item": [ { "id": "04a1746a-bc88-4e4f-99a1-8fd6b463ed2f", "name": "Create Wallet", "request": { "name": "Create Wallet", "description": { "content": "Creates a wallet on the BVNK platform.\n\n**šŸ“‹ Example Use Case:** Create an ETH wallet", "type": "text/plain" }, "url": { "path": [ "api", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"ETH\",\n \"description\": \"My 2nd ETH Wallet\"\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "2d7964bd-3765-4158-ac84-35b29220a2db", "name": "Created", "originalRequest": { "url": { "path": [ "api", "wallet" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"address\": \"\",\n \"approxAvailable\": \"\",\n \"approxBalance\": \"\",\n \"available\": \"\",\n \"balance\": \"\",\n \"convertedAvailable\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"custodianWallet\": null,\n \"depositFee\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"isEmoney\": false,\n \"lookup\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"supportsDeposits\": true,\n \"supportsThirdParty\": false,\n \"supportsWithdrawals\": true,\n \"withdrawalFee\": \"\",\n \"supportsInternalBvnkNetworkTransfers\": false,\n \"partner\": \"\",\n \"supportedTransferDestinations\": [\n \"\",\n \"\"\n ],\n \"approxConvertedAvailable\": \"\",\n \"lsid\": \"\",\n \"status\": \"ACTIVE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3d1804c-4513-4fd7-87b7-f48a1693ab5d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a0b7fa7-3c15-4976-a546-6092bed300df", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "wallet" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5e5adf7-e7b2-4935-bcfa-798992a18d50", "name": "List Wallets", "request": { "name": "List Wallets", "description": { "content": "Retrieves a list of wallets on your account. Displays the first 10 wallets without max set to higher", "type": "text/plain" }, "url": { "path": [ "api", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Starting point for pagination, used instead of `page. Useful for cursor-based pagination.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3c0a18c4-0212-4698-82ed-0ca43000515a", "name": "OK", "originalRequest": { "url": { "path": [ "api", "wallet" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Starting point for pagination, used instead of `page. Useful for cursor-based pagination.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"address\": \"\",\n \"approxAvailable\": \"\",\n \"approxBalance\": \"\",\n \"available\": \"\",\n \"balance\": \"\",\n \"convertedAvailable\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"custodianWallet\": null,\n \"depositFee\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"isEmoney\": false,\n \"lookup\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"supportsDeposits\": true,\n \"supportsThirdParty\": false,\n \"supportsWithdrawals\": true,\n \"withdrawalFee\": \"\",\n \"supportsInternalBvnkNetworkTransfers\": false,\n \"partner\": \"\",\n \"supportedTransferDestinations\": [\n \"\",\n \"\"\n ],\n \"approxConvertedAvailable\": \"\",\n \"lsid\": \"\",\n \"status\": \"INACTIVE\"\n },\n {\n \"address\": \"\",\n \"approxAvailable\": \"\",\n \"approxBalance\": \"\",\n \"available\": \"\",\n \"balance\": \"\",\n \"convertedAvailable\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"custodianWallet\": null,\n \"depositFee\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"isEmoney\": false,\n \"lookup\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"supportsDeposits\": true,\n \"supportsThirdParty\": false,\n \"supportsWithdrawals\": true,\n \"withdrawalFee\": \"\",\n \"supportsInternalBvnkNetworkTransfers\": false,\n \"partner\": \"\",\n \"supportedTransferDestinations\": [\n \"\",\n \"\"\n ],\n \"approxConvertedAvailable\": \"\",\n \"lsid\": \"\",\n \"status\": \"INACTIVE\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80502556-746d-496b-941d-ba46fddf1b81", "name": "Get Wallet", "request": { "name": "Get Wallet", "description": { "content": "Retrieves a specific wallet by its ID", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "a:24092328494070:G5i4XZ9:1", "key": "id", "disabled": false, "description": { "content": "(Required) The ID of the wallet that you want to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "82acd0b8-7855-4b74-a5eb-e8e85a3b08d3", "name": "OK", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"accountReference\": \"\",\n \"customerReference\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\",\n \"balance\": {\n \"value\": \"\",\n \"currencyCode\": \"TRX\"\n },\n \"ledgers\": [\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n },\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n }\n ],\n \"capabilities\": \"SAFEGUARDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "128b606a-f054-4cdf-9e53-f86be76c4f94", "name": "Not found.", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3fa5d20f-da55-4d43-b107-57413b18f3eb", "name": "List Wallet Balances", "request": { "name": "List Wallet Balances", "description": { "content": "Retrieves the balances of your wallets on platform.", "type": "text/plain" }, "url": { "path": [ "api", "wallet", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Date at to retrieve balances.", "type": "text/plain" }, "key": "date", "value": "example" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e07b4d81-bda9-4334-85e1-65f921963c0e", "name": "OK", "originalRequest": { "url": { "path": [ "api", "wallet", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Date at to retrieve balances.", "type": "text/plain" }, "key": "date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"currency\": {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"walletId\": \"\",\n \"available\": \"\",\n \"reserved\": \"\",\n \"convertedAvailable\": \"\",\n \"convertedReserved\": \"\",\n \"total\": \"\"\n },\n {\n \"currency\": {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"walletId\": \"\",\n \"available\": \"\",\n \"reserved\": \"\",\n \"convertedAvailable\": \"\",\n \"convertedReserved\": \"\",\n \"total\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62b71945-eda8-4936-b267-6fa34fcd6f0e", "name": "List Transactions", "request": { "name": "List Transactions", "description": { "content": "Retrieves a paginated list of transactions for a specific wallet. Supports filtering by `walletId` and optional date range.\n\nThe date range can be applied to the `createdAt` or `updatedAt` timestamp, determined by the `filterMode`. If omitted, the `filterMode` defaults to `CREATED_AT`.\n\nRefer to the [Fiat payments guide](https://docs.bvnk.com/docs/listing-transactions).", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the wallet to filter related transactions.", "type": "text/plain" }, "key": "walletId", "value": "a:24022637884682:hxhalPr:1" }, { "disabled": false, "description": { "content": "Comma-separated list of statuses to filter by (`statuses=COMPLETED,CANCELLED`).", "type": "text/plain" }, "key": "statuses", "value": "COMPLETED,PENDING_APPROVAL" }, { "disabled": false, "description": { "content": "Page number for pagination. Starts from 0.", "type": "text/plain" }, "key": "page", "value": "0" }, { "disabled": false, "description": { "content": "Number of items to return per page.", "type": "text/plain" }, "key": "size", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filterMode", "value": "UPDATED_AT" }, { "disabled": false, "description": { "content": "Start date-time filter (inclusive). Format: ISO8601.", "type": "text/plain" }, "key": "start", "value": "2025-04-30T12:27:40Z" }, { "disabled": false, "description": { "content": "End date-time filter (inclusive). Format: ISO8601.", "type": "text/plain" }, "key": "end", "value": "2025-05-30T12:27:40Z" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "33b2f2b9-de86-47b5-948c-741d1e250659", "name": "Paginated list of transactions", "originalRequest": { "url": { "path": [ "ledger", "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Unique identifier for the wallet to filter related transactions.", "type": "text/plain" }, "key": "walletId", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of statuses to filter by (`statuses=COMPLETED,CANCELLED`).", "type": "text/plain" }, "key": "statuses", "value": "COMPLETED,PENDING_APPROVAL" }, { "disabled": false, "description": { "content": "Page number for pagination. Starts from 0.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of items to return per page.", "type": "text/plain" }, "key": "size", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filterMode", "value": "UPDATED_AT" }, { "disabled": false, "description": { "content": "Start date-time filter (inclusive). Format: ISO8601.", "type": "text/plain" }, "key": "start", "value": "" }, { "disabled": false, "description": { "content": "End date-time filter (inclusive). Format: ISO8601.", "type": "text/plain" }, "key": "end", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"transactionId\": \"\",\n \"paymentId\": \"\",\n \"paymentReference\": \"\",\n \"type\": \"reversal\",\n \"status\": \"EXPIRED\",\n \"amount\": {\n \"value\": \"\",\n \"currencyCode\": \"USD\"\n },\n \"runningBalance\": {\n \"value\": \"\",\n \"currencyCode\": \"GBP\"\n },\n \"originator\": {\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n },\n \"walletId\": \"\"\n },\n \"beneficiary\": {\n \"entity\": {\n \"type\": \"COMPANY\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"walletId\": \"\"\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n }\n },\n \"details\": {\n \"paymentMethod\": \"FEDWIRE\",\n \"fxRate\": {\n \"baseCurrency\": \"\",\n \"counterCurrency\": \"\",\n \"merchantFxRate\": \"\",\n \"baseFxRate\": \"\",\n \"merchantSpread\": \"\"\n },\n \"complianceDetail\": {\n \"quisa\": \"sit mollit\",\n \"anim_bb\": false\n },\n \"hash\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"paymentId\": \"\",\n \"paymentReference\": \"\",\n \"type\": \"paymentOut\",\n \"status\": \"EXPIRED\",\n \"amount\": {\n \"value\": \"\",\n \"currencyCode\": \"GBP\"\n },\n \"runningBalance\": {\n \"value\": \"\",\n \"currencyCode\": \"GBP\"\n },\n \"originator\": {\n \"entity\": {\n \"type\": \"COMPANY\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n },\n \"walletId\": \"\"\n },\n \"beneficiary\": {\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"walletId\": \"\"\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bankCode\": \"\"\n }\n },\n \"details\": {\n \"paymentMethod\": \"ACH\",\n \"fxRate\": {\n \"baseCurrency\": \"\",\n \"counterCurrency\": \"\",\n \"merchantFxRate\": \"\",\n \"baseFxRate\": \"\",\n \"merchantSpread\": \"\"\n },\n \"complianceDetail\": {\n \"veniam_656\": 85906366,\n \"officiac5\": \"culpa anim\"\n },\n \"hash\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"pageable\": {\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"offset\": \"\",\n \"paged\": \"\",\n \"unpaged\": \"\"\n },\n \"last\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\",\n \"first\": \"\",\n \"size\": \"\",\n \"number\": \"\",\n \"sort\": [\n \"\",\n \"\"\n ],\n \"numberOfElements\": \"\",\n \"empty\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b227c73e-377d-4499-8bcb-f35cbb1cfb9f", "name": "Transactions Report", "request": { "name": "Transactions Report", "description": { "content": "Creates a report of all transactions from a wallet in the specified format and sends it via the preferred delivery method: WEBHOOK or EMAIL.\n\n**Note**: Reports are delivered instantly but the data has a one-hour lag for Production environment and eight-hour delay in sandbox. For example, a report requested at 9:00 AM will include transactions only up to 8:00 AM.\n\nSee the [Receive Transactions Report via Webhook](https://docs.bvnk.com/docs/receive-transaction-history-report-via-webhook) guide for more information.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Request a JSON transaction report delivered via email:**\n1. **Request a JSON transaction report delivered via email**\n\n**Request a CSV transaction report delivered via webhook:**\n1. **Request a CSV transaction report delivered via webhook**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"a:24092328494070:G5i4XZ9:1\",\n \"from\": \"2024-01-15T00:00:00Z\",\n \"to\": \"2024-12-31T23:59:59Z\",\n \"format\": \"JSON\",\n \"deliveryChannel\": \"EMAIL\",\n \"type\": \"TRANSACTION\"\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "5116b675-676e-437a-a8bb-c0e306c8d190", "name": "PROCESSING", "originalRequest": { "url": { "path": [ "ledger", "v1", "reports" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"format\": \"CSV\",\n \"deliveryChannel\": \"EMAIL\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"uuid\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"expiryDate\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"requestData\": {\n \"type\": \"\",\n \"externalProcessing\": \"\",\n \"walletId\": \"\",\n \"transactionType\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"format\": \"\",\n \"languageTag\": \"\",\n \"category\": \"\",\n \"accountName\": \"\",\n \"include\": \"\",\n \"exclude\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uuid\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"expiryDate\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"requestData\": {\n \"type\": \"\",\n \"externalProcessing\": \"\",\n \"walletId\": \"\",\n \"transactionType\": \"\",\n \"fromDate\": \"\",\n \"toDate\": \"\",\n \"format\": \"\",\n \"languageTag\": \"\",\n \"category\": \"\",\n \"accountName\": \"\",\n \"include\": \"\",\n \"exclude\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d2afce4-c765-40e6-97a6-1d6a14458c8e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "ledger", "v1", "reports" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"format\": \"CSV\",\n \"deliveryChannel\": \"EMAIL\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Fees", "description": "", "item": [ { "id": "e9bfd491-d27d-4f81-8fdf-84aff14bc7ca", "name": "Get Customer Fee Wallets", "request": { "name": "Get Customer Fee Wallets", "description": { "content": "Retrieves the list of available wallets that can receive customer fees.\n\nFor more information, refer to [Customer fees](https://docs.bvnk.com/docs/charge-customer-fees#/).", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "fees", "customer-fee-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cc404f2c-c260-4800-90de-920f2466034b", "name": "Successfully retrieved customer fee wallets", "originalRequest": { "url": { "path": [ "platform", "v1", "fees", "customer-fee-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"customerFeeWallets\": [\n {\n \"currency\": \"\",\n \"destinationWalletId\": \"\",\n \"pageable\": {\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"offset\": \"\",\n \"paged\": \"\",\n \"unpaged\": \"\"\n },\n \"last\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\",\n \"first\": \"\",\n \"size\": \"\",\n \"number\": \"\",\n \"sort\": [\n \"\",\n \"\"\n ],\n \"numberOfElements\": \"\",\n \"empty\": \"\"\n },\n {\n \"currency\": \"\",\n \"destinationWalletId\": \"\",\n \"pageable\": {\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"offset\": \"\",\n \"paged\": \"\",\n \"unpaged\": \"\"\n },\n \"last\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\",\n \"first\": \"\",\n \"size\": \"\",\n \"number\": \"\",\n \"sort\": [\n \"\",\n \"\"\n ],\n \"numberOfElements\": \"\",\n \"empty\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49228e7f-1ac5-4e3a-9f61-822a538d727a", "name": "Forbidden - Authorization token not found", "originalRequest": { "url": { "path": [ "platform", "v1", "fees", "customer-fee-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb9c9b3e-6274-4435-8f3c-6aafa354d4b1", "name": "Set Wallet for Customer Fees", "request": { "name": "Set Wallet for Customer Fees", "description": { "content": "Sets up the customer fee wallet for a specific currency. The customer fee wallet is where the collected customer fees will be credited when processing transactions. For more information, refer to [Customer fees](https://docs.bvnk.com/docs/charge-customer-fees#/).\n\n**šŸ“‹ Example Use Case:** Set the EUR fee wallet for customer fees", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "fees", "customer-fee-wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"EUR\",\n \"destinationWalletId\": \"a:25022552887731:z261S0y:1\"\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "dce4dbd4-9072-401b-bcf8-fb1436b7d895", "name": "Successfully retrieved customer fee wallets", "originalRequest": { "url": { "path": [ "platform", "v1", "fees", "customer-fee-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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"destinationWalletId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"customerFeeWallets\": [\n {\n \"currency\": \"\",\n \"destinationWalletId\": \"\"\n },\n {\n \"currency\": \"\",\n \"destinationWalletId\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46163429-cd3c-4322-be21-f8fac4b4cb57", "name": "Forbidden - Authorization token not found", "originalRequest": { "url": { "path": [ "platform", "v1", "fees", "customer-fee-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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"destinationWalletId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "305092be-0e8f-4e02-be47-1339354fbc5a", "name": "Not Found - Wallet not found", "originalRequest": { "url": { "path": [ "platform", "v1", "fees", "customer-fee-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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"destinationWalletId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2471e455-0fec-4ab7-9f72-8b95a25d9670", "name": "Unprocessable Entity - Invalid input parameters", "originalRequest": { "url": { "path": [ "platform", "v1", "fees", "customer-fee-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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"destinationWalletId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Reports", "description": "", "item": [ { "id": "61adc54e-392f-43a3-a7b4-ca256a31cec8", "name": "List Report Schedules", "request": { "name": "List Report Schedules", "description": { "content": "Retrieves a paginated list of report schedules for the authenticated user's account. Returns all schedules created by the user with their current configuration and delivery preferences.", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "report-schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination (0-based)", "type": "text/plain" }, "key": "page", "value": "0" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bfd7e5f8-4ddd-420d-a85e-eb061bdd2f4a", "name": "Report schedules retrieved successfully", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination (0-based)", "type": "text/plain" }, "key": "page", "value": "0" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"id\": \"\",\n \"createdBy\": \"\",\n \"accountReference\": \"\",\n \"time\": \"\",\n \"timezone\": \"\",\n \"frequencyType\": \"DAILY\",\n \"frequencyDay\": \"\",\n \"format\": \"JSON\",\n \"channel\": \"EMAIL\",\n \"email\": \"\",\n \"reportType\": \"SUMMARY\"\n },\n {\n \"id\": \"\",\n \"createdBy\": \"\",\n \"accountReference\": \"\",\n \"time\": \"\",\n \"timezone\": \"\",\n \"frequencyType\": \"WEEKLY\",\n \"frequencyDay\": \"\",\n \"format\": \"PDF\",\n \"channel\": \"WEBHOOK\",\n \"email\": \"\",\n \"reportType\": \"BALANCE\"\n }\n ],\n \"pageable\": {\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"sort\": [\n \"\",\n \"\"\n ],\n \"offset\": \"\",\n \"paged\": \"\",\n \"unpaged\": \"\"\n },\n \"last\": \"\",\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"first\": \"\",\n \"size\": \"\",\n \"number\": \"\",\n \"sort\": [\n \"\",\n \"\"\n ],\n \"numberOfElements\": \"\",\n \"empty\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "badaabc5-e1b9-4ffe-8699-1ce03bec3f24", "name": "Bad request - Invalid query parameters", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination (0-based)", "type": "text/plain" }, "key": "page", "value": "0" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"exercitation24f\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "355f9594-c2e6-49d6-a3a5-f043bc0c0ae7", "name": "Create Report Schedule", "request": { "name": "Create Report Schedule", "description": { "content": "Creates a new scheduled report that will be automatically generated and delivered according to the specified frequency and delivery preferences. Each user can create only one schedule per account.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Daily report via webhook:**\n1. **Daily report via webhook**\n\n**Weekly report via email:**\n1. **Weekly report via email**\n\n**Monthly report on 15th day:**\n1. **Monthly report on 15th day**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "report-schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"time\": \"12:00\",\n \"timezone\": \"Europe/London\",\n \"frequencyType\": \"DAILY\",\n \"frequencyDay\": 1,\n \"format\": \"CSV\",\n \"channel\": \"webhook\",\n \"reportParams\": {\n \"reportType\": \"TRANSACTION\",\n \"walletId\": \"a:02502251969431:yyDut96:1\"\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "b1e313d3-af46-4fe4-a9b7-fc8e7f810daf", "name": "Report schedule created successfully", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"time\": \"20:34\",\n \"timezone\": \"\",\n \"frequencyType\": \"WEEKLY\",\n \"format\": \"PDF\",\n \"channel\": \"webhook\",\n \"reportParams\": {\n \"reportType\": \"PAYMENT\",\n \"walletId\": \"\"\n },\n \"frequencyDay\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"createdBy\": \"\",\n \"name\": \"\",\n \"accountReference\": \"\",\n \"time\": \"\",\n \"timezone\": \"\",\n \"frequencyType\": \"DAILY\",\n \"frequencyDay\": \"\",\n \"format\": \"JSON\",\n \"channel\": \"EMAIL\",\n \"email\": \"\",\n \"reportParams\": {\n \"reportType\": \"TRANSACTION\",\n \"walletId\": \"\"\n },\n \"createdAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7495a97b-65af-4e06-8dbf-ddbfedb9f7a2", "name": "Bad request - Invalid input parameters", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"time\": \"20:34\",\n \"timezone\": \"\",\n \"frequencyType\": \"WEEKLY\",\n \"format\": \"PDF\",\n \"channel\": \"webhook\",\n \"reportParams\": {\n \"reportType\": \"PAYMENT\",\n \"walletId\": \"\"\n },\n \"frequencyDay\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"exercitation24f\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15172347-303f-4a25-8786-6903c5b5ee23", "name": "Conflict - Report schedule already exists for this user", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"time\": \"20:34\",\n \"timezone\": \"\",\n \"frequencyType\": \"WEEKLY\",\n \"format\": \"PDF\",\n \"channel\": \"webhook\",\n \"reportParams\": {\n \"reportType\": \"PAYMENT\",\n \"walletId\": \"\"\n },\n \"frequencyDay\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51772f70-479a-49d9-9c26-b558f9b11c5d", "name": "Get Supported Timezones", "request": { "name": "Get Supported Timezones", "description": { "content": "Retrieves a list of all supported timezones that can be used when creating or updating report schedules. Each timezone includes both the IANA timezone identifier and a human-readable label with UTC offset.", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "report-schedules", "timezones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b4487e12-59cc-468e-88b9-91e877ede887", "name": "Supported timezones retrieved successfully", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules", "timezones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"zoneId\": \"\",\n \"label\": \"\"\n },\n {\n \"zoneId\": \"\",\n \"label\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11f4f62c-3409-437c-9fe7-ab20bfc880ff", "name": "Update Existing Report Schedule", "request": { "name": "Update Existing Report Schedule", "description": { "content": "Updates an existing scheduled report with new frequency and delivery preferences. Only the user who created the schedule can update it.", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "report-schedules", ":scheduleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3afd38a6-fc31-4775-87e0-eaa556447825", "key": "scheduleId", "disabled": false, "description": { "content": "(Required) Unique identifier of the report schedule to update.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"time\": \"14:00\",\n \"timezone\": \"Europe/London\",\n \"frequencyType\": \"DAILY\",\n \"format\": \"CSV\",\n \"channel\": \"webhook\",\n \"frequencyDay\": 1,\n \"email\": \"test@example.com\",\n \"reportParams\": {\n \"reportType\": \"TRANSACTION\",\n \"walletId\": \"a:02502251969431:yyDut96:1\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d4e5cdd3-a6c8-4cb3-a2b9-3e2802b4cd9c", "name": "Report schedule updated successfully", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules", ":scheduleId" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"time\": \"22:50\",\n \"timezone\": \"\",\n \"frequencyType\": \"WEEKLY\",\n \"format\": \"JSON\",\n \"channel\": \"webhook\",\n \"frequencyDay\": \"\",\n \"email\": \"\",\n \"reportParams\": {\n \"reportType\": \"DIGITAL_ASSETS_VOLUME\",\n \"walletId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"createdBy\": \"\",\n \"name\": \"\",\n \"accountReference\": \"\",\n \"time\": \"\",\n \"timezone\": \"\",\n \"frequencyType\": \"DAILY\",\n \"frequencyDay\": \"\",\n \"format\": \"JSON\",\n \"channel\": \"WEBHOOK\",\n \"email\": \"\",\n \"reportParams\": {\n \"reportType\": \"TRANSACTION\",\n \"walletId\": \"\"\n },\n \"createdAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cfb79ea-2155-4d22-9a4f-74622c741c27", "name": "Bad request - Invalid input parameters", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules", ":scheduleId" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"time\": \"22:50\",\n \"timezone\": \"\",\n \"frequencyType\": \"WEEKLY\",\n \"format\": \"JSON\",\n \"channel\": \"webhook\",\n \"frequencyDay\": \"\",\n \"email\": \"\",\n \"reportParams\": {\n \"reportType\": \"DIGITAL_ASSETS_VOLUME\",\n \"walletId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"exercitation24f\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b83660c3-5e8e-4694-8d95-c561318136e3", "name": "Delete Report Schedule", "request": { "name": "Delete Report Schedule", "description": { "content": "Deletes an existing report schedule. Only the user who created the schedule can delete it. Once deleted, no further reports will be generated according to this schedule.", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "report-schedules", ":scheduleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3afd38a6-fc31-4775-87e0-eaa556447825", "key": "scheduleId", "disabled": false, "description": { "content": "(Required) Unique identifier of the report schedule to delete.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null, "header": [] }, "response": [ { "id": "c652d1b3-e5d1-40b6-84ac-200bfcc1f39d", "name": "Report schedule deleted successfully - No content returned", "originalRequest": { "url": { "path": [ "ledger", "v1", "report-schedules", ":scheduleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "Crypto Payments", "description": "", "item": [ { "name": "Estimate Payment", "description": "", "item": [ { "id": "e90d17fd-32ed-40be-bba5-c196cb88488c", "name": "Create an Estimate Payout", "request": { "name": "Create an Estimate Payout", "description": { "content": "Retrieves latest exchange rates, fees and network costs for a crypto payout without creating an actual payout. Provide either `walletRequiredAmount` (amount to send) or `paidRequiredAmount` (amount the recipient should receive). See the [Estimate Crypto Payouts](https://docs.bvnk.com/docs/estimate-crypto-payouts#/) guide for details.\n\n**šŸ“‹ Example Use Case:** Sample estimate request", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", "estimate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"a:24072237783989:Unkx9kW:1\",\n \"walletCurrency\": \"USD\",\n \"paidRequiredAmount\": 15,\n \"paidCurrency\": \"USDT\",\n \"reference\": \"REF46730\",\n \"network\": \"ETHEREUM\",\n \"complianceDetails\": {\n \"requesterIpAddress\": \"172.16.254.1\",\n \"partyDetails\": []\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "e699b752-316a-4893-868f-067cfa2881a4", "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletRequiredAmount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"walletId\": \"\",\n \"customerReference\": \"\",\n \"walletCurrency\": \"\",\n \"walletRequiredAmount\": \"\",\n \"paidCurrency\": \"\",\n \"paidRequiredAmount\": \"\",\n \"feeCurrency\": \"\",\n \"feePredictedAmount\": \"\",\n \"networkFeeCurrency\": \"\",\n \"networkFeePredictedAmount\": \"\",\n \"totalWalletAmount\": \"\",\n \"exchangeRate\": \"\",\n \"customerId\": \"\",\n \"paymentExternalId\": \"\",\n \"network\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a47620-b084-4a1d-9c3b-f4e6620a4800", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletRequiredAmount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "707741bf-12b9-452e-aa63-c2c9f3a8f8fd", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletRequiredAmount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17749d13-eb0f-4dc7-9849-b260312ed3fd", "name": "Update an Existing Estimate Payout", "request": { "name": "Update an Existing Estimate Payout", "description": { "content": "Refreshes the quote using the latest exchange rates and fees. Call periodically (e.g., every 30 seconds) with either `walletRequiredAmount` or `paidRequiredAmount` to recalculate the other.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "externalId", "disabled": false, "description": { "content": "(Required) The ID of the estimate payout.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"reference\": \"test-ref-123\",\n \"walletRequiredAmount\": 2000,\n \"paidRequiredAmount\": 3823.23,\n \"complianceDetails\": {\n \"partyDetails\": [],\n \"requesterIpAddress\": \"192.168.1.1\",\n \"contactId\": \"1b083898-73ca-42ba-b433-7dc20ea67667\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "02a79ed8-12f4-424e-a3da-36720986f2e7", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "update" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"walletRequiredAmount\": \"eiusmod nulla\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"externalId\": \"\",\n \"accountId\": \"\",\n \"walletId\": \"\",\n \"customerReference\": \"\",\n \"walletCurrency\": \"\",\n \"walletRequiredAmount\": \"\",\n \"paidCurrency\": \"\",\n \"paidRequiredAmount\": \"\",\n \"feeCurrency\": \"\",\n \"feePredictedAmount\": \"\",\n \"networkFeeCurrency\": \"\",\n \"networkFeePredictedAmount\": \"\",\n \"totalWalletAmount\": \"\",\n \"exchangeRate\": \"\",\n \"customerId\": \"\",\n \"paymentExternalId\": \"\",\n \"network\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b705fc18-eb74-4b2d-80c0-6fbd0af132ac", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "update" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"walletRequiredAmount\": \"eiusmod nulla\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0d31e57-fe6b-4a36-ba9a-557b57c57da1", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "update" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"walletRequiredAmount\": \"eiusmod nulla\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9441bd22-0cc7-4f59-bfb7-324ab9ee8320", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "update" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"walletRequiredAmount\": \"eiusmod nulla\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c729175-3c1c-4976-aa34-5d20ad9a1907", "name": "Accept an Estimated Payout", "request": { "name": "Accept an Estimated Payout", "description": { "content": "Accepts the current estimate and converts it into a pending crypto payment.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "externalId", "disabled": false, "description": { "content": "(Required) The ID of the estimate payout to accept.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"9e9bb7cb-f5d4-4f7b-bada-6ad156f3a8d8\",\n \"payOutDetails\": {\n \"currency\": \"USD\",\n \"address\": \"0xb794f5ea0ba39494ce839613fffba74279579268\",\n \"network\": \"TRON\",\n \"tag\": \"\"\n },\n \"complianceDetails\": {\n \"partyDetails\": [],\n \"requesterIpAddress\": \"192.168.1.1\",\n \"contactId\": \"1b083898-73ca-42ba-b433-7dc20ea67667\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2a66144c-29f5-4f8c-9bc5-f53d91a54b33", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "accept" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"payOutDetails\": {\n \"currency\": \"pp\",\n \"address\": \"leWwQyF18UK\",\n \"network\": \"BITCOIN\",\n \"tag\": \"O0yrIneDT\"\n },\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"\",\n \"merchantDisplayName\": \"\",\n \"walletId\": \"\",\n \"dateCreated\": \"\",\n \"expiryDate\": \"\",\n \"quoteExpiryDate\": \"\",\n \"acceptanceExpiryDate\": \"\",\n \"quoteStatus\": \"\",\n \"reference\": \"\",\n \"type\": \"IN\",\n \"subType\": \"merchantPayOut\",\n \"status\": \"EXPIRED\",\n \"displayCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"walletCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"paidCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"feeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"address\": {\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ]\n },\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\",\n \"transactions\": [\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n },\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n }\n ],\n \"refund\": {},\n \"currencyOptions\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"networkFeeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"flow\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eb28908-de9b-4554-90d3-a7ef3419ff24", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "accept" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"payOutDetails\": {\n \"currency\": \"pp\",\n \"address\": \"leWwQyF18UK\",\n \"network\": \"BITCOIN\",\n \"tag\": \"O0yrIneDT\"\n },\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "269ad348-64c9-43ee-807e-8e500431b89d", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "accept" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"payOutDetails\": {\n \"currency\": \"pp\",\n \"address\": \"leWwQyF18UK\",\n \"network\": \"BITCOIN\",\n \"tag\": \"O0yrIneDT\"\n },\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386d2868-f8fc-4f3b-8188-1b857daec47e", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "estimate", ":externalId", "accept" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"payOutDetails\": {\n \"currency\": \"pp\",\n \"address\": \"leWwQyF18UK\",\n \"network\": \"BITCOIN\",\n \"tag\": \"O0yrIneDT\"\n },\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09018dab-5eef-40eb-8495-045e01024104", "name": "Confirm Payment", "request": { "name": "Confirm Payment", "description": { "content": "Confirms a two-step payout.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", ":uuid", "confirm", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "5C8D8D78-366A-4AFB-B658-A64CE543C5DB", "key": "uuid", "disabled": false, "description": { "content": "(Required) The payment UUID received from [Accept an Estimate Payout](https://docs.bvnk.com/reference/payestimateaccept#/).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"complianceDetails\": {\n \"partyDetails\": [],\n \"requesterIpAddress\": \"192.168.1.1\",\n \"contactId\": \"1b083898-73ca-42ba-b433-7dc20ea67667\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "75a03110-0ae7-4921-a2e2-f7f588f28bb6", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "confirm", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"INDIVIDUAL\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"\",\n \"merchantDisplayName\": \"\",\n \"walletId\": \"\",\n \"dateCreated\": \"\",\n \"expiryDate\": \"\",\n \"quoteExpiryDate\": \"\",\n \"acceptanceExpiryDate\": \"\",\n \"quoteStatus\": \"\",\n \"reference\": \"\",\n \"type\": \"IN\",\n \"subType\": \"merchantPayOut\",\n \"status\": \"EXPIRED\",\n \"displayCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"walletCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"paidCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"feeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"address\": {\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ]\n },\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\",\n \"transactions\": [\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n },\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n }\n ],\n \"refund\": {},\n \"currencyOptions\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"networkFeeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"flow\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dd7c25f-2afb-4334-8230-619e018aef59", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "confirm", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"INDIVIDUAL\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d262ccce-2b6e-480e-8f78-7d0abde673f2", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "confirm", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"INDIVIDUAL\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "ba9225d6-efce-4e5c-afc9-bd3089ba2b22", "name": "Create Payment", "request": { "name": "Create Payment", "description": { "content": "Creates an incoming (type IN) or outcoming (type OUT) crypto payment.\n\nAlternatively, it creates a crypto payment that is either sent via a Customer's wallet or deposited into it. For more information, see the [Make Crypto Payments](https://docs.bvnk.com/docs/create-a-crypto-payout#/) guide.\n\nThere are two flows depending on specifying `payOutDetails`: \n\n - If you add `PayOutDetails` with all its child parameters, the payment is successfully created and the funds are sent to the specified wallet, with no further actions needed.\n\n - If not included in the request, in the response you receive `redirectUrl`. This is a link to a page, where to you can redirect your Customer so they can finalize the payment.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Incoming crypto payment:**\n1. **Incoming crypto payment - Ethereum**\n Use case: Customer pays in ETH to receive EUR in their wallet. The payment is converted automatically.\n2. **Incoming crypto payment - USDT (Tether)**\n Use case: Customer pays in USDT (ERC20) to receive USD. Stablecoin payment for e-commerce.\n3. **Incoming crypto payment**\n\n**Outgoing crypto payment:**\n1. **Outgoing crypto payment - Ethereum**\n Use case: Send ETH from EUR wallet to external Ethereum address. Two-step confirmation enabled for security.\n2. **Outgoing crypto payment - Bitcoin**\n Use case: Send Bitcoin from USD wallet to external Bitcoin address. Direct payout without two-step.\n3. **Outgoing crypto payment**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"a:24092328494070:G5i4XZ9:1\",\n \"amount\": 223.05,\n \"expiryMinutes\": 20,\n \"currency\": \"EUR\",\n \"returnUrl\": \"https://my-shop.com/payment-complete?ref=xyz\",\n \"reference\": \"myUniqueRef333\",\n \"customerId\": \"d063635e-0f83-4e47-a1f3-fc9484df1509\",\n \"type\": \"IN\",\n \"payInDetails\": {\n \"currency\": \"ETH\",\n \"network\": \"ETHEREUM\"\n },\n \"complianceDetails\": {\n \"requesterIpAddress\": \"172.16.254.1\",\n \"partyDetails\": [\n {\n \"type\": \"BENEFICIARY\",\n \"entityType\": \"COMPANY\",\n \"legalName\": \"BVNK LTD\",\n \"relationshipType\": \"SELF_OWNED\",\n \"countryCode\": \"GB\",\n \"registrationNumber\": \"5493001KJTIIGC8Y1R12\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "f39fc16c-5602-4c06-bf5b-816df5963624", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"type\": \"IN\",\n \"reference\": \"\",\n \"customerId\": \"\",\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n },\n \"payInDetails\": {\n \"currency\": \"\",\n \"network\": \"\",\n \"protocol\": \"\"\n },\n \"merchantId\": \"\",\n \"expiryMinutes\": \"\",\n \"returnUrl\": \"\",\n \"metadata\": {\n \"officia_a\": \"\",\n \"dolor_fe3\": \"\",\n \"labore_5\": \"\",\n \"sit8\": \"\"\n },\n \"embeddedCustomerDetails\": {\n \"reference\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"\",\n \"merchantDisplayName\": \"\",\n \"walletId\": \"\",\n \"dateCreated\": \"\",\n \"expiryDate\": \"\",\n \"quoteExpiryDate\": \"\",\n \"acceptanceExpiryDate\": \"\",\n \"quoteStatus\": \"\",\n \"reference\": \"\",\n \"type\": \"IN\",\n \"subType\": \"merchantPayOut\",\n \"status\": \"EXPIRED\",\n \"displayCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"walletCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"paidCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"feeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"address\": {\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ]\n },\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\",\n \"transactions\": [\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n },\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n }\n ],\n \"refund\": {},\n \"currencyOptions\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"networkFeeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"flow\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cba31555-e34b-4386-b3e6-f35b690cad8e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"type\": \"IN\",\n \"reference\": \"\",\n \"customerId\": \"\",\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n },\n \"payInDetails\": {\n \"currency\": \"\",\n \"network\": \"\",\n \"protocol\": \"\"\n },\n \"merchantId\": \"\",\n \"expiryMinutes\": \"\",\n \"returnUrl\": \"\",\n \"metadata\": {\n \"officia_a\": \"\",\n \"dolor_fe3\": \"\",\n \"labore_5\": \"\",\n \"sit8\": \"\"\n },\n \"embeddedCustomerDetails\": {\n \"reference\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3b2ac8f-d9e4-4d09-b241-346b8fd19089", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"type\": \"IN\",\n \"reference\": \"\",\n \"customerId\": \"\",\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n },\n \"payInDetails\": {\n \"currency\": \"\",\n \"network\": \"\",\n \"protocol\": \"\"\n },\n \"merchantId\": \"\",\n \"expiryMinutes\": \"\",\n \"returnUrl\": \"\",\n \"metadata\": {\n \"officia_a\": \"\",\n \"dolor_fe3\": \"\",\n \"labore_5\": \"\",\n \"sit8\": \"\"\n },\n \"embeddedCustomerDetails\": {\n \"reference\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e93ee14-4908-4e3a-ac2d-4f400b2b7d7a", "name": "List Payments", "request": { "name": "List Payments", "description": { "content": "Retrieves a list of payments on a specific Wallet ID.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Unique identifier of the wallet associated with the payment.", "type": "text/plain" }, "key": "walletId", "value": "acc:23040543559277:x8rvQ:0" }, { "disabled": false, "description": { "content": "**DEPRECATED: will be removed soon**. The customer reference.", "type": "text/plain" }, "key": "customerReference", "value": "REF1234" }, { "disabled": false, "description": { "content": "**DEPRECATED: will be removed soon**. The merchant payment uuid.", "type": "text/plain" }, "key": "paymentExternalId", "value": "5C8D8D78-366A-4AFB-B658-A64CE543C5DB" }, { "disabled": false, "description": { "content": "Unique identifier for the payment.", "type": "text/plain" }, "key": "uuid", "value": "3A6FAFFA-F21D-416E-B17E-2529A9BC44A0" }, { "disabled": false, "description": { "content": "Custom payment reference ID to link the payment to your customer.", "type": "text/plain" }, "key": "reference", "value": "REF767913" }, { "disabled": false, "description": { "content": "The start date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "fromDate", "value": "example" }, { "disabled": false, "description": { "content": "The end date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "toDate", "value": "example" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "COMPLETE" }, { "disabled": false, "description": { "content": "Ordering direction.", "type": "text/plain" }, "key": "order", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a4930917-9a21-483b-8814-a78253c462f9", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Unique identifier of the wallet associated with the payment.", "type": "text/plain" }, "key": "walletId", "value": "" }, { "disabled": false, "description": { "content": "**DEPRECATED: will be removed soon**. The customer reference.", "type": "text/plain" }, "key": "customerReference", "value": "" }, { "disabled": false, "description": { "content": "**DEPRECATED: will be removed soon**. The merchant payment uuid.", "type": "text/plain" }, "key": "paymentExternalId", "value": "" }, { "disabled": false, "description": { "content": "Unique identifier for the payment.", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Custom payment reference ID to link the payment to your customer.", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "The start date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "fromDate", "value": "" }, { "disabled": false, "description": { "content": "The end date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "toDate", "value": "" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "COMPLETE" }, { "disabled": false, "description": { "content": "Ordering direction.", "type": "text/plain" }, "key": "order", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"uuid\": \"\",\n \"merchantDisplayName\": \"\",\n \"walletId\": \"\",\n \"dateCreated\": \"\",\n \"expiryDate\": \"\",\n \"quoteExpiryDate\": \"\",\n \"acceptanceExpiryDate\": \"\",\n \"quoteStatus\": \"\",\n \"reference\": \"\",\n \"type\": \"IN\",\n \"subType\": \"merchantRefund\",\n \"status\": \"COMPLETE\",\n \"displayCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"walletCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"paidCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"feeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"address\": {\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ]\n },\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\",\n \"transactions\": [\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n },\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n }\n ],\n \"refund\": {},\n \"currencyOptions\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"networkFeeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"flow\": \"\"\n },\n {\n \"uuid\": \"\",\n \"merchantDisplayName\": \"\",\n \"walletId\": \"\",\n \"dateCreated\": \"\",\n \"expiryDate\": \"\",\n \"quoteExpiryDate\": \"\",\n \"acceptanceExpiryDate\": \"\",\n \"quoteStatus\": \"\",\n \"reference\": \"\",\n \"type\": \"IN\",\n \"subType\": \"merchantRefund\",\n \"status\": \"UNDERPAID\",\n \"displayCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"walletCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"paidCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"feeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"address\": {\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ]\n },\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\",\n \"transactions\": [\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n },\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n }\n ],\n \"refund\": {},\n \"currencyOptions\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"networkFeeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"flow\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "532c61e1-9eca-41e9-a154-c60f5cc221e8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Unique identifier of the wallet associated with the payment.", "type": "text/plain" }, "key": "walletId", "value": "" }, { "disabled": false, "description": { "content": "**DEPRECATED: will be removed soon**. The customer reference.", "type": "text/plain" }, "key": "customerReference", "value": "" }, { "disabled": false, "description": { "content": "**DEPRECATED: will be removed soon**. The merchant payment uuid.", "type": "text/plain" }, "key": "paymentExternalId", "value": "" }, { "disabled": false, "description": { "content": "Unique identifier for the payment.", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Custom payment reference ID to link the payment to your customer.", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "The start date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "fromDate", "value": "" }, { "disabled": false, "description": { "content": "The end date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "toDate", "value": "" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "COMPLETE" }, { "disabled": false, "description": { "content": "Ordering direction.", "type": "text/plain" }, "key": "order", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "134cedf1-9aa8-41f5-97cb-a649b950417b", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Unique identifier of the wallet associated with the payment.", "type": "text/plain" }, "key": "walletId", "value": "" }, { "disabled": false, "description": { "content": "**DEPRECATED: will be removed soon**. The customer reference.", "type": "text/plain" }, "key": "customerReference", "value": "" }, { "disabled": false, "description": { "content": "**DEPRECATED: will be removed soon**. The merchant payment uuid.", "type": "text/plain" }, "key": "paymentExternalId", "value": "" }, { "disabled": false, "description": { "content": "Unique identifier for the payment.", "type": "text/plain" }, "key": "uuid", "value": "" }, { "disabled": false, "description": { "content": "Custom payment reference ID to link the payment to your customer.", "type": "text/plain" }, "key": "reference", "value": "" }, { "disabled": false, "description": { "content": "The start date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "fromDate", "value": "" }, { "disabled": false, "description": { "content": "The end date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "toDate", "value": "" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "COMPLETE" }, { "disabled": false, "description": { "content": "Ordering direction.", "type": "text/plain" }, "key": "order", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aaa9ec7-306a-4c46-a670-8795f433f324", "name": "Update Payment", "request": { "name": "Update Payment", "description": { "content": "Updates a pending payment with currency or payout information.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", ":uuid", "update", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "5C8D8D78-366A-4AFB-B658-A64CE543C5DB", "key": "uuid", "disabled": false, "description": { "content": "(Required) The payment UUID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"payOutInstruction\": {\n \"code\": \"US\",\n \"currency\": \"USD\",\n \"address\": \"0xb794f5ea0ba39494ce839613fffba74279579268\",\n \"network\": \"ETHEREUM\",\n \"tag\": \"example\",\n \"protocol\": \"ERC20\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cddcd87e-d89c-41d1-8027-e80834f9497a", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "update", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"payOutInstruction\": {\n \"code\": \"\",\n \"currency\": \"\",\n \"address\": \"\",\n \"network\": \"\",\n \"tag\": \"\",\n \"protocol\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"\",\n \"merchantDisplayName\": \"\",\n \"walletId\": \"\",\n \"dateCreated\": \"\",\n \"expiryDate\": \"\",\n \"quoteExpiryDate\": \"\",\n \"acceptanceExpiryDate\": \"\",\n \"quoteStatus\": \"\",\n \"reference\": \"\",\n \"type\": \"IN\",\n \"subType\": \"merchantPayOut\",\n \"status\": \"EXPIRED\",\n \"displayCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"walletCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"paidCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"feeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"address\": {\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ]\n },\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\",\n \"transactions\": [\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n },\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n }\n ],\n \"refund\": {},\n \"currencyOptions\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"networkFeeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"flow\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "305103b5-3378-4e0a-b49b-f85d9f00ac2b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "update", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"payOutInstruction\": {\n \"code\": \"\",\n \"currency\": \"\",\n \"address\": \"\",\n \"network\": \"\",\n \"tag\": \"\",\n \"protocol\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b323ae-4cb0-4d85-b59b-bfc20469e0e1", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "update", "summary" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"payOutInstruction\": {\n \"code\": \"\",\n \"currency\": \"\",\n \"address\": \"\",\n \"network\": \"\",\n \"tag\": \"\",\n \"protocol\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "090ab192-0fdd-4117-a981-beffa6ff9355", "name": "Accept Payment", "request": { "name": "Accept Payment", "description": { "content": "Accepts a pending payment with currency or payout information.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", ":uuid", "accept", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "5C8D8D78-366A-4AFB-B658-A64CE543C5DB", "key": "uuid", "disabled": false, "description": { "content": "(Required) The payment UUID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": null }, "response": [ { "id": "89dfbaf4-576a-4cf7-970a-7703f6f06c1c", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "accept", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"\",\n \"merchantDisplayName\": \"\",\n \"walletId\": \"\",\n \"dateCreated\": \"\",\n \"expiryDate\": \"\",\n \"quoteExpiryDate\": \"\",\n \"acceptanceExpiryDate\": \"\",\n \"quoteStatus\": \"\",\n \"reference\": \"\",\n \"type\": \"IN\",\n \"subType\": \"merchantPayOut\",\n \"status\": \"EXPIRED\",\n \"displayCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"walletCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"paidCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"feeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"address\": {\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ]\n },\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\",\n \"transactions\": [\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n },\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n }\n ],\n \"refund\": {},\n \"currencyOptions\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"networkFeeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"flow\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b305cd5-6f07-4946-9345-39ed3d566d90", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "accept", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cbdfeec-db43-47bf-9590-e0a93da9c7f7", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "accept", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f932e48-1d3e-4d2b-9eb8-54331df81cd4", "name": "Get Payment", "request": { "name": "Get Payment", "description": { "content": "Retrieves details of a specific payment using the UUID of the payment.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", ":uuid", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "5C8D8D78-366A-4AFB-B658-A64CE543C5DB", "key": "uuid", "disabled": false, "description": { "content": "(Required) The payment UUID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8d1087ab-6d86-441c-b66d-df6c1e8ddc3d", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uuid\": \"\",\n \"merchantDisplayName\": \"\",\n \"walletId\": \"\",\n \"dateCreated\": \"\",\n \"expiryDate\": \"\",\n \"quoteExpiryDate\": \"\",\n \"acceptanceExpiryDate\": \"\",\n \"quoteStatus\": \"\",\n \"reference\": \"\",\n \"type\": \"IN\",\n \"subType\": \"merchantPayOut\",\n \"status\": \"EXPIRED\",\n \"displayCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"walletCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"paidCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"feeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"address\": {\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ]\n },\n \"returnUrl\": \"\",\n \"redirectUrl\": \"\",\n \"transactions\": [\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n },\n {\n \"dateCreated\": \"\",\n \"dateConfirmed\": \"\",\n \"hash\": \"\",\n \"amount\": \"\",\n \"risk\": {},\n \"networkFeeCurrency\": \"\",\n \"networkFeeAmount\": \"\",\n \"sources\": [\n \"\",\n \"\"\n ],\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n }\n }\n ],\n \"refund\": {},\n \"currencyOptions\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"networkFeeCurrency\": {\n \"currency\": \"\",\n \"amount\": \"\",\n \"actual\": \"\"\n },\n \"flow\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "befc6f17-019c-419e-ac6c-912b578b6149", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb9d679c-3f02-427a-bcbe-009f0cfb5145", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", ":uuid", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dba80002-9566-4d2c-9525-638f96bd1f0c", "name": "Validate Address", "request": { "name": "Validate Address", "description": { "content": "Validates that a crypto address is correct.\n\nUse this endpoint to validate that an address exists, is correctly formatted, and includes all the required data. This endpoint can help prevent your end users losing funds when submitting a payout.\n\n**šŸ“‹ Example Use Case:** Validate an Ethereum wallet address", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pay", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"crypto\",\n \"currency\": \"ETH\",\n \"address\": \"0xb794f5ea0ba39494ce839613fffba74279579268\",\n \"network\": \"ETHEREUM\"\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "86ff8a3e-bbf6-4000-9560-72968927b74a", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"currency\": \"\",\n \"address\": \"\",\n \"network\": \"\",\n \"tag\": \"\",\n \"protocol\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea5eec7a-5b07-4c6e-bde2-8698b504fbfa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"currency\": \"\",\n \"address\": \"\",\n \"network\": \"\",\n \"tag\": \"\",\n \"protocol\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32af7a90-8d55-44f8-8d12-b9379196569e", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v1", "pay", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"currency\": \"\",\n \"address\": \"\",\n \"network\": \"\",\n \"tag\": \"\",\n \"protocol\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Crypto Channels", "description": "", "item": [ { "id": "8cceec14-17e8-4422-9cde-ea10a8af49f3", "name": "Create Channel", "request": { "name": "Create Channel", "description": { "content": "Creates a channel through which your customers can send crypto payments.\n\n**šŸ“‹ Example Use Case:** Create an ETH payment channel", "type": "text/plain" }, "url": { "path": [ "api", "v2", "channel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"a:24092328494070:G5i4XZ9:1\",\n \"payCurrency\": \"ETH\",\n \"displayCurrency\": \"EUR\",\n \"reference\": \"c1b933d5-3354-4f83-a05f-0b53f1be85f2\",\n \"customerId\": \"d063635e-0f83-4e47-a1f3-fc9484df1509\",\n \"complianceDetails\": {\n \"requesterIpAddress\": \"172.16.254.1\",\n \"partyDetails\": [\n {\n \"entityType\": \"INDIVIDUAL\",\n \"type\": \"BENEFICIARY\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"dateOfBirth\": \"1984-06-30\",\n \"relationshipType\": \"THIRD_PARTY\",\n \"countryCode\": \"GB\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "a871ef18-523d-468d-85b7-b6e6fc72a586", "name": "Created", "originalRequest": { "url": { "path": [ "api", "v2", "channel" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"payCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"reference\": \"\",\n \"customerId\": \"\",\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"merchantId\": \"\",\n \"walletCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"payCurrency\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"reference\": \"\",\n \"status\": \"CLOSED\",\n \"uuid\": \"\",\n \"redirectUrl\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ],\n \"walletId\": \"\",\n \"walletDescription\": \"\",\n \"pegged\": \"\",\n \"accountReference\": \"\",\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"relationshipType\": \"\",\n \"entity\": {\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"postCode\": \"\"\n },\n \"category\": \"\",\n \"type\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7099d4f-e4d4-46a0-be90-1fc4428b31bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v2", "channel" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"payCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"reference\": \"\",\n \"customerId\": \"\",\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b44aeda-6bce-4cde-af0a-8bd3e1c3de7e", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v2", "channel" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"payCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"reference\": \"\",\n \"customerId\": \"\",\n \"complianceDetails\": {\n \"partyDetails\": [\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n },\n {\n \"type\": \"\",\n \"entityType\": \"COMPANY\",\n \"relationshipType\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"countryCode\": \"\",\n \"regionCode\": \"\"\n }\n ],\n \"requesterIpAddress\": \"\",\n \"contactId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8014c7ee-6066-457b-908c-9151901f0a4c", "name": "List Channels", "request": { "name": "List Channels", "description": { "content": "Retrieves all channels related to a Wallet ID.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "channel" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The merchant ID that the channels belong to", "type": "text/plain" }, "key": "walletId", "value": "a:24092328494070:G5i4XZ9:1" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "10" }, { "disabled": false, "description": { "content": "Use it to query channel based on the reference provided during creation. Can be UUID of the payment, reference, channel UUID, transaction hash, or wallet code.", "type": "text/plain" }, "key": "q", "value": "example" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bb5bcb5a-f17e-47d9-9e01-2c5a2564d0f1", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "channel" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The merchant ID that the channels belong to", "type": "text/plain" }, "key": "walletId", "value": "" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "" }, { "disabled": false, "description": { "content": "Use it to query channel based on the reference provided during creation. Can be UUID of the payment, reference, channel UUID, transaction hash, or wallet code.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"merchantId\": \"\",\n \"walletCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"payCurrency\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"reference\": \"\",\n \"status\": \"CLOSED\",\n \"uuid\": \"\",\n \"redirectUrl\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ],\n \"walletId\": \"\",\n \"walletDescription\": \"\",\n \"pegged\": \"\",\n \"accountReference\": \"\",\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"relationshipType\": \"\",\n \"entity\": {\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"postCode\": \"\"\n },\n \"category\": \"\",\n \"type\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"merchantId\": \"\",\n \"walletCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"payCurrency\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"reference\": \"\",\n \"status\": \"CLOSED\",\n \"uuid\": \"\",\n \"redirectUrl\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ],\n \"walletId\": \"\",\n \"walletDescription\": \"\",\n \"pegged\": \"\",\n \"accountReference\": \"\",\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"relationshipType\": \"\",\n \"entity\": {\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"postCode\": \"\"\n },\n \"category\": \"\",\n \"type\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03af1232-5d26-404c-a16b-8d971014bf46", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v2", "channel" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The merchant ID that the channels belong to", "type": "text/plain" }, "key": "walletId", "value": "" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "" }, { "disabled": false, "description": { "content": "Use it to query channel based on the reference provided during creation. Can be UUID of the payment, reference, channel UUID, transaction hash, or wallet code.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25543e79-1e4d-460f-93f3-3d4db8563f0a", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "api", "v2", "channel" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The merchant ID that the channels belong to", "type": "text/plain" }, "key": "walletId", "value": "" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "" }, { "disabled": false, "description": { "content": "Use it to query channel based on the reference provided during creation. Can be UUID of the payment, reference, channel UUID, transaction hash, or wallet code.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cce5d43a-330d-4920-925d-0463aeee44df", "name": "Get Channel", "request": { "name": "Get Channel", "description": { "content": "Retrieves a specific channel by its UUID.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "channel", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "9d1f67f2-a647-404b-9b02-247c77be81d0", "key": "uuid", "disabled": false, "description": { "content": "(Required) The UUID of the channel you are querying", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3a65bc2f-2b9d-452a-8d40-f98f12adfbeb", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "channel", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"merchantId\": \"\",\n \"walletCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"payCurrency\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"reference\": \"\",\n \"status\": \"CLOSED\",\n \"uuid\": \"\",\n \"redirectUrl\": \"\",\n \"uri\": \"\",\n \"alternatives\": [\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n },\n {\n \"network\": \"\",\n \"protocol\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"uri\": \"\"\n }\n ],\n \"walletId\": \"\",\n \"walletDescription\": \"\",\n \"pegged\": \"\",\n \"accountReference\": \"\",\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"relationshipType\": \"\",\n \"entity\": {\n \"externalId\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"postCode\": \"\"\n },\n \"category\": \"\",\n \"type\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70331264-d437-4720-94ef-9e6d7061ebfe", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v2", "channel", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b2ce5b2-ed53-4c8c-a147-10899bb353b0", "name": "Get Channel Payment", "request": { "name": "Get Channel Payment", "description": { "content": "Retrieves a specific payment made into a channel.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "channel", "payment", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "9d1f67f2-a647-404b-9b02-247c77be81d0", "key": "uuid", "disabled": false, "description": { "content": "(Required) The UUID of the payment you are querying.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b8dabdf8-4c06-4cc1-b858-6a6fada4b331", "name": "200", "originalRequest": { "url": { "path": [ "api", "v2", "channel", "payment", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"channelId\": \"\",\n \"merchantId\": \"\",\n \"merchantDisplayName\": \"\",\n \"reference\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"status\": \"HELD\",\n \"uuid\": \"\",\n \"hash\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"paidCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"walletCurrency\": \"\",\n \"feeCurrency\": \"\",\n \"paidAmount\": \"\",\n \"displayAmount\": \"\",\n \"walletAmount\": \"\",\n \"feeAmount\": \"\",\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"risk\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"sources\": [\n \"\",\n \"\"\n ],\n \"networkFee\": {\n \"paidCurrency\": \"\",\n \"paidAmount\": \"\",\n \"displayCurrency\": \"\",\n \"displayAmount\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d14f32b8-e250-4de0-94d0-5fdb03e3f819", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v2", "channel", "payment", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1da2f97e-f719-4cda-a943-8aaf5450eb31", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v2", "channel", "payment", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6d315a4-b5d7-4467-84f1-f216bd13cce9", "name": "List Channel Payments", "request": { "name": "List Channel Payments", "description": { "content": "Retrieves a list of payments to a channel on a specific Wallet ID.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "channel", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the wallet associated with the transaction.", "type": "text/plain" }, "key": "walletId", "value": "example" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "CANCELLED" }, { "disabled": false, "description": { "content": "The start date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "fromDate", "value": "example" }, { "disabled": false, "description": { "content": "The end date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "toDate", "value": "example" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "10" }, { "disabled": false, "description": { "content": "Use it to query channel based on the reference provided during creation. Can be UUID of the payment, reference, channel UUID, transaction hash, or wallet code.", "type": "text/plain" }, "key": "q", "value": "example" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e8dd4a09-48b3-4b39-94d7-6401dbf51b3a", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "channel", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the wallet associated with the transaction.", "type": "text/plain" }, "key": "walletId", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "CANCELLED" }, { "disabled": false, "description": { "content": "The start date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "fromDate", "value": "" }, { "disabled": false, "description": { "content": "The end date in format 'YYYY-MM-dd'.", "type": "text/plain" }, "key": "toDate", "value": "" }, { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "" }, { "disabled": false, "description": { "content": "Use it to query channel based on the reference provided during creation. Can be UUID of the payment, reference, channel UUID, transaction hash, or wallet code.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"channelId\": \"\",\n \"merchantId\": \"\",\n \"merchantDisplayName\": \"\",\n \"reference\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"status\": \"DETECTED\",\n \"uuid\": \"\",\n \"hash\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"paidCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"walletCurrency\": \"\",\n \"feeCurrency\": \"\",\n \"paidAmount\": \"\",\n \"displayAmount\": \"\",\n \"walletAmount\": \"\",\n \"feeAmount\": \"\",\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"risk\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"sources\": [\n \"\",\n \"\"\n ],\n \"networkFee\": {\n \"paidCurrency\": \"\",\n \"paidAmount\": \"\",\n \"displayCurrency\": \"\",\n \"displayAmount\": \"\"\n }\n },\n {\n \"channelId\": \"\",\n \"merchantId\": \"\",\n \"merchantDisplayName\": \"\",\n \"reference\": \"\",\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\",\n \"status\": \"CANCELLED\",\n \"uuid\": \"\",\n \"hash\": \"\",\n \"address\": \"\",\n \"tag\": \"\",\n \"paidCurrency\": \"\",\n \"displayCurrency\": \"\",\n \"walletCurrency\": \"\",\n \"feeCurrency\": \"\",\n \"paidAmount\": \"\",\n \"displayAmount\": \"\",\n \"walletAmount\": \"\",\n \"feeAmount\": \"\",\n \"exchangeRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"displayRate\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"risk\": {\n \"base\": \"\",\n \"counter\": \"\",\n \"rate\": \"\"\n },\n \"sources\": [\n \"\",\n \"\"\n ],\n \"networkFee\": {\n \"paidCurrency\": \"\",\n \"paidAmount\": \"\",\n \"displayCurrency\": \"\",\n \"displayAmount\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c12def67-9743-482a-b8ce-e0e743240c9a", "name": "Get Channel Spot Rate", "request": { "name": "Get Channel Spot Rate", "description": { "content": "Poll the current spot rate for a channel. Use this endpoint if you are building your own UI and need to display the live conversion rate to customers.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "channel", ":uuid", "spot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "9d1f67f2-a647-404b-9b02-247c77be81d0", "key": "uuid", "disabled": false, "description": { "content": "(Required) The UUID of the channel you are querying", "type": "text/plain" } } ] }, "method": "GET", "body": {}, "auth": null, "header": [] }, "response": [ { "id": "410c1782-e52a-42ed-9346-1b5a8528c9f3", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "channel", ":uuid", "spot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df286573-f1b2-4cc8-9224-00c9b6dd95e6", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v2", "channel", ":uuid", "spot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Fiat Payments", "description": "", "item": [ { "name": "Wallets", "description": "", "item": [ { "id": "915066dc-0ef8-4f65-9018-3e6d51d9be8d", "name": "Create Wallet", "request": { "name": "Create Wallet", "description": { "content": "Creates a fiat or crypto wallet for a specific Embedded Partner Customer, generating a unique virtual account tied to the wallet.\n\n---\n\nFor more information, how to apply it in the Embedded Wallets flow, refer to the [Create a customer wallet](https://docs.bvnk.com/docs/step-2-creating-a-customer-wallet-and-virtual-account#/create-a-customer-wallet) guide.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Create a USD fiat wallet for a customer:**\n1. **Create a USD fiat wallet for a customer**\n\n**Create a USDT crypto wallet for a customer:**\n1. **Create a USDT crypto wallet for a customer**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"USD\",\n \"name\": \"Customer USD Wallet\",\n \"customerReference\": \"b4e5c3d1-9a42-4e7b-8f34-7c6b2a89f3df\",\n \"instruction\": {\n \"type\": \"FIAT\",\n \"virtualAccountRequired\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "fbc0a675-ae45-4429-b3a6-458cefee3644", "name": "Wallet created successfully.", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"BTC\",\n \"name\": \"\",\n \"customerReference\": \"\",\n \"instruction\": {\n \"type\": \"FIAT\",\n \"virtualAccountRequired\": true,\n \"walletProfile\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"accountReference\": \"\",\n \"customerReference\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\",\n \"balance\": {\n \"value\": \"\",\n \"currencyCode\": \"TRX\"\n },\n \"ledgers\": [\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n },\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n }\n ],\n \"capabilities\": \"SAFEGUARDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8aa4c4b4-4bdf-452f-a698-db372f8bc6f8", "name": "Bad request.", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"BTC\",\n \"name\": \"\",\n \"customerReference\": \"\",\n \"instruction\": {\n \"type\": \"FIAT\",\n \"virtualAccountRequired\": true,\n \"walletProfile\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2c5d7de-9635-4e24-b614-8aed111b7fbd", "name": "Forbidden.", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currencyCode\": \"BTC\",\n \"name\": \"\",\n \"customerReference\": \"\",\n \"instruction\": {\n \"type\": \"FIAT\",\n \"virtualAccountRequired\": true,\n \"walletProfile\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1871a7e9-2aee-4989-a363-009dff5efad4", "name": "List Wallet Profiles", "request": { "name": "List Wallet Profiles", "description": { "content": "Returns available wallet profiles based on optional filters for currency codes and payment methods.\n\n---\n\nFor more information, how to apply it in the Embedded Wallets flow, refer to the [Assign a wallet profile](https://docs.bvnk.com/docs/step-2-creating-a-customer-wallet-and-virtual-account#/assign-a-wallet-profile) guide.", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "wallets", "profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by currency codes.\n\nNot all cryptocurrencies may be supported, as this depends on the specific jurisdiction. For example, for USA you can use only `BTC`, `SOL`, `ETH`, `USDT`, `USDC`, `TRX`.", "type": "text/plain" }, "key": "currencyCodes", "value": "USD" }, { "disabled": false, "description": { "content": "Filter by payment methods.\n\nIf you request an ACH Same Day payout outside its available window, it will be process as a next-day payout. However, the ACH Same Day fee may still be incurred.", "type": "text/plain" }, "key": "paymentMethods", "value": "SWIFT" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "64d32ab7-ee98-42c0-b9d9-5d2d63cf15d4", "name": "List of wallet profiles matching the query", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets", "profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by currency codes.\n\nNot all cryptocurrencies may be supported, as this depends on the specific jurisdiction. For example, for USA you can use only `BTC`, `SOL`, `ETH`, `USDT`, `USDC`, `TRX`.", "type": "text/plain" }, "key": "currencyCodes", "value": "USD" }, { "disabled": false, "description": { "content": "Filter by payment methods.\n\nIf you request an ACH Same Day payout outside its available window, it will be process as a next-day payout. However, the ACH Same Day fee may still be incurred.", "type": "text/plain" }, "key": "paymentMethods", "value": "SWIFT" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"profiles\": [\n {\n \"reference\": \"\",\n \"currencyCodes\": [\n \"LTC\",\n \"GBP\"\n ],\n \"paymentMethods\": [\n \"FEDWIRE\",\n \"SEPA_CT\"\n ]\n },\n {\n \"reference\": \"\",\n \"currencyCodes\": [\n \"EUR\",\n \"TRX\"\n ],\n \"paymentMethods\": [\n \"SWIFT\",\n \"ACH\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80502556-746d-496b-941d-ba46fddf1b81", "name": "Get Wallet", "request": { "name": "Get Wallet", "description": { "content": "Retrieves a specific wallet by its ID", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "a:24092328494070:G5i4XZ9:1", "key": "id", "disabled": false, "description": { "content": "(Required) The ID of the wallet that you want to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "82acd0b8-7855-4b74-a5eb-e8e85a3b08d3", "name": "OK", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"accountReference\": \"\",\n \"customerReference\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\",\n \"balance\": {\n \"value\": \"\",\n \"currencyCode\": \"TRX\"\n },\n \"ledgers\": [\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n },\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n }\n ],\n \"capabilities\": \"SAFEGUARDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "128b606a-f054-4cdf-9e53-f86be76c4f94", "name": "Not found.", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2d972c1-c2b1-445d-872d-2051c076f7ee", "name": "List all Customer Wallets", "request": { "name": "List all Customer Wallets", "description": { "content": "Retrieves a list of wallets for your Embedded Partner Customers (EPCs).\n\nā€¢ **Without parameters**: Returns all wallets associated with all your customers.\n\nā€¢ **With `customerReference` parameter**: Returns wallets for a specific customer only. Usage: `https://api.bvnk.com/ledger/v1/wallets?customerReference=550e8400-e29b-41d4-a716-446655440000\n`.", "type": "text/plain" }, "url": { "path": [ "ledger", "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The currency code for the wallet.", "type": "text/plain" }, "key": "currencyCode", "value": "POL" }, { "disabled": false, "description": { "content": "Reference to the customer who owns the wallet.", "type": "text/plain" }, "key": "customerReference", "value": "33e85982-e22b-4e8b-9057-445cf000bea9" }, { "disabled": false, "description": { "content": "Page number for pagination. Starts from 0.", "type": "text/plain" }, "key": "page", "value": "0" }, { "disabled": false, "description": { "content": "Number of items to return per page.", "type": "text/plain" }, "key": "size", "value": "10" }, { "disabled": false, "description": { "content": "Sorting criteria in the format `property,`. Default sort order is asc.", "type": "text/plain" }, "key": "sort", "value": "currencyCode,desc" }, { "disabled": false, "description": { "content": "Starting point for pagination, used instead of `page. Useful for cursor-based pagination.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "388c65b4-6e87-4e30-a457-533a39cc8f9a", "name": "OK", "originalRequest": { "url": { "path": [ "ledger", "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The currency code for the wallet.", "type": "text/plain" }, "key": "currencyCode", "value": "POL" }, { "disabled": false, "description": { "content": "Reference to the customer who owns the wallet.", "type": "text/plain" }, "key": "customerReference", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination. Starts from 0.", "type": "text/plain" }, "key": "page", "value": "" }, { "disabled": false, "description": { "content": "Number of items to return per page.", "type": "text/plain" }, "key": "size", "value": "" }, { "disabled": false, "description": { "content": "Sorting criteria in the format `property,`. Default sort order is asc.", "type": "text/plain" }, "key": "sort", "value": "" }, { "disabled": false, "description": { "content": "Starting point for pagination, used instead of `page. Useful for cursor-based pagination.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"id\": \"\",\n \"accountReference\": \"\",\n \"customerReference\": \"\",\n \"name\": \"\",\n \"status\": \"INACTIVE\",\n \"balance\": {\n \"value\": \"\",\n \"currencyCode\": \"TRX\"\n },\n \"ledgers\": [\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n },\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n }\n ],\n \"capabilities\": \"SAFEGUARDED\"\n },\n {\n \"id\": \"\",\n \"accountReference\": \"\",\n \"customerReference\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\",\n \"balance\": {\n \"value\": \"\",\n \"currencyCode\": \"LTC\"\n },\n \"ledgers\": [\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n },\n {\n \"type\": \"FIAT\",\n \"accountNumber\": \"\",\n \"code\": \"\",\n \"accountHolderName\": \"\",\n \"accountNumberFormat\": \"\",\n \"paymentReference\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"name\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n }\n ],\n \"capabilities\": \"SAFEGUARDED\"\n }\n ],\n \"pageable\": {\n \"pageNumber\": \"\",\n \"pageSize\": \"\",\n \"offset\": \"\"\n },\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"numberOfElements\": \"\",\n \"last\": \"\",\n \"first\": \"\",\n \"empty\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Payment Rules", "description": "", "item": [ { "id": "32bb0b7d-3091-4628-974f-83ca3d0d2822", "name": "Create on-ramp payment rule", "request": { "name": "Create on-ramp payment rule", "description": { "content": "Creates a rule that links a crypto wallet to a fiat virtual account to automatically handle on-ramp (fiat ā†’ crypto) flow. The `trigger` field defines the flow to activate:\n\n - `payment:payin:fiat` ā€” on-ramp\n\nFor more information, see the [Automate Fiat-to-Crypto Transfers](https://docs.bvnk.com/docs/automate-fiat-to-crypto-transfers#/) guide.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Example POST request | Company beneficiary:**\n1. **Example POST request | Company beneficiary**\n\n**Example POST request | Individual beneficiary:**\n1. **Example POST request | Individual beneficiary**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"REF558628\",\n \"trigger\": \"event:payment:payin\",\n \"walletId\": \"a:24122329329347:HsdJVhW:1\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": 0.5,\n \"currency\": \"USD\"\n }\n },\n \"beneficiary\": {\n \"currency\": \"USDT\",\n \"entity\": {\n \"customerIdentifier\": \"9401203948572394595\",\n \"legalName\": \"3Com\",\n \"type\": \"COMPANY\",\n \"relationshipType\": \"SELF_OWNED\",\n \"registrationNumber\": \"ABC21D21FZC\",\n \"address\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Suite 200\",\n \"city\": \"New York\",\n \"stateCode\": \"NY\",\n \"postalCode\": \"10001\",\n \"countryCode\": \"US\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"ETHEREUM\",\n \"address\": \"0x12323542636474747\",\n \"tag\": \"332455\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "04212891-7545-4534-9105-afb5e7f452cf", "name": "Success", "originalRequest": { "url": { "path": [ "payment", "v1", "rules" ], "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 \"reference\": \"\",\n \"trigger\": \"\",\n \"walletId\": \"\",\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"customerIdentifier\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"SOLANA\",\n \"address\": \"\",\n \"tag\": \"\"\n }\n },\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"trigger\": \"\",\n \"status\": \"\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"currency\": \"\",\n \"walletId\": \"\"\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"legalName\": \"\",\n \"type\": \"\",\n \"relationshipType\": \"\",\n \"registrationNumber\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postCode\": \"\",\n \"country\": \"\"\n }\n },\n \"cryptoAddresses\": {\n \"network\": \"\",\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"tag\": \"\"\n }\n },\n \"metadata\": {\n \"dolored\": \"\",\n \"aute90\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90da5d98-3bbf-4063-8c4f-010b8cf82e88", "name": "Bad request.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules" ], "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 \"reference\": \"\",\n \"trigger\": \"\",\n \"walletId\": \"\",\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"customerIdentifier\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"SOLANA\",\n \"address\": \"\",\n \"tag\": \"\"\n }\n },\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afb1626c-39be-4c8d-8172-231ce38ba0f1", "name": "Unauthorized.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules" ], "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 \"reference\": \"\",\n \"trigger\": \"\",\n \"walletId\": \"\",\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"customerIdentifier\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"SOLANA\",\n \"address\": \"\",\n \"tag\": \"\"\n }\n },\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "776a1556-734e-4fed-8e11-c35060200bf4", "name": "Forbidden.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules" ], "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 \"reference\": \"\",\n \"trigger\": \"\",\n \"walletId\": \"\",\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"customerIdentifier\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"SOLANA\",\n \"address\": \"\",\n \"tag\": \"\"\n }\n },\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cea44cbc-c93d-4dc4-b63a-85235dcd75cb", "name": "List Payment Rules", "request": { "name": "List Payment Rules", "description": { "content": "Retrieves a list of all payment rules configured for your account.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cc96fd1f-cdba-481d-b600-646adeeac511", "name": "OK", "originalRequest": { "url": { "path": [ "payment", "v1", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "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 {\n \"id\": \"\",\n \"reference\": \"\",\n \"trigger\": \"\",\n \"status\": \"\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"currency\": \"\",\n \"walletId\": \"\"\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"legalName\": \"\",\n \"type\": \"\",\n \"relationshipType\": \"\",\n \"registrationNumber\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postCode\": \"\",\n \"country\": \"\"\n }\n },\n \"cryptoAddresses\": {\n \"network\": \"\",\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"tag\": \"\"\n }\n },\n \"metadata\": {\n \"aliqua_dcc\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"reference\": \"\",\n \"trigger\": \"\",\n \"status\": \"\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"currency\": \"\",\n \"walletId\": \"\"\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"legalName\": \"\",\n \"type\": \"\",\n \"relationshipType\": \"\",\n \"registrationNumber\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postCode\": \"\",\n \"country\": \"\"\n }\n },\n \"cryptoAddresses\": {\n \"network\": \"\",\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"tag\": \"\"\n }\n },\n \"metadata\": {\n \"fugiat43\": \"\",\n \"sintc3\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b353c065-98ef-48fe-9b6b-67f6300c44fe", "name": "Bad request.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "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 \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b14a8917-0e71-4a67-a1dd-0354eff88cae", "name": "Unauthorized.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "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": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d92faa9-3ca2-45bd-b666-fb6ffba39071", "name": "Forbidden.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "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": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d128195-8f31-4e25-915d-63672485d58b", "name": "List Payment Rules by Wallet", "request": { "name": "List Payment Rules by Wallet", "description": { "content": "Retrieves a list of payment rules applied to a specific wallet by its ID.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "rules", ":walletId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "acc:22041242429000:3MPpU:0", "key": "walletId", "disabled": false, "description": { "content": "(Required) BVNK wallet ID to filter payment rules.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7e5a612c-d6eb-4fd8-8d9e-bf0557ba5bc6", "name": "OK", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":walletId" ], "host": [ "{{baseUrl}}" ], "query": [], "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 {\n \"id\": \"\",\n \"reference\": \"\",\n \"trigger\": \"\",\n \"status\": \"\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"currency\": \"\",\n \"walletId\": \"\"\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"legalName\": \"\",\n \"type\": \"\",\n \"relationshipType\": \"\",\n \"registrationNumber\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postCode\": \"\",\n \"country\": \"\"\n }\n },\n \"cryptoAddresses\": {\n \"network\": \"\",\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"tag\": \"\"\n }\n },\n \"metadata\": {\n \"aliqua_dcc\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"reference\": \"\",\n \"trigger\": \"\",\n \"status\": \"\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"currency\": \"\",\n \"walletId\": \"\"\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"legalName\": \"\",\n \"type\": \"\",\n \"relationshipType\": \"\",\n \"registrationNumber\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"postCode\": \"\",\n \"country\": \"\"\n }\n },\n \"cryptoAddresses\": {\n \"network\": \"\",\n \"addresses\": [\n \"\",\n \"\"\n ],\n \"tag\": \"\"\n }\n },\n \"metadata\": {\n \"fugiat43\": \"\",\n \"sintc3\": \"\"\n },\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebbb03d7-48fc-4c68-8dcc-9bc8dbef86d1", "name": "Bad request.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":walletId" ], "host": [ "{{baseUrl}}" ], "query": [], "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 \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "164378a2-ffb4-46c3-844f-ae3d68e61e34", "name": "Unauthorized.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":walletId" ], "host": [ "{{baseUrl}}" ], "query": [], "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": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35c538e4-e696-49d9-913b-0b4a3a9fec98", "name": "Forbidden.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":walletId" ], "host": [ "{{baseUrl}}" ], "query": [], "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": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a820d67-2a81-47ed-961c-9871686391c5", "name": "Not Found", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":walletId" ], "host": [ "{{baseUrl}}" ], "query": [], "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 \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "592a17f4-23a4-4328-85b7-39ee40ef24d1", "name": "Update Payment Rule", "request": { "name": "Update Payment Rule", "description": { "content": "Partially updates a previously created payment rule. Only properties included in the request are updated; omitted fields remain unchanged. Setting a nullable property to null clears it.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "98c0bb03-567f-11f0-b26e-6b1848874a27", "key": "id", "disabled": false, "description": { "content": "(Required) ID of the wallet configuration or rule to update. You can get this value from the `id` field of the [`/payment/v1/rules`](https://docs.bvnk.com/reference/paymentrulecreate#/) response.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"fees\": {\n \"customerFee\": {\n \"amount\": 10,\n \"currency\": \"USD\"\n }\n },\n \"beneficiary\": {\n \"currency\": \"USD\"\n },\n \"cryptoAddress\": {\n \"network\": \"TRON\",\n \"address\": \"example\",\n \"tag\": \"example\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6ba93cb1-c16a-45f0-be73-1675ff4790cc", "name": "Rule updated.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id" ], "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": "PATCH", "body": { "mode": "raw", "raw": "{\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"customerIdentifier\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"relationshipType\": \"THIRD_PARTY\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"BITCOIN\",\n \"address\": \"\",\n \"tag\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad03a5ce-cdf7-4d12-8647-c2fd9426c86f", "name": "Bad request.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"customerIdentifier\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"relationshipType\": \"THIRD_PARTY\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"BITCOIN\",\n \"address\": \"\",\n \"tag\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcc14216-92df-48d6-9f4d-997acdbc52b9", "name": "Unauthorized.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"customerIdentifier\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"relationshipType\": \"THIRD_PARTY\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"BITCOIN\",\n \"address\": \"\",\n \"tag\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b5e16b1-9bab-462e-84f8-1debad68f152", "name": "Forbidden.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"beneficiary\": {\n \"currency\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"customerIdentifier\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"\",\n \"address\": {\n \"addressLine1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"addressLine2\": \"\",\n \"country\": \"\",\n \"stateCode\": \"\"\n },\n \"relationshipType\": \"THIRD_PARTY\"\n }\n },\n \"cryptoAddress\": {\n \"network\": \"BITCOIN\",\n \"address\": \"\",\n \"tag\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d645982e-02f6-434b-a19b-2f58500cb0d7", "name": "Activate or Deactivate Payment Rule", "request": { "name": "Activate or Deactivate Payment Rule", "description": { "content": "Activates or deactivates a payment rule. If you linked a rule to an incorrect wallet, you can deactivate it. Deactivated rules will not trigger automated actions but remain in your account for reference.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "rules", ":id", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "98c0bb03-567f-11f0-b26e-6b1848874a27", "key": "id", "disabled": false, "description": { "content": "(Required) ID of the payment rule to activate or deactivate. You can get this value from the `id` field of the [`/payment/v1/rules`](https://docs.bvnk.com/reference/paymentrulecreate#/) response.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"ACTIVATE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5a976e65-6008-4928-a2b9-bc9650c92b4b", "name": "204 No Content", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"type\": \"DEACTIVATE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53ed19ae-a719-440c-8d9c-e0bbfb7a13e8", "name": "Bad request.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id", "actions" ], "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 \"type\": \"DEACTIVATE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c47575aa-5a88-4f9a-bee5-e974d64edc9d", "name": "Unauthorized.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id", "actions" ], "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 \"type\": \"DEACTIVATE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73c92aee-f9f6-4b9c-a429-dab4dac9d832", "name": "Forbidden.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id", "actions" ], "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 \"type\": \"DEACTIVATE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63661372-710f-44e8-acca-bf94ec13c1e0", "name": "Rule not found.", "originalRequest": { "url": { "path": [ "payment", "v1", "rules", ":id", "actions" ], "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 \"type\": \"DEACTIVATE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Payouts", "description": "", "item": [ { "id": "e893e556-dfec-40aa-b97c-ce5df1e1d7de", "name": "Get Payout", "request": { "name": "Get Payout", "description": { "content": "Retrieves a specific payout.\n\nYou can also use this endpoint to check the status of the crypto or fiat payout.\n\n**Note**: The PENDING_APPROVAL status is only relevant for **fiat payouts**.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "payouts", ":transactionReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "5dc4e061-31c6-4b96-8c4d-0ea984aece0b", "key": "transactionReference", "disabled": false, "description": { "content": "(Required) The transaction reference of the payout that you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "de7c3a56-5358-4f4b-ac5e-7bf0d02ba447", "name": "OK", "originalRequest": { "url": { "path": [ "payment", "v1", "payouts", ":transactionReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactionReference\": \"\",\n \"paymentReference\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"GBP\"\n },\n \"fee\": {\n \"value\": \"\",\n \"currency\": \"GBP\"\n },\n \"walletId\": \"\",\n \"status\": \"FAILED\",\n \"createdAt\": \"\",\n \"details\": {\n \"type\": \"FIAT\",\n \"beneficiary\": {\n \"entityType\": \"COMPANY\",\n \"companyDetails\": {\n \"name\": \"\"\n },\n \"individualDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"08/25/3440\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"postCode\": \"\",\n \"fullAddress\": \"\"\n },\n \"bankAccount\": {\n \"format\": \"IBAN\",\n \"bankName\": \"\",\n \"accountNumber\": \"\",\n \"bankCode\": \"\",\n \"bankAddress\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"postCode\": \"\",\n \"fullAddress\": \"\"\n }\n },\n \"correspondentBic\": \"\"\n }\n },\n \"metadata\": {\n \"Lorem_69\": \"\",\n \"proidente\": \"\",\n \"ipsum__4\": \"\",\n \"nisi0c\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc9669f5-992e-45d9-aa7a-d8ad59f27514", "name": "Not found.", "originalRequest": { "url": { "path": [ "payment", "v1", "payouts", ":transactionReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10f4ab59-ed3b-486d-9e63-18d7517e6d76", "name": "Initiate Payout (ver. 2)", "request": { "name": "Initiate Payout (ver. 2)", "description": { "content": "Creates a payout to business or individual customers.\n\nIn case of payment in Euro, the transaction is subject to **Verification of Payee** (VoP): if the beneficiary's name in the request doesn't match the name in the beneficiary's bank account, the status 202 Verification Failed is returned. To proceed with the payment, you must [Confirm Beneficiary's name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2#/). For the details, refer to the [Initiate Payouts (ver. 2)](https://docs.bvnk.com/docs/initiate-payment-2#/) guide.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Individual beneficiary:**\n1. **Individual beneficiary**\n\n**Company beneficiary:**\n1. **Company beneficiary**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "payment", "v2", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "disabled": false, "description": { "content": "Optional. Verification ID acquired from the beneficiary verification request via [`POST /platform/v1/beneficiaries/verification`](https://docs.bvnk.com/reference/verifybeneficiary). Include this header to use a previously verified beneficiary for the payout.\n\nWhen using this header, you can skip further confirmation of the beneficiary's name as BVNK already attempted to verify it.\n\nIf you don't add the header, you may need to [confirm the name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2#/).", "type": "text/plain" }, "key": "X-Verification-Id", "value": "example" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"a:25030543848767:1f8xnw3:1\",\n \"amount\": 1000.5,\n \"currency\": \"USD\",\n \"reference\": \"PAYOUT-2024-001\",\n \"method\": \"ACH\",\n \"beneficiary\": {\n \"remittanceInformation\": \"Payment for services\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"dateOfBirth\": \"15-01-1990\",\n \"relationshipType\": \"THIRD_PARTY\",\n \"address\": {\n \"addressLine1\": \"321 Side St\",\n \"city\": \"New York\",\n \"region\": \"NY\",\n \"postCode\": \"10001\",\n \"country\": \"US\"\n }\n },\n \"bankAccount\": {\n \"accountNumber\": \"900012647634\",\n \"accountType\": \"CHECKING\",\n \"bank\": {\n \"identificationCode\": \"CHASUS33\",\n \"nid\": \"021000021\",\n \"address\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"region\": \"NY\",\n \"postCode\": \"10001\",\n \"country\": \"US\"\n }\n }\n }\n },\n \"metadata\": {\n \"source\": \"api\",\n \"memberId\": \"987654321\"\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "18612ede-d3df-484c-9f3f-529ebf965f70", "name": "Payment accepted for processing.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "Optional. Verification ID acquired from the beneficiary verification request via [`POST /platform/v1/beneficiaries/verification`](https://docs.bvnk.com/reference/verifybeneficiary). Include this header to use a previously verified beneficiary for the payout.\n\nWhen using this header, you can skip further confirmation of the beneficiary's name as BVNK already attempted to verify it.\n\nIf you don't add the header, you may need to [confirm the name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2#/).", "type": "text/plain" }, "key": "X-Verification-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"beneficiary\": {\n \"remittanceInformation\": \"įš€fXRl\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"THIRD_PARTY\",\n \"dateOfBirth\": \"69-59-0809\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"accountType\": \"SAVINGS\",\n \"intermediaryBanks\": [\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n ]\n }\n },\n \"reference\": \"\",\n \"method\": \"SWIFT\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"EUR\"\n }\n },\n \"metadata\": {\n \"aliquade9\": \"\",\n \"eiusmod_0f\": \"\",\n \"minim1af\": \"\"\n },\n \"requestDetails\": {\n \"originator\": {\n \"ipAddress\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"method\": \"BANK_TRANSFER\",\n \"status\": \"CANCELLED\",\n \"type\": \"payment:payout:fiat\",\n \"fees\": {\n \"processingFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"amount\": \"\",\n \"currency\": \"AAD\",\n \"walletId\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"dateOfBirth\": \"00-69-2467\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"customerId\": \"\"\n },\n \"beneficiary\": {\n \"remittanceInformation\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"dateOfBirth\": \"18-55-6021\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"amount\": \"\",\n \"currency\": \"HRP\",\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"accountType\": \"SAVINGS\",\n \"intermediaryBanks\": [\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n ]\n }\n },\n \"metadata\": {\n \"quib26\": \"\",\n \"ut_e0\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"direction\": \"OUT\",\n \"reference\": \"\",\n \"trackingDetails\": [\n {\n \"externalTransactionId\": \"\",\n \"imad\": \"\",\n \"omad\": \"\",\n \"traceNumber\": \"\",\n \"uetr\": \"\"\n },\n {\n \"externalTransactionId\": \"\",\n \"imad\": \"\",\n \"omad\": \"\",\n \"traceNumber\": \"\",\n \"uetr\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca30f315-93c3-4a24-a492-088857de02c7", "name": "Confirmation required.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "Optional. Verification ID acquired from the beneficiary verification request via [`POST /platform/v1/beneficiaries/verification`](https://docs.bvnk.com/reference/verifybeneficiary). Include this header to use a previously verified beneficiary for the payout.\n\nWhen using this header, you can skip further confirmation of the beneficiary's name as BVNK already attempted to verify it.\n\nIf you don't add the header, you may need to [confirm the name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2#/).", "type": "text/plain" }, "key": "X-Verification-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"beneficiary\": {\n \"remittanceInformation\": \"įš€fXRl\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"THIRD_PARTY\",\n \"dateOfBirth\": \"69-59-0809\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"accountType\": \"SAVINGS\",\n \"intermediaryBanks\": [\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n ]\n }\n },\n \"reference\": \"\",\n \"method\": \"SWIFT\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"EUR\"\n }\n },\n \"metadata\": {\n \"aliquade9\": \"\",\n \"eiusmod_0f\": \"\",\n \"minim1af\": \"\"\n },\n \"requestDetails\": {\n \"originator\": {\n \"ipAddress\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Id\": \"\",\n \"status\": \"PAYEE_VERIFICATION_REQUIRED\",\n \"verificationResult\": {\n \"matchStatus\": \"NOT_POSSIBLE\",\n \"actualName\": \"\",\n \"providedName\": \"\"\n },\n \"requiredAction\": \"CONFIRM_BENEFICIARY\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79e6f2c0-79fc-4014-ab4a-ac659e4fece1", "name": "Bad request", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "Optional. Verification ID acquired from the beneficiary verification request via [`POST /platform/v1/beneficiaries/verification`](https://docs.bvnk.com/reference/verifybeneficiary). Include this header to use a previously verified beneficiary for the payout.\n\nWhen using this header, you can skip further confirmation of the beneficiary's name as BVNK already attempted to verify it.\n\nIf you don't add the header, you may need to [confirm the name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2#/).", "type": "text/plain" }, "key": "X-Verification-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"beneficiary\": {\n \"remittanceInformation\": \"įš€fXRl\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"THIRD_PARTY\",\n \"dateOfBirth\": \"69-59-0809\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"accountType\": \"SAVINGS\",\n \"intermediaryBanks\": [\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n ]\n }\n },\n \"reference\": \"\",\n \"method\": \"SWIFT\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"EUR\"\n }\n },\n \"metadata\": {\n \"aliquade9\": \"\",\n \"eiusmod_0f\": \"\",\n \"minim1af\": \"\"\n },\n \"requestDetails\": {\n \"originator\": {\n \"ipAddress\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a11dc290-8d07-4cca-a01d-853a21c4a795", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "Optional. Verification ID acquired from the beneficiary verification request via [`POST /platform/v1/beneficiaries/verification`](https://docs.bvnk.com/reference/verifybeneficiary). Include this header to use a previously verified beneficiary for the payout.\n\nWhen using this header, you can skip further confirmation of the beneficiary's name as BVNK already attempted to verify it.\n\nIf you don't add the header, you may need to [confirm the name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2#/).", "type": "text/plain" }, "key": "X-Verification-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"beneficiary\": {\n \"remittanceInformation\": \"įš€fXRl\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"THIRD_PARTY\",\n \"dateOfBirth\": \"69-59-0809\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"accountType\": \"SAVINGS\",\n \"intermediaryBanks\": [\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n ]\n }\n },\n \"reference\": \"\",\n \"method\": \"SWIFT\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"EUR\"\n }\n },\n \"metadata\": {\n \"aliquade9\": \"\",\n \"eiusmod_0f\": \"\",\n \"minim1af\": \"\"\n },\n \"requestDetails\": {\n \"originator\": {\n \"ipAddress\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ac0c6cd-4cc2-4d5f-a828-0e1a4c69c3e0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "disabled": false, "description": { "content": "Optional. Verification ID acquired from the beneficiary verification request via [`POST /platform/v1/beneficiaries/verification`](https://docs.bvnk.com/reference/verifybeneficiary). Include this header to use a previously verified beneficiary for the payout.\n\nWhen using this header, you can skip further confirmation of the beneficiary's name as BVNK already attempted to verify it.\n\nIf you don't add the header, you may need to [confirm the name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2#/).", "type": "text/plain" }, "key": "X-Verification-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"beneficiary\": {\n \"remittanceInformation\": \"įš€fXRl\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"THIRD_PARTY\",\n \"dateOfBirth\": \"69-59-0809\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"accountType\": \"SAVINGS\",\n \"intermediaryBanks\": [\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n ]\n }\n },\n \"reference\": \"\",\n \"method\": \"SWIFT\",\n \"fees\": {\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"EUR\"\n }\n },\n \"metadata\": {\n \"aliquade9\": \"\",\n \"eiusmod_0f\": \"\",\n \"minim1af\": \"\"\n },\n \"requestDetails\": {\n \"originator\": {\n \"ipAddress\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4639d290-0b25-4193-ac7f-e1d13084e512", "name": "Retrieve Payout (ver. 2).", "request": { "name": "Retrieve Payout (ver. 2).", "description": { "content": "Retrieves a specific payout. You can also use this endpoint to check the status of the crypto or fiat payout.", "type": "text/plain" }, "url": { "path": [ "payment", "v2", "payouts", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "transactionId", "disabled": false, "description": { "content": "(Required) The transaction ID of the payout that you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d39240f1-f53a-4daa-9cc5-7994e01a8f67", "name": "Payout retrieved successfully.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"method\": \"BANK_TRANSFER\",\n \"status\": \"CANCELLED\",\n \"type\": \"payment:payout:fiat\",\n \"fees\": {\n \"processingFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"amount\": \"\",\n \"currency\": \"AAD\",\n \"walletId\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"dateOfBirth\": \"00-69-2467\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"customerId\": \"\"\n },\n \"beneficiary\": {\n \"remittanceInformation\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"dateOfBirth\": \"18-55-6021\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"amount\": \"\",\n \"currency\": \"HRP\",\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"accountType\": \"SAVINGS\",\n \"intermediaryBanks\": [\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n ]\n }\n },\n \"metadata\": {\n \"quib26\": \"\",\n \"ut_e0\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"direction\": \"OUT\",\n \"reference\": \"\",\n \"trackingDetails\": [\n {\n \"externalTransactionId\": \"\",\n \"imad\": \"\",\n \"omad\": \"\",\n \"traceNumber\": \"\",\n \"uetr\": \"\"\n },\n {\n \"externalTransactionId\": \"\",\n \"imad\": \"\",\n \"omad\": \"\",\n \"traceNumber\": \"\",\n \"uetr\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31f2cdd5-611c-40a5-acf6-78e9e26ec91f", "name": "Bad request", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6be9282-086f-42c7-8895-613efdf3f42b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ab88a7b-f861-42b4-9540-fd92a5515d63", "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ad65e49-86e2-471e-be65-a71c2718fc14", "name": "Get Proof of Payment PDF", "request": { "name": "Get Proof of Payment in PDF", "description": { "content": "Retrieves a Proof of Payment PDF report for a fiat wallet payout. The proof of payment is available only for completed fiat payouts.", "type": "text/plain" }, "url": { "path": [ "payment", "v2", "payouts", ":transactionId", "proof-of-payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "transactionId", "disabled": false, "description": { "content": "(Required) The transaction ID of the payout for which to retrieve the proof of payment.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "30c78d5e-71c0-444e-85e6-dbc906f2edf9", "name": "Proof of Payment PDF retrieved successfully.\n\n**Note**: The response returns a byte array. Ensure your client library supports handling binary/byte array responses.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId", "proof-of-payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/pdf" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" }, { "disabled": false, "description": { "content": "The media type of the response body.", "type": "text/plain" }, "key": "Content-Type", "value": "" }, { "disabled": false, "description": { "content": "Indicates that the response should be downloaded as an attachment with the specified filename.", "type": "text/plain" }, "key": "Content-Disposition", "value": "" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9257369-594d-4185-b286-9a0df5f8e134", "name": "Unauthorized.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId", "proof-of-payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d3b14dd-9222-4e10-b23b-95ec970ca4a9", "name": "Forbidden.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId", "proof-of-payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f52dd60e-9fcd-4e45-b368-7c4e0359d98f", "name": "TransactionId not found.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId", "proof-of-payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e21991aa-57a9-4863-840c-3f34451e8e63", "name": "Internal server error", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":transactionId", "proof-of-payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4446993c-f816-4df5-b391-b2d98cc8a613", "name": "Verify Beneficiary", "request": { "name": "Verify Beneficiary's Name", "description": { "content": "Verifies the beneficiary's name. You can call this endpoint before creating a payout via [`POST /payment/v2/payouts`](https://docs.bvnk.com/reference/payoutcreatev2#/) to verify the beneficiary's name and receive a verification ID that can be used in subsequent payout requests.\n\nWhen using this endpoint, make sure you specify the same beneficiary's names as you will use in the payload of the [Initiate Payout](https://docs.bvnk.com/reference/payoutcreatev2#/) request.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Individual Beneficiary Verification:**\n1. **Individual Beneficiary Verification**\n\n**Company Beneficiary Verification:**\n1. **Company Beneficiary Verification**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "beneficiaries", "verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"GB29NWBK60161331926819\",\n \"bankCode\": \"NWBKGB2L\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"currency\": \"EUR\"\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "2e000257-6f21-423a-8b14-0e2b8077632b", "name": "OK", "originalRequest": { "url": { "path": [ "platform", "v1", "beneficiaries", "verification" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"\",\n \"bankCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"matchStatus\": \"NO_MATCH\",\n \"providedName\": \"\",\n \"validUntil\": \"\",\n \"actualName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "711adf93-b44b-49b8-9767-dd5b754f2274", "name": "Bad request - Invalid input parameters", "originalRequest": { "url": { "path": [ "platform", "v1", "beneficiaries", "verification" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"\",\n \"bankCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6670dc15-878a-417c-b83b-23c2b98b144c", "name": "Unauthorized - Invalid authentication", "originalRequest": { "url": { "path": [ "platform", "v1", "beneficiaries", "verification" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"\",\n \"bankCode\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebe03de1-ee88-4247-8469-885d53652a85", "name": "Confirm Beneficiary", "request": { "name": "Confirm Beneficiary's Name", "description": { "content": "Confirms a payout when the beneficiary name check returns a mismatch warning. If not confirmed within five minutes, the action expires. In this case, make a new payout.", "type": "text/plain" }, "url": { "path": [ "payment", "v2", "payouts", ":Id", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "Id", "disabled": false, "description": { "content": "(Required) The payout transaction identifier returned by [`POST /payment/v2/payouts`](https://docs.bvnk.com/reference/payoutcreatev2).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"CONFIRM_BENEFICIARY\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c754a5e6-3420-4408-a8f3-564e675b3f17", "name": "Confirmation accepted; returns standard payout details.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":Id", "actions" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"CONFIRM_BENEFICIARY\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"method\": \"BANK_TRANSFER\",\n \"status\": \"CANCELLED\",\n \"type\": \"payment:payout:fiat\",\n \"fees\": {\n \"processingFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"customerFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"amount\": \"\",\n \"currency\": \"AAD\",\n \"walletId\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"dateOfBirth\": \"00-69-2467\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"customerId\": \"\"\n },\n \"beneficiary\": {\n \"remittanceInformation\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationshipType\": \"SELF_OWNED\",\n \"dateOfBirth\": \"18-55-6021\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"amount\": \"\",\n \"currency\": \"HRP\",\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"bank\": {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n \"accountType\": \"SAVINGS\",\n \"intermediaryBanks\": [\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n },\n {\n \"identificationCode\": \"\",\n \"nid\": \"\",\n \"country\": \"\",\n \"address\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postCode\": \"\"\n }\n }\n ]\n }\n },\n \"metadata\": {\n \"quib26\": \"\",\n \"ut_e0\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"direction\": \"OUT\",\n \"reference\": \"\",\n \"trackingDetails\": [\n {\n \"externalTransactionId\": \"\",\n \"imad\": \"\",\n \"omad\": \"\",\n \"traceNumber\": \"\",\n \"uetr\": \"\"\n },\n {\n \"externalTransactionId\": \"\",\n \"imad\": \"\",\n \"omad\": \"\",\n \"traceNumber\": \"\",\n \"uetr\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53aa03d6-a889-4562-ad65-d677a15c837e", "name": "Bad request (e.g., expired confirmation window).", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":Id", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"CONFIRM_BENEFICIARY\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8284b40-4978-49fc-931a-853b253d5e2d", "name": "Transaction not found.", "originalRequest": { "url": { "path": [ "payment", "v2", "payouts", ":Id", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"CONFIRM_BENEFICIARY\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Refunds", "description": "", "item": [ { "id": "64f744b4-ffd6-414c-9a75-fa9d720f5e7f", "name": "Estimate Refund Fee", "request": { "name": "Estimate Refund Fee", "description": { "content": "Returns the estimated processing fee and the maximum remaining refundable balance for the pay-in. The fee will be deducted from your wallet when issuing a refund. The fee amount may vary depending on the merchant contract with BVNK.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "payins", ":transactionReference", "refund", "estimate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "023e5e53-6f50-4af5-a7e4-c9f15d493f90", "key": "transactionReference", "disabled": false, "description": { "content": "(Required) Unique reference (UUID) of the pay-in you plan to refund.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": 150.5,\n \"currency\": \"GBP\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "62b32e52-f99f-433e-9132-5819faf1845f", "name": "Fee estimate returned successfully.", "originalRequest": { "url": { "path": [ "payment", "v1", "payins", ":transactionReference", "refund", "estimate" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"currency\": \"USD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fee\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"maxAvailableToRefund\": {\n \"value\": \"\",\n \"currency\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "384eddb6-8418-4d15-8a57-ac2e86346cd1", "name": "Estimate could not be produced because the pay-in is not refundable or the amount is invalid.", "originalRequest": { "url": { "path": [ "payment", "v1", "payins", ":transactionReference", "refund", "estimate" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"currency\": \"USD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestHeader\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9a9c14-7d7a-434a-ae96-a01b0b482894", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "payment", "v1", "payins", ":transactionReference", "refund", "estimate" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"currency\": \"USD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22edea74-d316-4504-8f1a-2ae2a6ff4a85", "name": "Refund Pay-in", "request": { "name": "Refund Pay-in", "description": { "content": "Initiates seamless one-click refund processing for any previous pay-in. Once accepted, a refund transaction appears in your portal and can be acquired via API. \n\n Upon activation, the system automatically generates a new transaction according to our standard workflow. You can request multiple refunds for the same transaction, as long as the total refunded amount doesn't exceed what was originally paid in.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "payins", ":transactionReference", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "023e5e53-6f50-4af5-a7e4-c9f15d493f90", "key": "transactionReference", "disabled": false, "description": { "content": "(Required) Unique reference (UUID) of the pay-in you want to refund.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentReference\": \"test-ref-123\",\n \"amount\": {\n \"value\": 150.5,\n \"currency\": \"GBP\"\n },\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "081230bb-d735-4fb3-b902-71e43139e3c5", "name": "Refund request accepted", "originalRequest": { "url": { "path": [ "payment", "v1", "payins", ":transactionReference", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentReference\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"USD\"\n },\n \"metadata\": {\n \"iruredc\": \"\",\n \"dolore_48\": \"\",\n \"aliqua_10\": \"\",\n \"ipsum__e\": \"\",\n \"ullamco32f\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactionReference\": \"\",\n \"fee\": {\n \"value\": \"\",\n \"currency\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e332aa1-5c1e-40d5-a894-2f09a0c9b5a0", "name": "Estimate could not be produced because the pay-in is not refundable or the amount is invalid.", "originalRequest": { "url": { "path": [ "payment", "v1", "payins", ":transactionReference", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentReference\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"USD\"\n },\n \"metadata\": {\n \"iruredc\": \"\",\n \"dolore_48\": \"\",\n \"aliqua_10\": \"\",\n \"ipsum__e\": \"\",\n \"ullamco32f\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestHeader\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f1174b-81b0-4bbd-91ae-076644b62719", "name": "Unexpected Error", "originalRequest": { "url": { "path": [ "payment", "v1", "payins", ":transactionReference", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentReference\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"USD\"\n },\n \"metadata\": {\n \"iruredc\": \"\",\n \"dolore_48\": \"\",\n \"aliqua_10\": \"\",\n \"ipsum__e\": \"\",\n \"ullamco32f\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"documentLink\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "e87d42c7-df5b-4fc4-9dae-4a445d42c9dd", "name": "Simulate Pay-in (ver. 2)", "request": { "name": "Simulate Pay-in (ver. 2)", "description": { "content": "Simulates pay-ins with different currencies and payment methods in the sandbox environment.\n\nThis version allows specifying originator entity details (individual or company) for more comprehensive testing scenarios.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Pay-in from an individual:**\n1. **Pay-in from an individual**\n\n**Pay-in from a company:**\n1. **Pay-in from a company**\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "payment", "v2", "payins", "simulation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"a:24092328494070:G5i4XZ9:1\",\n \"method\": \"SEPA_CT\",\n \"remittanceInformation\": \"Invoice payment 12345\",\n \"amount\": 1500,\n \"currency\": \"EUR\",\n \"originator\": {\n \"name\": \"Emily Kaldwin\",\n \"bankAccount\": {\n \"accountNumber\": \"GB87SYPE04082500000904\",\n \"accountNumberFormat\": \"IBAN\",\n \"bankCode\": \"SRLGGB2L\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "803bf923-5a19-4d71-b077-173360f7b995", "name": "Success", "originalRequest": { "url": { "path": [ "payment", "v2", "payins", "simulation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"remittanceInformation\": \"ā€†Rs2Rā€†QzKob\",\n \"amount\": \"\",\n \"currency\": \"AFP\",\n \"originator\": {\n \"name\": \"\",\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"accountNumberFormat\": \"ABA\",\n \"bankCode\": \"\"\n }\n },\n \"method\": \"SEPA_CT\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42296042-8c73-4c7b-b35b-56d803bd08bb", "name": "Bad request", "originalRequest": { "url": { "path": [ "payment", "v2", "payins", "simulation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"remittanceInformation\": \"ā€†Rs2Rā€†QzKob\",\n \"amount\": \"\",\n \"currency\": \"AFP\",\n \"originator\": {\n \"name\": \"\",\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"accountNumberFormat\": \"ABA\",\n \"bankCode\": \"\"\n }\n },\n \"method\": \"SEPA_CT\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Internal Transfers", "description": "", "item": [ { "id": "a3271cc8-d567-48d8-a247-da493b3593a7", "name": "Create Internal Transfer", "request": { "name": "Create Internal Transfer", "description": { "content": "Create an internal Fiat transfer to an existing beneficiary wallet.\n\n**šŸ“‹ Example Use Case:** Transfer USD between wallets", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"a:24092328494070:G5i4XZ9:1\",\n \"amount\": {\n \"value\": 700,\n \"currency\": \"USD\"\n },\n \"paymentReference\": \"Payment for invoice 12345\",\n \"instruction\": {\n \"type\": \"FIAT\",\n \"beneficiaryWalletId\": \"a:87333266494070:G5i9AT9:1\"\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "83af8dee-1667-421d-ba16-571d3eee79b8", "name": "Created", "originalRequest": { "url": { "path": [ "payment", "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"USD\"\n },\n \"paymentReference\": \"XKwqI7Uph\\u000btw7uLUcā€ˆ\\nAuā€†\\r46kjz\",\n \"instruction\": {\n \"type\": \"FIAT\",\n \"beneficiaryWalletId\": \"\"\n },\n \"metadata\": {\n \"exercitation79\": \"\",\n \"commodo_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactionReference\": \"\",\n \"fee\": {\n \"value\": \"\",\n \"currency\": \"EUR\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43145ee5-9d8b-4790-97e0-e32e7f076316", "name": "Bad request", "originalRequest": { "url": { "path": [ "payment", "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"USD\"\n },\n \"paymentReference\": \"XKwqI7Uph\\u000btw7uLUcā€ˆ\\nAuā€†\\r46kjz\",\n \"instruction\": {\n \"type\": \"FIAT\",\n \"beneficiaryWalletId\": \"\"\n },\n \"metadata\": {\n \"exercitation79\": \"\",\n \"commodo_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4618b17-dd30-4d4d-876d-7e14a8fb5eaa", "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment", "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"USD\"\n },\n \"paymentReference\": \"XKwqI7Uph\\u000btw7uLUcā€ˆ\\nAuā€†\\r46kjz\",\n \"instruction\": {\n \"type\": \"FIAT\",\n \"beneficiaryWalletId\": \"\"\n },\n \"metadata\": {\n \"exercitation79\": \"\",\n \"commodo_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd6a19b2-c3d8-4b06-ae99-4551c2fb0a8a", "name": "Get Transfer", "request": { "name": "Get Transfer", "description": { "content": "Retrieves a specific transfer details.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "transfers", ":transactionReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "5dc4e061-31c6-4b96-8c4d-0ea984aece0b", "key": "transactionReference", "disabled": false, "description": { "content": "(Required) The transactionReference of the transfer that you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "09446aed-8467-414c-b89e-3e1a3ba46ee4", "name": "OK", "originalRequest": { "url": { "path": [ "payment", "v1", "transfers", ":transactionReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transactionReference\": \"\",\n \"paymentReference\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"GBP\"\n },\n \"fee\": {\n \"value\": \"\",\n \"currency\": \"GBP\"\n },\n \"walletId\": \"\",\n \"status\": \"REJECTED\",\n \"createdAt\": \"\",\n \"details\": {\n \"type\": \"WALLET\",\n \"beneficiary\": {\n \"entityType\": \"INDIVIDUAL\",\n \"companyDetails\": {\n \"name\": \"\"\n },\n \"individualDetails\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"dateOfBirth\": \"01/35/1510\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"countryCode\": \"\",\n \"postCode\": \"\"\n },\n \"walletId\": \"\"\n }\n },\n \"metadata\": {\n \"culpa_a4c\": \"\",\n \"Utc7d\": \"\",\n \"ute\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "743fa19b-56ea-4bc9-b4ac-22da9e5fa197", "name": "Not found.", "originalRequest": { "url": { "path": [ "payment", "v1", "transfers", ":transactionReference" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9847eb4-7440-4702-b43d-78d8fae2be27", "name": "Create Internal Transfer (ver. 2)", "request": { "name": "Create Internal Transfer (ver. 2)", "description": { "content": "Creates an internal stablecoin and fiat transfer between EPC and EP wallets.\n\nPayment combinations:\n\n- Crypto to crypto\n\n- Fiat to fiat\n\n**šŸ“‹ Example Use Case:** Create internal transfer", "type": "text/plain" }, "url": { "path": [ "payment", "v2", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "550e8400-e29b-41d4-a716-446655440000" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"REF558628\",\n \"walletId\": \"a:24122329329347:HsdJVhW:2\",\n \"amount\": 23,\n \"currency\": \"USD\",\n \"beneficiary\": {\n \"walletId\": \"a:25021926815866:4jlPfFg:1\"\n },\n \"metadata\": {\n \"memberId\": \"987654321\"\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "c0003838-c5db-4ded-833f-5e6fa138c87b", "name": "Transfer created successfully", "originalRequest": { "url": { "path": [ "payment", "v2", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"beneficiary\": {\n \"walletId\": \"\"\n },\n \"metadata\": {\n \"aliquip8d7\": \"\",\n \"labore676\": \"\",\n \"in_eb\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"type\": \"payment:transfer\",\n \"status\": \"PROCESSING\",\n \"method\": \"BOOK\",\n \"fees\": {\n \"processingFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"walletId\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n },\n \"beneficiary\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"walletId\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"metadata\": {\n \"tempor_345\": \"\",\n \"pariatur301\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0295642-ae0b-4f4c-bd47-735f4d7ee25d", "name": "Bad request", "originalRequest": { "url": { "path": [ "payment", "v2", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"beneficiary\": {\n \"walletId\": \"\"\n },\n \"metadata\": {\n \"aliquip8d7\": \"\",\n \"labore676\": \"\",\n \"in_eb\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d9a04fb-a3d3-4d6e-9516-00e86d628372", "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment", "v2", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Unique request identifier (any string, preferably in UUID format).", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"walletId\": \"\",\n \"reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"beneficiary\": {\n \"walletId\": \"\"\n },\n \"metadata\": {\n \"aliquip8d7\": \"\",\n \"labore676\": \"\",\n \"in_eb\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17e2d0fc-e3db-4023-b9db-bd15a5f1613c", "name": "Get Transfer (ver. 2)", "request": { "name": "Get Transfer (ver. 2)", "description": { "content": "Retrieves a specific transfer details.", "type": "text/plain" }, "url": { "path": [ "payment", "v2", "transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ae29acc3-c54a-11f0-90b6-21c3f364ff25", "key": "transferId", "disabled": false, "description": { "content": "(Required) The transfer ID that you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5fc07cd8-4eba-48eb-8819-31b6e0d9bb6a", "name": "Transfer retrieved successfully", "originalRequest": { "url": { "path": [ "payment", "v2", "transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"type\": \"payment:transfer\",\n \"status\": \"PROCESSING\",\n \"method\": \"BOOK\",\n \"fees\": {\n \"processingFee\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"originator\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"walletId\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n },\n \"beneficiary\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"walletId\": \"\",\n \"entity\": {\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n }\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"metadata\": {\n \"tempor_345\": \"\",\n \"pariatur301\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e977cd43-f223-4761-8037-d10d07cc8230", "name": "Transfer not found", "originalRequest": { "url": { "path": [ "payment", "v2", "transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa31e5e2-7a21-47f8-86bd-e3e3c1870d74", "name": "List Transfer Beneficiaries", "request": { "name": "List Transfer Beneficiaries", "description": { "content": "Retrieves a list of beneficiaries eligible for transfers for a specified wallet.", "type": "text/plain" }, "url": { "path": [ "payment", "v1", "transfers", ":walletId", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The currency code for the wallets.", "type": "text/plain" }, "key": "currencyCode", "value": "GBP" }, { "disabled": false, "description": { "content": "The type of the wallets.", "type": "text/plain" }, "key": "walletType", "value": "MAIN" }, { "disabled": false, "description": { "content": "Customer reference for the wallets being requested.", "type": "text/plain" }, "key": "customerReference", "value": "33e85982-e22b-4e8b-9057-445cf000bea9" } ], "variable": [ { "type": "any", "value": "a:24092328494070:G5i4XZ9:1", "key": "walletId", "disabled": false, "description": { "content": "(Required) The wallet ID for which you are listing the eligible beneficiaries.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "22d95ab5-e3b5-4d19-acb0-899db04b0db3", "name": "OK", "originalRequest": { "url": { "path": [ "payment", "v1", "transfers", ":walletId", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The currency code for the wallets.", "type": "text/plain" }, "key": "currencyCode", "value": "" }, { "disabled": false, "description": { "content": "The type of the wallets.", "type": "text/plain" }, "key": "walletType", "value": "" }, { "disabled": false, "description": { "content": "Customer reference for the wallets being requested.", "type": "text/plain" }, "key": "customerReference", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"walletId\": \"\",\n \"name\": \"\",\n \"balance\": {\n \"value\": \"\",\n \"currency\": \"USD\"\n },\n \"walletType\": \"MAIN\"\n },\n {\n \"walletId\": \"\",\n \"name\": \"\",\n \"balance\": {\n \"value\": \"\",\n \"currency\": \"USD\"\n },\n \"walletType\": \"CUSTOMER\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58e37a8b-a3b2-4257-bff3-aa9dcd1f15b7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment", "v1", "transfers", ":walletId", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The currency code for the wallets.", "type": "text/plain" }, "key": "currencyCode", "value": "" }, { "disabled": false, "description": { "content": "The type of the wallets.", "type": "text/plain" }, "key": "walletType", "value": "" }, { "disabled": false, "description": { "content": "Customer reference for the wallets being requested.", "type": "text/plain" }, "key": "customerReference", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"details\": {\n \"documentLink\": \"\",\n \"errors\": {\n \"requestBody\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Trading and Conversions", "description": "", "item": [ { "id": "6241a7c9-3922-4721-a04e-e5dc3c5cbe57", "name": "Create Quote", "request": { "name": "Create Quote", "description": { "content": "Creates a quote to convert currency between wallets.\n\nFor wallet-to-wallet payment quotes, the payment processing is synchronous. You can expect the following statuses in the response:\n\n| When | `quoteStatus` | `paymentStatus` |\n|------|-------------|---------------|\n| **Successful payment**|| |\n| Getting an estimate | `ESTIMATE` | `PENDING` |\n| Creating a quote | `PENDING` | `PENDING` |\n| Accepting the quote | `PAYMENT_OUT_PROCESSED` | `SUCCESS` |\n|**Failed payment**|| |\n| Pay-in fails | `PAYMENT_IN_FAILED` | `FAILED` |\n| Conversion fails | `CONVERSION_FAILED` | `FAILED` |\n| Pay-out fails | `PAYMENT_OUT_FAILED` | `FAILED` |\n\nIf you don't receive `\"paymentStatus\": \"SUCCESS\"` in the response, you can call `/api/v1/quote/{uuid}` to check the conversion progress.\n\n**šŸ“‹ Example Use Case:** Convert EUR to USDC between wallets", "type": "text/plain" }, "url": { "path": [ "api", "v1", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Create estimate quote", "type": "text/plain" }, "key": "estimate", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": \"EUR\",\n \"to\": \"USDC\",\n \"fromWalletLsid\": \"a:25052137356562:qjOSsJf:1\",\n \"toWalletLsid\": \"a:24092328494070:G5i4XZ9:2\",\n \"amountIn\": 500,\n \"useMinimum\": false,\n \"useMaximum\": false,\n \"payInMethod\": \"wallet\",\n \"payOutMethod\": \"wallet\"\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "67212aba-7d4a-4cc3-87c9-eac5afdb82fc", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Create estimate quote", "type": "text/plain" }, "key": "estimate", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\",\n \"fromWalletLsid\": \"\",\n \"useMinimum\": \"\",\n \"useMaximum\": \"\",\n \"toWalletLsid\": \"\",\n \"amountIn\": \"\",\n \"payInMethod\": \"\",\n \"payOutMethod\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"amountIn\": \"\",\n \"amountDue\": \"\",\n \"amountOut\": \"\",\n \"price\": \"\",\n \"quoteStatus\": \"PENDING\",\n \"paymentStatus\": \"FAILED\",\n \"acceptanceExpiryDate\": \"\",\n \"acceptanceDate\": \"\",\n \"paymentExpiryDate\": \"\",\n \"paymentReceiptDate\": \"\",\n \"payInLegs\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n }\n ],\n \"payInMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"settlementCurrency\": \"\",\n \"requestedCurrency\": \"\",\n \"estimatedExchangeRate\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"payOutMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"currency\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"uuid\": \"\",\n \"payOutInstruction\": \"\",\n \"payInInstruction\": {\n \"action\": \"\",\n \"form\": \"\",\n \"redirectUrl\": \"\",\n \"displayParameters\": \"\"\n },\n \"usePayInMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"usePayOutMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"fee\": \"\",\n \"processingFee\": \"\",\n \"type\": \"FIXED\",\n \"netPrice\": \"\",\n \"grossPrice\": \"\",\n \"amountInGross\": \"\",\n \"amountInNet\": \"\",\n \"fees\": {\n \"percentage\": {\n \"service\": \"\",\n \"processing\": \"\"\n },\n \"value\": {\n \"service\": \"\",\n \"processing\": \"\"\n }\n },\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "336b25d9-2d78-4161-9343-bb9e0a39baee", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "quote" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Create estimate quote", "type": "text/plain" }, "key": "estimate", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\",\n \"fromWalletLsid\": \"\",\n \"useMinimum\": \"\",\n \"useMaximum\": \"\",\n \"toWalletLsid\": \"\",\n \"amountIn\": \"\",\n \"payInMethod\": \"\",\n \"payOutMethod\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ae32019-8b1b-4c55-ac44-e90d6d8f130f", "name": "Accept Quote", "request": { "name": "Accept Quote", "description": { "content": "Executes a quote.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "quote", "accept", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "5dc4e061-31c6-4b96-8c4d-0ea984aece0b", "key": "uuid", "disabled": false, "description": { "content": "(Required) The quote UUID you are accepting.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"successUrl\": \"https://app.sandbox.bvnk.com/wallets/convert/complete/{{quote_id}}\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "260cd2b2-d216-4573-9bd9-970af1b6d52a", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "quote", "accept", ":uuid" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"successUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"quote\": {\n \"id\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"amountIn\": \"\",\n \"amountDue\": \"\",\n \"amountOut\": \"\",\n \"price\": \"\",\n \"quoteStatus\": \"PAYMENT_OUT_FAILED\",\n \"paymentStatus\": \"REFUND_PENDING\",\n \"acceptanceExpiryDate\": \"\",\n \"acceptanceDate\": \"\",\n \"paymentExpiryDate\": \"\",\n \"paymentReceiptDate\": \"\",\n \"payInLegs\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n }\n ],\n \"payInMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"settlementCurrency\": \"\",\n \"requestedCurrency\": \"\",\n \"estimatedExchangeRate\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"payOutMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"currency\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"uuid\": \"\",\n \"payOutInstruction\": \"\",\n \"payInInstruction\": {\n \"action\": \"\",\n \"form\": \"\",\n \"redirectUrl\": \"\",\n \"displayParameters\": \"\"\n },\n \"usePayInMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"usePayOutMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"fee\": \"\",\n \"processingFee\": \"\",\n \"type\": \"MARKET\",\n \"netPrice\": \"\",\n \"grossPrice\": \"\",\n \"amountInGross\": \"\",\n \"amountInNet\": \"\",\n \"fees\": {\n \"percentage\": {\n \"service\": \"\",\n \"processing\": \"\"\n },\n \"value\": {\n \"service\": \"\",\n \"processing\": \"\"\n }\n },\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\"\n },\n \"payInInstruction\": {\n \"action\": \"\",\n \"form\": \"\",\n \"redirectUrl\": \"\",\n \"displayParameters\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e563a334-8727-41f5-abd7-9b90fd3e2ca2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "quote", "accept", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"successUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1a3bb7f-095a-432a-8b14-6357a3dd3f64", "name": "Get Quote", "request": { "name": "Get Quote", "description": { "content": "Retrieves a specific quote.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "quote", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "0a12a214-1619-43fa-9be1-0029f6a440a0", "key": "uuid", "disabled": false, "description": { "content": "(Required) UUID of the quote you are retrieving.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6d95cb2a-43f1-4ebf-a665-0db48b013fdc", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "quote", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"amountIn\": \"\",\n \"amountDue\": \"\",\n \"amountOut\": \"\",\n \"price\": \"\",\n \"quoteStatus\": \"PENDING\",\n \"paymentStatus\": \"FAILED\",\n \"acceptanceExpiryDate\": \"\",\n \"acceptanceDate\": \"\",\n \"paymentExpiryDate\": \"\",\n \"paymentReceiptDate\": \"\",\n \"payInLegs\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n }\n ],\n \"payInMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"settlementCurrency\": \"\",\n \"requestedCurrency\": \"\",\n \"estimatedExchangeRate\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"payOutMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"currency\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"uuid\": \"\",\n \"payOutInstruction\": \"\",\n \"payInInstruction\": {\n \"action\": \"\",\n \"form\": \"\",\n \"redirectUrl\": \"\",\n \"displayParameters\": \"\"\n },\n \"usePayInMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"usePayOutMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"fee\": \"\",\n \"processingFee\": \"\",\n \"type\": \"FIXED\",\n \"netPrice\": \"\",\n \"grossPrice\": \"\",\n \"amountInGross\": \"\",\n \"amountInNet\": \"\",\n \"fees\": {\n \"percentage\": {\n \"service\": \"\",\n \"processing\": \"\"\n },\n \"value\": {\n \"service\": \"\",\n \"processing\": \"\"\n }\n },\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed65dbe1-ddb5-44b9-a7f2-c7dc543e0a7b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "quote", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "69361bd3-238f-44b1-91e0-bf3b334ae41a", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v1", "quote", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10dcbced-a4cf-42f6-8cb7-5684743ad7fc", "name": "List Quotes", "request": { "name": "List Quotes", "description": { "content": "Retrieves all quotes on a specific Merchant ID.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "quote", ":merchantId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "example", "key": "merchantId", "disabled": false, "description": { "content": "(Required) Merchant ID you are retrieving quotes from.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "624dc391-944d-433b-abb5-634502457482", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "quote", ":merchantId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"amountIn\": \"\",\n \"amountDue\": \"\",\n \"amountOut\": \"\",\n \"price\": \"\",\n \"quoteStatus\": \"PAYMENT_OUT_FAILED\",\n \"paymentStatus\": \"PENDING\",\n \"acceptanceExpiryDate\": \"\",\n \"acceptanceDate\": \"\",\n \"paymentExpiryDate\": \"\",\n \"paymentReceiptDate\": \"\",\n \"payInLegs\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n }\n ],\n \"payInMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"settlementCurrency\": \"\",\n \"requestedCurrency\": \"\",\n \"estimatedExchangeRate\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"payOutMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"currency\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"uuid\": \"\",\n \"payOutInstruction\": \"\",\n \"payInInstruction\": {\n \"action\": \"\",\n \"form\": \"\",\n \"redirectUrl\": \"\",\n \"displayParameters\": \"\"\n },\n \"usePayInMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"usePayOutMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"fee\": \"\",\n \"processingFee\": \"\",\n \"type\": \"MARKET\",\n \"netPrice\": \"\",\n \"grossPrice\": \"\",\n \"amountInGross\": \"\",\n \"amountInNet\": \"\",\n \"fees\": {\n \"percentage\": {\n \"service\": \"\",\n \"processing\": \"\"\n },\n \"value\": {\n \"service\": \"\",\n \"processing\": \"\"\n }\n },\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\"\n },\n {\n \"id\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"amountIn\": \"\",\n \"amountDue\": \"\",\n \"amountOut\": \"\",\n \"price\": \"\",\n \"quoteStatus\": \"CONVERSION_FAILED\",\n \"paymentStatus\": \"CANCELLED\",\n \"acceptanceExpiryDate\": \"\",\n \"acceptanceDate\": \"\",\n \"paymentExpiryDate\": \"\",\n \"paymentReceiptDate\": \"\",\n \"payInLegs\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"dateCreated\": \"\",\n \"reference\": \"\",\n \"currency\": \"\"\n }\n ],\n \"payInMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"settlementCurrency\": \"\",\n \"requestedCurrency\": \"\",\n \"estimatedExchangeRate\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"payOutMethod\": {\n \"id\": \"\",\n \"code\": \"\",\n \"currency\": \"\",\n \"accountMethods\": [\n \"\",\n \"\"\n ]\n },\n \"uuid\": \"\",\n \"payOutInstruction\": \"\",\n \"payInInstruction\": {\n \"action\": \"\",\n \"form\": \"\",\n \"redirectUrl\": \"\",\n \"displayParameters\": \"\"\n },\n \"usePayInMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"usePayOutMethod\": {\n \"id\": \"\",\n \"display\": \"\"\n },\n \"fee\": \"\",\n \"processingFee\": \"\",\n \"type\": \"FIXED\",\n \"netPrice\": \"\",\n \"grossPrice\": \"\",\n \"amountInGross\": \"\",\n \"amountInNet\": \"\",\n \"fees\": {\n \"percentage\": {\n \"service\": \"\",\n \"processing\": \"\"\n },\n \"value\": {\n \"service\": \"\",\n \"processing\": \"\"\n }\n },\n \"dateCreated\": \"\",\n \"lastUpdated\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5155cd04-7837-46b4-bad8-857e1706cd23", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "quote", ":merchantId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "67989c6c-8405-491b-9dc2-756e91ee4ece", "name": "Not Found", "originalRequest": { "url": { "path": [ "api", "v1", "quote", ":merchantId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Currencies", "description": "", "item": [ { "id": "94bae539-8c11-4a28-bbe4-8a6cb720494a", "name": "List Crypto Currencies", "request": { "name": "List Crypto Currencies", "description": { "content": "Retrieves a list of all cryptocurrencies available on the BVNK platform. This list represents cryptocurrencies that end users can select whilst making a payment.\n\nAlso, see [Currencies](https://docs.bvnk.com/bvnk/references/currencies/) for the comprehensive list of available currencies.", "type": "text/plain" }, "url": { "path": [ "api", "currency", "crypto" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" }, { "disabled": false, "description": { "content": "Only list currencies that allow deposits.", "type": "text/plain" }, "key": "allowDeposits", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ea1b4112-fdd0-415e-8076-a0f8731a6c6e", "name": "OK", "originalRequest": { "url": { "path": [ "api", "currency", "crypto" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" }, { "disabled": false, "description": { "content": "Only list currencies that allow deposits.", "type": "text/plain" }, "key": "allowDeposits", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e60b5f30-a310-4e3e-899f-ab6271638dae", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "currency", "crypto" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" }, { "disabled": false, "description": { "content": "Only list currencies that allow deposits.", "type": "text/plain" }, "key": "allowDeposits", "value": "false" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d198d29-ebb2-4a54-b52c-c78a490a17ee", "name": "List Fiat Currencies", "request": { "name": "List Fiat Currencies", "description": { "content": "Retrieves a list of all display fiat currencies available on BVNK's Crypto Payments API.\nThis list refers to currencies merchants can display on a payment page to an end user. It does not represent the list of currencies that can be held on the platform in wallets.", "type": "text/plain" }, "url": { "path": [ "api", "currency", "fiat" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a676dfa8-fd09-4bf1-b789-a30eced1ee9d", "name": "OK", "originalRequest": { "url": { "path": [ "api", "currency", "fiat" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": true,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {},\n \"pricePrecision\": 2,\n \"quantityPrecision\": 2,\n \"supportsDeposits\": true,\n \"supportsWithdrawals\": true,\n \"withdrawalFee\": \"\"\n },\n {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": true,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {},\n \"pricePrecision\": 2,\n \"quantityPrecision\": 2,\n \"supportsDeposits\": true,\n \"supportsWithdrawals\": true,\n \"withdrawalFee\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "518d15ab-3a53-4ccf-9d0b-52d02962884f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "currency", "fiat" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c98360c6-9692-4e7e-96e2-6aa724b8f4ce", "name": "List Wallet Currencies", "request": { "name": "List Wallet Currencies", "description": { "content": "These are the currencies that can be used to create a new wallet.", "type": "text/plain" }, "url": { "path": [ "api", "currency", "deposit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "744b69ba-ab5f-49b5-9678-93dd4a8ea780", "name": "OK", "originalRequest": { "url": { "path": [ "api", "currency", "deposit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89612de2-3e74-4c73-83f2-760a592a683f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "currency", "deposit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Where to start fetching records.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Maximum number of items in response.", "type": "text/plain" }, "key": "max", "value": "200" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc3c4d12-8c0c-40ad-b584-d7b523d5daa4", "name": "Get Exchange Rate", "request": { "name": "Get Exchange Rate", "description": { "content": "Provides a mid market exchange rate between two assets.", "type": "text/plain" }, "url": { "path": [ "api", "currency", "convert", ":fromCode", ":toCode" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The amount to be converted.", "type": "text/plain" }, "key": "amount", "value": "1" } ], "variable": [ { "type": "any", "value": "ETH", "key": "fromCode", "disabled": false, "description": { "content": "(Required) The currency to be converted from.", "type": "text/plain" } }, { "type": "any", "value": "BTC", "key": "toCode", "disabled": false, "description": { "content": "(Required) The currency to be converted to.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f63b4d87-77a9-4460-9312-70b210cc3730", "name": "OK", "originalRequest": { "url": { "path": [ "api", "currency", "convert", ":fromCode", ":toCode" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The amount to be converted.", "type": "text/plain" }, "key": "amount", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf4cb3e-4730-4b11-8b37-07023ad84d63", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "currency", "convert", ":fromCode", ":toCode" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The amount to be converted.", "type": "text/plain" }, "key": "amount", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3cf63c62-6eff-4e1a-9b2a-abdd187346c8", "name": "List Exchange Rates", "request": { "name": "List Exchange Rates", "description": { "content": "Lists available exchange rates for a given currency.", "type": "text/plain" }, "url": { "path": [ "api", "currency", "values", ":baseCurrency" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ETH", "key": "baseCurrency", "disabled": false, "description": { "content": "(Required) The currency to get exchange rates for.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d2452647-f112-4073-83da-3c67b0b71d2f", "name": "OK", "originalRequest": { "url": { "path": [ "api", "currency", "values", ":baseCurrency" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"baseCode\": \"\",\n \"counterCode\": \"\",\n \"rate\": \"\"\n },\n {\n \"baseCode\": \"\",\n \"counterCode\": \"\",\n \"rate\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae898bed-fc93-4a22-bad7-75cf69a026fa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "currency", "values", ":baseCurrency" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Merchant IDs", "description": "", "item": [ { "id": "b910cb71-4c4b-4e97-b936-18e07c87523f", "name": "Create Merchant ID", "request": { "name": "Create Merchant ID", "description": { "content": "Generate a Merchant ID for your account to process pay-ins and pay-outs through our API.\n\nA Merchant ID is essential as it designates the account wallet where incoming pay-ins will be settled. For instance, if a Merchant ID is associated with a EUR wallet ID, any incoming USDT payment will be automatically converted to EUR and deposited in the designated EUR wallet.\n\nVice versa, any outgoing USDT payment will be automatically converted and withdrawn from the designated EUR wallet.\n\nFor further information, please visit https://docs.bvnk.com/docs/creating-your-first-merchant to learn more about creating your first Merchant ID.\n\n**šŸ“‹ Example Use Case:** Create a new Merchant ID linked to a EUR wallet", "type": "text/plain" }, "url": { "path": [ "api", "v1", "merchant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Acme Corp Payments\",\n \"webhookUrl\": \"https://acme-corp.com/webhooks/bvnk\",\n \"wallet\": {\n \"id\": \"501098\"\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "384ce722-1b82-4ec6-9c70-68157a1d1d6b", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "merchant" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"wallet\": {\n \"id\": \"\"\n },\n \"webhookUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"merchantId\": \"\",\n \"displayName\": \"\",\n \"secret\": \"\",\n \"webhookUrl\": \"\",\n \"autoConvertInvalidPayments\": true,\n \"defaultExpiryMinutes\": \"\",\n \"webhookVersion\": \"\",\n \"wallet\": {\n \"address\": \"\",\n \"approxAvailable\": \"\",\n \"approxBalance\": \"\",\n \"available\": \"\",\n \"balance\": \"\",\n \"convertedAvailable\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"custodianWallet\": null,\n \"depositFee\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"isEmoney\": false,\n \"lookup\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"supportsDeposits\": true,\n \"supportsThirdParty\": false,\n \"supportsWithdrawals\": true,\n \"withdrawalFee\": \"\",\n \"supportsInternalBvnkNetworkTransfers\": false,\n \"partner\": \"\",\n \"supportedTransferDestinations\": [\n \"\",\n \"\"\n ],\n \"approxConvertedAvailable\": \"\",\n \"lsid\": \"\",\n \"status\": \"TERMINATED\"\n },\n \"emailRecipients\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48a9849d-003c-4ba7-af18-fa1a7f16b0d3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "merchant" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"wallet\": {\n \"id\": \"\"\n },\n \"webhookUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorList\": [\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"parameter\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83fe9675-694a-4f13-9604-445821668ba1", "name": "List Merchant IDs", "request": { "name": "List Merchant IDs", "description": { "content": "Retrieves merchant IDs setup on your account.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "merchant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "45e74162-cc33-4b51-af25-9cb4c11226e3", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "merchant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"displayName\": \"\",\n \"secret\": \"\",\n \"webhookUrl\": \"\",\n \"autoConvertInvalidPayments\": true,\n \"defaultExpiryMinutes\": \"\",\n \"webhookVersion\": \"\",\n \"wallet\": {\n \"address\": \"\",\n \"approxAvailable\": \"\",\n \"approxBalance\": \"\",\n \"available\": \"\",\n \"balance\": \"\",\n \"convertedAvailable\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"custodianWallet\": null,\n \"depositFee\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"isEmoney\": false,\n \"lookup\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"supportsDeposits\": true,\n \"supportsThirdParty\": false,\n \"supportsWithdrawals\": true,\n \"withdrawalFee\": \"\",\n \"supportsInternalBvnkNetworkTransfers\": false,\n \"partner\": \"\",\n \"supportedTransferDestinations\": [\n \"\",\n \"\"\n ],\n \"approxConvertedAvailable\": \"\",\n \"lsid\": \"\",\n \"status\": \"INACTIVE\"\n },\n \"emailRecipients\": \"\"\n },\n {\n \"id\": \"\",\n \"merchantId\": \"\",\n \"displayName\": \"\",\n \"secret\": \"\",\n \"webhookUrl\": \"\",\n \"autoConvertInvalidPayments\": true,\n \"defaultExpiryMinutes\": \"\",\n \"webhookVersion\": \"\",\n \"wallet\": {\n \"address\": \"\",\n \"approxAvailable\": \"\",\n \"approxBalance\": \"\",\n \"available\": \"\",\n \"balance\": \"\",\n \"convertedAvailable\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"depositFee\": \"\",\n \"fiat\": false,\n \"icon\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"options\": {\n \"transaction\": \"\",\n \"explorer\": \"\",\n \"address\": \"\",\n \"confirmations\": \"\"\n },\n \"pricePrecision\": 5,\n \"protocols\": [\n {\n \"code\": \"\",\n \"network\": \"\"\n },\n {\n \"code\": \"\",\n \"network\": \"\"\n }\n ],\n \"quantityPrecision\": 5,\n \"supportsDeposits\": false,\n \"supportsWithdrawals\": false,\n \"withdrawalFee\": \"\",\n \"withdrawalParameters\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"custodianWallet\": null,\n \"depositFee\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"isEmoney\": false,\n \"lookup\": \"\",\n \"network\": \"\",\n \"protocol\": \"\",\n \"supportsDeposits\": true,\n \"supportsThirdParty\": false,\n \"supportsWithdrawals\": true,\n \"withdrawalFee\": \"\",\n \"supportsInternalBvnkNetworkTransfers\": false,\n \"partner\": \"\",\n \"supportedTransferDestinations\": [\n \"\",\n \"\"\n ],\n \"approxConvertedAvailable\": \"\",\n \"lsid\": \"\",\n \"status\": \"TERMINATED\"\n },\n \"emailRecipients\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "441dd40c-06cd-43f3-8364-4da687b1ecc0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "v1", "merchant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Embedded Express", "description": "", "item": [ { "id": "d1d274c5-ec1d-4077-9f10-a1478a176f76", "name": "Create Express Session", "request": { "name": "Create Express Session", "description": { "content": "Creates a wallet session URL for Embedded Express customers, allowing them to access their branded stablecoin wallet. The URL is returned in `walletSessionUrl` and can be shared via web view, redirect, or other integration methods. Each session link is time-bound and user-specific for security. BVNK verifies the user's identity before granting access. For details on the customer experience, consult your Account Manager.\n\nTo maintain consistent branding, include the optional `theme` object with each session creation. This ensures your customer sees your colors and logo in their wallet interface.\n\nThe endpoint automatically manages onboarding based on the customer's status with BVNK:\n\nā€¢ New customers receive an onboarding link.\n\nā€¢ Existing BVNK customers who have not used Express receive an Express registration link.\n\nā€¢ Existing Express customers receive a login link.\n\nā€¢ Customers with an active session token can access the wallet interface directly.\n\nFor existing BVNK customers receiving an Express link for the first time, ensure the link is accessible only by the intended customer.\n\nUse this endpoint to enable Express features for your customers.\n\n**šŸ“‹ Available Use Case Examples:**\n\n**Existing embedded customer:**\n1. **Existing embedded customer**\n Request payload for an existing embedded customer who already exists in your system.\n\n**New embedded customer:**\n1. **New embedded customer**\n Request payload for a new customer who doesn't exist in your system yet.\n\n\n*Note: The request body below shows the first example. Modify it to match any of the available use cases above.*", "type": "text/plain" }, "url": { "path": [ "platform", "v1", "wallet-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerReference\": \"22c8168d-f735-43f8-9a3b-a1578efeb86c\",\n \"theme\": {\n \"logo\": \"https://ok14static.oktacdn.com/fs/bco/1/fs0waisynotIeKa80697\",\n \"primary\": \"#121212\",\n \"secondary\": \"#382457\",\n \"accent\": \"#DEF832\"\n }\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [ { "id": "95af68ec-748c-4849-9129-78a76988281d", "name": "Express session created successfully", "originalRequest": { "url": { "path": [ "platform", "v1", "wallet-sessions" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerReference\": \"\",\n \"theme\": {\n \"logo\": \"\",\n \"primary\": \"#0F1187\",\n \"secondary\": \"#7E96Ec\",\n \"accent\": \"#A73EA5\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"walletSessionUrl\": \"\",\n \"externalCustomerReference\": \"\",\n \"customerReference\": \"\",\n \"customerType\": \"COMPANY\",\n \"useCase\": \"EMBEDDED_STABLECOIN_WALLETS\",\n \"countryCode\": \"\",\n \"theme\": {\n \"logo\": \"\",\n \"primary\": \"#A23FF2\",\n \"secondary\": \"#e0Ce8D\",\n \"accent\": \"#53a1ee\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78ca1c59-2bf2-4c53-bb9f-d05ca57f2eae", "name": "Bad Request", "originalRequest": { "url": { "path": [ "platform", "v1", "wallet-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerReference\": \"\",\n \"theme\": {\n \"logo\": \"\",\n \"primary\": \"#0F1187\",\n \"secondary\": \"#7E96Ec\",\n \"accent\": \"#A73EA5\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff2369b0-99aa-49f2-a1be-516a9e299b08", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "v1", "wallet-sessions" ], "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: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerReference\": \"\",\n \"theme\": {\n \"logo\": \"\",\n \"primary\": \"#0F1187\",\n \"secondary\": \"#7E96Ec\",\n \"accent\": \"#A73EA5\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n },\n {\n \"code\": \"FORBIDDEN\",\n \"message\": \"\",\n \"fieldName\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Hawk Authentication Pre-request Script", "const hawkAuthId = pm.environment.get(\"hawk_auth_id\") || pm.collectionVariables.get(\"hawk_auth_id\");", "const hawkAuthKey = pm.environment.get(\"hawk_auth_key\") || pm.collectionVariables.get(\"hawk_auth_key\");", "", "// Trim credentials to avoid whitespace issues", "const trimmedHawkId = (hawkAuthId || \"\").trim();", "const trimmedHawkKey = (hawkAuthKey || \"\").trim();", "", "if (!trimmedHawkId || !trimmedHawkKey) {", " console.warn(\"Hawk Auth ID and Key must be set in environment or collection variables\");", " return;", "}", "", "// Generate timestamp and nonce (matching Node.js example from docs)", "const timestamp = Math.floor(Date.now() / 1000);", "const nonce = Math.random().toString(36).substring(7);", "", "// Get request method", "const method = pm.request.method.toUpperCase();", "", "// Construct URL from Postman URL object", "const urlObj = pm.request.url;", "", "// Get base URL from environment or construct from host", "const baseUrl = pm.environment.get(\"baseUrl\") || pm.collectionVariables.get(\"baseUrl\") || \"api.sandbox.bvnk.com\";", "const protocol = urlObj.protocol || \"https\";", "", "// Get hostname (just the host, no port) - handle both array and string formats", "let host;", "if (urlObj.host && Array.isArray(urlObj.host)) {", " let hostValue = urlObj.host[0] || baseUrl;", " // Resolve Postman variable if it's a variable reference like {{baseUrl}}", " if (hostValue && typeof hostValue === \"string\" && hostValue.startsWith(\"{{\") && hostValue.endsWith(\"}}\")) {", " const varName = hostValue.slice(2, -2);", " host = pm.environment.get(varName) || pm.collectionVariables.get(varName) || baseUrl;", " } else {", " host = hostValue;", " }", "} else if (typeof urlObj.host === \"string\") {", " host = urlObj.host;", "} else {", " host = baseUrl;", "}", "", "// Remove protocol if present", "host = host.replace(/^https?:\\/\\//, \"\");", "", "// Remove port from host if present (host should be just hostname)", "host = host.split(\":\")[0];", "", "// Get path - resolve path variables to their actual values", "// This is critical: the path in the normalized string must match exactly what is sent", "let path;", "try {", " // First, try to get the fully resolved URL from Postman (if available)", " // This is the most reliable way to get the exact path that will be sent", " let resolvedUrl = null;", " try {", " // Try to get resolved URL - Postman may provide this", " if (typeof pm.request.url.toString === \"function\") {", " const urlString = pm.request.url.toString();", " if (urlString && urlString.startsWith(\"http\")) {", " try {", " const url = new URL(urlString);", " resolvedUrl = url.pathname;", " } catch (e) {", " // URL parsing failed, continue with manual resolution", " }", " }", " }", " } catch (e) {", " // toString() not available or failed, continue with manual resolution", " }", " ", " if (resolvedUrl) {", " path = resolvedUrl;", " console.log(\"Using resolved URL path:\", path);", " } else if (urlObj.path && Array.isArray(urlObj.path)) {", " // Build path array, replacing variables with their values", " // CRITICAL: Must resolve path variables from urlObj.variable array", " const pathParts = urlObj.path.map(segment => {", " // Check if this segment is a variable (starts with :)", " if (segment && typeof segment === \"string\" && segment.startsWith(\":\")) {", " const varName = segment.substring(1);", " let varValue = null;", " ", " // Strategy 1: Check urlObj.variable array (Postman URL variables)", " // This is where Postman stores path variable values when set in the UI", " if (urlObj.variable && Array.isArray(urlObj.variable)) {", " const pathVar = urlObj.variable.find(v => v && v.key === varName && !v.disabled);", " if (pathVar && pathVar.value) {", " varValue = String(pathVar.value).trim();", " }", " }", " ", " // Strategy 2: Try to get from Postman environment/collection variables", " // (Some users might set path variables as env/collection vars)", " if (!varValue || varValue === \"\" || varValue === \"\" || varValue.startsWith(\"<\")) {", " const envValue = pm.environment.get(varName);", " const collValue = pm.collectionVariables.get(varName);", " if (envValue && envValue !== \"\" && !envValue.startsWith(\"<\")) {", " varValue = String(envValue).trim();", " } else if (collValue && collValue !== \"\" && !collValue.startsWith(\"<\")) {", " varValue = String(collValue).trim();", " }", " }", " ", " // Use the resolved value if valid", " // IMPORTANT: Do NOT URL-encode path segments - Postman handles this automatically", " // The path variable value should be used as-is (Postman will encode it when building the URL)", " if (varValue && varValue !== \"\" && varValue !== \"\" && !varValue.startsWith(\"<\") && varValue !== \":\") {", " return varValue;", " }", " ", " // If variable not found or is placeholder, this will cause auth failure", " console.error(\"CRITICAL: Path variable \" + varName + \" is not set or is a placeholder. Current value: \" + (varValue || \"null\") + \". Hawk auth will fail!\");", " return segment;", " }", " return segment || \"\";", " }).filter(s => s);", " path = \"/\" + pathParts.join(\"/\");", " } else if (typeof urlObj.path === \"string\") {", " path = urlObj.path.startsWith(\"/\") ? urlObj.path : \"/\" + urlObj.path;", " } else {", " path = \"/\";", " }", " ", " // Ensure path starts with /", " if (!path.startsWith(\"/\")) {", " path = \"/\" + path;", " }", " ", " // Log the final path for debugging", " console.log(\"Final resolved path for Hawk MAC:\", path);", "} catch (e) {", " console.error(\"Error resolving path:\", e);", " console.error(\"Stack:\", e.stack);", " path = \"/\";", "}", "", "// Get query string - construct from query parameters array", "// CRITICAL: Build query string exactly as Postman sends it", "// Postman only includes enabled parameters with non-empty, non-placeholder values", "let query = \"\";", "if (urlObj.query && Array.isArray(urlObj.query)) {", " const queryParts = urlObj.query", " .filter(q => {", " // Only include enabled parameters with real values", " if (!q.key || q.disabled) return false;", " const value = q.value || \"\";", " // Exclude empty values, placeholders, and variable references", " if (value === \"\" || value === \"\" || value === \"\" || value === \"\" || ", " value === \"\" || value === \"\" || value === \"\" || ", " value.startsWith(\"<\") || value.startsWith(\"{{\") || value.startsWith(\"%3C\")) {", " return false;", " }", " return true;", " })", " .map(q => {", " // Use encodeURIComponent to match Postman's encoding", " // Postman automatically encodes query parameter values", " return q.key + \"=\" + encodeURIComponent(q.value);", " });", " ", " if (queryParts.length > 0) {", " query = \"?\" + queryParts.join(\"&\");", " }", "}", "", "// Resource is path + query (matching Python example: parsed_uri.path + parsed_uri.query)", "const resource = path + query;", "", "// Get port (default to 443 for https, 80 for http)", "const port = String(urlObj.port || (protocol === \"https\" ? 443 : 80));", "", "// Generate normalized string for MAC calculation", "// Format: hawk.1.header\\nts\\nnonce\\nmethod\\nresource\\nhost\\nport\\nhash\\n\\n", "// Note: hash is empty string for BVNK API (payload validation not used)", "// Important: host must be lowercase (per Java/Python examples), port must be string", "const hash = \"\";", "const normalized = \"hawk.1.header\\n\" + timestamp + \"\\n\" + nonce + \"\\n\" + method + \"\\n\" + resource + \"\\n\" + host.toLowerCase() + \"\\n\" + port + \"\\n\" + hash + \"\\n\\n\";", "", "// Calculate MAC using HMAC-SHA256", "// Note: CryptoJS is deprecated but works reliably in Postman", "const mac = CryptoJS.HmacSHA256(normalized, trimmedHawkKey).toString(CryptoJS.enc.Base64);", "", "// Construct Hawk Authorization header (matching Node.js example format)", "const hawkHeader = \"Hawk id=\\\"\" + trimmedHawkId + \"\\\", ts=\\\"\" + timestamp + \"\\\", nonce=\\\"\" + nonce + \"\\\", mac=\\\"\" + mac + \"\\\"\";", "", "// Remove any existing Authorization header (including variables like {{apiKey}})", "const authHeaders = pm.request.headers.filter(h => h.key && h.key.toLowerCase() === \"authorization\");", "authHeaders.forEach(h => pm.request.headers.remove(h));", "", "// Add the new Hawk Authorization header", "pm.request.headers.add({", " key: \"Authorization\",", " value: hawkHeader,", " disabled: false", "});", "", "// Debug logging - enable to troubleshoot", "console.log(\"=== Hawk Authentication Debug ===\");", "console.log(\"Method:\", method);", "console.log(\"Resource (path + query):\", resource);", "console.log(\"Host:\", host);", "console.log(\"Port:\", port);", "console.log(\"Normalized string (with \\\\n):\");", "console.log(normalized.replace(/\\n/g, \"\\\\n\"));", "console.log(\"Authorization Header:\", hawkHeader);", "", "// Show path variable resolution for debugging", "if (urlObj.variable && urlObj.variable.length > 0) {", " console.log(\"Path Variables in URL:\");", " urlObj.variable.forEach(v => {", " console.log(\" \" + v.key + \" = \" + (v.value || \"(not set)\") + (v.disabled ? \" [DISABLED]\" : \"\"));", " });", "}", "console.log(\"=================================\");" ] } } ], "variable": [ { "key": "baseUrl", "value": "api.sandbox.bvnk.com", "type": "string" }, { "key": "hawk_auth_id", "value": "AQ0PMJCuWdIVwRP1yU5Qx6zuKEcXqSlxM1ZApmc4RvYapXoIE7NT4TtZUNL4p67U", "type": "string" }, { "key": "hawk_auth_key", "value": "uI9k1T9ve84bzQSlFxPLdrc4w7F5SHSPEhJFC950L9VIod7ew4QSP08wQAjP3oEG", "type": "string" } ] }