{ "item": [ { "id": "41614aa3-64a7-4f3a-925d-567070c8050c", "name": "Clients", "description": { "content": "Onboard, update and retrieve the clients under your distributor account.", "type": "text/plain" }, "item": [ { "id": "f8136f46-db49-4ea8-a9ee-02d5d88ef55b", "name": "Get all clients", "request": { "name": "Get all clients", "description": { "content": "Retrieves a list of all active clients associated with your distributor account.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a1078c15-a9d0-4652-920f-5bb84b8f5aab", "name": "Returns an array of clients", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"clientType\": \"Limited Company\",\n \"identifier\": \"CLIENT-001\",\n \"externalReference\": \"EXT-REF-001\",\n \"expectedMonthlySpend\": 5000,\n \"riskRating\": \"Low\",\n \"contacts\": [\n {\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"street\": \"1 High Street\",\n \"city\": \"London\",\n \"region\": \"Greater London\",\n \"postcode\": \"EC1A 1BB\",\n \"countryCode\": \"GB\"\n },\n \"dateOfBirth\": \"1985-06-15\"\n }\n ],\n \"corporateDetails\": {\n \"name\": \"Acme Ltd\",\n \"registrationNumber\": \"12345678\",\n \"registeredAddress\": {\n \"street\": \"1 High Street\",\n \"city\": \"London\",\n \"region\": \"Greater London\",\n \"postcode\": \"EC1A 1BB\",\n \"countryCode\": \"GB\"\n },\n \"industryCode\": \"6419\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "078ae2b3-8c46-4824-b4e5-90e0056122f5", "name": "Validation failed", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82f69547-ef7f-45f3-a96c-37bac56a6881", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a063a355-090d-44ff-bc79-37fcfdf3b060", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07ff6c5a-55a7-484c-8b06-93f647439c6f", "name": "Onboard a new client", "request": { "name": "Onboard a new client", "description": { "content": "Provisions a new client under your distributor account. Upon creation, the client status is initially `Active`.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"Limited Company\",\n \"expectedMonthlySpend\": 5000,\n \"externalReference\": \"EXT-REF-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n }\n ],\n \"corporate\": {\n \"industryCode\": \"6419\",\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"registrationNumber\": \"12345678\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "61e11c79-78f3-46c9-88aa-8c908a6362c3", "name": "Client created successfully", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"Limited Company\",\n \"expectedMonthlySpend\": 5000,\n \"externalReference\": \"EXT-REF-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n }\n ],\n \"corporate\": {\n \"industryCode\": \"6419\",\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"registrationNumber\": \"12345678\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"response\": {\n \"clientType\": \"Limited Company\",\n \"identifier\": \"CLIENT-001\",\n \"externalReference\": \"EXT-REF-001\",\n \"expectedMonthlySpend\": 5000,\n \"riskRating\": \"Low\",\n \"contacts\": [\n {\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"street\": \"1 High Street\",\n \"city\": \"London\",\n \"region\": \"Greater London\",\n \"postcode\": \"EC1A 1BB\",\n \"countryCode\": \"GB\"\n },\n \"dateOfBirth\": \"1985-06-15\"\n }\n ],\n \"corporateDetails\": {\n \"name\": \"Acme Ltd\",\n \"registrationNumber\": \"12345678\",\n \"registeredAddress\": {\n \"street\": \"1 High Street\",\n \"city\": \"London\",\n \"region\": \"Greater London\",\n \"postcode\": \"EC1A 1BB\",\n \"countryCode\": \"GB\"\n },\n \"industryCode\": \"6419\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cd412ea-268c-4542-861e-a6659d3755f4", "name": "Validation failed — see the `errors` array", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"Limited Company\",\n \"expectedMonthlySpend\": 5000,\n \"externalReference\": \"EXT-REF-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n }\n ],\n \"corporate\": {\n \"industryCode\": \"6419\",\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"registrationNumber\": \"12345678\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b225293-5d30-4e6e-9e49-e56c4531fe74", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"Limited Company\",\n \"expectedMonthlySpend\": 5000,\n \"externalReference\": \"EXT-REF-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n }\n ],\n \"corporate\": {\n \"industryCode\": \"6419\",\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"registrationNumber\": \"12345678\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "168f0227-2934-4f28-a126-9c971f7f22ef", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"Limited Company\",\n \"expectedMonthlySpend\": 5000,\n \"externalReference\": \"EXT-REF-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n }\n ],\n \"corporate\": {\n \"industryCode\": \"6419\",\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"registrationNumber\": \"12345678\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f4edabd-539c-4378-9048-5e6e65f3f30d", "name": "Update an existing client", "request": { "name": "Update an existing client", "description": { "content": "Updates the details of an existing client. The payload completely overwrites the existing corporate and associate details.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expectedMonthlySpend\": 5000,\n \"reference\": \"CLIENT-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n }\n ],\n \"corporate\": {\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"industryCode\": \"6419\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "570de694-91c5-4ed8-a48f-0a2ad5e4e0b2", "name": "Client updated successfully", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expectedMonthlySpend\": 5000,\n \"reference\": \"CLIENT-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n }\n ],\n \"corporate\": {\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"industryCode\": \"6419\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"response\": {\n \"clientType\": \"Limited Company\",\n \"identifier\": \"CLIENT-001\",\n \"externalReference\": \"EXT-REF-001\",\n \"expectedMonthlySpend\": 5000,\n \"riskRating\": \"Low\",\n \"contacts\": [\n {\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"street\": \"1 High Street\",\n \"city\": \"London\",\n \"region\": \"Greater London\",\n \"postcode\": \"EC1A 1BB\",\n \"countryCode\": \"GB\"\n },\n \"dateOfBirth\": \"1985-06-15\"\n }\n ],\n \"corporateDetails\": {\n \"name\": \"Acme Ltd\",\n \"registrationNumber\": \"12345678\",\n \"registeredAddress\": {\n \"street\": \"1 High Street\",\n \"city\": \"London\",\n \"region\": \"Greater London\",\n \"postcode\": \"EC1A 1BB\",\n \"countryCode\": \"GB\"\n },\n \"industryCode\": \"6419\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6970fe91-0865-4ac0-9905-0545997b0d2e", "name": "Validation failed — see the `errors` array", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expectedMonthlySpend\": 5000,\n \"reference\": \"CLIENT-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n }\n ],\n \"corporate\": {\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"industryCode\": \"6419\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af225ecc-a07b-4662-89ea-f6d4e1105230", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expectedMonthlySpend\": 5000,\n \"reference\": \"CLIENT-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n }\n ],\n \"corporate\": {\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"industryCode\": \"6419\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "428789c7-5516-4a78-9875-c78b461432b4", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "client" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expectedMonthlySpend\": 5000,\n \"reference\": \"CLIENT-001\",\n \"riskRating\": \"Low\",\n \"associates\": [\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n },\n {\n \"dateOfBirth\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\"\n }\n ],\n \"corporate\": {\n \"name\": \"Acme Ltd\",\n \"registeredAddress\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"industryCode\": \"6419\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1574c0c7-1a88-4511-826a-fe67afc007a4", "name": "Get a specific client", "request": { "name": "Get a specific client", "description": { "content": "Retrieves the full details of a specific client using their Mercury-assigned client reference.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "client", ":reference" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "ac33c6db-a269-430a-b269-ce15bbfca183", "name": "Returns the client", "originalRequest": { "url": { "path": [ "api", "v1", "client", ":reference" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientType\": \"Limited Company\",\n \"identifier\": \"CLIENT-001\",\n \"externalReference\": \"EXT-REF-001\",\n \"expectedMonthlySpend\": 5000,\n \"riskRating\": \"Low\",\n \"contacts\": [\n {\n \"identifier\": \"b7809e48-6407-4b44-b613-921049f2d7e8\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"physicalAddress\": {\n \"street\": \"1 High Street\",\n \"city\": \"London\",\n \"region\": \"Greater London\",\n \"postcode\": \"EC1A 1BB\",\n \"countryCode\": \"GB\"\n },\n \"dateOfBirth\": \"1985-06-15\"\n }\n ],\n \"corporateDetails\": {\n \"name\": \"Acme Ltd\",\n \"registrationNumber\": \"12345678\",\n \"registeredAddress\": {\n \"street\": \"1 High Street\",\n \"city\": \"London\",\n \"region\": \"Greater London\",\n \"postcode\": \"EC1A 1BB\",\n \"countryCode\": \"GB\"\n },\n \"industryCode\": \"6419\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1f84621-95bc-470d-b172-90943b192637", "name": "Reference not found or client is not Active — \"Client with the provided reference could not be found or their account is not Active\"", "originalRequest": { "url": { "path": [ "api", "v1", "client", ":reference" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5fdd84b-5515-4cf0-b13f-9e4c8777c009", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "client", ":reference" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "50ac30b5-126e-426b-a553-40e9d2a69424", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "client", ":reference" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2a87935-6cba-44ab-b5f1-c123f9c7d24c", "name": "Get all accounts for a client", "request": { "name": "Get all accounts for a client", "description": { "content": "Retrieves a list of all EUR and GBP virtual IBANs belonging to the specified client.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "client", ":reference", "accounts" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "60a7bfca-4812-4162-a967-b532976771fc", "name": "Returns an array of virtual IBANs", "originalRequest": { "url": { "path": [ "api", "v1", "client", ":reference", "accounts" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB85CLRB04274893940059\",\n \"sortCode\": \"042748\",\n \"accountNumber\": \"93940059\",\n \"balance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"currency\": \"EUR\",\n \"status\": \"Active\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n },\n {\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB71CLRB04082700001159\",\n \"sortCode\": \"040827\",\n \"accountNumber\": \"00001159\",\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"currency\": \"GBP\",\n \"status\": \"Active\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb6e952f-bd83-4d5e-b5be-38cb53109afb", "name": "Reference not found or client is not Active — \"Client with the provided reference could not be found or their account is not Active\"", "originalRequest": { "url": { "path": [ "api", "v1", "client", ":reference", "accounts" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b441b02-bc7a-4012-bee0-0df090083399", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "client", ":reference", "accounts" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ada1a6a2-28dc-48d7-b77d-7ea73129fe10", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "client", ":reference", "accounts" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2a0245bf-7323-4885-87eb-2dd959565ce4", "name": "Confirmation of Payee", "description": { "content": "Verify a payee's account name, and check whether Secondary Reference Data is required, before sending a GBP payment.", "type": "text/plain" }, "item": [ { "id": "71cc62b5-10bc-4652-9103-131290090b73", "name": "Conduct a Confirmation of Payee (CoP) account name check", "request": { "name": "Conduct a Confirmation of Payee (CoP) account name check", "description": { "content": "Verifies whether the provided `accountName` matches the legal owner name of the destination bank account.\r\n \r\n`response.data.matched` gives the result; `response.data.reasonCode` and `reasonCodeDescription` explain it.\r\nWhen `response.isSuccess` is `false`, see `response.error`.\r\n \r\nPass the returned `confirmationOfPayeeCheckId` to `POST /api/v1/payments` to link the check to a payment.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "cop", "account-name-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"accountType\": \"Personal\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\",\n \"accountName\": \"John Smith\",\n \"secondaryReference\": \"string\",\n \"secondaryReferenceCheckId\": 5288\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0a3866d3-cde2-47c5-94e5-118a2d0cee5d", "name": "Check performed — see `response.data.matched`", "originalRequest": { "url": { "path": [ "api", "v1", "cop", "account-name-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"accountType\": \"Personal\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\",\n \"accountName\": \"John Smith\",\n \"secondaryReference\": \"string\",\n \"secondaryReferenceCheckId\": 5288\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"confirmationOfPayeeCheckId\": 12345,\n \"response\": {\n \"isSuccess\": true,\n \"data\": {\n \"matched\": true,\n \"name\": \"John Smith\",\n \"reasonCode\": \"MATC\",\n \"reasonCodeDescription\": \"The account name matches.\",\n \"matchedBank\": \"Monzo\",\n \"responseWithinSla\": true,\n \"legalOwnerType\": \"PERS\",\n \"responderRegistrationId\": \"123456789\"\n },\n \"error\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ded4ebc-2b9e-42bf-b228-338991c7d095", "name": "Validation failed — see the `errors` array", "originalRequest": { "url": { "path": [ "api", "v1", "cop", "account-name-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"accountType\": \"Personal\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\",\n \"accountName\": \"John Smith\",\n \"secondaryReference\": \"string\",\n \"secondaryReferenceCheckId\": 5288\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e35785b-9774-46cd-b526-0db55e4557b1", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "cop", "account-name-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"accountType\": \"Personal\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\",\n \"accountName\": \"John Smith\",\n \"secondaryReference\": \"string\",\n \"secondaryReferenceCheckId\": 5288\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d872157-dfa9-433e-b5c1-286f85e7bc50", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "cop", "account-name-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"accountType\": \"Personal\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\",\n \"accountName\": \"John Smith\",\n \"secondaryReference\": \"string\",\n \"secondaryReferenceCheckId\": 5288\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "012ea5a3-419a-47d6-a9ad-01c4a8103d15", "name": "Check if Secondary Reference Data (SRD) is required", "request": { "name": "Check if Secondary Reference Data (SRD) is required", "description": { "content": "Submits a pre-check to assess whether the destination account requires additional Secondary Reference Data\r\n(e.g., a building society roll number) before a full CoP name check can be performed.\r\n \r\nIf `response.data.secondaryReferenceDataRequired` is `true`, pass the returned `confirmationOfPayeeCheckId` as\r\n`secondaryReferenceCheckId`, and the customer-provided roll number as `secondaryReference`, in the subsequent CoP name check.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "cop", "account-srd-requirement-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "82c7b9b2-06ae-40ab-8582-3186a963aada", "name": "Pre-check performed — see `response.data.secondaryReferenceDataRequired`", "originalRequest": { "url": { "path": [ "api", "v1", "cop", "account-srd-requirement-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"confirmationOfPayeeCheckId\": 67890,\n \"response\": {\n \"isSuccess\": true,\n \"data\": {\n \"secondaryReferenceDataRequired\": false,\n \"bankName\": \"Nationwide\",\n \"identification\": \"NA\"\n },\n \"error\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a33e020e-aec5-4953-bb7d-47b8338555af", "name": "Validation failed — see the `errors` array", "originalRequest": { "url": { "path": [ "api", "v1", "cop", "account-srd-requirement-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57dff7bd-d4e3-48bd-b67d-8f5e52cdbd7b", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "cop", "account-srd-requirement-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "63621608-269e-4cf3-bf2a-b556631dca6f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "cop", "account-srd-requirement-check" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountNumber\": \"55779911\",\n \"clientReference\": \"CLIENT-001\",\n \"countryCode\": \"GB\",\n \"currency\": \"GBP\",\n \"sortCode\": \"200000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "cf9f2e8f-ea2c-412d-ab1c-5547bde57001", "name": "EUR Payments", "description": { "content": "Submit outbound EUR SEPA Credit Transfer (SCT) payments.", "type": "text/plain" }, "item": [ { "id": "fc55404f-2e87-4779-88c0-a713e7e466d2", "name": "Submit a EUR SEPA Credit Transfer (SCT) payment", "request": { "name": "Submit a EUR SEPA Credit Transfer (SCT) payment", "description": { "content": "Submits an outbound EUR payment via the SEPA Credit Transfer scheme.\r\n \r\n**Operating hours:** Monday–Friday, 06:00–14:25 UK time only. Rejected outside these hours and on TARGET2 holidays (1 Jan, 1 May, 25–26 Dec).\r\n \r\nThe client must have sufficient EUR funds.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "euro", "payments", "sepa-ct" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\",\n \"creditor\": {\n \"accountName\": \"Example GmbH\",\n \"iban\": \"FR7630006000011234567890189\",\n \"swiftCode\": \"BNPAFRPP\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB85CLRB04274893940059\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 6053.876350653498\n },\n \"paymentReference\": \"Invoice EUR-2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4cff3bf1-6999-4d2b-944c-02b5e50a6dd5", "name": "Payment accepted; status is `Pending`", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "payments", "sepa-ct" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\",\n \"creditor\": {\n \"accountName\": \"Example GmbH\",\n \"iban\": \"FR7630006000011234567890189\",\n \"swiftCode\": \"BNPAFRPP\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB85CLRB04274893940059\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 6053.876350653498\n },\n \"paymentReference\": \"Invoice EUR-2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payment\": {\n \"paymentId\": \"085440ed-1326-41f4-b4a6-6188dbd42409\",\n \"reference\": \"CLIENT-001\",\n \"debtor\": {\n \"iban\": \"GB85CLRB04274893940059\",\n \"paymentAmount\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"paymentReference\": \"Invoice EUR-2026-001\",\n \"name\": \"Acme Ltd\"\n },\n \"creditor\": {\n \"accountName\": \"Sender GmbH\",\n \"accountNumber\": null,\n \"sortCode\": null,\n \"iban\": \"FR7630006000011234567890189\"\n },\n \"status\": \"Pending\",\n \"message\": \"Payment has been successfully requested and is now being processed\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e3dc560-0815-46e7-875e-7bd352e1b1ab", "name": "Validation failed — see the `errors` array", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "payments", "sepa-ct" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\",\n \"creditor\": {\n \"accountName\": \"Example GmbH\",\n \"iban\": \"FR7630006000011234567890189\",\n \"swiftCode\": \"BNPAFRPP\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB85CLRB04274893940059\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 6053.876350653498\n },\n \"paymentReference\": \"Invoice EUR-2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c921580-0282-437f-b83d-de10cda94d78", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "payments", "sepa-ct" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\",\n \"creditor\": {\n \"accountName\": \"Example GmbH\",\n \"iban\": \"FR7630006000011234567890189\",\n \"swiftCode\": \"BNPAFRPP\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB85CLRB04274893940059\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 6053.876350653498\n },\n \"paymentReference\": \"Invoice EUR-2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49ac25cc-051b-4f6a-aa2d-5e8e6d778604", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "payments", "sepa-ct" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\",\n \"creditor\": {\n \"accountName\": \"Example GmbH\",\n \"iban\": \"FR7630006000011234567890189\",\n \"swiftCode\": \"BNPAFRPP\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB85CLRB04274893940059\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 6053.876350653498\n },\n \"paymentReference\": \"Invoice EUR-2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "21dbeb70-e967-4130-8daa-db2a6e6d340a", "name": "EUR Virtual IBANs", "description": { "content": "Create, block, unblock and close EUR virtual IBANs, and retrieve their statements.", "type": "text/plain" }, "item": [ { "id": "e7aa2a38-4c66-4fd5-89af-6389312e1d7c", "name": "Get all EUR virtual accounts", "request": { "name": "Get all EUR virtual accounts", "description": { "content": "Returns all EUR virtual IBANs registered under your distributor account.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "ba4af964-4375-40b7-bb4a-dc8b8ce8e0d6", "name": "Returns an array of virtual IBANs", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB85CLRB04274893940059\",\n \"sortCode\": \"042748\",\n \"accountNumber\": \"93940059\",\n \"balance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"currency\": \"EUR\",\n \"status\": \"Active\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbc1324e-056f-41e4-b4b5-37f8e0fbeb5f", "name": "Validation failed", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d7f189-524b-4209-9aed-11c8bcbdfe4a", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ed6f1f7-b370-4873-8b05-40fb7493be2a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12e96e7b-3888-4412-a7a2-1303b51bebc8", "name": "Create a new EUR virtual IBAN for a client", "request": { "name": "Create a new EUR virtual IBAN for a client", "description": { "content": "Provisions a new EUR multi-currency virtual IBAN for the specified client. A client can only have one active EUR virtual IBAN.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d8932483-a9a7-475c-b7ee-e7a6ef608f9f", "name": "Virtual IBAN created successfully", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"response\": {\n \"status\": \"Processing\",\n \"message\": \"Your account request has been logged and is currently being processed\",\n \"requestId\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4\",\n \"createdDate\": \"2026-02-23T15:26:37Z\",\n \"clientReference\": \"CLIENT-001\",\n \"requestedAccountDetails\": {\n \"accountName\": \"Acme Ltd\",\n \"accountType\": \"MCCY\",\n \"currency\": [\n \"EUR\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f6dc8c1-ba15-423d-a942-94a47e9d14d6", "name": "Validation failed — see the `errors` array. Returns \"The client already has a Virtual IBAN for the currency\" if the client already has an active EUR virtual IBAN.", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfd19d21-1269-46a9-9c00-fbd0b391196f", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3bd7d8f2-a184-4fe8-8f8d-93b310bd7d74", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60dd097d-e0b3-4e19-a809-567a11b2523e", "name": "Get account statements for all EUR accounts", "request": { "name": "Get account statements for all EUR accounts", "description": { "content": "Returns transaction statements for all EUR virtual IBANs under your distributor.\r\nAll filter fields are optional. If omitted, all available transactions are returned.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "euro", "vibans", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fce8d259-a74b-423f-9d55-334835a33139", "name": "Returns an array of statements", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"clientReference\": \"CLIENT-001\",\n \"externalClientReference\": \"EXT-REF-001\",\n \"date\": \"2026-02-13\",\n \"timeStamp\": \"2026-02-13T10:46:41Z\",\n \"endToEndIdentifier\": \"E2E-20260213-001\",\n \"detail\": \"Invoice EUR-2026-001\",\n \"payments\": 0,\n \"receipts\": 1000,\n \"bankAccount\": \"GB85CLRB04274893940059\",\n \"bankReference\": \"Invoice EUR-2026-001\",\n \"transactionType\": \"Credit\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22481194-0369-4039-aa62-4eef5565228e", "name": "Validation failed (e.g., date is in the future)", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0caf4f5-6a79-4d01-9a89-0f70bce5cc03", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38bebcd8-ac80-4558-b887-6e87800d4a5e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d64f0f3a-5f73-4e0b-844d-84b913052277", "name": "Block a EUR virtual IBAN", "request": { "name": "Block a EUR virtual IBAN", "description": { "content": "Blocks the specified EUR virtual IBAN, preventing any further payments from or to it.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "7a3c1b51-7282-4e28-bea7-57cf4b1ee2d3", "name": "IBAN blocked successfully", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB85CLRB04274893940059\",\n \"sortCode\": \"042748\",\n \"accountNumber\": \"93940059\",\n \"balance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"currency\": \"EUR\",\n \"status\": \"Blocked\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "594b213f-012e-4fd5-b6e2-e4f7685296db", "name": "Validation failed (e.g., IBAN not found or client not Active)", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "509df511-a3f6-4c93-a6e0-9a03957c8ad5", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4981df0a-3f27-4ecf-b22d-faee4b2519fc", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33728c24-f96f-4763-939a-4fc3885fcc4e", "name": "Unblock a EUR virtual IBAN", "request": { "name": "Unblock a EUR virtual IBAN", "description": { "content": "Re-activates a previously blocked EUR virtual IBAN.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "f978cd0c-493a-4741-a585-fb2d89041007", "name": "IBAN unblocked successfully", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB85CLRB04274893940059\",\n \"sortCode\": \"042748\",\n \"accountNumber\": \"93940059\",\n \"balance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"currency\": \"EUR\",\n \"status\": \"Active\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb13a323-797f-44b8-81af-c24d4af29ed3", "name": "Validation failed (e.g., IBAN not found or client not Active)", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dacade1a-abf8-4c5b-a5aa-04d2b9e88191", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8cdaa86-a259-4415-bc07-563442037e92", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8e7e701-2199-4750-9973-f3ddc3c2d17b", "name": "Close a EUR virtual IBAN", "request": { "name": "Close a EUR virtual IBAN", "description": { "content": "Permanently closes the specified EUR virtual IBAN. **This action is irreversible.**\r\nThe account balance must be **zero across all currencies** before it can be closed.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "f045009f-2f67-40df-992e-b6a5dc3c750f", "name": "IBAN closed successfully", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB85CLRB04274893940059\",\n \"sortCode\": \"042748\",\n \"accountNumber\": \"93940059\",\n \"balance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"EUR\",\n \"amount\": 1000\n },\n \"currency\": \"EUR\",\n \"status\": \"A request to close the account has been logged and is currently being processed\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eca0d99-3de5-4fd8-ac1f-04eca0e5f9b5", "name": "Validation failed (e.g., IBAN not found, client not Active, or non-zero balance — \"Account with the provided Iban has a positive balance in one or more currencies. Cannot close account until balance is zero\")", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd6db538-45b6-4dff-8198-b6b868211aee", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b2401182-866e-4c4d-a806-a9d18caf2311", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "euro", "vibans", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB85CLRB04274893940059", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "22f55511-fee3-4a63-ae7d-1de906f6602c", "name": "Lookups", "description": { "content": "Reference data — currencies, countries, natures of business, risk ratings and other accepted values used by the other endpoints. Each lookup returns its items in `data`; send an item's `value` in requests (`display` is a readable label).", "type": "text/plain" }, "item": [ { "id": "2547bdf1-c9ab-4199-b9b0-53c3c75f4e9c", "name": "Get currencies", "request": { "name": "Get currencies", "description": { "content": "Retrieves a list of all currencies available for payments.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "lookup", "currencies" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET" }, "response": [ { "id": "76b3c841-34ee-4a12-99ca-82a91533d506", "name": "Returns the currencies in `data`", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "currencies" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": [\n {\n \"display\": \"string\",\n \"value\": \"string\"\n },\n {\n \"display\": \"string\",\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ffc5ad3-43ef-4a76-8ef9-c747ad63d9ba", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "currencies" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "505b5d94-1e9f-4429-ba19-e7e75ca62d9d", "name": "Get countries", "request": { "name": "Get countries", "description": { "content": "Retrieves a list of all valid ISO 3166-1 alpha-2 country codes.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "lookup", "countries" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET" }, "response": [ { "id": "9ea4daf5-e2c8-41c0-9992-3cb2125f1a3d", "name": "Returns the countries in `data`", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "countries" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": [\n {\n \"display\": \"string\",\n \"value\": \"string\"\n },\n {\n \"display\": \"string\",\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "235acb98-ecf4-4e80-825a-b2de4cd51da3", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "countries" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfe62ebe-3c8c-43b3-8dc3-796669ff1008", "name": "Get natures of business", "request": { "name": "Get natures of business", "description": { "content": "Retrieves a list of valid SIC codes or Nature of Business descriptions for onboarding clients.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "lookup", "natures-of-business" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET" }, "response": [ { "id": "ef78cd4b-6f02-4b6b-aaf2-767f78ae8414", "name": "Returns the natures of business in `data`", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "natures-of-business" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": [\n {\n \"display\": \"string\",\n \"value\": \"string\"\n },\n {\n \"display\": \"string\",\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a21813d-277c-4dde-8355-284ae6449622", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "natures-of-business" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "126f9187-8c25-418c-a114-cbdca7676d92", "name": "Get CoP-eligible currencies", "request": { "name": "Get CoP-eligible currencies", "description": { "content": "Retrieves the subset of currencies eligible for Confirmation of Payee checks (e.g., GBP).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "lookup", "cop-eligible-currencies" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET" }, "response": [ { "id": "d6fab253-b1e2-47d5-a1eb-d45ebf2bfa06", "name": "Returns the eligible currencies in `data`", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "cop-eligible-currencies" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": [\n {\n \"display\": \"string\",\n \"value\": \"string\"\n },\n {\n \"display\": \"string\",\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c9f3f62-5c11-4499-8a46-d0fa7a098d35", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "cop-eligible-currencies" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4eaad8fa-3aa4-4f99-a5d3-22f4199a9ca7", "name": "Get CoP-eligible countries", "request": { "name": "Get CoP-eligible countries", "description": { "content": "Retrieves the subset of countries eligible for Confirmation of Payee checks (e.g., GB).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "lookup", "cop-eligible-countries" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET" }, "response": [ { "id": "e3639068-d624-42e8-a89c-9bc7d2716f9a", "name": "Returns the eligible countries in `data`", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "cop-eligible-countries" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": [\n {\n \"display\": \"string\",\n \"value\": \"string\"\n },\n {\n \"display\": \"string\",\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0828a39d-b069-450c-830d-0c0e425691f2", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "cop-eligible-countries" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17f66066-e76c-4c3e-8693-ffac52cb6f46", "name": "Get CoP legal owner types", "request": { "name": "Get CoP legal owner types", "description": { "content": "Retrieves the permissible legal owner account types to supply during a Confirmation of Payee check (e.g., `INDIVIDUAL`, `LLC`, `PLC`, etc).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "lookup", "cop-legal-owner-types" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET" }, "response": [ { "id": "a94bb14a-cc91-4912-996d-8a7cd8a092ff", "name": "Returns the legal owner types in `data`", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "cop-legal-owner-types" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": [\n {\n \"display\": \"string\",\n \"value\": \"string\"\n },\n {\n \"display\": \"string\",\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef1d1f6b-a223-4c04-a4c9-0e1052e12cf0", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "cop-legal-owner-types" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53c053a1-e257-46e4-9556-4642bd3b379d", "name": "Get client risk rating levels", "request": { "name": "Get client risk rating levels", "description": { "content": "Retrieves the permissible risk rating levels to supply when onboarding a new client (`Low`, `Medium`, `High`).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "lookup", "client-risk-rating-levels" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET" }, "response": [ { "id": "c5f3c1f9-5d92-4179-aa48-bfb10242c860", "name": "Returns the risk rating levels in `data`", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "client-risk-rating-levels" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": [\n {\n \"display\": \"string\",\n \"value\": \"string\"\n },\n {\n \"display\": \"string\",\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b93bb6cd-24e5-46c1-b37c-f3c575dfe8da", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "client-risk-rating-levels" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "605e663b-0592-4831-a639-77c6bb040df4", "name": "Get payment return reasons", "request": { "name": "Get payment return reasons", "description": { "content": "Retrieves a list of all payment return reasons.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "lookup", "payment-return-reasons" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET" }, "response": [ { "id": "fe3d9a69-7a91-49be-b71e-17379fd0aec5", "name": "Returns the payment return reasons in `data`", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "payment-return-reasons" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": [\n {\n \"display\": \"string\",\n \"value\": \"string\"\n },\n {\n \"display\": \"string\",\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccc2b28c-06c8-4acf-a175-7af27c67aad3", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "lookup", "payment-return-reasons" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "75dc89d3-ac52-4281-9c9b-a62999cc2013", "name": "GBP Payments", "description": { "content": "Submit outbound GBP Faster Payments (FPS) and return received inbound FPS payments.", "type": "text/plain" }, "item": [ { "id": "3e3dc326-b8e1-4bfb-a4e0-869d64259fd4", "name": "Submit a GBP Faster Payments (FPS) payment", "request": { "name": "Submit a GBP Faster Payments (FPS) payment", "description": { "content": "Submits an outbound GBP payment via the Faster Payments Scheme. The client must have sufficient GBP funds.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "payments" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"creditor\": {\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"55779911\",\n \"sortCode\": \"200000\",\n \"iban\": \"GB60BARC20000055779911\",\n \"emailAddress\": \"john.smith@example.com\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB71CLRB04082700001159\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 208.41735628150948\n },\n \"paymentReference\": \"Invoice 2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\",\n \"reference\": \"CLIENT-001\",\n \"confirmationOfPayeeCheckId\": 12345\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e19568bd-8cea-418c-8b18-39406fe6b56f", "name": "Payment accepted; status is `Pending`", "originalRequest": { "url": { "path": [ "api", "v1", "payments" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"creditor\": {\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"55779911\",\n \"sortCode\": \"200000\",\n \"iban\": \"GB60BARC20000055779911\",\n \"emailAddress\": \"john.smith@example.com\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB71CLRB04082700001159\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 208.41735628150948\n },\n \"paymentReference\": \"Invoice 2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\",\n \"reference\": \"CLIENT-001\",\n \"confirmationOfPayeeCheckId\": 12345\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payment\": {\n \"paymentId\": \"764b7d22-9fa0-43bb-920e-326e8634b0f8\",\n \"reference\": \"CLIENT-001\",\n \"debtor\": {\n \"iban\": \"GB71CLRB04082700001159\",\n \"paymentAmount\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 500\n },\n \"paymentReference\": \"Invoice 2025-001\",\n \"name\": \"Acme Ltd\"\n },\n \"creditor\": {\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"55779911\",\n \"sortCode\": \"200000\",\n \"iban\": \"GB60BARC20000055779911\"\n },\n \"status\": \"Pending\",\n \"message\": \"Payment has been successfully requested and is now being processed\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf94b50b-235f-432c-95c4-0aff03664bf1", "name": "Validation failed — see the `errors` array", "originalRequest": { "url": { "path": [ "api", "v1", "payments" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"creditor\": {\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"55779911\",\n \"sortCode\": \"200000\",\n \"iban\": \"GB60BARC20000055779911\",\n \"emailAddress\": \"john.smith@example.com\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB71CLRB04082700001159\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 208.41735628150948\n },\n \"paymentReference\": \"Invoice 2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\",\n \"reference\": \"CLIENT-001\",\n \"confirmationOfPayeeCheckId\": 12345\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9acc150-e013-42f7-b4a6-5510d9281f2a", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "payments" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"creditor\": {\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"55779911\",\n \"sortCode\": \"200000\",\n \"iban\": \"GB60BARC20000055779911\",\n \"emailAddress\": \"john.smith@example.com\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB71CLRB04082700001159\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 208.41735628150948\n },\n \"paymentReference\": \"Invoice 2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\",\n \"reference\": \"CLIENT-001\",\n \"confirmationOfPayeeCheckId\": 12345\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09b089f4-dfc3-4f01-8fc5-f07405e3707d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "payments" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"creditor\": {\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"55779911\",\n \"sortCode\": \"200000\",\n \"iban\": \"GB60BARC20000055779911\",\n \"emailAddress\": \"john.smith@example.com\",\n \"address\": {\n \"unit\": \"string\",\n \"building\": \"string\",\n \"complex\": \"string\",\n \"street\": \"string\",\n \"streetNo\": \"string\",\n \"suburb\": \"string\",\n \"city\": \"string\",\n \"region\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\"\n }\n },\n \"debtor\": {\n \"iban\": \"GB71CLRB04082700001159\",\n \"paymentAmount\": {\n \"currencyCode\": \"string\",\n \"amount\": 208.41735628150948\n },\n \"paymentReference\": \"Invoice 2026-001\"\n },\n \"endToEndIdentifier\": \"E2E-20260213-001\",\n \"reference\": \"CLIENT-001\",\n \"confirmationOfPayeeCheckId\": 12345\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5f521fa-9a12-44c6-bd0f-a5f8ee099bef", "name": "Return a received GBP FPS payment", "request": { "name": "Return a received GBP FPS payment", "description": { "content": "Returns a previously received inbound FPS payment back to the sender.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "payments", "return-payment" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"returnReason\": \"string\",\n \"transactionId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4a9e69ed-f091-4733-ba0d-0eca5eb8dd1b", "name": "Return accepted", "originalRequest": { "url": { "path": [ "api", "v1", "payments", "return-payment" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"returnReason\": \"string\",\n \"transactionId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Return payment successfully submitted.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9977255b-f7e3-4d3b-95fe-18aff46f27f0", "name": "Validation failed — see the `errors` array", "originalRequest": { "url": { "path": [ "api", "v1", "payments", "return-payment" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"returnReason\": \"string\",\n \"transactionId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f77db708-4e5d-4996-95bf-cabb9d7545aa", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "payments", "return-payment" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"returnReason\": \"string\",\n \"transactionId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f135092-f4d0-4ce7-92c4-3682c7e4a914", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "payments", "return-payment" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"returnReason\": \"string\",\n \"transactionId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dda927b6-b4bf-4fdb-8f20-3a9770bd84d7", "name": "GBP Virtual Accounts", "description": { "content": "Create, block, unblock and close GBP (Sterling) virtual accounts, and retrieve their statements.", "type": "text/plain" }, "item": [ { "id": "c5e2981d-04e9-447f-9e11-c946c41d569f", "name": "Get all GBP virtual accounts", "request": { "name": "Get all GBP virtual accounts", "description": { "content": "Returns all GBP virtual accounts (Sterling) registered under your distributor account.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "7bb1cf12-ee05-446e-94e8-34ce9c1f1edd", "name": "Returns an array of virtual accounts", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB71CLRB04082700001159\",\n \"sortCode\": \"040827\",\n \"accountNumber\": \"00001159\",\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"currency\": \"GBP\",\n \"status\": \"Active\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "451c4398-145f-4153-ada4-f0b905b42621", "name": "Validation failed", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90f35f51-9509-4219-9ed1-523bc2a10de0", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f8746ad-441f-41f1-8d4b-87c66db4703c", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da4b7eb5-08f5-4668-bb07-c7484ae22368", "name": "Create a new GBP virtual account for a client", "request": { "name": "Create a new GBP virtual account for a client", "description": { "content": "Provisions a new GBP (Sterling) virtual account for the specified client. A client can only have one active GBP virtual account.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "45742a4b-9f0a-40b6-b26e-54589c6bacfe", "name": "Virtual account created successfully", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"response\": {\n \"status\": \"Processing\",\n \"message\": \"Your account request has been logged and is currently being processed\",\n \"requestId\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4\",\n \"createdDate\": \"2026-02-23T15:26:37Z\",\n \"clientReference\": \"CLIENT-001\",\n \"requestedAccountDetails\": {\n \"accountName\": \"Acme Ltd\",\n \"accountType\": \"GB\",\n \"currency\": [\n \"GBP\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b28fa12-b543-40f2-a9a0-b73a7c86fb67", "name": "Validation failed — see the `errors` array. Returns \"The client already has a Virtual IBAN for the currency\" if the client already has an active GBP virtual account.", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "606ab498-4b9e-4ea2-934d-f39230060c1c", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6fe6166-d8f1-4e8f-9ab8-8e7865b49045", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientReference\": \"CLIENT-001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aff1df8a-38de-445f-91ad-e15e4e0c5eb5", "name": "Get account statements for all GBP accounts", "request": { "name": "Get account statements for all GBP accounts", "description": { "content": "Returns transaction statements for all GBP virtual accounts under your distributor.\r\nAll filter fields are optional. If omitted, all available transactions are returned.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "sterling-account", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "429fd902-c14c-4840-9fe8-38f8d4bd8331", "name": "Returns an array of statements", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"clientReference\": \"CLIENT-001\",\n \"externalClientReference\": \"EXT-REF-001\",\n \"date\": \"2025-08-11\",\n \"timeStamp\": \"2025-08-11T08:38:16Z\",\n \"endToEndIdentifier\": \"E2E-20260213-001\",\n \"detail\": \"Invoice GBP-2026-001\",\n \"payments\": 500,\n \"receipts\": 0,\n \"bankAccount\": \"GB71CLRB04082700001159\",\n \"bankReference\": \"Invoice GBP-2026-001\",\n \"transactionType\": \"Debit\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "189ee58f-08f9-4750-a404-d7eca5dce6e9", "name": "Validation failed (e.g., date is in the future)", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7d50bf5-e878-424c-9d48-a9b96c494b34", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c665f41f-3bd5-4747-b8d6-e0902ff06cbe", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", "statements" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"endDate\": {\n \"year\": 1985,\n \"month\": 6,\n \"day\": 15\n },\n \"pageSize\": 100\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56f35d5b-101e-4651-bcfe-c1239489591b", "name": "Block a GBP virtual account", "request": { "name": "Block a GBP virtual account", "description": { "content": "Blocks the specified GBP virtual account, preventing any further payments from or to it.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "sterling-account", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "4bc91acd-e477-4223-86cd-b152a69a2887", "name": "Account blocked successfully", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB71CLRB04082700001159\",\n \"sortCode\": \"040827\",\n \"accountNumber\": \"00001159\",\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"currency\": \"GBP\",\n \"status\": \"Blocked\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16a69a13-f215-4073-8674-04c8bed9021e", "name": "Validation failed (e.g., IBAN not found or client not Active)", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d9c094f-d53a-4baa-b0e3-6b998343782f", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2442a6ae-a1ca-480d-a2a0-88cf8dd0995c", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "block", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to block. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8ae9a51-95bb-4757-9d4d-e42adb975cb8", "name": "Unblock a GBP virtual account", "request": { "name": "Unblock a GBP virtual account", "description": { "content": "Re-activates a previously blocked GBP virtual account.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "sterling-account", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "78564dac-e999-499d-8a22-44ea3a204911", "name": "Account unblocked successfully", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB71CLRB04082700001159\",\n \"sortCode\": \"040827\",\n \"accountNumber\": \"00001159\",\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"currency\": \"GBP\",\n \"status\": \"Active\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a00c243-c84b-4b8d-8eaf-b2513313f211", "name": "Validation failed (e.g., IBAN not found or client not Active)", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78d00133-0172-4fc6-a552-a573c80a402a", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ef54e86-60d3-4d25-a231-5673a84ed07b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "unblock", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to unblock. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "696d9bb7-3de1-4a75-a591-88d31dba8cdd", "name": "Close a GBP virtual account", "request": { "name": "Close a GBP virtual account", "description": { "content": "Permanently closes the specified GBP virtual account. **This action is irreversible.**\r\nThe account balance must be **zero across all currencies** before it can be closed.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "sterling-account", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "cc9e35b4-0a34-4c5e-b051-fe3838452940", "name": "Account closed successfully", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientReference\": \"CLIENT-001\",\n \"clientName\": \"Acme Ltd\",\n \"accountName\": \"Acme Ltd\",\n \"iban\": \"GB71CLRB04082700001159\",\n \"sortCode\": \"040827\",\n \"accountNumber\": \"00001159\",\n \"balance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"availableBalance\": {\n \"currencyCode\": \"GBP\",\n \"amount\": 1000\n },\n \"currency\": \"GBP\",\n \"status\": \"A request to close the account has been logged and is currently being processed\",\n \"externalReference\": \"EXT-REF-001\",\n \"createdDate\": \"2026-02-23T15:26:37Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c1c4462-97de-443c-80a8-0b1f570b8eb6", "name": "Validation failed (e.g., IBAN not found, client not Active, or non-zero balance — \"Account with the provided Iban has a positive balance in one or more currencies. Cannot close account until balance is zero\")", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Error\",\n \"message\": \"Request validation failed\",\n \"errors\": [\n {\n \"propertyName\": \"FieldName\",\n \"errorDescription\": \"Description of the validation error.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "923210f7-af60-4b69-92a4-c9dbf75195e4", "name": "Missing or invalid `x-api-key`, `x-nonce` or `Authorization` signature. The response has no body.", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a13550e0-2358-4d7d-ab6f-226f62ba66dc", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "v1", "sterling-account", ":reference", "close", ":iban" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "CLIENT-001", "key": "reference", "description": "(Required) The Mercury-assigned client reference. Must belong to an `Active` client under your distributor account." }, { "disabled": false, "type": "any", "value": "GB71CLRB04082700001159", "key": "iban", "description": "(Required) The IBAN to close. Must exist and belong to the specified client." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Internal server error\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const apiKey = pm.variables.get(\"api_key\");", "const secretKey = pm.variables.get(\"secret_key\");", "", "if (!apiKey || !secretKey) {", " console.warn(\"Mercury: set api_key and secret_key in your environment. Sending this request unsigned.\");", "} else {", " const method = pm.request.method.toUpperCase();", " const path = pm.variables.replaceIn(pm.request.url.getPath());", " const nonce = pm.variables.replaceIn(\"{{$guid}}\");", "", " const parts = [apiKey, method, path];", " if (method !== \"GET\") {", " const raw = pm.request.body && pm.request.body.mode === \"raw\" ? pm.request.body.raw : \"\";", " parts.push(pm.variables.replaceIn(raw || \"\"));", " }", " parts.push(nonce);", "", " const signature = CryptoJS.enc.Base64.stringify(CryptoJS.HmacSHA256(parts.join(\"\\n\"), secretKey));", "", " pm.request.headers.upsert({ key: \"x-api-key\", value: apiKey });", " pm.request.headers.upsert({ key: \"x-nonce\", value: nonce });", " pm.request.headers.upsert({ key: \"Authorization\", value: \"HMACSHA256 \" + signature });", "}" ] } } ], "variable": [ { "key": "base_url", "value": "https://www.api.external.test.mercury.global", "type": "string" } ], "info": { "_postman_id": "2d6f2802-0555-4a97-aa56-88f3ab95ff3d", "name": "Mercury External API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Integration API for onboarding clients, managing EUR and GBP virtual IBANs, submitting SEPA CT and FPS payments, performing Confirmation of Payee checks, and receiving real-time webhook notifications.", "type": "text/plain" } }, "auth": { "type": "noauth" } }