{"info":{"_postman_id":"e7f30add-f7da-484d-ae4c-78f41f87d6ca","name":"Documentation","description":"

📚 LumonPay Developer Documentation

\n

Welcome to the LumonPay Developer Documentation.
Here, you'll find all the information needed to integrate with LumonPay's APIs, designed to support secure and efficient access to our services.

\n

This documentation covers key areas including:

\n\n

Each API is structured to provide a consistent, reliable, and secure experience for developers integrating with LumonPay.
Examples, required parameters, response formats, and authorization details are provided to help you implement and consume our services seamlessly.

\n

If you encounter any issues or have questions, please reach out to the LumonPay technical support team for assistance..

\n
\n

Happy Building! 🚀

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📚 LumonPay Developer Documentation","slug":"lumonpay-developer-documentation"}],"owner":"44783697","collectionId":"e7f30add-f7da-484d-ae4c-78f41f87d6ca","publishedId":"2sBXc7K4Q8","public":true,"customColor":{"top-bar":"082b3d","right-sidebar":"082b3d","highlight":"ec5954"},"publishDate":"2026-02-12T13:13:24.000Z"},"item":[{"name":"Leads API","item":[{"name":"Get Token","event":[{"listen":"test","script":{"exec":["const responseJson = pm.response.json();\r","pm.environment.set(\"leadAuthToken\", responseJson.access_token);"],"type":"text/javascript","packages":{},"id":"efd093bc-b34a-4f3b-9947-f7a7a3a56804"}}],"id":"93fa34e7-dc0c-4c30-83d2-3313835ee3f5","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"grant_type","value":"client_credentials"},{"type":"text","key":"client_id","value":"{{ClientId_Lead}}"},{"type":"text","key":"client_secret","value":"{{ClientSecret_Lead}}"},{"type":"text","key":"scope","value":"{{scopeClient_Lead}}"}]},"url":"{{identity_url}}/connect/token","description":"

📄 Description

\n

This API endpoint is used to obtain an authentication token necessary for accessing protected resources within the LumonPay environment.
The request must use the client_credentials grant type, providing a valid client_id, client_secret, and scope.

\n

📤 Request Body (x-www-form-urlencoded)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
grant_typestringYesMust be set to client_credentials.
client_idstringYesThe unique identifier assigned to the client requesting the token.
client_secretstringYesThe secret key associated with the client ID used for authentication.
scopestringYesSpecifies the level of access being requested.
\n

📩 Response

\n

On success, the API returns a JSON object containing the following:

\n\n

🔔 Note:
The access_token must be included in the Authorization header as a Bearer token when making subsequent API requests:

\n","urlObject":{"path":["connect","token"],"host":["{{identity_url}}"],"query":[],"variable":[]}},"response":[{"id":"b04d41d5-2fdb-4711-915e-845f03dcf652","name":"Get Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"grant_type","value":"client_credentials"},{"type":"text","key":"client_id","value":"{{ClientId_Lead}}"},{"type":"text","key":"client_secret","value":"{{ClientSecret_Lead}}"},{"type":"text","key":"scope","value":"{{scopeClient_Lead}}"}]},"url":"{{identity_url}}/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Apr 2025 14:25:59 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-store, no-cache, max-age=0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Cross-Origin-Embedder-Policy","value":"unsafe-none"},{"key":"Permissions-Policy","value":"accelerometer=(),camera=(), display-capture=(), geolocation=(), gyroscope=(), microphone=(), midi=(), screen-wake-lock=()"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"92a0ffabac99e5fe-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"string\",\n \"expires_in\": 0,\n \"token_type\": \"string\",\n \"scope\": \"string\"\n}"}],"_postman_id":"93fa34e7-dc0c-4c30-83d2-3313835ee3f5"},{"name":"Create Lead","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"853a4407-b46d-41ef-93ee-d8779113e539"}}],"id":"584f95f1-51ec-4ab0-a0eb-e11bc2ed0089","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leadAuthToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"title\": \"Mr\",\r\n \"first_name\": \"First Name\",\r\n \"last_name\": \"Last Name\",\r\n \"mobile_phone_country\": \"+44\",\r\n \"mobile_phone\": \"07400123456\",\r\n \"email\": \"email_test@lumonpay.com\",\r\n \"currency_sell\": \"EUR\",\r\n \"currency_buy\": \"GBP\",\r\n \"amount_you_want_buy\": \"100000\", \r\n \"ref_id\": \"Ref Id Partnership\",\r\n \"client_type\": \"Private\",\r\n \"source\": \"Source\",\r\n \"destination_of_funds\":\"UK\",\r\n \"reason_for_transfer\": \"Property Purchase\" \r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/rest/leads","description":"

📄 Description

\n

This endpoint enables the creation of one or more lead records within the Lumon system.
It is intended for registering potential clients interested in currency exchange services.
The endpoint supports bulk lead creation by accepting an array of lead objects in the request body.

\n

🔐 Authorization

\n

Authentication is required.
Include the following header in your request:

\n

📩 Response

\n

Upon successful submission, the API returns:

\n\n","urlObject":{"path":["rest","leads"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"564fda02-fe0a-4a3d-bb60-b7fd908850b1","name":"Create Lead","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"title\": \"Mr\",\r\n \"first_name\": \"First Name\",\r\n \"last_name\": \"Last Name\",\r\n \"mobile_phone_country\": \"+44\",\r\n \"mobile_phone\": \"07400123456\",\r\n \"email\": \"email_test@lumonpay.com\",\r\n \"currency_sell\": \"EUR\",\r\n \"currency_buy\": \"GBP\",\r\n \"amount_you_want_buy\": \"100000\", \r\n \"ref_id\": \"Ref Id Partnership\",\r\n \"client_type\": \"Private\",\r\n \"source\": \"Source\",\r\n \"destination_of_funds\":\"UK\",\r\n \"reason_for_transfer\": \"Property Purchase\" \r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/rest/leads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"LED-0000123\",\n \"title\": \"Mr\",\n \"first_name\": \"First Name\",\n \"last_name\": \"Last Name\",\n \"email\": \"email_test@lumonpay.com\",\n \"client_type\": \"Private\",\n \"mobile_phone\": \"07400123456\",\n \"mobile_phone_country\": \"+44\",\n \"reason_for_transfer\": \"Property Purchase\",\n \"currency_buy\": \"GBP\",\n \"currency_sell\": \"EUR\",\n \"amount_you_want_buy\": 100000,\n \"destination_of_funds\": \"UK\",\n \"ref_id\": \"Ref Id Partnership\",\n \"source\": \"Source\",\n \"lead_id\": \"63cc4256-07d8-4d0b-ad27-791fda0cffaa\"\n }\n]"}],"_postman_id":"584f95f1-51ec-4ab0-a0eb-e11bc2ed0089"}],"id":"b9cb5e3c-8656-430c-ac4f-3358566a85d6","description":"

📄 Overview

\n

This documentation describes the Leads API, which manages the endpoints responsible for lead creation within Lumon.
It enables the capture and registration of key prospect data, ensuring seamless integration with internal systems.
The API supports the onboarding and sales pipeline by providing a consistent, secure, and efficient process for handling lead information.

\n","_postman_id":"b9cb5e3c-8656-430c-ac4f-3358566a85d6"},{"name":"Rates API","item":[{"name":"Get Token","event":[{"listen":"test","script":{"exec":["const responseJson = pm.response.json();\r","pm.environment.set(\"rateAuthToken\", responseJson.access_token);"],"type":"text/javascript","packages":{},"id":"2fd9629a-0c56-4c11-8a33-17813c6f7028"}}],"id":"e4c8e128-77db-49f2-895e-65873690740b","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"grant_type","value":"client_credentials"},{"type":"text","key":"client_id","value":"{{ClientId_Rate}}"},{"type":"text","key":"client_secret","value":"{{ClientSecret_Rate}}"},{"type":"text","key":"scope","value":"{{scopeClient_Rate}}"}]},"url":"{{identity_url}}/connect/token","description":"

📄 Description

\n

This API endpoint is used to obtain an authentication token required for accessing protected resources within the LumonPay environment.
The request must be made using the client_credentials grant type, providing a valid client_id, client_secret, and scope.

\n

📤 Request Body (x-www-form-urlencoded)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
grant_typestringYesMust be set to client_credentials.
client_idstringYesThe unique identifier for the client requesting the token.
client_secretstringYesThe secret key associated with the client ID for authentication.
scopestringYesDefines the level of access required.
\n

📩 Response

\n

On success, the API returns a JSON object containing:

\n\n

🔔 Note:
The access_token must be included in the Authorization header as a Bearer token in subsequent API requests:

\n","urlObject":{"path":["connect","token"],"host":["{{identity_url}}"],"query":[],"variable":[]}},"response":[{"id":"8c5f111a-4dd0-478f-a21d-758f97b31211","name":"Get Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"grant_type","value":"client_credentials"},{"type":"text","key":"client_id","value":"{{ClientId_Rate}}"},{"type":"text","key":"client_secret","value":"{{ClientSecret_Rate}}"},{"type":"text","key":"scope","value":"{{scopeClient_Rate}}"}]},"url":"{{identity_url}}/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Apr 2025 14:25:59 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-store, no-cache, max-age=0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Cross-Origin-Embedder-Policy","value":"unsafe-none"},{"key":"Permissions-Policy","value":"accelerometer=(),camera=(), display-capture=(), geolocation=(), gyroscope=(), microphone=(), midi=(), screen-wake-lock=()"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"92a0ffabac99e5fe-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"string\",\n \"expires_in\": 0,\n \"token_type\": \"string\",\n \"scope\": \"string\"\n}"}],"_postman_id":"e4c8e128-77db-49f2-895e-65873690740b"},{"name":"Get All Currencies Rate","id":"2481b8b9-ba5a-478e-bec5-4dbb76e2b6f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{rateAuthToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{api_url}}/rest/rate/api/rates/daily_rates","description":"

📄 Description

\n

This API endpoint retrieves the latest daily exchange rates for all supported currencies within the LumonPay environment.
The response provides exchange rate data, enabling clients to access and process up-to-date currency conversion rates.

\n

🔐 Authorization

\n

Authentication is required.
Include the following header in your request:

\n

📩 Response

\n

On success, the API returns a JSON object containing the latest exchange rates for multiple currencies.

\n","urlObject":{"path":["rest","rate","api","rates","daily_rates"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"1c2d09c5-a0d0-4340-86f7-591ae48cc69f","name":"Get All Currencies Rate","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/rest/rate/api/rates/daily_rates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Apr 2025 14:26:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:cbf9a874-28c0-4c17-ae66-0159b5b26b7d"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Cross-Origin-Embedder-Policy","value":"unsafe-none"},{"key":"Permissions-Policy","value":"accelerometer=(),camera=(), display-capture=(), geolocation=(), gyroscope=(), microphone=(), midi=(), screen-wake-lock=()"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"92a0fffb9910d6dd-IAD"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"base\": \"AED\",\n \"to\": \"AUD\",\n \"rate\": 0.4307,\n \"date\": \"2025-04-02\",\n \"status\": {\n \"code\": \"RATE_UPDATED\",\n \"response\": \"rate is up-to-date\"\n }\n },\n {\n \"base\": \"AED\",\n \"to\": \"BBD\",\n \"rate\": 0.5435,\n \"date\": \"2025-04-02\",\n \"status\": {\n \"code\": \"RATE_UPDATED\",\n \"response\": \"rate is up-to-date\"\n }\n }\n]"}],"_postman_id":"2481b8b9-ba5a-478e-bec5-4dbb76e2b6f5"},{"name":"Get Currency Pair Rate","id":"82e4d27e-429c-4c57-b2b7-585a50750b15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{rateAuthToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{api_url}}/rest/rate/api/rates/rate_by_currencies?currencyFrom=USD¤cyTo=EUR","description":"

📄 Description

\n

This API endpoint retrieves the exchange rate for a specific currency pair within the LumonPay environment.
By providing the source (currencyFrom) and target (currencyTo) currencies as query parameters, clients can obtain the latest conversion rate between them.

\n

🔐 Authorization

\n

Authentication is required.
Include the following header in your request:

\n

🔎 Query Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeRequiredDescription
currencyFromstringYesThe currency code of the source currency (e.g., USD for United States Dollar).
currencyTostringYesThe currency code of the target currency (e.g., EUR for Euro).
\n

📩 Response

\n

On success, the API returns a JSON object containing the exchange rate for the specified currency pair.

\n","urlObject":{"path":["rest","rate","api","rates","rate_by_currencies"],"host":["{{api_url}}"],"query":[{"key":"currencyFrom","value":"USD"},{"key":"currencyTo","value":"EUR"}],"variable":[]}},"response":[{"id":"8dbff9b4-4149-48da-a454-5e9a4253f4b1","name":"Get Currency Pair Rate","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/rest/rate/api/rates/rate_by_currencies?currencyFrom=USD¤cyTo=EUR","host":["{{api_url}}"],"path":["rest","rate","api","rates","rate_by_currencies"],"query":[{"key":"currencyFrom","value":"USD"},{"key":"currencyTo","value":"EUR"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Apr 2025 14:27:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:cbf9a874-28c0-4c17-ae66-0159b5b26b7d"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Cross-Origin-Embedder-Policy","value":"unsafe-none"},{"key":"Permissions-Policy","value":"accelerometer=(),camera=(), display-capture=(), geolocation=(), gyroscope=(), microphone=(), midi=(), screen-wake-lock=()"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"92a1018cf844b964-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"base\": \"USD\",\n \"to\": \"EUR\",\n \"rate\": 0.919,\n \"date\": \"2025-04-02\",\n \"status\": {\n \"code\": \"RATE_UPDATED\",\n \"response\": \"rate is up-to-date\"\n }\n}"}],"_postman_id":"82e4d27e-429c-4c57-b2b7-585a50750b15"}],"id":"c5eac61e-f1e6-49e2-a8e1-9ad4c10f4041","description":"

📄 Overview

\n

This documentation covers the Rates endpoint, which provides the latest exchange rate for a specific currency pair within the LumonPay environment.
It allows clients to retrieve the most up-to-date conversion value between two currencies by supplying them as parameters in the request.

\n","_postman_id":"c5eac61e-f1e6-49e2-a8e1-9ad4c10f4041"},{"name":"Soldo Orchestrator API","item":[{"name":"Soldo Account","item":[{"name":"Create Soldo Account","id":"f967d806-2770-4bae-9061-7efa005e3078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idempotency-key","value":"string","description":"

The idempotency key to ensure that the request is processed only once.

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"middle_name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"card_type\": \"string\",\n \"card_currency_code\": \"string\",\n \"affiliate_code\": \"string\",\n \"mobile_prefix\": \"string\",\n \"mobile_number\": \"string\",\n \"job_title\": \"string\",\n \"department\": \"string\",\n \"address_line1\": \"string\",\n \"address_city\": \"string\",\n \"address_post_code\": \"string\",\n \"address_country\": \"string\",\n \"address_line2\": \"string\",\n \"address_county\": \"string\",\n \"delivery_phone_number\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/rest/soldo-orchestrator/api/Account","description":"

Create Soldo Account

\n

Overview

\n

This endpoint creates a new Soldo account for a user. It provisions an account with personal details, contact information, address, and card preferences. The account creation process includes setting up the user's profile and optionally issuing a payment card.

\n

Request Body Parameters

\n

Personal Information

\n\n

Card Details

\n\n

Contact Information

\n\n

Professional Details

\n\n

Address Information

\n\n

Additional Fields

\n\n

Idempotency Key

\n

The idempotency_key field is crucial for preventing duplicate account creation. When you provide an idempotency key, the API will recognize repeated requests with the same key and return the original response instead of creating duplicate accounts. This is especially important in scenarios where network issues might cause request retries.

\n

Best Practice: Generate a unique UUID or similar identifier for each account creation attempt and include it as the idempotency key.

\n

Response Scenarios

\n

Success Response

\n

When the account is successfully created, you'll receive a confirmation with the account details.

\n

Bad Request (400)

\n

This response indicates that the request was malformed or contained invalid data. Common causes include:

\n\n

Action: Review the error message in the response body to identify which field(s) need correction.

\n

Internal Server Error (500)

\n

This response indicates a server-side error occurred during account creation. This could be due to:

\n\n

Action: Retry the request with the same idempotency key. If the issue persists, contact support.

\n

Notes

\n\n","urlObject":{"path":["rest","soldo-orchestrator","api","Account"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"49e9ad06-f77a-4013-8e36-1cc07d02dd01","name":"OK","originalRequest":{"method":"POST","header":[{"description":"The idempotency key to ensure that the request is processed only once.","key":"idempotency-key","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"middle_name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"card_type\": \"string\",\n \"card_currency_code\": \"string\",\n \"affiliate_code\": \"string\",\n \"mobile_prefix\": \"string\",\n \"mobile_number\": \"string\",\n \"job_title\": \"string\",\n \"department\": \"string\",\n \"address_line1\": \"string\",\n \"address_city\": \"string\",\n \"address_post_code\": \"string\",\n \"address_country\": \"string\",\n \"address_line2\": \"string\",\n \"address_county\": \"string\",\n \"delivery_phone_number\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/Account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"surname\": \"string\",\n \"middle_name\": \"string\",\n \"email\": \"string\",\n \"status\": \"string\",\n \"full_name\": \"string\"\n },\n \"address\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"recipient_name\": \"string\",\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"post_code\": \"string\",\n \"country\": \"string\",\n \"category\": \"string\"\n },\n \"card\": {\n \"id\": \"string\",\n \"status\": \"string\",\n \"creation_time\": \"1947-01-08T17:40:46.602Z\"\n }\n}"},{"id":"abd64d76-f706-45fc-b415-b395206e7870","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"The idempotency key to ensure that the request is processed only once.","key":"idempotency-key","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"middle_name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"card_type\": \"string\",\n \"card_currency_code\": \"string\",\n \"affiliate_code\": \"string\",\n \"mobile_prefix\": \"string\",\n \"mobile_number\": \"string\",\n \"job_title\": \"string\",\n \"department\": \"string\",\n \"address_line1\": \"string\",\n \"address_city\": \"string\",\n \"address_post_code\": \"string\",\n \"address_country\": \"string\",\n \"address_line2\": \"string\",\n \"address_county\": \"string\",\n \"delivery_phone_number\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/Account"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"problem_details\": {\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 5250,\n \"detail\": \"string\",\n \"instance\": \"string\"\n },\n \"content_type\": \"string\",\n \"status_code\": 2128\n}"},{"id":"adabd99e-993e-46e3-9132-73774dd4e676","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"description":"The idempotency key to ensure that the request is processed only once.","key":"idempotency-key","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"middle_name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"card_type\": \"string\",\n \"card_currency_code\": \"string\",\n \"affiliate_code\": \"string\",\n \"mobile_prefix\": \"string\",\n \"mobile_number\": \"string\",\n \"job_title\": \"string\",\n \"department\": \"string\",\n \"address_line1\": \"string\",\n \"address_city\": \"string\",\n \"address_post_code\": \"string\",\n \"address_country\": \"string\",\n \"address_line2\": \"string\",\n \"address_county\": \"string\",\n \"delivery_phone_number\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/Account"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"problem_details\": {\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 5250,\n \"detail\": \"string\",\n \"instance\": \"string\"\n },\n \"content_type\": \"string\",\n \"status_code\": 2128\n}"}],"_postman_id":"f967d806-2770-4bae-9061-7efa005e3078"}],"id":"3b729bcc-b437-4373-8cc1-7ea12a1961ff","_postman_id":"3b729bcc-b437-4373-8cc1-7ea12a1961ff","description":""},{"name":"Wallet","item":[{"name":"Wallet Transfer","id":"11127e31-4c82-4db2-9a06-1b495335deb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"batch_id\": \"string\",\n \"wallet_transfers\": [\n {\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"amount\": 7640.368365660961,\n \"currency_code\": \"string\"\n },\n {\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"amount\": 345.07547638315873,\n \"currency_code\": \"string\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/rest/soldo-orchestrator/api/Wallet/batch-transfer","description":"

Batch Wallet Transfer

\n

This endpoint enables you to execute multiple wallet-to-wallet transfers in a single batch operation. It's designed to efficiently process bulk transfer requests while maintaining transaction integrity and traceability.

\n

Overview

\n

The Batch Wallet Transfer endpoint allows you to transfer funds between multiple wallet pairs simultaneously. Each batch is identified by a unique batch_id and can contain multiple individual wallet transfer operations. This is particularly useful for:

\n
    \n

  • Processing payroll or bulk payments

    \n
    • \n

  • Executing multiple transfers as part of a single business operation

    \n
    • \n

  • Maintaining atomicity across related transfers

    \n
    • \n

  • Reducing API calls when handling multiple transfers

    \n
    • \n
\n

Request Body Structure

\n

The request body consists of two main components:

\n

batch_id (string, required)

\n

A unique identifier for this batch of transfers. This ID is used to track and reference the entire batch operation, enabling you to:

\n
    \n

  • Query the status of all transfers in the batch response

    \n
    • \n

  • Maintain idempotency for retry scenarios

    \n
    • \n

  • Audit and reconcile batch operations

    \n
    • \n
\n

wallet_transfers (array, required)

\n

An array of individual wallet transfer objects. Each transfer in the array represents a single wallet-to-wallet transaction with the following fields:

\n

Transfer Object Fields

\n
    \n

  • external_identifier (string, required)
    A unique reference ID for this specific transfer within the batch. Use this to track individual transfers in your system and correlate them with the batch operation.

    \n
    • \n

  • from_wallet_id (string, required)
    The unique identifier of the source wallet from which funds will be debited. Ensure this wallet has sufficient balance to complete the transfer.

    \n
    • \n

  • to_wallet_id (string, required)
    The unique identifier of the destination wallet that will receive the funds. The wallet must be active and able to receive transfers.

    \n
    • \n

  • amount (number, required)
    The transfer amount in the specified currency. This should be a positive decimal number representing the exact amount to transfer (e.g., 100.50 for one hundred and fifty cents).

    \n
    • \n

  • currency_code (string, required)
    The ISO 4217 three-letter currency code for the transfer (e.g., \"USD\", \"EUR\", \"GBP\"). All transfers within a batch can use different currencies if supported by the wallets.

    \n
    • \n
\n

Response Codes

\n

200 OK

\n

The batch transfer request was successfully processed. All transfers in the batch have been validated and executed. The response will contain details about the completed batch operation.

\n

400 Bad Request

\n

The batch transfer request failed validation. This can occur due to:

\n
    \n

  • Invalid or missing required fields

    \n
    • \n

  • Malformed batch_id or wallet identifiers

    \n
    • \n

  • Insufficient funds in source wallets

    \n
    • \n

  • Invalid currency codes

    \n
    • \n

  • Duplicate external_identifier values within the batch

    \n
    • \n

  • Inactive or non-existent wallet IDs

    \n
    • \n
\n

Check the error response body for specific validation failure details.

\n

Important Notes

\n

Batch Processing

\n
    \n

  • All transfers within a batch are processed together

    \n
    • \n

  • If any transfer in the batch fails validation, the entire batch may be rejected (depending on your configuration)

    \n
    • \n

  • Use unique external_identifier values for each transfer to ensure proper tracking

    \n
    • \n

  • The batch_id should be unique across all batch operations to prevent duplicate processing

    \n
    • \n
\n

Transfer Requirements

\n
    \n

  • Source wallets must have sufficient balance for their respective transfers

    \n
    • \n

  • Both source and destination wallets must be active and in good standing

    \n
    • \n

  • Currency codes must be supported by both the source and destination wallets

    \n
    • \n

  • Transfer amounts must be positive values and respect any minimum/maximum limits

    \n
    • \n

  • Ensure proper authorization and permissions for the wallets involved in the transfers

    \n
    • \n
\n

Best Practices

\n
    \n

  • Validate wallet balances before submitting the batch

    \n
    • \n

  • Use meaningful batch_id and external_identifier values for easier tracking

    \n
    • \n

  • Implement retry logic with the same batch_id to ensure idempotency

    \n
    • \n

  • Monitor batch operations and handle failures appropriately

    \n
    • \n

  • Keep batch sizes reasonable to avoid timeout issues

    \n
    • \n
\n","urlObject":{"path":["rest","soldo-orchestrator","api","Wallet","batch-transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"1ad21334-2dc9-44d3-8edb-90d71d5aec68","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"batch_id\": \"string\",\n \"wallet_transfers\": [\n {\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"amount\": 7640.368365660961,\n \"currency_code\": \"string\"\n },\n {\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"amount\": 345.07547638315873,\n \"currency_code\": \"string\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/Wallet/batch-transfer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success_results\": [\n {\n \"id\": \"56ab9734-2240-f7a0-9b14-816319f77dc1\",\n \"batch_id\": \"string\",\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"currency_code\": \"string\",\n \"amount\": 7285.271660672083,\n \"status\": \"string\",\n \"error_details\": \"string\",\n \"error_code\": \"string\",\n \"created_by\": \"string\",\n \"created_date_utc\": \"2016-06-02T04:59:50.829Z\",\n \"updated_date_utc\": \"1952-06-21T11:26:18.019Z\"\n },\n {\n \"id\": \"9efc87f0-ae54-9334-592f-d6b0d0fa5847\",\n \"batch_id\": \"string\",\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"currency_code\": \"string\",\n \"amount\": 4353.523333737177,\n \"status\": \"string\",\n \"error_details\": \"string\",\n \"error_code\": \"string\",\n \"created_by\": \"string\",\n \"created_date_utc\": \"1974-07-25T10:22:44.355Z\",\n \"updated_date_utc\": \"1961-07-22T11:08:54.678Z\"\n }\n ],\n \"error_results\": [\n {\n \"id\": \"118e6a3c-ce16-67ca-8f03-5282033c7903\",\n \"batch_id\": \"string\",\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"currency_code\": \"string\",\n \"amount\": 8506.257894696992,\n \"status\": \"string\",\n \"error_details\": \"string\",\n \"error_code\": \"string\",\n \"created_by\": \"string\",\n \"created_date_utc\": \"1960-03-21T01:02:46.030Z\",\n \"updated_date_utc\": \"2009-09-06T00:39:36.951Z\"\n },\n {\n \"id\": \"f84b2c5d-5bc0-b270-a999-f49af98135c9\",\n \"batch_id\": \"string\",\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"currency_code\": \"string\",\n \"amount\": 5668.808682081308,\n \"status\": \"string\",\n \"error_details\": \"string\",\n \"error_code\": \"string\",\n \"created_by\": \"string\",\n \"created_date_utc\": \"1995-04-22T10:13:46.520Z\",\n \"updated_date_utc\": \"1963-09-10T02:56:47.844Z\"\n }\n ]\n}"},{"id":"9aa5a969-fbf7-43c3-ab81-bf5bd036ec2a","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"batch_id\": \"string\",\n \"wallet_transfers\": [\n {\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"amount\": 7640.368365660961,\n \"currency_code\": \"string\"\n },\n {\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"amount\": 345.07547638315873,\n \"currency_code\": \"string\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/Wallet/batch-transfer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"problem_details\": {\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 5250,\n \"detail\": \"string\",\n \"instance\": \"string\"\n },\n \"content_type\": \"string\",\n \"status_code\": 2128\n}"},{"id":"c9de7b14-5b7f-4c5e-b074-5e20ce3bca8e","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"batch_id\": \"string\",\n \"wallet_transfers\": [\n {\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"amount\": 7640.368365660961,\n \"currency_code\": \"string\"\n },\n {\n \"external_identifier\": \"string\",\n \"from_wallet_id\": \"string\",\n \"to_wallet_id\": \"string\",\n \"amount\": 345.07547638315873,\n \"currency_code\": \"string\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/Wallet/batch-transfer"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"problem_details\": {\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 5250,\n \"detail\": \"string\",\n \"instance\": \"string\"\n },\n \"content_type\": \"string\",\n \"status_code\": 2128\n}"}],"_postman_id":"11127e31-4c82-4db2-9a06-1b495335deb5"}],"id":"e4a5561b-bd8e-4bb5-9c11-cb7143334901","_postman_id":"e4a5561b-bd8e-4bb5-9c11-cb7143334901","description":""}],"id":"52bb950a-49bd-4f63-8c6c-cc0d502ca811","description":"

Soldo Account Orchestration Service

\n

A secure REST API for creating and managing Soldo accounts and wallet transfers with automated card provisioning.

\n

Key Features:

\n
    \n

  • 🔐 Automated account creation with single API call

    \n
    • \n

  • 💳 Batch wallet transfers with auto-retries and rate limit handling

    \n
    • \n

  • 💳 Multi-card support (VIRTUAL or PHYSICAL)

    \n
    • \n

  • 💱 Multi-currency support (GBP, EUR)

    \n
    • \n

  • 🔄 Idempotent operations for safe retries

    \n
    • \n

  • 🔒 JWT Bearer authentication with role-based authorization

    \n
    • \n
\n

Base URL's:

\n

The base URL's for the pre-preoduction and production environment are the following:

\n\n

Getting Started:

\n
    \n

  1. Obtain a JWT Bearer token from the identity server

    \n
    2. \n

  2. Add the token to the Authorization header: Bearer {your_token}

    \n
    3. \n

  3. Make API calls using the available endpoints below

    \n
    4. \n
\n

The request must use the client_credentials grant type, providing a valid client_id, client_secret, and scope.

\n

🔒 Authentication

\n

URL

\n\n

Request Body (x-www-form-urlencoded)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
grant_typestringYesMust be set to client_credentials.
client_idstringYesThe unique identifier assigned to the client requesting the token.
client_secretstringYesThe secret key associated with the client ID used for authentication.
scopestringYesSpecifies the level of access being requested.
\n

📩 Response

\n

On success, the API returns a JSON object containing the following:

\n
    \n

  • access_token: The token to be used for authorized API requests.

    \n
    • \n

  • token_type: The type of the token issued (typically Bearer).

    \n
    • \n

  • expires_in: The duration (in seconds) before the token expires.

    \n
    • \n

  • scope: The access scope granted.

    \n
    • \n
\n

🔔 Note:
The access_token must be included in the Authorization header as a Bearer token when making subsequent API requests:

\n

Contact Support:

\n

Page: https://www.lumonpay.com/get-in-touch/
Email: support@lumonpay.com

\n","_postman_id":"52bb950a-49bd-4f63-8c6c-cc0d502ca811"}]}