{"info":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","description":"

The Xtrm Payments API

Contact Support:
Name: Xtrm API Help desk
Email: apisupport@xtrm.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17145483","collectionId":"b999d270-4b9c-431b-8ef4-fb6817cfff94","publishedId":"2sBXwsKpBf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-06-10T17:47:34.000Z"},"item":[{"name":"API Release Notes","item":[{"name":"5.0 (Nero) Release","id":"bdb7fb23-fb15-4e8a-8ca4-458e7f06ca59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","description":"

5.0 (Nero)

Coming Soon

Release 4.92.6

Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality

New Calls

There are no new changes for the 4.92.6 release.

Changed Calls

Created Date	Description
4.92.6 05/22/2026	Added new param IssuerTransactionId in the TransferFundDynamicAccountCreateUser endpoint to validate the transaction with idempotency.
4.92.6 05/22/2026	Added new param IsReplay in the response object of TransferFund, TransferFundToCompany, TransferFundDynamicAccountCreateUser to identify the response is for actual request or duplicate request.

Schema Changes

There are no schema changes for the 4.92.6 release.

Announcements

There are no announcements for the 4.92.6 release.

New Features

There are no new features for the 4.92.6 release.

Changed Functionality

Created Date	Description
4.92.6 05/22/2026	The existing parameter, IssuerTransactionId, in the TransferFund and TransferFundToCompany endpoints will now be used to validate transactions and enforce idempotency.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"148adeee-5b42-4404-b19c-e7fe656f96ba"},{"name":"4.92.5 Release","id":"d264318f-a655-406e-9b11-1411866109ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"d264318f-a655-406e-9b11-1411866109ae"},{"name":"4.92.4 Release","id":"e9f1e502-128d-4ade-bbd7-3fce59c593b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"e9f1e502-128d-4ade-bbd7-3fce59c593b0"},{"name":"4.92.3 Release","id":"25db6562-dfb0-4007-a9e4-bfeec950c48b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"25db6562-dfb0-4007-a9e4-bfeec950c48b"},{"name":"4.92.2 Release","id":"6f456f51-ae9f-4837-aa9e-a4c0b903340b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"6f456f51-ae9f-4837-aa9e-a4c0b903340b"},{"name":"4.92.1 Release","id":"995da837-507e-49c3-a91e-ce0ea0fe5079","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"995da837-507e-49c3-a91e-ce0ea0fe5079"},{"name":"4.92.0 Release","id":"02707267-f4e8-4ed3-b43d-76d12bccde91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"02707267-f4e8-4ed3-b43d-76d12bccde91"},{"name":"4.91.9 Release","id":"8fc9c9a4-876b-468a-9e94-6dc4a51c99a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8fc9c9a4-876b-468a-9e94-6dc4a51c99a6"},{"name":"4.91.8 Release","id":"8293f236-f7bf-4154-ab7a-0bdc2f3070e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8293f236-f7bf-4154-ab7a-0bdc2f3070e0"},{"name":"4.91.7 Release","id":"fa69b5dc-3e29-4097-8179-193ac4b5ec62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"fa69b5dc-3e29-4097-8179-193ac4b5ec62"},{"name":"4.91.6 Release","id":"50ddbec6-1934-4655-af15-579d8f8a8d71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"50ddbec6-1934-4655-af15-579d8f8a8d71"},{"name":"4.91.5 Release","id":"2052fbea-d7b0-4585-9f3b-864f35148511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"2052fbea-d7b0-4585-9f3b-864f35148511"},{"name":"4.91.4 Release","id":"ec1a8d85-7a67-40d4-8846-9c59773ceab2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"ec1a8d85-7a67-40d4-8846-9c59773ceab2"},{"name":"4.91.3 Release","id":"b8de3e73-7210-4d02-8391-4d59b1535631","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"b8de3e73-7210-4d02-8391-4d59b1535631"},{"name":"4.91.2 Release","id":"a7245047-a53e-4aaa-b7a9-08022a3627dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"a7245047-a53e-4aaa-b7a9-08022a3627dc"},{"name":"4.91.1 Release","id":"eca88e7c-344b-4265-bf0f-dd8d551ad305","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"eca88e7c-344b-4265-bf0f-dd8d551ad305"},{"name":"4.91 Release","id":"b9b6f3c2-e258-478d-9161-1637abc40093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"b9b6f3c2-e258-478d-9161-1637abc40093"},{"name":"4.9 Release","id":"bf36b6cc-f158-4792-90ee-7748641b261c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"bf36b6cc-f158-4792-90ee-7748641b261c"},{"name":"4.8 Release","id":"63e13e0c-d6a1-4c61-a69c-5c766db1ec7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"63e13e0c-d6a1-4c61-a69c-5c766db1ec7b"},{"name":"4.7 Release","id":"3d676c9a-d618-4f2d-addf-211d90949f95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"3d676c9a-d618-4f2d-addf-211d90949f95"},{"name":"4.6 Release","id":"77d05f7c-31b8-4fe0-b0e1-a5a430f87dfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"77d05f7c-31b8-4fe0-b0e1-a5a430f87dfd"},{"name":"4.5 Release","id":"0ae85753-b188-45cf-ab26-923711e9a213","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"0ae85753-b188-45cf-ab26-923711e9a213"},{"name":"4.4 Release","id":"0d5985b4-28bc-4e38-8cb0-0f59eb65e5c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"0d5985b4-28bc-4e38-8cb0-0f59eb65e5c4"},{"name":"4.3 Release","id":"b806277e-0b29-4093-9925-3c88505688ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"b806277e-0b29-4093-9925-3c88505688ea"},{"name":"4.2 Release","id":"3817b5fc-5234-497b-81ce-2d8758ca7c29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"3817b5fc-5234-497b-81ce-2d8758ca7c29"},{"name":"4.1.1 Release","id":"70f6b9c1-41fe-4add-9796-a75f7454af63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"70f6b9c1-41fe-4add-9796-a75f7454af63"},{"name":"4.1 Release","id":"ef80ef50-8774-4c73-9510-3d795ccfe9e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"ef80ef50-8774-4c73-9510-3d795ccfe9e0"},{"name":"4.01 Release","id":"bc1f6807-c614-44bc-a697-35243d82d8a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"bc1f6807-c614-44bc-a697-35243d82d8a9"},{"name":"4.0 Release","id":"0e0e5bf1-48c8-4291-8b42-664fe637d46b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"0e0e5bf1-48c8-4291-8b42-664fe637d46b"},{"name":"3.0 Release","id":"4b4b28d3-9d75-4d32-84e1-f8765c3f42fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc","id":"bef38276-dac8-4390-b931-56c8e2984efc","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"4b4b28d3-9d75-4d32-84e1-f8765c3f42fb"}],"id":"bef38276-dac8-4390-b931-56c8e2984efc","description":"

Xtrm API (XAPI) Documentation

\n\n

We’ve developed the Xtrm API (XAPI) for you to embed global payments into your system. This overview gives you an understanding of the types of calls possible with XAPI. You can explore the calls and responses you’ll use while embedding XAPI into your site, mobile app, or platform. Please don't hesitate to contact us with any questions by emailing apisupport@xtrm.com

\n\n

Quick Start Guide

\n\n

Follow these steps to get going quickly:

\n\n

Create your sandbox company account
You will recieve a validation link in your email after you complete the signup with the link above. Click that Validation link to accept the terms and conditions and create your login password. Then our team will approve your account, and complete the setup on your behalf.
Login to your account. Go to Settings, then Integrations then click Get Credentials

\n\n

From this screen you can get your API credentials and request which IPs you want to be whitelisted. Our team will approve the IP addresses and will fund your sandbox company account with test funds so you can start testing.

\n\n

Sandbox environment
(https://sandbox.xtrm.com)

\n\n

The sandbox environment is a complete stateful replica of the Xtrm production environment, supporting all of the same API endpoints. Applications should be tested against the sandbox environment before being used in production. Once Sandbox testing is completed, we will have a call with our ops team to verify that you are ready for the production environment.

\n\n

Differences from production environment

\n\n

The Sandbox contains only test data and is completely separate from your production account
Actual money is not sent or received as part of test transactions. Real financial data should never be used in the Sandbox.
All access API endpoints have a base URL of https://xapisandbox.xtrm.com/API/V4/ in sandbox and https://xapi.xtrm.com/API/V4/ in production.

\n\n

Transfer behavior in the sandbox

\n\n

The sandbox environment does not actually make any transfers out of the platform, so a pending transfer will not be processed as it would in production. It will simply remain in the pending state indefinitely.

\n\n

Sandbox setup

\n\n

Once your IPs are approved, we will add $5000 USD and 5000 of your local currency, if requested, to digital wallets in your sandbox testing account.

\n\n

API Release Notes

Version	Release Date	Status
V5.0 Nero	Coming Soon	Coming Soon
V4.92.6	06-01-2026	Live
V4.92.5	05-25-2026	Live
V4.92.4	11-22-2025	Live
V4.92.3	10-14-2025	Live
V4.92.2	06-27-2025	Live
V4.92.1	04-24-2025	Live
V4.92.0	02-10-2025	Live
V4.91.9	01-27-2025	Live
V4.91.8	08-10-2023	Live
V4.91.7	04-17-2023	Live
V4.91.6	02-20-2023	Live
V4.91.5	12-02-2022	Live
V4.91.4	11-22-2022	Live
V4.91.3	08-01-2022	Live
V4.91.2	05-20-2022	Live
V4.91.1	04-10-2022	Live
V4.91	03-29-2022	Live
V4.9	04-01-2022	Live
V4.8	12-19-2021	Live
V4.7	03-05-2021	Live
V4.6	01-25-2021	Live
V4.5	11-09-2020	Live
V4.4	10-10-2020	Live
V4.3	10-31-2019	Live
V4.2	03-11-2019	Live
V4.1.1	11-02-2018	Live
V4.1	05-01-2018	Live
V4.01	02-23-2018	Live
V4.0	02-12-2018	Live
V3.0	08-20-2017	Live
V2.0	03-14-2017	Retired
V1.0	11-02-2016	Retired

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8ca436d3-24a0-474f-b2fc-f7ec781fa744"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"72c06f79-1125-4a50-9fa8-9ec0eeecb5e5"}}],"_postman_id":"bef38276-dac8-4390-b931-56c8e2984efc"},{"name":"Authorization","item":[{"name":"Get or renew an authorization token","id":"8903381c-2fd3-4ab1-aa1b-4b42d493ec77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","description":"

(Required) always has value password or refresh_token

\n"},{"key":"client_id","value":"{{xtrm_client_id}}","description":"

(Required) Xtrm-supplied client id

\n"},{"key":"client_secret","value":"{{xtrm_client_secret}}","description":"

(Required) Xtrm-supplied client secret

\n"},{"key":"refresh_token","value":"66fa9c8ad2264077ab565aa1e38927b0","description":"

(Optional) only required when renewing a token

\n"}]},"url":"https://xapisandbox.xtrm.com/oAuth/token","description":"

Initial authorization token request

This API call has no security; it is the basis of the bearer authentication. Security is provided by the use of secure http (https) and the remitter’s API credentials.

grant_type is either password to get a new session token, or refresh_token
to renew a session.

The refresh_token is provided in the response of a successful Authorization call. The refresh_token needs to be passed only when the grant_type has the value of refresh_token.

access_token expires after 24 hours of inactivity. After it expires, neither it nor the refresh_token are valid.

\n","urlObject":{"path":["oAuth","token"],"host":["https://xapisandbox.xtrm.com"],"query":[],"variable":[]}},"response":[{"id":"9b79b91a-65d4-4db4-8d40-6d01f4558a5e","name":"200 OK - Token Issued","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) always has value `password` or `refresh_token`\n","key":"grant_type","value":"password"},{"description":"(Required) XTRM-supplied client id\n","key":"client_id","value":"{{xtrm_client_id}}"},{"description":"(Required) XTRM-supplied client secret\n","key":"client_secret","value":"{{xtrm_client_secret}}"},{"description":"only present when renewing a token\n","key":"refresh_token","value":"66fa9c8ad2264077ab565aa1e38927b0"}]},"url":"https://xapisandbox.xtrm.com/oAuth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"access_token\": \"rlpRJOTSQxQt1QKs+VUKXKwYAdjuZXHk++P8fk+y/bYVeG77Xanucg8IhiXH2m6kF95YMN4fGfTNGIdp6201hIqOUKSCTsSGxgjtcrqkPchZ07wn20xt+55k6tWKeysdZdlulE9alPZWefSaBig+ekSITRO8cmndIRbRJBDIkF0C/fLFeGkMqNsVIcUU=\",\n\t\"token_type\": \"bearer\",\n\t\"expires_in\": 86399,\n\t\"refresh_token\": \"8ad2264b06082ab565aa1e3896fa927c\",\n\t\".issued\": \"Mon, 22 Jan 2018 17:20:45 GMT\",\n\t\".expires\": \"Tue, 23 Jan 2018 17:20:45 GMT\",\n\t\"client_id\": \"9999999_API_User\"\n}"}],"_postman_id":"8903381c-2fd3-4ab1-aa1b-4b42d493ec77"}],"id":"4b5a5f3f-aef2-4df4-a7a4-07b4754140f1","description":"

Endpoints for authenticating and securely authorizing your API requests.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"d71155c5-d737-4794-afab-9af268637b51"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"d2287ef3-ac52-4f00-ae21-c616a8de0fa8"}}],"_postman_id":"4b5a5f3f-aef2-4df4-a7a4-07b4754140f1"},{"name":"Banks","item":[{"name":"Delete a beneficiary’s linked bank","id":"7fbef0b5-23ed-48a1-9903-7334d939bc3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"DeleteBankBeneficiary\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"RecipientAccountNumber\": \"SPN9999888\",\n \"BeneficiaryBankID\": \"12e6f8ac19804f90be485045f50ace57\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Bank/DeleteBankBeneficiary","description":"

Used to delete a beneficiary’s linked bank. Get the required BeneficiaryBankID from the GetLinkedBankAccounts or GetACHDebitLinkedBankAccounts API call.

Request Parameters

\n\n

Parameter	Description	Required
RecipientAccountNumber	A unique Xtrm account identifier, starting with `SPN` for companies or `PAT` for personal accounts. This will be the account that you are deleting the linked bank for.	true
BeneficiaryBankID	Bank-dependent ID for beneficiary. Get the required `BeneficiaryBankID` from the `GetLinkedBankAccounts` or `GetACHDebitLinkedBankAccounts` API call.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
BeneficiaryBankID	Bank-dependent ID for beneficiary
Success	Success or failure of operation (true/false)
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch a list of the Bank debit linked bank accounts (or bank transfers systems analogous to ACH). This is used to fund company wallets using the Bank debit method.

Request Parameters

\n\n

Parameter	Description	Required
RecipientUserId	A unique Xtrm account identifier, starting with `SPN` for companies or `PAT` for personal accounts.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false)
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.
TransferFee	Fee for transfer
BankName	Bank Name
BranchName	Bank branch identifier
ACHDebitApprovalStatus	Approval status of the ACH debit link (e.g., Approved, Pending, Rejected).
AccountNumber	Bank account number
BankBeneficiaryStatus	Current operational status of the bank beneficiary profile (e.g., Active, Inactive).
BeneficiaryId	Unique identity code for the linked bank profile
BeneficiaryName	Name of the beneficiary on the bank account
Country	Name of the country
Currency	The three-letter ISO currency code
EntityID	A unique internal system identifier used to map this bank profile to a specific entity record.
PaymentMethods	An object detailing the accepted payment methods (e.g., {\"Payment\": \"ACH\"}).

Retrieves a list of bank withdrawal types for the bank such as wire, ACH, and similar systems.

Request Parameters

\n\n

Parameter	Description	Required
CountryISO2	The two-character ISO country abbreviation. Can be retrieved using the `GetCountry` call.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false)
WithdrawTypes	How funds are withdrawn (ACH or WIRE). The result is an array of strings.

This call is for Linking a bank to fund a Company wallet. Linking a bank beneficiary may require multiple steps. Different jurisdictions require different or additional pieces of information. Our API will serve the localized requirements based on the linking banks requirements.

Additional Details:

The Maximum number of linked banks that can be added to a Personal/User account is 3.
\n
The Maximum number of linked banks that can be added to a Company account is 50.
\n

Additional Jurisdiction Information:

In some cases, additional information may be requested by the bank to complete the linkage depending on its local requirements.
In such cases, the initial response may return with a 200 code, and the LinkBankBeneficiary:request:OperationStatus: Success may be false.
The Error field will have an ErrorMessage, and report that an additional FieldName and FieldLabel are required (possibly \"RoutingNumber\" and \"Account Number\", respectively.
The call is then made a second time, filling out the required field (in this example, the field LinkACHDebitBankBeneficiary:request:Beneficiary:BankDetails:RegulatoryFields).
Unusual data will be specified as going into RegulatoryFields.

Exotic Currency Requirements:

Some currencies will require currency-specific information to remit funds. This follows the two-step, first response delivers the additional requirements, and the second call completes the process as described above.

Request 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\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\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Required
UserID	A unique Xtrm account identifier, starting with `SPN` for company accounts or `PAT` for personal accounts.	true
Currency	The three-letter ISO currency code for the bank account.	true
CountryISO2	The two-character ISO country abbreviation for the bank's location.	true
EntityID	A unique internal system identifier used to map this bank profile to a specific entity record.	false
InstitutionName	Name of the financial institution.	true
Key	The parameter name for additional compliance data (used inside RegulatoryFields).	false
Value	The specific data value corresponding to the regulatory Key (used inside RegulatoryFields).	false
RoutingNumber	Financial institution routing number.	true
SWIFTBIC	SWIFT-BIC routing code.	true
AccountNumber	Institution account identifier.	true
AccountType	The type of bank account. Must be the value 'BUSINESS'.	true
City	Name of the beneficiary's city, from 1 to 25 characters.	true
ContactName	The name of the beneficiary, from 2 to 40 characters in length.	true
CountryISO2	The two-character ISO country abbreviation for the beneficiary's address.	true
PhoneNumber	A phone number of the beneficiary, represented as a string of 1 to 25 characters.	true
PostalCode	ZIP code or other code for mail delivery for the beneficiary.	true
Region	Region/State value for the beneficiary. Must be either the 2 letter ISO2 code or the full state name.	true
AddressLine1	Beneficiary's street name, number, and other delivery specifics.	true
AddressLine2	Beneficiary's street name, number, and other delivery specifics (apartment, suite, etc.).	false
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

Response 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\n\n\n\n\n\n\n\n\n

Parameter	Description
ACHDebitApprovalStatus	The current verification and approval status specifically for ACH debit funding (e.g., Pending, Approved, Declined).
AccountIdentityLevel	The compliance verification level of the account's identity (e.g., Pending, Approved, Declined).
BankBeneficiaryStatus	The overall operational status of the newly linked bank profile (e.g., Pending, Active, Suspended).
BeneficiaryId	The unique identity code generated by Xtrm for this linked bank profile.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch a list of the beneficiary linked bank accounts. This is used when making direct pass through payments to a beneficiary’s bank account.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecipientUserId	A unique Xtrm account identifier, starting with `SPN` for company accounts or `PAT` for personal accounts.	true

\n\n

Response Parameters

\n\n

Parameter	Description
EntityID	A unique internal system identifier used to map this bank profile to a specific entity record.
TransferFee	Fee for transfer
ACHDebitApprovalStatus	Approval status of the ACH debit link (e.g., Approved, Pending, Rejected).
AccountNumber	Bank account number
BankBeneficiaryStatus	Current operational status of the bank beneficiary profile (e.g., Active, Inactive).
BankName	Name of the bank
BranchName	Bank branch identifier
BeneficiaryId	Unique identity code for the linked bank profile
BeneficiaryName	Name of the beneficiary on the bank account
Country	Name of the country
Currency	The three-letter ISO currency code
PaymentMethods	An object detailing the accepted payment methods (e.g., {\"Payment\": \"ACH\"}).
Success	Success or failure of operation (true / false)
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Linking a bank beneficiary may require multiple steps. Different jurisdictions require different or additional pieces of information. Our API will serve the localized requirements based on the linking banks requirements. The first step involves submitting five Required pieces of information.

Additional Details:

The Maximum number of linked banks that can be added to a User account is 3.
\n
The Maximum number of linked banks that can be added to a Company account is 50.
\n

Additional Jurisdiction Information:

Exotic Currency Requirements:

Request Parameters

Parameter	Description	Required
UserID	A unique Xtrm account identifier, starting with `SPN` for company accounts or `PAT` for personal accounts.	true
Currency	The three-letter ISO currency code for the bank account.	true
CountryISO2	The two-character ISO country abbreviation for the bank's location.	true
EntityID	A unique internal system identifier used to map this bank profile to a specific entity record.	false
InstitutionName	Name of the financial institution.	true
Key	The parameter name for additional compliance data (used inside RegulatoryFields).	false
Value	The specific data value corresponding to the regulatory Key (used inside RegulatoryFields).	false
RoutingNumber	Financial institution routing number.	true
SWIFTBIC	SWIFT-BIC routing code.	true
AccountNumber	Institution account identifier.	true
AccountType	The type of bank account. Must be the value 'BUSINESS'.	true
City	Name of the beneficiary's city, from 1 to 25 characters.	true
ContactName	The name of the beneficiary, from 2 to 40 characters in length.	true
CountryISO2	The two-character ISO country abbreviation for the beneficiary's address.	true
PhoneNumber	A phone number of the beneficiary, represented as a string of 1 to 25 characters.	true
PostalCode	ZIP code or other code for mail delivery for the beneficiary.	true
Region	Region/State value for the beneficiary. Must be either the 2 letter ISO2 code or the full state name.	true
AddressLine1	Beneficiary's street name, number, and other delivery specifics.	true
AddressLine2	Beneficiary's street name, number, and other delivery specifics (apartment, suite, etc.).	false
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

Response 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\n\n\n\n\n\n\n\n\n

Parameter	Description
ACHDebitApprovalStatus	The current verification and approval status specifically for ACH funding/transfers (e.g., Pending, Approved, Declined).
AccountIdentityLevel	The compliance verification level of the account's identity (e.g., Pending, Approved, Declined).
BankBeneficiaryStatus	The overall operational status of the newly linked bank profile (e.g., Pending, Active, Suspended).
BeneficiaryId	The unique identity code generated by Xtrm for this linked bank profile.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This initiates a small micro-deposit (usually around $0.05 USD) to a linked bank account to ensure that Xtrm has connected the remitting entity to the correct account. Once the remitting entity has verified the exact amount deposited into their account, the VerifyACHDebitMicrodeposit API endpoint marks the connection as verified and correct.

Xtrm sends all ACH requests immediately. However, the receiving institution may take up to 2 working days to acknowledge and respond to the transaction.

Xtrm credits the account immediately upon acknowledgement of a successful transaction.

Request Parameters

\n\n

Parameter	Description	Required
BeneficiaryBankID	Identification code for linked bank returned when linking a bank or using `GetACHDebitLinkedBankAccounts`	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
UserID	A unique Xtrm account identifier, starting with `SPN` for company accounts or `PAT` for personal accounts.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Message	A human-readable string confirming the execution status of the micro-deposit, which typically includes the masked bank account number.
Success	Success or failure of operation (true / false)
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Search banks within a country using SwiftBIC.

Request Parameters

\n\n

Parameter	Description	Required
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25.	true
RecordsToTake	The maximum number of results to return per page.	true
SWIFTBIC	SWIFT-BIC routing code	true
BankCountryISO2	The two-character ISO country abbreviation for the bank's location.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
CountryName	The name of the country where the bank branch is located.
RoutingType	The specific routing system or network type associated with the bank.
AddressLine1	The first line of the bank branch's physical address.
BIC	The SWIFT-BIC routing code for the bank.
BranchCode	The specific identifier code for the bank branch.
BranchName	The name of the specific bank branch.
NationalId	The national identification routing number for the bank.
PostalCode	The postal or ZIP code for the bank branch.
AddressLine2	The second line of the bank branch's physical address.
AddressLine4	The fourth line of the bank branch's physical address.
InstitutionName	The name of the financial institution.
AddressLine3	The third line of the bank branch's physical address.
City	The city where the bank branch is located.
CountryCode	The two-character ISO country abbreviation for the bank.
Success	Success or failure of operation (true / false)
RecordsToSkip	The number of records bypassed before returning these results.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of records available for this query.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Search banks within a country using national id / routing code.

Request Parameters

\n\n

Parameter	Description	Required
BankCountryISO2	The two-character ISO country abbreviation for the bank's location.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
NationalID	The national identification routing code (e.g., Routing Number, Sort Code).	true
RecordsToTake	The maximum number of results to return per page.	true
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false)
City	The city where the bank branch is located.
CountryName	The name of the country where the bank branch is located.
AddressLine1	The first line of the bank branch's physical address.
AddressLine2	The second line of the bank branch's physical address.
AddressLine3	The third line of the bank branch's physical address.
AddressLine4	The fourth line of the bank branch's physical address.
BranchInformation	Additional details or the name of the specific bank branch.
CountryISO2	The two-character ISO country abbreviation for the bank.
InstitutionName	The name of the financial institution.
PostalCode	The postal or ZIP code for the bank branch.
NationalIdType	The system type of the national routing code returned (e.g., USBC, SORT_CODE, BSB).
NationalIdentifier	The specific national identification routing code for the bank.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This endpoint checks if a provided International Bank Account Number (IBAN) is structurally and mathematically valid for the specified country. It is highly recommended to call this endpoint before attempting to link a bank or initiate a transfer, as validating the IBAN upfront prevents failed transactions and routing errors.

Request Parameters

\n\n

Parameter	Description	Required
BankCountryISO2	The two-character ISO country abbreviation for the bank's location.	true
IBAN	The International Bank Account Number (IBAN) to be validated.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
IsValid	Indicates whether the provided IBAN is mathematically and structurally valid (true / false). Note: The `Success` parameter simply means the API call executed without server errors. To determine if the IBAN is actually valid, you must check the boolean value of this `IsValid` parameter.
Success	Success or failure of the API execution (true / false).
SWIFTBIC	The SWIFT-BIC routing code associated with the validated IBAN (returned if the IBAN is valid and the BIC can be derived).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This call verifies that the micro-deposit of funds sent to a remitting entity's bank account was received correctly, confirming account ownership and ensuring the account is correctly linked.

Request Parameters

\n\n

Parameter	Description	Required
BeneficiaryBankID	Identification code for the linked bank, returned when linking a bank or using `GetACHDebitLinkedBankAccounts`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
UserID	A unique Xtrm account identifier, starting with `SPN` for company accounts or `PAT` for personal accounts.	true
Amount_1	The first micro-deposit amount (in string format) that appeared on the beneficiary's bank statement, used to verify account ownership.	true
Amount_2	The second micro-deposit amount (in string format) that appeared on the beneficiary's bank statement, used to verify account ownership.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Message	A human-readable string confirming the execution status of the bank verification.
Success	Success or failure of operation (true / false)
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoints to search, verify, link, and remove bank account connections and routing details for an Xtrm account.

\n","_postman_id":"a52a0f91-6f93-4c57-9cd9-9d74107a0b46","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Cards","item":[{"name":"Delete a beneficiary’s linked Card","id":"280df77f-880c-41eb-bbdb-55b6b4394c91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DeleteCard\": {\n\t\t\"request\": {\n\t\t\t\"IssuerAccountNumber\": \"SPN1111222\",\n\t\t\t\"UserID\": \"SPN9999888\",\n\t\t\t\"CardToken\": \"F99BA315C4734B3\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Card/DeleteCard","description":"

Delete a beneficiary’s linked Card. Get the required CardToken from the GetLinkedCards API call.

Request Parameters

\n\n

Parameter	Description	Required
UserID	A unique Xtrm account identifier, starting with `SPN` for company accounts or `PAT` for personal accounts.	true
CardToken	The unique tokenized identifier for the linked card you wish to delete.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
CardToken	The unique tokenized identifier of the card that was successfully deleted.
Success	Success or failure of operation (true / false)
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch a list of the beneficiary linked Card accounts. This is used when making direct pass through payments to a beneficiary’s Card account.

Request Parameters

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
UserId	A unique Xtrm account identifier, starting with `SPN` for company accounts or `PAT` for personal accounts.	true

\n\n

Response Parameters

Parameter	Description
City	The city associated with the card's billing address.
EntityID	A unique internal system identifier used to map this card profile to a specific entity record.
PostalCode	The postal or ZIP code for the card's billing address.
State	The state or region abbreviation for the card's billing address.
AddressLine1	The first line of the card's billing address.
CardType	The brand or network of the card (e.g., Visa, MasterCard).
Country	The two-character ISO country abbreviation for the card's billing address.
CardToken	The unique tokenized identifier for the linked card.
LinkCardType	The classification type of the linked card (e.g., Debit, Credit).
FirstName	The first name of the cardholder.
CardNo	The masked or partial card number (typically showing the last 4 digits) for security.
ExpMonth	The expiration month of the card, represented as a numeric string (1 to 12).
ExpYear	The four-digit expiration year of the card.
LastName	The last name of the cardholder.
NameOnCard	The full name exactly as it appears printed on the card.
AddressLine2	The second line of the card's billing address (e.g., apartment or suite number).
Success	Success or failure of operation (true / false)
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Linking a Card for identity or transfer.

Exotic Currency Requirements

When the link card type is transfer, only US cards (CountryCode: US) can be linked.

Request Parameters

Parameter	Description	Required
EntityID	A unique internal system identifier used to map this card profile to a specific entity record.	false
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
LinkCardType	The intended purpose of linking the card. Must be either `identity` or `transfer`.	true
UserID	A unique Xtrm account identifier, starting with `SPN` for company accounts or `PAT` for personal accounts.	true
State	The state or region abbreviation for the card's billing address.	true
ExpYear	The four-digit expiration year of the card.	true
FirstName	The first name of the cardholder.	true
LastName	The last name of the cardholder.	true
NameOnCard	The full name exactly as it appears printed on the card.	true
AddressLine1	The first line of the card's billing address.	true
AddressLine2	The second line of the card's billing address (e.g., apartment or suite number).	false
CountryCode2	The two-character ISO country abbreviation for the card's billing address.	true
PostalCode	The postal or ZIP code for the card's billing address.	true
CardNo	The full primary account number (PAN) of the credit or debit card.	true
City	The city associated with the card's billing address.	true
ExpMonth	The expiration month of the card, represented as a numeric string (1 to 12).	true
CardType	The brand or network of the card (e.g., Visa, MasterCard).	true
cvv	The 3- or 4-digit Card Verification Value (CVV/CVC) typically found on the back of the card.	true

Response 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\n\n\n\n\n

Parameter	Description
CardToken	The unique tokenized identifier generated by Xtrm for the linked card.
Success	Success or failure of operation (true / false).
AccountIdentityLevel	The compliance verification level of the account's identity (e.g., Pending, Approved, Declined).
CardStatus	The overall operational status of the newly linked card (e.g., Pending, Active, Declined).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoints for linking, retrieving, and deleting credit or debit card profiles associated with an account.

\n","_postman_id":"7118b2c8-06de-4ede-95b9-bd60f3faf974","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Beneficiary Company","item":[{"name":"Check company beneficiary existence","id":"e96c005e-a1aa-4485-83be-e244519259b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"CheckBeneficiaryExist\": {\n\t\t\"request\": {\n\t\t\t\"IssuerAccountNumber\": \"SPN1111222\",\n\t\t\t\"CompanyName\": \"Acme Corporation\",\n\t\t\t\"CompanyEmailDomain\": \"acmecorp.com\",\n\t\t\t\"Pagination\": {\n\t\t\t\t\"RecordsToSkip\": \"1\",\n\t\t\t\t\"RecordsToTake\": \"25\"\n\t\t\t}\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Beneficiary/CheckBeneficiaryExist","description":"

Search for existing Xtrm account by company email domain or by company name.

\n\n

Often, companies have preexisting accounts within the Xtrm ecosystem. This API call finds all companies matching a particular name, and returns some minimal information about them.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
CompanyEmailDomain	The email domain registered to the company (e.g., example.com) used to search for the beneficiary.	false
CompanyName	The registered name of the company beneficiary to search for.	false
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25.	true
RecordsToTake	The maximum number of results to return per page.	true

\n\n

Response Parameters

\n\n

Parameter	Description
MasterAdminLastName	The last name of the company's master administrator.
Name	The registered name of the company beneficiary.
Status	The current operational status of the company beneficiary (e.g., Active, Pending).
AccountIdentityLevel	The compliance verification level of the company's identity (e.g., Pending, Approved, Declined).
AccountNumber	The unique Xtrm account identifier for the matching company beneficiary, starting with `SPN`.
Email	The primary contact email address registered for the company.
MasterAdminFirstName	The first name of the company's master administrator.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Once created via this call, beneficiary companies will be reviewed for KYC (Know Your Customer) compliance. Ensure that the information is real and accurate. Do not create test companies or emails on production servers.

\n\n

Request Parameters

Parameter	Description	Required
AdminEmail	The primary email address for the company's master administrator.	true
AdminFirstName	The first name of the company's master administrator.	true
AdminLastName	The last name of the company's master administrator.	true
AdminMobileNumber	The mobile phone number of the company's master administrator.	false
City	The city where the company is physically located.	false
EmailNotification	Determines whether an account creation notification email is sent to the admin's email address (true / false).	true
Region	The state, province, or geographic region of the company's physical address.	false
CountryISO2	The two-character ISO country abbreviation for the company's location.	true
PostalCode	The postal or ZIP code for the company's physical address.	false
BeneficiaryCompanyName	The legally registered name of the company beneficiary being created.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
SalesforcePartnerID	The specific Salesforce identifier for the partner.	false
OtherPartnerID	An alternative identifying code for the partner (if not using Salesforce).	false
PartnerAccountManager	The full name of the partner’s designated account manager.	false
PartnerLevel	The designated partner status, tier, or sales level.	false
Region	The operational or sales region associated with the partner profile.	false
WebAddress	The primary website URL for the company.	false

\n\n

Response Parameters

Parameter	Description
BeneficiaryID	The unique Xtrm account identifier generated for the new company beneficiary, starting with `SPN`.
ClientID	The Xtrm API Client ID assigned to the newly created beneficiary for future API calls.
Success	Success or failure of operation (true / false).
SecretKey	The Xtrm-supplied secret key used to authenticate API calls for this specific beneficiary.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch a list of beneficiaries for the company.

Request Parameters

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
Pagination.RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25.	true
Pagination.RecordsToTake	The maximum number of results to return per page.	true

\n\n

Response Parameters

Parameter	Description
BeneficiaryAccountIdentityLevel	The compliance verification level of the company's identity (e.g., Pending, Approved, Declined).
BeneficiarySalesforceId	The specific Salesforce identifier for the beneficiary.
OtherPartnerID	An alternative identifying code for the partner (if not using Salesforce).
PartnerAccountManager	The full name of the partner’s designated account manager.
Region	The state, province, or geographic region of the beneficiary.
BeneficiaryCompanyName	The legally registered name of the company beneficiary.
BeneficiaryContact	The primary contact name for the beneficiary.
BeneficiaryEmail	The primary contact email address for the beneficiary.
BeneficiaryID	The unique Xtrm account identifier for the beneficiary, starting with `SPN`.
Success	Success or failure of operation (true / false).
RecordsToSkip	The number of records bypassed before returning these results.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of records available for this query.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch a list of entities for the company.

Request Parameters

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25. (Passed inside the Pagination object).	true
RecordsToTake	The maximum number of results to return per page. (Passed inside the Pagination object).	true
UserID	A unique Xtrm account identifier, starting with `SPN` for companies.	true

\n\n

Response Parameters

Parameter	Description
Success	Success or failure of operation (true / false).
RecordsToSkip	The number of records bypassed before returning these results.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of records available for this query.
EntityId	The unique internal system identifier for the entity.
EntityName	The registered name of the entity.
IsPrimeEntity	Indicates whether this is the primary entity associated with the user (true / false).
TotalUsers	The total number of users assigned to or associated with this entity.
EntityDescription	A brief description or categorization of the entity.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API call will update a beneficiary company account. Beneficiary companies will be reviewed for KYC (Know Your Customer) compliance. Ensure that the information is real and accurate.

Request Parameters

Parameter	Description	Required
WebAddress	The primary website URL for the company.	true
City	The city where the company is physically located.	true
CountryISO2	The two-character ISO country abbreviation for the company's location.	true
PostalCode	The postal or ZIP code for the company's physical address.	true
Region	The state, province, or geographic region of the company's physical address.	true
AdminFirstName	The first name of the company's master administrator.	true
AdminLastName	The last name of the company's master administrator.	true
BeneficiaryCompanyName	The legally registered name of the company beneficiary.	true
BeneficiaryID	The unique Xtrm account identifier for the beneficiary being updated, starting with `SPN`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
OtherPartnerID	An alternative identifying code for the partner (if not using Salesforce).	true
PartnerAccountManager	The full name of the partner’s designated account manager.	false
PartnerLevel	The designated partner status, tier, or sales level.	false
Region	The operational or sales region associated with the partner profile.	true
SalesforcePartnerID	The specific Salesforce identifier for the partner.	false

\n\n

Response Parameters

Parameter	Description
AccountIdentityLevel	The compliance verification level of the company's identity (e.g., Pending, Approved, Declined).
BeneficiaryID	The unique Xtrm account identifier for the updated beneficiary, starting with `SPN`.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API call allows you to fill and submit your or your connected company’s Advanced Profile Application. This application is meant for accounts that are looking to remit funds.

There are 4 sections in the Advanced Profile Application: Business Entity Information, Authorized Contact Information, Director Information, and Ownership Information.

If you are completing this form for a US company, you must complete Business Entity Information and Authorized Contact Information; the rest of the sections are not required.
\n
If you are completing this form for a non-US company, you must complete all four sections.
\n

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
Ticker_Symbol	[Business Entity] The stock exchange ticker symbol for the company, if publicly traded.	false
IsPublicallyTraded	[Business Entity] Indicates whether the company is publicly traded ('yes' or 'no').	true
Middle_Name	[Authorized Contact] The legal middle name of the authorized contact person.	false
Postal_Code	[Authorized Contact] The ZIP or postal code for the authorized contact's address.	true
Region_Code2	[Authorized Contact] The two-character state, province, or region abbreviation for the authorized contact.	true
Country_Code2	[Authorized Contact] The two-character ISO 3166-1 alpha-2 country code for the authorized contact.	true
First_Name	[Authorized Contact] The legal first name of the authorized contact.	true
Job_Title	[Authorized Contact] The professional title or role of the authorized contact within the company.	true
Date_of_Birth	[Authorized Contact] The authorized contact's date of birth in mm/dd/yyyy format.	true
Email_Address	[Authorized Contact] The direct professional email address for the authorized contact.	true
Last_Name	[Authorized Contact] The legal last name of the authorized contact.	true
Percentage_Owned	[Ownership] The percentage of the company owned by this individual, expressed as a whole number (e.g., 25 for 25%).	true
Address_Line_1	[Authorized Contact] The primary street address for the authorized contact.	true
Citizenship	[Authorized Contact] The two-character ISO country code representing the authorized contact's primary citizenship.	true
City	[Authorized Contact] The city of residence for the authorized contact.	true
Payments_Type	[Business Entity] The expected geographical scope of payments. Must be exactly 'USA Only' or 'International'.	false
Address_Line_1	[Director/Owner] The primary street address for the director or owner.	false
Citizenship	[Director/Owner] The two-character ISO country code representing the director or owner's primary citizenship.	true
Country_Code2	[Director/Owner] The two-character ISO 3166-1 alpha-2 country code for the director or owner.	false
First_Name	[Director/Owner] The legal first name of the director or owner.	true
Job_Title	[Director/Owner] The professional title or role of the director.	true
Postal_Code	[Director/Owner] The ZIP or postal code for the director or owner's address.	false
Business_Phone	[Business Entity] The primary contact phone number for the business.	true
City	[Director/Owner] The city of residence for the director or owner.	false
Date_Of_Birth	[Director/Owner] The director or owner's date of birth in mm/dd/yyyy format.	true
Email_Address	[Director/Owner] The direct email address for the director or owner.	true
Last_Name	[Director/Owner] The legal last name of the director or owner.	true
Region_Code2	[Director/Owner] The two-character state, province, or region abbreviation for the director or owner.	false
BeneficiaryAccountNumber	[Business Entity] The unique Xtrm account identifier for the beneficiary company, starting with `SPN`.	true
Company_Type	[Business Entity] The legal structure or corporate classification of the company (e.g., LLC, Corporation).	true
Countries_Sending_To	[Business Entity] A list of countries the business expects to remit funds to.	false
Identification_Type	[Authorized Contact/Director] The type of government-issued identification provided (e.g., Passport, Driver License).	true
Industry_Classification	[Business Entity] The general taxonomic identification or category of the business (e.g., Technology, Accommodation).	false
Postal_Code	[Business Entity] The ZIP or postal code for the business's primary headquarters.	true
Tax_Identification_Number	[Business Entity] The official tax identifier for the company (e.g., US EIN, SSN, or international equivalent).	true
Address_Line_2	[Business Entity] Additional street address information (Suite, Floor) for the business.	false
Address_Line_3	[Business Entity] Additional street address information for the business.	false
Country_Of_Incorporation_Code2	[Business Entity] The two-character ISO country abbreviation where the business is officially incorporated.	true
Expected_Annual_Volume	[Business Entity] The projected total annual processing volume, represented as a numeric string.	false
Expected_Transaction_Amount	[Business Entity] The projected average monetary amount per transaction, represented as a numeric string.	false
Region_Of_Incorporation_Code2	[Business Entity] The two-character state or region abbreviation where the business is officially incorporated.	true
Website	[Business Entity] The official website URL or domain of the company.	true
Address_Line_1	[Business Entity] The primary street address for the business's headquarters.	true
City	[Business Entity] The city where the business's headquarters is located.	true
Expected_Currencies	[Business Entity] A list of currencies the business expects to transact in (e.g., USD, EUR).	false
Fictitious_Name	[Business Entity] The \"Doing Business As\" (DBA) or fictitious trade name of the company.	false
Identification_Number	[Authorized Contact/Director] The unique alphanumeric number of the provided government-issued identification.	true
Purpose_Of_Transactions	[Business Entity] A clear business description explaining the nature and reason for the fund transfers.	true
Region_Code2	[Business Entity] The two-character state or region code for the business's headquarters.	true
Countries_Receiving_From	[Business Entity] A list of countries the business expects to receive funds from.	false
Country_Code2	[Business Entity] The two-character ISO country code for the business's headquarters.	true
Country_Of_Registration_Code2	[Business Entity] The two-character ISO country code where the business is officially registered.	true

\n\n

Response Parameters

\n\n

Parameter	Description
BeneficiaryID	The unique Xtrm account identifier (starting with `SPN`) for the company whose profile was updated.
Success	Success or failure of the operation (true / false).
message	A system message providing additional context regarding the submission, such as approval status or missing requirements.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API call is used to get the status of the Advanced Profile Application using company advanced profile. The status would be one of:

\n\n

Submitted
Pending
Approved

\n\n

Request Parameters

\n\n

Parameter	Description	Required
BeneficiaryAccountNumber	The unique Xtrm account identifier for the beneficiary company you are querying, starting with `SPN`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
BeneficiaryID	The unique Xtrm account identifier for the queried beneficiary, starting with `SPN`.
Message	A readable string indicating the current verification status of the beneficiary account (e.g., Submitted, Pending, or Approved).
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API call retrieves a list of standard company types (legal structures) recognized and available for a specific country.

Request Parameters

Parameter	Description	Required
CountryISO2	The two-character ISO country abbreviation representing the country for which to retrieve standard company types.	true

\n\n

Response Parameters

Parameter	Description
CompanyType	The recognized legal structure of the company (e.g., Incorporated, Limited Liability Company, Sole Proprietorship) applicable to the requested country.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Returns the complete list of countries.

Note: This endpoint requires a POST method with an empty JSON body {} to retrieve the list. A standard GET request will return an error.

Response Parameters

Parameter	Description
CountryCode	The two-character ISO country abbreviation (ISO 3166-1 alpha-2).
CountryName	The full registered name of the country.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}},"urlObject":{"path":["Register","GetAdvancedContactCountry"],"host":["https://xapisandbox.xtrm.com/API/v4"],"query":[],"variable":[]}},"response":[{"id":"93e7e6b8-4d1e-4c0f-b093-74f89d616ddb","name":"200 OK - Get Countries and Country Codes","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Register/GetAdvancedContactCountry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"AdvancedContactCountryResponse\": {\n \"AdvancedContactCountryResult\": {\n \"AdvancedContactCountry\": {\n \"AdvancedContactCountryDetails\": [\n {\n \"CountryCode\": \"AF\",\n \"CountryName\": \"Afghanistan\"\n },\n {\n \"CountryCode\": \"AX\",\n \"CountryName\": \"Aland Islands\"\n },\n {\n \"CountryCode\": \"AL\",\n \"CountryName\": \"Albania\"\n },\n {\n \"CountryCode\": \"DZ\",\n \"CountryName\": \"Algeria\"\n },\n {\n \"CountryCode\": \"AS\",\n \"CountryName\": \"AMERICAN SAMOA\"\n },\n {\n \"CountryCode\": \"AD\",\n \"CountryName\": \"Andorra\"\n },\n {\n \"CountryCode\": \"AO\",\n \"CountryName\": \"Angola\"\n },\n {\n \"CountryCode\": \"AI\",\n \"CountryName\": \"Anguilla\"\n },\n {\n \"CountryCode\": \"AQ\",\n \"CountryName\": \"Antarctica\"\n },\n {\n \"CountryCode\": \"AG\",\n \"CountryName\": \"Antigua and Barbuda\"\n },\n {\n \"CountryCode\": \"AR\",\n \"CountryName\": \"Argentina\"\n },\n {\n \"CountryCode\": \"AM\",\n \"CountryName\": \"Armenia\"\n },\n {\n \"CountryCode\": \"AW\",\n \"CountryName\": \"Aruba\"\n },\n {\n \"CountryCode\": \"AU\",\n \"CountryName\": \"Australia\"\n },\n {\n \"CountryCode\": \"AT\",\n \"CountryName\": \"Austria\"\n },\n {\n \"CountryCode\": \"AZ\",\n \"CountryName\": \"Azerbaijan\"\n },\n {\n \"CountryCode\": \"BS\",\n \"CountryName\": \"Bahamas\"\n },\n {\n \"CountryCode\": \"BH\",\n \"CountryName\": \"Bahrain\"\n },\n {\n \"CountryCode\": \"BD\",\n \"CountryName\": \"Bangladesh\"\n },\n {\n \"CountryCode\": \"BB\",\n \"CountryName\": \"Barbados\"\n },\n {\n \"CountryCode\": \"BY\",\n \"CountryName\": \"Belarus\"\n },\n {\n \"CountryCode\": \"BE\",\n \"CountryName\": \"Belgium\"\n },\n {\n \"CountryCode\": \"BZ\",\n \"CountryName\": \"Belize\"\n },\n {\n \"CountryCode\": \"BJ\",\n \"CountryName\": \"Benin\"\n },\n {\n \"CountryCode\": \"BM\",\n \"CountryName\": \"Bermuda\"\n },\n {\n \"CountryCode\": \"BT\",\n \"CountryName\": \"Bhutan\"\n },\n {\n \"CountryCode\": \"BO\",\n \"CountryName\": \"Bolivia\"\n },\n {\n \"CountryCode\": \"BQ\",\n \"CountryName\": \"Bonaire, St. Eustatius and Saba\"\n },\n {\n \"CountryCode\": \"BA\",\n \"CountryName\": \"Bosnia and Herzegovina\"\n },\n {\n \"CountryCode\": \"BW\",\n \"CountryName\": \"Botswana\"\n },\n {\n \"CountryCode\": \"BR\",\n \"CountryName\": \"Brazil\"\n },\n {\n \"CountryCode\": \"IO\",\n \"CountryName\": \"British Indian Ocean Territory\"\n },\n {\n \"CountryCode\": \"VG\",\n \"CountryName\": \"British Virgin Islands\"\n },\n {\n \"CountryCode\": \"BN\",\n \"CountryName\": \"Brunei\"\n },\n {\n \"CountryCode\": \"BG\",\n \"CountryName\": \"Bulgaria\"\n },\n {\n \"CountryCode\": \"BF\",\n \"CountryName\": \"Burkina Faso\"\n },\n {\n \"CountryCode\": \"BI\",\n \"CountryName\": \"Burundi\"\n },\n {\n \"CountryCode\": \"KH\",\n \"CountryName\": \"Cambodia\"\n },\n {\n \"CountryCode\": \"CM\",\n \"CountryName\": \"Cameroon\"\n },\n {\n \"CountryCode\": \"CA\",\n \"CountryName\": \"Canada\"\n },\n {\n \"CountryCode\": \"CV\",\n \"CountryName\": \"Cape Verde\"\n },\n {\n \"CountryCode\": \"KY\",\n \"CountryName\": \"Cayman Islands\"\n },\n {\n \"CountryCode\": \"CF\",\n \"CountryName\": \"Central African Republic\"\n },\n {\n \"CountryCode\": \"TD\",\n \"CountryName\": \"Chad\"\n },\n {\n \"CountryCode\": \"CL\",\n \"CountryName\": \"Chile\"\n },\n {\n \"CountryCode\": \"CN\",\n \"CountryName\": \"China\"\n },\n {\n \"CountryCode\": \"CX\",\n \"CountryName\": \"Christmas Island\"\n },\n {\n \"CountryCode\": \"CC\",\n \"CountryName\": \"Cocos Keeling Island\"\n },\n {\n \"CountryCode\": \"CO\",\n \"CountryName\": \"Colombia\"\n },\n {\n \"CountryCode\": \"KM\",\n \"CountryName\": \"Comoros\"\n },\n {\n \"CountryCode\": \"CK\",\n \"CountryName\": \"Cook Islands\"\n },\n {\n \"CountryCode\": \"CR\",\n \"CountryName\": \"Costa Rica\"\n },\n {\n \"CountryCode\": \"CI\",\n \"CountryName\": \"Cote d Ivoire\"\n },\n {\n \"CountryCode\": \"HR\",\n \"CountryName\": \"Croatia\"\n },\n {\n \"CountryCode\": \"CU\",\n \"CountryName\": \"Cuba\"\n },\n {\n \"CountryCode\": \"CW\",\n \"CountryName\": \"Curacao\"\n },\n {\n \"CountryCode\": \"CY\",\n \"CountryName\": \"Cyprus\"\n },\n {\n \"CountryCode\": \"CZ\",\n \"CountryName\": \"Czech Republic\"\n },\n {\n \"CountryCode\": \"CD\",\n \"CountryName\": \"Democratic Republic of the Congo\"\n },\n {\n \"CountryCode\": \"DK\",\n \"CountryName\": \"Denmark\"\n },\n {\n \"CountryCode\": \"DJ\",\n \"CountryName\": \"Djibouti\"\n },\n {\n \"CountryCode\": \"DM\",\n \"CountryName\": \"Dominica\"\n },\n {\n \"CountryCode\": \"DO\",\n \"CountryName\": \"Dominican Republic\"\n },\n {\n \"CountryCode\": \"EC\",\n \"CountryName\": \"Ecuador\"\n },\n {\n \"CountryCode\": \"EG\",\n \"CountryName\": \"Egypt\"\n },\n {\n \"CountryCode\": \"SV\",\n \"CountryName\": \"El Salvador\"\n },\n {\n \"CountryCode\": \"GQ\",\n \"CountryName\": \"Equatorial Guinea\"\n },\n {\n \"CountryCode\": \"ER\",\n \"CountryName\": \"Eritrea\"\n },\n {\n \"CountryCode\": \"EE\",\n \"CountryName\": \"Estonia\"\n },\n {\n \"CountryCode\": \"ET\",\n \"CountryName\": \"Ethiopia\"\n },\n {\n \"CountryCode\": \"FK\",\n \"CountryName\": \"Falkland Islands (Malvinas)\"\n },\n {\n \"CountryCode\": \"FO\",\n \"CountryName\": \"Faroe Islands\"\n },\n {\n \"CountryCode\": \"FJ\",\n \"CountryName\": \"Fiji\"\n },\n {\n \"CountryCode\": \"FI\",\n \"CountryName\": \"Finland\"\n },\n {\n \"CountryCode\": \"FR\",\n \"CountryName\": \"France\"\n },\n {\n \"CountryCode\": \"GF\",\n \"CountryName\": \"French Guiana\"\n },\n {\n \"CountryCode\": \"PF\",\n \"CountryName\": \"French Polynesia\"\n },\n {\n \"CountryCode\": \"GA\",\n \"CountryName\": \"Gabon\"\n },\n {\n \"CountryCode\": \"GE\",\n \"CountryName\": \"Georgia\"\n },\n {\n \"CountryCode\": \"DE\",\n \"CountryName\": \"Germany\"\n },\n {\n \"CountryCode\": \"GH\",\n \"CountryName\": \"Ghana\"\n },\n {\n \"CountryCode\": \"GI\",\n \"CountryName\": \"Gibraltar\"\n },\n {\n \"CountryCode\": \"GR\",\n \"CountryName\": \"Greece\"\n },\n {\n \"CountryCode\": \"GL\",\n \"CountryName\": \"Greenland\"\n },\n {\n \"CountryCode\": \"GD\",\n \"CountryName\": \"Grenada\"\n },\n {\n \"CountryCode\": \"GP\",\n \"CountryName\": \"Guadeloupe\"\n },\n {\n \"CountryCode\": \"GU\",\n \"CountryName\": \"GUAM\"\n },\n {\n \"CountryCode\": \"GT\",\n \"CountryName\": \"Guatemala\"\n },\n {\n \"CountryCode\": \"GG\",\n \"CountryName\": \"Guernsey, Channel Islands\"\n },\n {\n \"CountryCode\": \"GN\",\n \"CountryName\": \"Guinea\"\n },\n {\n \"CountryCode\": \"GW\",\n \"CountryName\": \"Guinea Bissau\"\n },\n {\n \"CountryCode\": \"GY\",\n \"CountryName\": \"Guyana\"\n },\n {\n \"CountryCode\": \"HT\",\n \"CountryName\": \"Haiti\"\n },\n {\n \"CountryCode\": \"VA\",\n \"CountryName\": \"Holy See\"\n },\n {\n \"CountryCode\": \"HN\",\n \"CountryName\": \"Honduras\"\n },\n {\n \"CountryCode\": \"HK\",\n \"CountryName\": \"Hong Kong\"\n },\n {\n \"CountryCode\": \"HU\",\n \"CountryName\": \"Hungary\"\n },\n {\n \"CountryCode\": \"IS\",\n \"CountryName\": \"Iceland\"\n },\n {\n \"CountryCode\": \"IN\",\n \"CountryName\": \"India\"\n },\n {\n \"CountryCode\": \"ID\",\n \"CountryName\": \"Indonesia\"\n },\n {\n \"CountryCode\": \"IR\",\n \"CountryName\": \"Iran\"\n },\n {\n \"CountryCode\": \"IQ\",\n \"CountryName\": \"Iraq\"\n },\n {\n \"CountryCode\": \"IE\",\n \"CountryName\": \"Ireland\"\n },\n {\n \"CountryCode\": \"IM\",\n \"CountryName\": \"Isle of Man\"\n },\n {\n \"CountryCode\": \"IL\",\n \"CountryName\": \"Israel\"\n },\n {\n \"CountryCode\": \"IT\",\n \"CountryName\": \"Italy\"\n },\n {\n \"CountryCode\": \"JM\",\n \"CountryName\": \"Jamaica\"\n },\n {\n \"CountryCode\": \"JP\",\n \"CountryName\": \"Japan\"\n },\n {\n \"CountryCode\": \"JE\",\n \"CountryName\": \"Jersey, Channel Islands\"\n },\n {\n \"CountryCode\": \"JO\",\n \"CountryName\": \"Jordan\"\n },\n {\n \"CountryCode\": \"KZ\",\n \"CountryName\": \"Kazakhstan\"\n },\n {\n \"CountryCode\": \"KE\",\n \"CountryName\": \"Kenya\"\n },\n {\n \"CountryCode\": \"KI\",\n \"CountryName\": \"Kiribati\"\n },\n {\n \"CountryCode\": \"XK\",\n \"CountryName\": \"Kosovo\"\n },\n {\n \"CountryCode\": \"KW\",\n \"CountryName\": \"Kuwait\"\n },\n {\n \"CountryCode\": \"KG\",\n \"CountryName\": \"Kyrgyzstan\"\n },\n {\n \"CountryCode\": \"LA\",\n \"CountryName\": \"Laos\"\n },\n {\n \"CountryCode\": \"LV\",\n \"CountryName\": \"Latvia\"\n },\n {\n \"CountryCode\": \"LB\",\n \"CountryName\": \"Lebanon\"\n },\n {\n \"CountryCode\": \"LS\",\n \"CountryName\": \"Lesotho\"\n },\n {\n \"CountryCode\": \"LR\",\n \"CountryName\": \"Liberia\"\n },\n {\n \"CountryCode\": \"LY\",\n \"CountryName\": \"Libya\"\n },\n {\n \"CountryCode\": \"LI\",\n \"CountryName\": \"Liechtenstein\"\n },\n {\n \"CountryCode\": \"LT\",\n \"CountryName\": \"Lithuania\"\n },\n {\n \"CountryCode\": \"LU\",\n \"CountryName\": \"Luxembourg\"\n },\n {\n \"CountryCode\": \"MO\",\n \"CountryName\": \"Macao\"\n },\n {\n \"CountryCode\": \"MK\",\n \"CountryName\": \"Macedonia, TFYR\"\n },\n {\n \"CountryCode\": \"MG\",\n \"CountryName\": \"Madagascar\"\n },\n {\n \"CountryCode\": \"MW\",\n \"CountryName\": \"Malawi\"\n },\n {\n \"CountryCode\": \"MY\",\n \"CountryName\": \"Malaysia\"\n },\n {\n \"CountryCode\": \"MV\",\n \"CountryName\": \"Maldives\"\n },\n {\n \"CountryCode\": \"ML\",\n \"CountryName\": \"Mali\"\n },\n {\n \"CountryCode\": \"MT\",\n \"CountryName\": \"Malta\"\n },\n {\n \"CountryCode\": \"MH\",\n \"CountryName\": \"Marshall Islands\"\n },\n {\n \"CountryCode\": \"MQ\",\n \"CountryName\": \"Martinique\"\n },\n {\n \"CountryCode\": \"MR\",\n \"CountryName\": \"Mauritania\"\n },\n {\n \"CountryCode\": \"MU\",\n \"CountryName\": \"Mauritius\"\n },\n {\n \"CountryCode\": \"YT\",\n \"CountryName\": \"Mayotte\"\n },\n {\n \"CountryCode\": \"MX\",\n \"CountryName\": \"Mexico\"\n },\n {\n \"CountryCode\": \"FM\",\n \"CountryName\": \"Micronesia\"\n },\n {\n \"CountryCode\": \"MD\",\n \"CountryName\": \"Moldova\"\n },\n {\n \"CountryCode\": \"MC\",\n \"CountryName\": \"Monaco\"\n },\n {\n \"CountryCode\": \"MN\",\n \"CountryName\": \"Mongolia\"\n },\n {\n \"CountryCode\": \"ME\",\n \"CountryName\": \"Montenegro\"\n },\n {\n \"CountryCode\": \"MS\",\n \"CountryName\": \"Montserrat\"\n },\n {\n \"CountryCode\": \"MA\",\n \"CountryName\": \"Morocco\"\n },\n {\n \"CountryCode\": \"MZ\",\n \"CountryName\": \"Mozambique\"\n },\n {\n \"CountryCode\": \"MM\",\n \"CountryName\": \"Myanmar\"\n },\n {\n \"CountryCode\": \"NA\",\n \"CountryName\": \"Namibia\"\n },\n {\n \"CountryCode\": \"NR\",\n \"CountryName\": \"Nauru\"\n },\n {\n \"CountryCode\": \"NP\",\n \"CountryName\": \"Nepal\"\n },\n {\n \"CountryCode\": \"NL\",\n \"CountryName\": \"Netherlands\"\n },\n {\n \"CountryCode\": \"AN\",\n \"CountryName\": \"Netherlands Antilles\"\n },\n {\n \"CountryCode\": \"NC\",\n \"CountryName\": \"New Caledonia\"\n },\n {\n \"CountryCode\": \"NZ\",\n \"CountryName\": \"New Zealand\"\n },\n {\n \"CountryCode\": \"NI\",\n \"CountryName\": \"Nicaragua\"\n },\n {\n \"CountryCode\": \"NE\",\n \"CountryName\": \"Niger\"\n },\n {\n \"CountryCode\": \"NG\",\n \"CountryName\": \"Nigeria\"\n },\n {\n \"CountryCode\": \"NU\",\n \"CountryName\": \"Niue\"\n },\n {\n \"CountryCode\": \"NF\",\n \"CountryName\": \"Norfolk Island\"\n },\n {\n \"CountryCode\": \"MP\",\n \"CountryName\": \"NORTHERN MARIANA ISLANDS\"\n },\n {\n \"CountryCode\": \"NO\",\n \"CountryName\": \"Norway\"\n },\n {\n \"CountryCode\": \"OM\",\n \"CountryName\": \"Oman\"\n },\n {\n \"CountryCode\": \"PK\",\n \"CountryName\": \"Pakistan\"\n },\n {\n \"CountryCode\": \"PW\",\n \"CountryName\": \"Palau\"\n },\n {\n \"CountryCode\": \"PS\",\n \"CountryName\": \"Palestinian Territory, Occupied\"\n },\n {\n \"CountryCode\": \"PA\",\n \"CountryName\": \"Panama\"\n },\n {\n \"CountryCode\": \"PG\",\n \"CountryName\": \"Papua New Guinea\"\n },\n {\n \"CountryCode\": \"PY\",\n \"CountryName\": \"Paraguay\"\n },\n {\n \"CountryCode\": \"PE\",\n \"CountryName\": \"Peru\"\n },\n {\n \"CountryCode\": \"PH\",\n \"CountryName\": \"Philippines\"\n },\n {\n \"CountryCode\": \"PN\",\n \"CountryName\": \"Pitcairn\"\n },\n {\n \"CountryCode\": \"PL\",\n \"CountryName\": \"Poland\"\n },\n {\n \"CountryCode\": \"PT\",\n \"CountryName\": \"Portugal\"\n },\n {\n \"CountryCode\": \"PR\",\n \"CountryName\": \"PUERTO RICO\"\n },\n {\n \"CountryCode\": \"QA\",\n \"CountryName\": \"Qatar\"\n },\n {\n \"CountryCode\": \"CG\",\n \"CountryName\": \"Republic of the Congo\"\n },\n {\n \"CountryCode\": \"RE\",\n \"CountryName\": \"Reunion\"\n },\n {\n \"CountryCode\": \"RO\",\n \"CountryName\": \"Romania\"\n },\n {\n \"CountryCode\": \"RU\",\n \"CountryName\": \"Russia\"\n },\n {\n \"CountryCode\": \"RW\",\n \"CountryName\": \"Rwanda\"\n },\n {\n \"CountryCode\": \"WS\",\n \"CountryName\": \"Samoa\"\n },\n {\n \"CountryCode\": \"SM\",\n \"CountryName\": \"San Marino\"\n },\n {\n \"CountryCode\": \"ST\",\n \"CountryName\": \"Sao Tome and Principe\"\n },\n {\n \"CountryCode\": \"SA\",\n \"CountryName\": \"Saudi Arabia\"\n },\n {\n \"CountryCode\": \"SN\",\n \"CountryName\": \"Senegal\"\n },\n {\n \"CountryCode\": \"RS\",\n \"CountryName\": \"Serbia\"\n },\n {\n \"CountryCode\": \"SC\",\n \"CountryName\": \"Seychelles\"\n },\n {\n \"CountryCode\": \"SL\",\n \"CountryName\": \"Sierra Leone\"\n },\n {\n \"CountryCode\": \"SG\",\n \"CountryName\": \"Singapore\"\n },\n {\n \"CountryCode\": \"SX\",\n \"CountryName\": \"Sint Maarten\"\n },\n {\n \"CountryCode\": \"SK\",\n \"CountryName\": \"Slovakia\"\n },\n {\n \"CountryCode\": \"SI\",\n \"CountryName\": \"Slovenia\"\n },\n {\n \"CountryCode\": \"SB\",\n \"CountryName\": \"Solomon Islands\"\n },\n {\n \"CountryCode\": \"SO\",\n \"CountryName\": \"Somalia\"\n },\n {\n \"CountryCode\": \"ZA\",\n \"CountryName\": \"South Africa\"\n },\n {\n \"CountryCode\": \"KR\",\n \"CountryName\": \"South Korea\"\n },\n {\n \"CountryCode\": \"SS\",\n \"CountryName\": \"South Sudan\"\n },\n {\n \"CountryCode\": \"ES\",\n \"CountryName\": \"Spain\"\n },\n {\n \"CountryCode\": \"LK\",\n \"CountryName\": \"Sri Lanka\"\n },\n {\n \"CountryCode\": \"BL\",\n \"CountryName\": \"St. Barthelemy\"\n },\n {\n \"CountryCode\": \"SH\",\n \"CountryName\": \"St. Helena\"\n },\n {\n \"CountryCode\": \"KN\",\n \"CountryName\": \"St. Kitts and Nevis\"\n },\n {\n \"CountryCode\": \"LC\",\n \"CountryName\": \"St. Lucia\"\n },\n {\n \"CountryCode\": \"MF\",\n \"CountryName\": \"St. Martin\"\n },\n {\n \"CountryCode\": \"PM\",\n \"CountryName\": \"St. Pierre et Miquelon\"\n },\n {\n \"CountryCode\": \"VC\",\n \"CountryName\": \"St. Vincent and the Grenadines\"\n },\n {\n \"CountryCode\": \"SD\",\n \"CountryName\": \"Sudan\"\n },\n {\n \"CountryCode\": \"SR\",\n \"CountryName\": \"Suriname\"\n },\n {\n \"CountryCode\": \"SJ\",\n \"CountryName\": \"Svalbard and Jan Mayen Islands\"\n },\n {\n \"CountryCode\": \"SZ\",\n \"CountryName\": \"Swaziland\"\n },\n {\n \"CountryCode\": \"SE\",\n \"CountryName\": \"Sweden\"\n },\n {\n \"CountryCode\": \"CH\",\n \"CountryName\": \"Switzerland\"\n },\n {\n \"CountryCode\": \"SY\",\n \"CountryName\": \"Syria\"\n },\n {\n \"CountryCode\": \"TW\",\n \"CountryName\": \"Taiwan\"\n },\n {\n \"CountryCode\": \"TJ\",\n \"CountryName\": \"Tajikistan\"\n },\n {\n \"CountryCode\": \"TZ\",\n \"CountryName\": \"Tanzania\"\n },\n {\n \"CountryCode\": \"TH\",\n \"CountryName\": \"Thailand\"\n },\n {\n \"CountryCode\": \"GM\",\n \"CountryName\": \"The Gambia\"\n },\n {\n \"CountryCode\": \"TL\",\n \"CountryName\": \"Timor Leste\"\n },\n {\n \"CountryCode\": \"TG\",\n \"CountryName\": \"Togo\"\n },\n {\n \"CountryCode\": \"TK\",\n \"CountryName\": \"Tokelau\"\n },\n {\n \"CountryCode\": \"TO\",\n \"CountryName\": \"Tonga\"\n },\n {\n \"CountryCode\": \"TT\",\n \"CountryName\": \"Trinidad and Tobago\"\n },\n {\n \"CountryCode\": \"TN\",\n \"CountryName\": \"Tunisia\"\n },\n {\n \"CountryCode\": \"TR\",\n \"CountryName\": \"Turkey\"\n },\n {\n \"CountryCode\": \"TM\",\n \"CountryName\": \"Turkmenistan\"\n },\n {\n \"CountryCode\": \"TC\",\n \"CountryName\": \"Turks and Caicos Islands\"\n },\n {\n \"CountryCode\": \"TV\",\n \"CountryName\": \"Tuvalu\"\n },\n {\n \"CountryCode\": \"UG\",\n \"CountryName\": \"Uganda\"\n },\n {\n \"CountryCode\": \"UA\",\n \"CountryName\": \"Ukraine\"\n },\n {\n \"CountryCode\": \"AE\",\n \"CountryName\": \"United Arab Emirates\"\n },\n {\n \"CountryCode\": \"GB\",\n \"CountryName\": \"United Kingdom\"\n },\n {\n \"CountryCode\": \"US\",\n \"CountryName\": \"United States\"\n },\n {\n \"CountryCode\": \"UM\",\n \"CountryName\": \"United States Minor Outlying Island\"\n },\n {\n \"CountryCode\": \"UY\",\n \"CountryName\": \"Uruguay\"\n },\n {\n \"CountryCode\": \"UZ\",\n \"CountryName\": \"Uzbekistan\"\n },\n {\n \"CountryCode\": \"VU\",\n \"CountryName\": \"Vanuatu\"\n },\n {\n \"CountryCode\": \"VE\",\n \"CountryName\": \"Venezuela\"\n },\n {\n \"CountryCode\": \"VN\",\n \"CountryName\": \"Viet Nam\"\n },\n {\n \"CountryCode\": \"VI\",\n \"CountryName\": \"VIRGIN ISLANDS (U.S.)\"\n },\n {\n \"CountryCode\": \"WF\",\n \"CountryName\": \"Wallis and Futuna\"\n },\n {\n \"CountryCode\": \"EH\",\n \"CountryName\": \"Western Sahara\"\n },\n {\n \"CountryCode\": \"YE\",\n \"CountryName\": \"Yemen\"\n },\n {\n \"CountryCode\": \"ZM\",\n \"CountryName\": \"Zambia\"\n },\n {\n \"CountryCode\": \"ZW\",\n \"CountryName\": \"Zimbabwe\"\n }\n ]\n },\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": null\n }\n }\n }\n}"}],"_postman_id":"873ad59f-d475-4085-bb97-60ac92e1e789"},{"name":"Get standard job titles","id":"63305bdc-cabd-4502-8b11-7ed41e36bded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Register/GetAdvancedContactJobTitles","description":"

Fetchs a list of standard job titles.

\n\n

Note: This endpoint requires a POST method with an empty JSON body {} to retrieve the list.

Response Parameters

\n\n

Parameter	Description
JobTitle	A standard job title or professional designation recognized by the system.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Retrieves a list of administrative regions (states, provinces, territories, etc.) for a specified country.

Request Parameters

Parameter	Description	Required
CountryCode	The two-character ISO country abbreviation (ISO 3166-1 alpha-2) for which to retrieve regions.	true

\n\n

Response Parameters

Parameter	Description
StateCode	The abbreviated code or identifier for the region, state, or province.
StateName	The full administrative name of the region, state, or province.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API fetches the Advanced Profile Application details for a company for which your account has read access (either your company, or a connected company).

Request Parameters

\n\n

Parameter	Description	Required
BeneficiaryAccountNumber	The unique Xtrm account identifier for the company whose profile you are querying, starting with `SPN`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Countries_Sending_To	[Business Entity] A list of countries the business expects to remit funds to.
Country_Of_Incorporation_Code2	[Business Entity] The two-character ISO country abbreviation where the business is officially incorporated.
Expected_Currencies	[Business Entity] A list of currencies the business expects to transact in (e.g., USD, EUR).
FictitiousName	[Business Entity] The \"Doing Business As\" (DBA) or fictitious trade name of the company.
Industry_Classification	[Business Entity] The general taxonomic identification or category of the business (e.g., Technology, Accommodation).
Address_Line_2	[Business Entity] Additional street address information (Suite, Floor) for the business headquarters.
Address_Line_3	[Business Entity] Additional street address information for the business headquarters.
Countries_Receiving_From	[Business Entity] A list of countries the business expects to receive funds from.
Region_Code2	[Business Entity] The two-character state or region abbreviation for the business's headquarters.
Tax_Identification_Number	[Business Entity] The official tax identifier for the company (e.g., US EIN, SSN, or international equivalent).
Expected_Per_Transaction_Amount	[Business Entity] The projected average monetary amount per transaction, represented as a numeric string.
Purpose_Of_Transactions	[Business Entity] A clear business description explaining the nature and reason for the fund transfers.
Expected_Annual_Volume	[Business Entity] The projected total annual processing volume, represented as a numeric string.
Identification_Number	[Authorized Contact/Director] The unique alphanumeric number of the provided government-issued identification.
Identification_Type	[Authorized Contact/Director] The type of government-issued identification provided (e.g., Passport, Driver License).
Region_Of_Incorporation_Code2	[Business Entity] The two-character state or region abbreviation where the business is officially incorporated.
Website	[Business Entity] The official website URL or domain of the company.
Address_Line_1	[Business Entity] The primary street address for the business's headquarters.
City	[Business Entity] The city where the business's headquarters is located.
Company_Type	[Business Entity] The legal structure or corporate classification of the company (e.g., LLC, Corporation).
Country_Code2	[Business Entity] The two-character ISO 3166-1 alpha-2 country code for the business's headquarters.
Postal_Code	[Business Entity] The ZIP or postal code for the business's primary headquarters.
Country_Of_Registration_Code2	[Business Entity] The two-character ISO country code where the business is officially registered.
IsPublicallyTraded	[Business Entity] Indicates whether the company is publicly traded ('yes' or 'no').
Email_Address	[Authorized Contact] The direct professional email address for the authorized contact.
Last_Name	[Authorized Contact] The legal last name of the authorized contact.
Percentage_Owned	[Ownership] The percentage of the company owned by this individual, expressed as a whole number (e.g., 25 for 25%).
Address_Line_1	[Authorized Contact] The primary street address for the authorized contact.
Citizenship	[Authorized Contact] The two-character ISO country code representing the authorized contact's primary citizenship.
City	[Authorized Contact] The city of residence for the authorized contact.
Date_of_Birth	[Authorized Contact] The authorized contact's date of birth in mm/dd/yyyy format.
Postal_Code	[Authorized Contact] The ZIP or postal code for the authorized contact's address.
Region_Code2	[Authorized Contact] The two-character state, province, or region abbreviation for the authorized contact.
Country_Code2	[Authorized Contact] The two-character ISO 3166-1 alpha-2 country code for the authorized contact.
First_Name	[Authorized Contact] The legal first name of the authorized contact.
Job_Title	[Authorized Contact] The professional title or role of the authorized contact within the company.
Middle_Name	[Authorized Contact] The legal middle name of the authorized contact person.
Ticker_Symbol	[Business Entity] The stock exchange ticker symbol for the company, if publicly traded.
Payments_Type	[Business Entity] The expected geographical scope of payments (e.g., 'USA Only' or 'International').
Status	[System] The current approval status of the Advanced Profile Application (e.g., Pending, Approved, Declined).
Address_Line_1	[Director/Owner] The primary street address for the director or owner.
Citizenship	[Director/Owner] The two-character ISO country code representing the director or owner's primary citizenship.
Country_Code2	[Director/Owner] The two-character ISO 3166-1 alpha-2 country code for the director or owner.
First_Name	[Director/Owner] The legal first name of the director or owner.
Job_Title	[Director/Owner] The professional title or role of the director.
Postal_Code	[Director/Owner] The ZIP or postal code for the director or owner's address.
Business_Phone	[Business Entity] The primary contact phone number for the business.
City	[Director/Owner] The city of residence for the director or owner.
Date_Of_Birth	[Director/Owner] The director or owner's date of birth in mm/dd/yyyy format.
Email_Address	[Director/Owner] The direct email address for the director or owner.
Last_Name	[Director/Owner] The legal last name of the director or owner.
Region_Code2	[Director/Owner] The two-character state, province, or region abbreviation for the director or owner.
BeneficiaryAccountNumber	[Business Entity] The unique Xtrm account identifier for the beneficiary company, starting with `SPN`.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Get the list of identification types that you may submit for account completion.

\n\n

Note: This endpoint requires a POST method with an empty JSON body {} to retrieve the list.

Response Parameters

\n\n

Parameter	Description
IdentificationType	The recognized name and category of the identity document (e.g., Passport, Driver's License, National ID).
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Retrieves a comprehensive list of standard NAICS (North American Industry Classification System) industry types.

Note: This endpoint requires a POST method with an empty JSON body {} to retrieve the list.

Response Parameters

\n\n

Parameter	Description
Industry	The general taxonomic classification of the business industry (e.g., Accommodation, Utilities, Manufacturing).
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoints for checking the existence of, creating, configuring, and retrieving profile details for company beneficiary accounts (SPN).

\n","_postman_id":"4c8a87cc-829b-4591-a5be-2eecf8582008","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Beneficiary User","item":[{"name":"Check beneficiary existence","id":"33b7d934-dfcf-40f6-b83b-3a9e14d95f88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CheckUserExist\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"Email\": \"jane.doe@example.com\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Beneficiary/CheckUserExist","description":"

This endpoint checks the existence of a personal beneficiary account using their email address and returns minimal profile details if a match is found.

Response Parameters

Parameter	Description
Success	Success or failure of operation (true / false).
AccountIdentityLevel	The compliance verification level of the personal account's identity (e.g., Draft, Basic, Standard, Advanced).
AccountNo	The unique Xtrm account identifier for the personal beneficiary, starting with `PAT`.
Country	The two-character ISO country abbreviation for the beneficiary's location.
Employer	The name of the beneficiary's employer.
Name	The full name of the personal beneficiary.
State	The state, province, or region where the beneficiary resides.
Status	The current operational status of the beneficiary account (e.g., Active, Pending).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Retrieves a paginated list of personal (non-company) beneficiaries associated with your account.

Request Parameters

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25. (Passed inside the Pagination object).	true
RecordsToTake	The maximum number of results to return per page. (Passed inside the Pagination object).	true

\n\n

Response Parameters

Parameter	Description
Country	The two-character ISO country abbreviation for the beneficiary's location.
Email	The primary contact email address for the personal beneficiary.
Employer	The name of the beneficiary's employer.
Name	The full name of the personal beneficiary.
State	The state, province, or region where the beneficiary resides.
AccountIdentityLevel	The compliance verification level of the personal account's identity (e.g., Draft, Basic, Standard, Advanced).
AccountNo	The unique Xtrm account identifier for the personal beneficiary, starting with `PAT`.
Success	Success or failure of operation (true / false).
RecordsToSkip	The number of records bypassed before returning these results.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of records available for this query.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This creates a beneficiary Personal User Account where the beneficiary can send and receive all payments. A wallet is also created for the user, holding the currency for the country specified during creation. These will be reviewed for KYC (Know Your Customer) compliance so information submitted must be real and accurate. Do not create test users or emails on production servers.

Request Parameters

\n\n

Parameter	Description	Required
LegalFirstName	The legal first name of the personal beneficiary.	true
EmailNotification	Determines whether the beneficiary receives an email notifying them of the account creation (true / false).	true
Day	The day of the beneficiary's birth month (numeric value 1 to 31).	false
Month	The numeric month of the beneficiary's birth (1 to 12).	false
Year	The four-digit year of the beneficiary's birth.	false
EmailAddress	The primary contact email address for the personal beneficiary.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
LegalLastName	The legal last name of the personal beneficiary.	true
MobilePhone	The primary mobile phone number for the beneficiary.	false
TaxId	The Tax Identification Number (e.g., SSN, National ID) for the beneficiary.	false
CountryISO2	The two-character ISO country abbreviation for the beneficiary's residence.	true
PostalCode	The postal or ZIP code for the beneficiary's physical address.	false
Region	The state, province, or geographic region of the beneficiary's physical address.	false
AddressLine1	The first line of the beneficiary's physical address (e.g., street name and number).	false
AddressLine2	The second line of the beneficiary's physical address (if applicable).	false
AptSuitNum	The apartment, suite, or building number for the beneficiary's physical address.	false
City	The city of the beneficiary's physical address.	false

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
UserID	The unique Xtrm account identifier generated for the new personal beneficiary, starting with `PAT`.
AccountIdentityLevel	The compliance verification level of the personal account's identity (e.g., Draft, Basic, Standard, Advanced).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

","urlObject":{"path":["Register","CreateUser"],"host":["https://xapisandbox.xtrm.com/API/v4"],"query":[],"variable":[]}},"response":[{"id":"9bdf594c-e974-45df-a8b9-90f6390eb8be","name":"200 OK - User Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CreateUser\": {\n \"request\": {\n \"Address\": {\n \"AddressLine1\": \"123 Main Street\",\n \"AddressLine2\": \"Apartment 4B\",\n \"AptSuitNum\": \"Apt 4B\",\n \"City\": \"Los Angeles\",\n \"CountryISO2\": \"US\",\n \"PostalCode\": \"90001\",\n \"Region\": \"CA\"\n },\n \"DateOfBirth\": {\n \"Day\": \"15\",\n \"Month\": \"08\",\n \"Year\": \"1990\"\n },\n \"EmailAddress\": \"jane.doe@example.com\",\n \"EmailNotification\": \"true\",\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"LegalFirstName\": \"Jane\",\n \"LegalLastName\": \"Doe\",\n \"MobilePhone\": \"14085551234\",\n \"TaxId\": \"555-66-7777\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Register/CreateUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"CreateUserResponse\": {\n \"CreateUserResult\": {\n \"UserID\": \"PAT9999888\",\n \"AccountIdentityLevel\": \"Standard\",\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": null\n }\n }\n }\n}"}],"_postman_id":"32e5c80b-be1c-4db2-bdb0-ce2c0fc45511"},{"name":"Update a beneficiary user","id":"af134e47-25cb-4705-aaad-e02714fc2967","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"UpdateUser\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"UserId\": \"PAT9999888\",\n \"LegalFirstName\": \"Jane\",\n \"LegalLastName\": \"Doe\",\n \"Address\": {\n \"CountryISO2\": \"US\",\n \"AddressLine1\": \"123 Main Street\",\n \"AddressLine2\": \"Apartment 4B\",\n \"AptSuitNum\": \"Apt 4B\",\n \"City\": \"Los Angeles\",\n \"PostalCode\": \"90001\",\n \"Region\": \"CA\"\n },\n \"DateOfBirth\": {\n \"Day\": \"15\",\n \"Month\": \"08\",\n \"Year\": \"1990\"\n },\n \"MobileCountryISO2\": \"US\",\n \"MobileNumber\": \"14085551234\",\n \"OTP\": \"123456\",\n \"TaxId\": \"555-66-7777\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Register/UpdateUser","description":"

You must be connected to the Personal User account to make updates.

If the user's profile does not have a mobile number, it can be updated without requiring an OTP.

If a mobile number is already saved, updating it will require an OTP, which will be sent to the user's registered mobile number and must be provided for verification.

Request Parameters

\n\n

Parameter	Description	Required
MobileCountryISO2	The two-character ISO country abbreviation for the new or existing mobile phone number.	false
MobileNumber	The mobile phone number to associate with the beneficiary profile.	false
OTP	A one-time password string consisting of exactly six digits. Required for verification if a mobile number is already saved to the profile.	false
City	The city of the beneficiary's physical address.	false
CountryISO2	The two-character ISO country abbreviation for the beneficiary's physical address.	true
PostalCode	The postal or ZIP code for the beneficiary's physical address.	false
Region	The state, province, or geographic region of the beneficiary's physical address.	false
AddressLine1	The primary line of the beneficiary's physical address (e.g., street name and street number).	false
AddressLine2	The secondary line of the beneficiary's physical address (e.g., building name, floor, or care-of details).	false
AptSuitNum	The specific apartment, suite, or unit number for the physical address.	false
Day	The day of the beneficiary's birth month (numeric value 1 to 31).	false
Month	The numeric month of the beneficiary's birth (1 to 12).	false
Year	The four-digit year of the beneficiary's birth.	false
LegalLastName	The legal last name of the personal beneficiary.	true
TaxId	The Tax Identification Number (e.g., SSN, National ID) for the beneficiary.	false
UserId	The unique Xtrm account identifier for the beneficiary being updated, starting with `PAT`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
LegalFirstName	The legal first name of the personal beneficiary.	true

\n\n

Response Parameters

\n\n

Parameter	Description
AccountIdentityLevel	The compliance verification level of the personal account's identity (e.g., Draft, Basic, Standard, Advanced).
Success	Success or failure of operation (true / false).
UserID	The unique Xtrm account identifier for the updated personal beneficiary, starting with `PAT`.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoints for creating, updating, and retrieving profile details for personal beneficiary accounts (PAT).

\n","_postman_id":"12888b1d-d7f3-4084-9037-97b622e10524","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"General","item":[{"name":"Get country list","id":"286f830a-88ca-4e88-840b-698f95df77db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/General/GetCountry","description":"

Retrieve a global list of countries.

Note: This request requires an empty JSON object {} in the body.

Response Parameters

Parameter	Description
Currency	The standard three-letter ISO 4217 currency code associated with the country.
CountryCode	The three-character ISO country abbreviation (ISO 3166-1 alpha-3) or standard dialing code.
CountryID	The unique internal system identifier for the country.
CountryISO2	The two-character ISO country abbreviation (ISO 3166-1 alpha-2).
CountryName	The full recognized name of the country.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

","urlObject":{"path":["General","GetCountry"],"host":["https://xapisandbox.xtrm.com/API/v4"],"query":[],"variable":[]}},"response":[{"id":"e41b7887-46e2-4ec4-89f5-a8c3beeee355","name":"200 OK - Get Countries","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/General/GetCountry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"GetCountryResponse\": {\n \"GetCountryResult\": {\n \"Country\": [\n {\n \"CountryID\": 1,\n \"CountryName\": \"United States of America\",\n \"CountryISO2\": \"US\",\n \"CountryCode\": \"USA\",\n \"Currency\": \"USD\"\n },\n {\n \"CountryID\": 12,\n \"CountryName\": \"India\",\n \"CountryISO2\": \"IN\",\n \"CountryCode\": \"IND\",\n \"Currency\": \"INR\"\n },\n {\n \"CountryID\": 13,\n \"CountryName\": \"United Kingdom\",\n \"CountryISO2\": \"GB\",\n \"CountryCode\": \"GBR\",\n \"Currency\": \"GBP\"\n\n }\n ],\n \"OperationStatus\": {\n \"Errors\": null,\n \"Success\": true\n }\n }\n }\n}"}],"_postman_id":"286f830a-88ca-4e88-840b-698f95df77db"},{"name":"Get states (regions) within a country","id":"3f6b2a4e-7d73-477c-8db9-716ec3cba179","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"GetState\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"CountryID\": \"1\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/General/GetState","description":"

For a particular country, get the list of regions (states, provinces, regions, etc.).

Request Parameters

\n\n

Parameter	Description	Required
CountryID	The unique internal system identifier for the country. Retrieved from the call `GetCountry`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
StateName	The full administrative name of the region, state, or province.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Utility endpoints for global system lookups, standard configurations, and core platform operations.

\n","_postman_id":"b96ac153-9b27-47ec-9803-7fe7429e75c9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"OTP","item":[{"name":"Get connected status","id":"f3ee7c53-5857-439d-9020-c5020cdc35fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"GetConnectedStatus\": {\n \"Request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"UserID\": \"SPN9999888\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/OTP/GetConnectedStatus","description":"

This allows you to get the connected status of the remitter and the user or company. If they are not connected, you can use GetOTPAuthorizedVendor to send a one-time password to the user or company to connect and authorize the remitter, followed by ValidateOTPAuthorizeVendor to validate the one-time password and complete the connection/authorization.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
UserID	A unique Xtrm account identifier for the queried entity, starting with `SPN` for Company Accounts or `PAT` for Personal Accounts.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
Status	The current connection status between the remitter and the beneficiary (e.g., Connected, Pending, or Not Connected).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This is used to generate an authentication one time password to allow the vendor (remitter) to be authorized by the user (beneficiary) to transfer funds, access wallets, access wallet transactions and withdraw funds.

\n\n

Request Parameters

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecipientUserId	The unique Xtrm account identifier for the beneficiary receiving the OTP, starting with `SPN` for Company Accounts or `PAT` for Personal Accounts.	true

\n\n

Response Parameters

Parameter	Description
Message	A human-readable string indicating the status of the OTP generation (e.g., confirmation that the OTP was successfully sent to the user's registered contact method).
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This is used to validate the one time password to allow the user to transfer funds and is used in conjunction with GetOTPAuthorizedVendor.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
OneTimePassword	A one-time password string consisting of exactly six digits.	true
RecipientUserID	The unique Xtrm account identifier for the beneficiary validating the OTP, starting with `SPN` for Company Accounts or `PAT` for Personal Accounts.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Message	A human-readable string indicating the status of the OTP validation (e.g., Authorized).
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoints to verify connection statuses or generate One-Time Passwords (OTP) required to securely connect and authenticate to Personal or Company accounts.

\n","_postman_id":"1109e942-f6ed-4d5f-a7e2-874fdf7c8af4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Payment Methods","item":[{"name":"Get payment methods for a beneficiary company","id":"ffe044b1-3b31-44b6-8736-1f96fdc86a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Payment/GetBeneficiaryCompanyPaymentMethods","description":"

A beneficiary company may transfer to bank endpoints from their Xtrm AnyPay™ digital wallet.

Note: This request requires an empty JSON object {} in the body.

Response Parameters

\n\n

Parameter	Description
BeneficiaryCompanyPaymentMethodId	The unique internal identifier for the specific payment method available to the beneficiary company.
BeneficiaryCompanyPaymentMethodName	The display name of the available payment method.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Choose the payment method. You can pay to the Xtrm AnyPay™ digital wallet (recommended) where the user can choose how to transfer the funds out of Xtrm. Alternatively you create a pass through payment directly to a number of end points such as bank account, gift cards, or a prepaid debit card.

Note: This request requires an empty JSON object {} in the body.

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
PaymentMethodId	The unique internal identifier for the specific send payment method.
PaymentMethodName	The display name of the available send payment method.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch the list of available payment methods for an individual beneficiary user. You can pay to the Xtrm AnyPay™ digital wallet (recommended), where the user can choose how to transfer the funds out of Xtrm. Alternatively, you can create a pass-through payment directly to a number of endpoints such as a bank account, gift card, or prepaid debit card.

Note: This request requires an empty JSON object {} in the body.

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
UserPaymentMethodId	The unique internal identifier for the specific payment method available to the individual beneficiary.
UserPaymentMethodName	A user-friendly description of the available payment method.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoints to retrieve, configure, and manage available payment methods for funding and withdrawals.

\n","_postman_id":"4ca700f2-1a77-4bd7-bf34-ca78d2b516a5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Programs","item":[{"name":"Create a company payment program","id":"f54407ba-75e0-4577-bdbc-9312b38e7637","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CreateProgram\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"Description\": \"Standard Corporate Rewards Program\",\n \"TransactionCategoryID\": \"6\",\n \"TransactionSubCategoryID\": \"6\",\n \"IsClaim\": true,\n \"ClaimAmount\": \"341.25\",\n \"CurrencyCode\": \"USD\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Programs/CreateProgram","description":"

Creates company program and returns Program ID as well as success status.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
TransactionCategoryID	The top-level numeric ID for the transaction category.	true
TransactionSubCategoryID	The specific numeric ID for the transaction sub-category.	true
ClaimAmount	The specific amount or value allocated for claims within this program.	false
CurrencyCode	The standard three-letter ISO 4217 currency code for the program (e.g., USD, EUR).	false
Description	A user-friendly name or short description of the payment program being created (e.g., \"Q3 Employee Bonus Program\").	true
IsClaim	Indicates whether this program is claim-based (true / false).	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
ProgramID	The unique internal identifier generated for the newly created payment program.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This allows you to get a list of your company payment programs or projects for use with the Transfer Funds API request.

Request Parameters

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25. (Passed inside the Pagination object).	true
RecordsToTake	The maximum number of results to return per page. (Passed inside the Pagination object).	true

\n\n

Response Parameters

Parameter	Description
Success	Success or failure of operation (true / false).
RecordsToSkip	The number of records bypassed before returning these results.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of records available for this query.
ProgramType	The operational type or classification of the payment program.
IsClaim	Indicates whether this is a claimed reward (beneficiary-requested compensation) program (true / false).
ProgramCategory	The assigned category or sub-category classification for the program.
ProgramId	The unique internal identifier for the program.
ProgramName	The user-friendly, customer-supplied name or description of the payment program.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch a list of program categories. Used along with the program type to create new programs.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25. (Passed inside the Pagination object).	true
RecordsToTake	The maximum number of results to return per page. (Passed inside the Pagination object).	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of records available for this query.
RecordsToSkip	The number of records bypassed before returning these results.
CategoryID	The unique internal identifier code for the program category.
CategoryName	A user-friendly display name for the program category.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Return the available program types (subcategories) for a given program category.

Request Parameters

\n\n

Parameter	Description	Required
CategoryID	The unique internal identifier code for the program category.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25. (Passed inside the Pagination object).	true
RecordsToTake	The maximum number of results to return per page. (Passed inside the Pagination object).	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
RecordsToSkip	The number of records bypassed before returning these results.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of records available for this query.
SubCategoryID	The unique internal identifier code for the program subcategory.
SubCategoryName	A user-friendly display name for the program subcategory.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Update your company payment programs or projects.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
ProgramID	The unique internal identifier for the program you are updating.	true
TransactionCategoryID	The top-level numeric ID for the transaction category.	true
TransactionSubCategoryID	The specific numeric ID for the transaction sub-category.	true
ClaimAmount	The specific amount or value allocated for claims within this program.	false
CurrencyCode	The standard three-letter ISO 4217 currency code for the program (e.g., USD, EUR).	false
Description	A user-friendly name or short description of the payment program being updated (e.g., \"Updated Q3 Employee Bonus Program\").	true
IsClaim	Indicates whether this program is claim-based (true / false).	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
ProgramID	The unique internal identifier for the updated payment program.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoints to create and manage specific remittance, payout, or budget programs.

\n","_postman_id":"e04b87ef-8525-42f4-9542-fd0d3a72af7b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Transfer Funds","item":[{"name":"Beneficiary company withdraw funds","id":"1d552bed-1a45-4b30-8e94-19c844b2490e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"BeneficiaryCompanyWithdrawFund\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"Currency\": \"USD\",\n \"Amount\": \"50.00\",\n \"PaymentMethodID\": \"XTR94508\",\n \"BeneficiaryAccountNumber\": \"SPN9999888\",\n \"BeneficiaryWalletID\": \"67890\",\n \"OTP\": \"123456\",\n \"BankPaymentMethod\": \"ACH\",\n \"BeneficiaryCardToken\": \"F2AA507CD01E4EC\",\n \"BeneficiaryLinkedBankID\": \"12e6f8ac19804f90be485045f50ace57\",\n \"EmailNotification\": true,\n \"SendTransferCodeToEmail\": \"true\",\n \"SendTransferCodeToMobile\": \"true\",\n \"description\": \"Withdraw - For Payments\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Fund/BeneficiaryCompanyWithdrawFund","description":"

This allows you to make transfers from a company wallet to a beneficiary company wallet or pass-through payments to a beneficiaries Bank account. When making transfers, if the beneficiary does not have a wallet in that currency, one will be created automatically.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
OTP	A one-time password string consisting of exactly six digits.	true
SendTransferCodeToMobile	Indicates whether to send the transfer code to the registered mobile number. Note: This must be passed as a string (`\"true\"` / `\"false\"`), not a standard Boolean.	false
Amount	The specific amount or value to withdraw, passed as a string.	true
BankPaymentMethod	The BankPaymentMethod can be retrieved from the PaymentMethods collection within the BankDetails object, which is available through the GetLinkedBankAccounts response.	false
BeneficiaryCardToken	A unique token generated for credit/debit card reference.	false
BeneficiaryLinkedBankID	The unique identification code for the beneficiary's linked bank account.	false
BeneficiaryWalletID	The unique internal identifier or name of the destination wallet.	true
EmailNotification	Indicates whether the beneficiary should receive a standard email notification regarding this withdrawal. Note: Unlike the transfer code flags, this must be passed as a true Boolean (true / false).	false
BeneficiaryAccountNumber	The unique Xtrm account identifier for the receiving beneficiary, starting with `SPN` for Company Accounts.	true
Currency	The standard three-letter ISO 4217 currency code for the withdrawal (e.g., USD, EUR).	true
PaymentMethodID	The unique internal identifier for the specific withdrawal payment method.	true
SendTransferCodeToEmail	Indicates whether to send the transfer code to the registered email address. Note: This must be passed as a string (`\"true\"` / `\"false\"`), not a standard Boolean.	false

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
Label	A categorical name or term for the returned detail.
Value	The specific data value corresponding to the Label.
PaymentDate	The recorded timestamp or payment date of the transaction.
PaymentStatus	The current operational status of the payment.
PaymentTransactionId	The globally unique identifier for the transaction and account. Note: This returns explicitly as an Integer (e.g., 79821134), not a string.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API call returns the fees set by Xtrm.

Request Parameters

Parameter	Description	Required
BeneficiaryAccountNumber	The unique Xtrm account identifier for the receiving company, starting with `SPN`.	true
CurrencyCode	The standard three-letter ISO 4217 currency code for the transaction (e.g., USD, EUR).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

Parameter	Description
Success	Success or failure of operation (true / false).
CapFee	The maximum capped fee amount applied when sending funds to a company beneficiary.
FlatFee	The fixed flat fee amount applied when sending funds to a company beneficiary.
PercentageFee	The percentage-based fee applied when sending funds to a company beneficiary.
CapFee	The maximum capped fee amount applied when sending funds to an individual beneficiary.
FlatFee	The fixed flat fee amount applied when sending funds to an individual beneficiary.
PercentageFee	The percentage-based fee applied when sending funds to an individual beneficiary.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Retrieves the fund request details for a connected company within a specified date range.

Request Parameters

Parameter	Description	Required
FromDate	The starting date for the query, formatted strictly as MM/DD/YYYY (e.g., 01/31/2023).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to bypass before returning results. For example, to retrieve page 2 with a `RecordsToTake` limit of 25, set this to 25. (Passed inside the Pagination object).	true
RecordsToTake	The maximum number of results to return per page. (Passed inside the Pagination object).	true
PaymentType	The classification of the payment type to filter the requests by (e.g., Personal, Credits, Debits).	true
ToDate	The ending date for the query, formatted strictly as MM/DD/YYYY (e.g., 12/31/2023).	true
BeneficiaryAccountNumber	The unique Xtrm account identifier for the connected beneficiary company, starting with `SPN`.	true

\n\n

Response Format (CSV Columns)

Column Header	Description
Account Number	The unique Xtrm account identifier for the connected company (starting with `SPN`).
Name	The registered name of the connected company.
Credits	The total credited amount for the specified date range.
Debits	The total debited amount for the specified date range.
Currency	The standard three-letter ISO 4217 currency code for the transaction totals (e.g., USD, AED, CAD).

This allows you to transfer funds between wallets in any combination (e.g., personal wallet to company wallet, personal wallet to another personal wallet, company wallet to personal wallet, or company wallet to another company wallet).

On the initial TransferFundWalletToWallet call, a 6-digit one-time password (OTP) is generated and sent to the user from whom the funds will be debited. Capture this 6-digit OTP value from the user in your application and resubmit TransferFundWalletToWallet with the OTP included to complete the transaction.

Request Parameters

\n\n

Parameter	Description	Required
FromWalletID	The unique internal identifier or name of the originating wallet.	true
OTP	A one-time password string consisting of exactly six digits. Note: Omit this field or leave it blank in the initial payload to kickstart the OTP generation process. It is required on the second request to finalize the transfer.	true
ToAccountNumber	A unique Xtrm account identifier for the destination account, starting with `SPN` for Company Accounts or `PAT` for Personal Accounts.	true
Amount	The specific amount or value to transfer, passed as a string.	true
Currency	The standard three-letter ISO 4217 currency code for the transfer (e.g., USD, EUR).	true
Description	A field for explanatory remarks or a memo regarding the transfer.	true
FromAccountNumber	A unique Xtrm account identifier for the originating account, starting with `SPN` for Company Accounts or `PAT` for Personal Accounts.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
ToWalletID	The unique internal identifier or name of the destination wallet.	true

\n\n

Response Parameters

\n\n

Parameter	Description
TransactionID	The globally unique identifier for the transaction and account.
Amount	The base amount transferred in the specific currency, returned as a string.
Currency	The standard three-letter ISO 4217 currency code used for the transfer.
Fee	The transaction fee applied to the transfer in the specific currency, returned as a string.
Success	Success or failure of operation (true / false).
TotalAmount	The total amount debited (transfer amount plus any fees) in the specific currency, returned as a string.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This allows a personal account to withdraw funds using one of the available payment methods from their Xtrm AnyPay™ Digital Wallet.

On the initial UserWithdrawFund call, a 6-digit one-time password (OTP) is generated and sent to the personal account holder. Retrieve this 6-digit OTP value from the personal account in your application and resubmit UserWithdrawFund with the OTP included to complete the transaction.

Request Parameters

\n\n

Parameter	Description	Required
SKU	The specific item identifier or purchase code (e.g., for gift card withdrawals).	false
Amount	The specific amount or value to withdraw, passed as a string.	true
BankPaymentMethod	The specific method of bank transfer. This can be retrieved from the PaymentMethods collection within the BankDetails object via the `GetLinkedBankAccounts` response.	false
SendTransferCodeToEmail	Indicates whether to send the transfer code to the registered email address. Note: This must be passed as a string (`\"true\"` / `\"false\"`), not a standard Boolean.	false
UserPrepaidVisaEmailID	The target email address to deliver the Prepaid Visa details to, if applicable.	false
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
PaymentMethodID	The unique internal identifier for the specific withdrawal payment method.	true
SendTransferCodeToMobile	Indicates whether to send the transfer code to the registered mobile number. Note: This must be passed as a string (`\"true\"` / `\"false\"`), not a standard Boolean.	false
UserID	The unique Xtrm account identifier for the withdrawing user, starting with `PAT`.	true
CardToken	A unique token generated for a specific credit/debit card reference.	false
Currency	The standard three-letter ISO 4217 currency code for the withdrawal (e.g., USD, EUR).	true
EmailNotification	Indicates whether the user should receive a standard email notification regarding this withdrawal (true / false).	false
OTP	A one-time password string consisting of exactly six digits. Note: Omit this field or leave it blank in the initial payload to kickstart the OTP generation process. It is required on the second request to finalize the transfer.	true
UserGiftCardEmailID	The target email address to deliver the Gift Card details to, if applicable.	false
UserLinkedBankID	The unique identification code for the user's linked bank account. This can be retrieved via the `GetLinkedBankAccounts` endpoint.	false

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
Label	A categorical name or term for the returned detail.
Value	The specific data value corresponding to the Label.
PaymentDate	The recorded timestamp or payment date of the transaction.
PaymentStatus	The current operational status of the payment (e.g., completed, pending).
TotalAmount	The total amount debited (withdrawal amount plus any fees) in the specific currency, returned as a string.
Amount	The base amount withdrawn in the specific currency, returned as a string.
Currency	The standard three-letter ISO 4217 currency code used for the withdrawal.
Fee	The transaction fee applied to the withdrawal in the specific currency, returned as a string.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Click the redemption link above to claim your reward.
Select a Virtual Visa Card, ready for immediate use online or over the phone anywhere Visa debit is accepted, or select a Physical Visa Card to be mailed to you (shipping and handling fee of $3.00 applies).
The redemption site will ask you to provide your name, address, email and mobile phone number to be associated with your Prepaid Card.
Agree to the Cardholder Agreement to complete the redemption.

\\n

NOTE: You must select your card within 4 months from the date this email was sent. Your right to the payment expires after that time. Once redeemed, you'll have 7 months to use your Visa Prepaid Card wherever Visa debit is accepted in the U.S.

The redemption website provides balance information and transaction history to help you keep track of all your rewards. Please note that some merchants may choose not to accept out of country currency at their own discretion. If this occurs, pay for your purchase by another payment method and use your Visa Prepaid Card at a different merchant.

\"\n }\n },\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": []\n }\n }\n }\n}"},{"id":"48aff49a-2139-4200-bf40-a89705309ac7","name":"200 OK - User Withdraw Fund (Digital Gift Card)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"UserWithdrawFund\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"UserID\": \"PAT9999888\",\n \"Amount\": \"50.00\",\n \"Currency\": \"USD\",\n \"PaymentMethodID\": \"XTR94505\",\n \"OTP\": \"874812\",\n \"EmailNotification\": true,\n \"SKU\": \"ACME-SKU-1001\",\n \"SendTransferCodeToEmail\": \"true\",\n \"SendTransferCodeToMobile\": \"true\",\n \"UserGiftCardEmailID\": \"jane.doe@example.com\",\n \"description\": \"Withdraw Funds\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Fund/UserWithdrawFund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"UserWithdrawFundResponse\": {\n \"UserWithdrawFundResult\": {\n \"PaymentTransactionId\": \"397782\",\n \"PaymentDate\": \"2026-06-05T15:48:52.679009Z\",\n \"PaymentStatus\": \"Completed\",\n \"Amount\": \"50.00\",\n \"Fee\": \"0.50\",\n \"TotalAmount\": \"50.50\",\n \"Currency\": \"USD\",\n \"PayDirectTransactionDetails\": null,\n \"RedemptionDetails\": {\n \"Method\": \"Digital Gift Card\",\n \"TransactionStatus\": \"Success\",\n \"TransactionNumber\": \"RA260605-146803-04\",\n \"Giftcard\": \"Acme Retail Emporium Gift Card $50.00\",\n \"GiftcardImageUrl\": \"\\\"https://dwwvg90koz96l.cloudfront.net/images/brands/acme-1200w.png\\\"\",\n \"RecipientEmail\": \"jane.doe@example.com\",\n \"RecipientName\": \"Jane Doe\",\n \"RecipientMobilePhoneNumber\": \"+14085551234\",\n \"Amount\": \"50.00 USD\",\n \"TimeProcessed\": \"Jun 05, 2026 11:48:52 AM\",\n \"Reward\": {\n \"Credentials\": {\n \"ClaimCode\": null\n },\n \"CredentialList\": [\n {\n \"Label\": \"PIN\",\n \"Value\": \"3200\",\n \"Type\": \"text\",\n \"CredentialType\": \"pin\"\n },\n {\n \"Label\": \"Serial Number\",\n \"Value\": \"3451020619378808751\",\n \"Type\": \"text\",\n \"CredentialType\": \"cardNumber\"\n }\n ],\n \"RedemptionInstructions\": \"

Where you can redeem your Gift Card:

\\n

Online at www.acmecorp.com. By phone on orders for Acme Retail Emporium.
At our company owned and participating franchised retail store locations.

\\n

Limit one Gift Card, Fresh Rewards pass and/or Savings Pass per order. Some promotions may restrict redemption to certain brands and will be clearly noted on the promotion. May become redeemable at additional brands and locations, which information will be updated on this page. See conditions and restrictions as detailed below.

\"\n }\n },\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": []\n }\n }\n }\n}"},{"id":"9f2aea6e-f0fb-44e5-8c88-385d752e187d","name":"200 OK - User Withdraw Fund (Bank Transfer)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"UserWithdrawFund\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"UserID\": \"PAT9999888\",\n \"Amount\": \"5\",\n \"Currency\": \"USD\",\n \"PaymentMethodID\": \"XTR94500\",\n \"OTP\": \"235511\",\n \"EmailNotification\": true,\n \"SendTransferCodeToEmail\": \"true\",\n \"SendTransferCodeToMobile\": \"true\",\n \"UserLinkedBankID\": \"a9c5d0b0691e4c3aa49c5091b205bacf\",\n \"description\": \"Withdraw Funds\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Fund/UserWithdrawFund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"UserWithdrawFundResponse\": {\r\n \"UserWithdrawFundResult\": {\r\n \"PaymentTransactionId\": \"397785\",\r\n \"PaymentDate\": \"2026-06-05T16:33:26.385963Z\",\r\n \"PaymentStatus\": \"Completed\",\r\n \"Amount\": \"4.50\",\r\n \"Fee\": \"0.50\",\r\n \"TotalAmount\": \"5.00\",\r\n \"Currency\": \"USD\",\r\n \"PayDirectTransactionDetails\": null,\r\n \"RedemptionDetails\": null,\r\n \"OperationStatus\": {\r\n \"Success\": true,\r\n \"Errors\": []\r\n }\r\n }\r\n }\r\n}"},{"id":"b010601a-546c-4812-97dd-91de0a698dd7","name":"200 OK - User Withdraw Fund (Rapid Transfer)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"UserWithdrawFund\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"UserID\": \"PAT9999888\",\n \"Amount\": \"5\",\n \"Currency\": \"USD\",\n \"PaymentMethodID\": \"XTR94508\",\n \"OTP\": \"427474\",\n \"BankPaymentMethod\": \"ACH\",\n \"CardToken\": \"F2AA507CD01E4EC\",\n \"EmailNotification\": true,\n \"SKU\": \"U935268\",\n \"SendTransferCodeToEmail\": \"true\",\n \"SendTransferCodeToMobile\": \"true\",\n \"description\": \"Withdraw Funds\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Fund/UserWithdrawFund"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"UserWithdrawFundResponse\": {\r\n \"UserWithdrawFundResult\": {\r\n \"PaymentTransactionId\": \"397786\",\r\n \"PaymentDate\": \"2026-06-05T17:01:59.9444934Z\",\r\n \"PaymentStatus\": \"Completed\",\r\n \"Amount\": \"3.75\",\r\n \"Fee\": \"1.25\",\r\n \"TotalAmount\": \"5\",\r\n \"Currency\": \"USD\",\r\n \"PayDirectTransactionDetails\": [\r\n [\r\n {\r\n \"Name\": \"Transfer Type\",\r\n \"Value\": \"Instant (RBT)\"\r\n },\r\n {\r\n \"Name\": \"Transaction Status\",\r\n \"Value\": \"COMPLETED\"\r\n },\r\n {\r\n \"Name\": \"Amount\",\r\n \"Value\": \"3.75\"\r\n },\r\n {\r\n \"Name\": \"Currency\",\r\n \"Value\": \"USD\"\r\n },\r\n {\r\n \"Name\": \"Order Number\",\r\n \"Value\": \"XqYvUR5VQWkgAVUE_TzlmA\"\r\n },\r\n {\r\n \"Name\": \"Date Booked\",\r\n \"Value\": \"6/5/2026 1:01:59 PM\"\r\n },\r\n {\r\n \"Name\": \"Beneficiary Name\",\r\n \"Value\": \"Jane Doe\"\r\n },\r\n {\r\n \"Name\": \"Date\",\r\n \"Value\": \"6/5/2026 1:01:59 PM\"\r\n }\r\n ]\r\n ],\r\n \"RedemptionDetails\": null,\r\n \"OperationStatus\": {\r\n \"Success\": true,\r\n \"Errors\": []\r\n }\r\n }\r\n }\r\n}"}],"_postman_id":"a57a04c9-f89b-47e8-9e2a-d5b5b308cf25"},{"name":"Transfer Funds to User","id":"974f20bb-6d3a-42ab-9baf-97db5e1244b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TransferFund\": {\n \"request\": {\n \"Transaction\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"PaymentType\": \"Personal\",\n \"PaymentMethodID\": \"XTR94500\",\n \"WalletID\": \"67890\",\n \"PaymentDescription\": \"Bonus Payout\",\n \"PaymentCurrency\": \"USD\",\n \"EmailNotification\": \"true\",\n \"TransactionDetails\": [\n {\n \"IssuerTransactionId\": \"TXN-777888\",\n \"PaymentAmount\": \"341.25\",\n \"RecipientUserID\": \"PAT9999888\",\n \"BeneficiaryCheckAddresss1\": \"1234 Market Street\",\n \"BeneficiaryCheckAddresss2\": \"Suite 100\",\n \"BeneficiaryCheckCity\": \"San Francisco\",\n \"BeneficiaryCheckCountryCodeISO2\": \"US\",\n \"BeneficiaryCheckMemo\": \"Sales incentive payment\",\n \"BeneficiaryCheckName\": \"Jane Doe\",\n \"BeneficiaryCheckPostalCode\": \"94105\",\n \"BeneficiaryCheckReference\": \"Invoice 10293\",\n \"BeneficiaryCheckState\": \"CA\",\n \"CardToken\": \"F2AA507CD01E4EC\",\n \"Comment\": \"Q3 Sales Bonus\",\n \"DealRegId\": \"J. Doe - US\",\n \"PartnerAccountNumber\": \"SPN8888777\",\n \"SKU\": \"MOCK-SKU-1001\",\n \"UserGiftCardEmailID\": \"jane.doe@example.com\",\n \"UserLinkedBankID\": \"12e6f8ac19804f90be485045f50ace57\",\n \"UserPrepaidVisaEmailID\": \"jane.doe@example.com\"\n }\n ],\n \"ProgramID\": \"5555\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Fund/TransferFund","description":"

This allows you to make transfers from a company wallet to a beneficiary personal wallet (AnyPay™), or pass-through payments to a beneficiary's bank account or Prepaid Virtual Visa. When you make transfers, if the beneficiary does not have a wallet in that currency, one will be created automatically.

The Transaction Detail element provides information on when the transaction generates additional information (typically redemption details for gift cards or debit cards) that need to be displayed to the user in a web or mobile application.

Request Parameters

\n\n

Parameter	Description	Required
PaymentType	The classification of the payment type (e.g., Personal, Credits, Debits).	true
ProgramID	The unique internal identifier for the associated payment program.	false
PaymentAmount	The specific amount or value to transfer, passed as a string.	true
UserGiftCardEmailID	The target email address to deliver the Gift Card details to, if applicable.	false
BeneficiaryCheckAddress	The first line of the street address for check delivery.	false
BeneficiaryCheckCity	The city name for check delivery.	false
Comment	A comment or note on the transaction, up to 500 characters.	false
PartnerAccountNumber	A unique Xtrm account identifier for the partner account, starting with `SPN`.	false
BeneficiaryCheckPostalCode	The postal or ZIP code for check delivery.	false
CardToken	A unique token generated for a specific credit/debit card reference.	false
BeneficiaryCheckReference	A reference note to be included on the check, up to 500 characters.	false
BeneficiaryCheckState	The state, province, or region for check delivery.	false
DealRegId	The specific person or identifier for the deal registration.	false
IssuerTransactionId	An issuer-supplied unique identifier (5 to 256 characters, alphanumeric/hyphens only) that specifies this transaction for idempotency. Xtrm returns this identifier unchanged. A unique identifier must be passed for each payment request. The same identifier can be reused after 24 hours.	true
SKU	The specific item identifier or purchase code.	false
UserPrepaidVisaEmailID	The target email address to deliver the Prepaid Visa details to, if applicable.	false
BeneficiaryCheckAddress2	The second line of the street address for check delivery (if applicable).	false
BeneficiaryCheckMemo	A memo to be printed on the check.	false
RecipientUserID	The unique Xtrm account identifier for the receiving user, starting with `PAT`.	true
BeneficiaryCheckCountryCodeISO2	The two-character ISO country abbreviation for check delivery.	false
BeneficiaryCheckName	The full name of the check recipient.	false
WalletID	The unique internal identifier or name of the originating wallet.	true
EmailNotification	Indicates whether the user should receive a standard email notification (true / false).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call.	true
PaymentMethodID	The unique internal identifier for the chosen payment method.	true
PaymentCurrency	The standard three-letter ISO 4217 currency code for the payment.	true
PaymentDescription	A field for explanatory remarks or a memo regarding the payment.	true
UserLinkedBankID	The unique identification code for the user's linked bank account. This can be retrieved via the `GetLinkedBankAccounts` endpoint.	false

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of operation (true / false).
Fee	The transaction fee applied to the transfer in the specific currency, returned as a string.
IssuerTransactionId	The exact issuer-supplied unique identifier passed in the request payload, returned for idempotency confirmation.
Label	A categorical name or term for the returned detail/credential.
Value	The specific data value corresponding to the Label.
PaymentTransactionId	The globally unique identifier for the transaction and account.
RecipientUserId	The unique Xtrm account identifier for the recipient, starting with `PAT`.
Currency	The standard three-letter ISO 4217 currency code used for the transfer.
Amount	The base amount transferred in the specific currency, returned as a string.
GiftCard	The name and type of the generated gift card (if applicable).
RecipientMobilePhoneNumber	The registered mobile phone number of the recipient.
RecipientName	The full registered name of the recipient.
TransactionNumber	The specific ID number generated for the transaction.
TransactionStatus	The current operational status of the transaction (e.g., completed, pending, failed).
method	The specific payment method utilized for the transfer.
GiftCardImageUrl	The URL for a displayable image of the generated gift card.
RecipientEmail	The primary email address associated with the recipient.
ClaimCode	The generated ID or code required for claiming the reward.
RedemptionInstructions	Specific redemption instructions provided for the reward or digital card.
CredentialType	The type or classification of the credential generated.
Type	The specific kind of data or credential format.
TimeProcessed	The exact timestamp of when the transaction was successfully processed.
TotalAmount	The total amount debited (transfer amount plus any fees) in the specific currency, returned as a string.
IsReplay	When a duplicate request (same payload with the same idempotency key) comes in, this parameter returns true to differentiate whether the response is for the actual request or a duplicate replay.
BeneficiaryTransactionId	The globally unique identifier generated for the beneficiary's side of the transaction.
PaymentDate	The recorded timestamp or payment date of the overall transaction.
PaymentStatus	The current operational status of the payment (e.g., completed, pending).
SubTransactionId	The globally unique identifier for any beneficiary sub-transactions.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Where you can redeem your Gift Card:

\\n

Online at www.acmecorp.com. By phone on orders for Acme Retail Emporium.
At our company owned and participating franchised retail store locations.

\\n

Limit one Gift Card per order. Some promotions may restrict redemption to certain brands and will be clearly noted on the promotion. May become redeemable at additional brands and locations, which information will be updated on this page. See conditions and restrictions as detailed below.

\"\r\n }\r\n },\r\n \"PayDirectTransactionDetails\": []\r\n }\r\n ],\r\n \"OperationStatus\": {\r\n \"Success\": true,\r\n \"Errors\": [],\r\n \"IsReplay\": true\r\n }\r\n }\r\n }\r\n}"},{"id":"9f041c5f-d3b7-4731-8167-34c6b9d565a8","name":"200 OK - Transfer Funds to User (Prepaid Visa Card)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TransferFund\": {\n \"request\": {\n \"Transaction\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"PaymentType\": \"Personal\",\n \"PaymentMethodID\": \"XTR94503\",\n \"WalletID\": \"122181\",\n \"PaymentDescription\": \"in\",\n \"PaymentCurrency\": \"USD\",\n \"EmailNotification\": \"true\",\n \"TransactionDetails\": [\n {\n \"IssuerTransactionId\": \"TXN-777891\",\n \"PaymentAmount\": \"100\",\n \"RecipientUserID\": \"PAT9999888\",\n \"Comment\": \"Q3 Sales Bonus\",\n \"DealRegId\": \"J. Doe - US\",\n \"PartnerAccountNumber\": \"SPN8888777\",\n \"SKU\": \"U677579\",\n \"UserPrepaidVisaEmailID\": \"jane.doe@example.com\"\n }\n ],\n \"ProgramID\": \"2314\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Fund/TransferFund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"TransferFundResponse\": {\n \"TransferFundResult\": {\n \"TransactionDetail\": [\n {\n \"IssuerTransactionId\": \"TXN-777891\",\n \"PaymentTransactionId\": \"879268\",\n \"BeneficiaryTransactionId\": \"397795\",\n \"SubTransactionId\": \"18185317\",\n \"RecipientUserId\": \"PAT9999888\",\n \"PaymentDate\": \"2026-06-05T13:55:43.247\",\n \"PaymentStatus\": \"Completed\",\n \"Amount\": \"100.00\",\n \"Fee\": \"5.00\",\n \"TotalAmount\": \"105.00\",\n \"Currency\": \"USD\",\n \"RedemptionDetails\": {\n \"Method\": \"Prepaid Virtual Visa or Mastercard\",\n \"TransactionStatus\": \"Success\",\n \"TransactionNumber\": \"RA260605-146804-25\",\n \"Giftcard\": \"Visa® Prepaid Card USD\",\n \"GiftcardImageUrl\": \"https://example.com/images/brands/visa-200w.png\",\n \"RecipientEmail\": \"jane.doe@example.com\",\n \"RecipientName\": \"Jane Doe\",\n \"RecipientMobilePhoneNumber\": \"+14085551234\",\n \"Amount\": \"100.00 USD\",\n \"TimeProcessed\": \"Jun 05, 2026 01:55:45 PM\",\n \"Reward\": {\n \"Credentials\": {\n \"ClaimCode\": null\n },\n \"CredentialList\": [\n {\n \"Label\": \"Redemption Link\",\n \"Value\": \"https://account.example.com/token/040685C9DEE71EE20FC1FF0C7BB83CDD\",\n \"Type\": \"url\",\n \"CredentialType\": \"redemptionUrl\"\n },\n {\n \"Label\": \"Digital Token\",\n \"Value\": \"9XYZABCDEF12\",\n \"Type\": \"text\",\n \"CredentialType\": \"cardNumber\"\n }\n ],\n \"RedemptionInstructions\": \"

Click the redemption link above to claim your reward.
Select a Virtual Visa Card, ready for immediate use online or over the phone anywhere Visa debit is accepted, or select a Physical Visa Card to be mailed to you (shipping and handling fee of $3.00 applies).
The redemption site will ask you to provide your name, address, email and mobile phone number to be associated with your Prepaid Card.
Agree to the Cardholder Agreement to complete the redemption.

\\n

\"\n }\n },\n \"PayDirectTransactionDetails\": []\n }\n ],\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": [],\n \"IsReplay\": true\n }\n }\n }\n}"}],"_postman_id":"974f20bb-6d3a-42ab-9baf-97db5e1244b9"},{"name":"Transfer funds to user’s default wallet (create user and wallet as needed)","id":"01585ffd-6834-46d4-8f08-f4ae55fd3d47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TransferFundToDynamicAccountUser\": {\n \"Request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"FromAccountNumber\": \"SPN8888777\",\n \"FromWalletID\": \"122190\",\n \"RecipientEmail\": \"jane.doe@example.com\",\n \"Currency\": \"USD\",\n \"Amount\": \"50\",\n \"Description\": \"Good job!\",\n \"IssuerTransactionId\": \"TXN-777892\",\n \"RecipientFirstName\": \"Jane\",\n \"RecipientLastName\": \"Doe\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Fund/TransferFundDynamicAccountCreateUser","description":"

This allows the transfer of funds from a company wallet to a new personal account or an existing personal account wallet. The personal account is created dynamically if the email ID used does not already exist within the system. The new personal account is automatically connected to the creating company account.

Request Parameters

\n\n

Parameter	Description	Required
RecipientLastName	The legal last name of the personal beneficiary. Required if a new account needs to be created dynamically.	false
Amount	The specific amount or value to transfer, passed as a string.	true
FromWalletID	The unique internal identifier or name of the originating company wallet.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
IssuerTransactionId	An issuer-supplied unique identifier (5 to 256 characters, alphanumeric/hyphens only) that specifies this transaction for idempotency. Xtrm uses this identifier to prevent duplicate entries. The same identifier may be reused after 24 hours.	false
RecipientEmail	The primary contact email address for the personal beneficiary. This acts as the unique identifier to look up or dynamically create the account.	true
RecipientFirstName	The legal first name of the personal beneficiary. Required if a new account needs to be created dynamically.	false
Currency	The standard three-letter ISO 4217 currency code for the transfer (e.g., USD, EUR).	true
Description	A field for explanatory remarks or a memo regarding the fund transfer.	true
FromAccountNumber	The unique Xtrm account identifier for the originating company account, starting with `SPN`.	true

\n\n

Response Parameters

\n\n

Parameter	Description
IsReplay	When a duplicate request (same payload with the same idempotency key) comes in, this parameter returns true to differentiate whether the response is for the actual request or a duplicate replay request.
Success	Success or failure of operation (true / false).
RecipientAccountNumber	The unique Xtrm account identifier for the recipient, starting with `PAT` for Personal Accounts.
TotalAmount	The total amount debited (transfer amount plus any fees) in the specific currency, returned as a string.
TransactionID	The globally unique identifier generated for the transaction and account.
Amount	The base amount transferred in the specific currency, returned as a string.
Currency	The standard three-letter ISO 4217 currency code used for the transfer.
Fee	The transaction fee applied to the transfer in the specific currency, returned as a string.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This allows you to make transfers from a company wallet to a beneficiary company wallet (AnyPay) or pass-through payments to a beneficiary's bank account. When making transfers, if the beneficiary does not have a wallet in that currency, one will be created automatically.

Request Parameters

\n\n

Parameter	Description	Required
CardToken	A unique token generated for credit/debit card reference.	false
Description	A field for explanatory remarks or a memo regarding the transfer.	true
PaymentMethodID	The unique internal identifier for the chosen payment method, fetched via the API.	true
BeneficiaryCheckAddress1	The first line of the street address for check delivery.	false
ProgramId	The unique internal identifier for the associated payment program.	false
BeneficiaryCheckCountryCodeISO2	The two-character ISO country abbreviation for check delivery.	false
PaymentType	The classification of the payment type (e.g., Company, Credits, Debits).	true
BeneficiaryCheckCity	The city name for check delivery (1 to 25 characters).	false
BeneficiaryCheckMemo	A user-defined memo string to be printed directly on the physical check.	false
BeneficiaryCheckName	The full name of the beneficiary company to be printed on the check (2 to 40 characters).	false
BeneficiaryCheckPostalCode	The postal or ZIP code for check delivery.	false
BeneficiaryCheckReference	An internal reference note to accompany the check transaction, up to 500 characters.	false
Currency	The standard three-letter ISO 4217 currency code for the transfer (e.g., USD, EUR).	true
Amount	The specific amount or value to transfer, passed as a string.	true
BeneficiaryCheckAddress2	The second line of the street address for check delivery, if applicable.	false
WalletId	The unique internal identifier or name of the originating company wallet.	true
EmailNotification	Indicates whether an email notification should be sent to the beneficiary. This must be passed as a string value (`\"true\"` or `\"false\"`).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
BeneficiaryPayPalEmailID	A valid target PayPal email address if transferring funds directly to PayPal.	false
BeneficiaryWalletID	The unique internal identifier or name of the destination company wallet.	true
IssuerTransactionId	An issuer-supplied unique identifier (5 to 256 characters, alphanumeric/hyphens only) that specifies this transaction for idempotency. Xtrm uses this identifier to prevent duplicate entries. The same identifier may be reused after 24 hours.	true
BeneficiaryAccountNumber	The unique Xtrm account identifier for the receiving company, starting with `SPN`.	true
BeneficiaryCheckState	The state, province, or region jurisdiction for check delivery.	false
BeneficiaryLinkedBankID	The unique identification code for the beneficiary's linked bank account. This can be retrieved via the `GetLinkedBankAccounts` endpoint.	false

\n\n

Response Parameters

\n\n

Parameter	Description
BeneficiaryTransactionId	The globally unique identifier generated for the beneficiary's side of the transaction.
Currency	The standard three-letter ISO 4217 currency code used for the transfer.
Fee	The transaction fee applied to the transfer in the specific currency, returned as a string.
IssuerTransactionId	The exact issuer-supplied unique identifier passed in the request payload, returned for idempotency confirmation.
PaymentTransactionId	The globally unique identifier for the transaction and account.
Success	Success or failure of operation (true / false).
BeneficiaryAccountNumber	The unique Xtrm account identifier for the receiving company, starting with `SPN`.
PaymentStatus	The current operational status of the payment (e.g., completed, pending).
SubTransactionId	The globally unique identifier for any beneficiary sub-transactions.
TotalAmount	The total amount debited (transfer amount plus any fees) in the specific currency, returned as a string.
Amount	The base amount transferred in the specific currency, returned as a string.
IsReplay	When a duplicate request (same payload with the same idempotency key) comes in, this parameter returns true to differentiate whether the response is for the actual request or a duplicate replay request.
Label	A categorical name or term for the returned detail.
Value	The specific data value corresponding to the Label.
PaymentDate	The recorded timestamp or payment date of the overall transaction.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

The Mass Pay API allows you to disburse funds to multiple recipients in a single HTTP request. You submit a batch and receive an immediate synchronous 202 Accepted response , while processing happens asynchronously in the background.

\n\n

Request Parameters

\n\n

1. Batch Envelope Fields

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier that owns the source funds.	true
SourceWalletId	The unique identifier for the wallet funding the batch, which inherently implies the currency of the batch.	true
CustomerBatchId	A client-supplied unique identifier for tracking the batch. If omitted, the server automatically assigns one.	false
EmailNotification	Optional flag for email delivery rails. Note: Passed as a string value (`\"true\"` or `\"false\"`).	false
Items	An array of transaction item objects to be processed in this batch. Default maximum of 1,000 items per batch request.	true

\n\n

2. Individual Item Fields (Within the Items Array)

Parameter	Description	Required
CustomerTransactionId	A client-supplied unique identifier for individual item transaction tracking. If omitted, the server automatically assigns one.	false
RecipientId	The unique identifier code for the transaction beneficiary.	true
Amount	The payment amount value passed as a positive decimal string (e.g., `\"10.00\"`).	true
SendMethodId	The specific delivery method identifier code. Supported methods include Bank Transfer (`XTR94500`), Wallet (`XTR94502`), Prepaid Debit Card (`XTR94503`), Digital Gift Card (`XTR94505`), Rapid Transfer (`XTR94508`), and Check (`XTR94507`).	true
Description	An optional user-supplied note or remark for the transaction (maximum 1024 characters).	false
Destination	A nested object container holding method-specific routing and delivery fields. See details below.	true

\n\n

3. Destination Object Fields
The parameters required inside the Destination object depend entirely on the specified SendMethodId.

Parameter	Description	Required Condition
BeneficiaryBankID	The unique ID code for the target linked bank account. Defaults to the recipient wallet's default bank if omitted.	Optional for Bank Transfer (`XTR94500`)
BeneficiaryBankPaymentMethod	The bank payment routing rail type (e.g., `ACH`, `Wire`).	Optional for Bank Transfer (`XTR94500`)
WalletId	The specific destination wallet identifier. Defaults to the recipient's default wallet if omitted.	Optional for Wallet Transfer (`XTR94502`)
Email	The target delivery email address for digital credentials.	Required for Prepaid Debit Card (`XTR94503`) and Digital Gift Card (`XTR94505`)
SKU	The internal product catalog code mapping to the specific card reward.	Required for Prepaid Debit Card (`XTR94503`) and Digital Gift Card (`XTR94505`)
CardToken	A unique secure token representing credit/debit card references.	Required for Rapid Transfer (`XTR94508`)
BeneficiaryCheckName	The full recipient name to print on a physical check (up to 100 characters).	Required for Check Delivery (`XTR94507`)
BeneficiaryCheckAddress1	The primary street delivery address details for check mail routing.	Required for Check Delivery (`XTR94507`)
BeneficiaryCheckAddress2	The secondary line for address specifics (suite, apartment, etc.).	false
BeneficiaryCheckCity	The destination city for physical check mail delivery.	Required for Check Delivery (`XTR94507`)
BeneficiaryCheckState	The destination state, region, or province jurisdiction.	Required for Check Delivery (`XTR94507`)
BeneficiaryCheckPostalCode	The destination ZIP or postal code.	Required for Check Delivery (`XTR94507`)
BeneficiaryCheckCountryCodeISO2	The two-letter country code abbreviation for the destination address (e.g., `US`).	Required for Check Delivery (`XTR94507`)
BeneficiaryCheckMemo	A memo string up to 100 characters printed on the physical check body.	false
BeneficiaryCheckReference	An explanatory or tracking note printed on the check stub.	false

\n\n

Response Parameters

Parameter	Description
BatchTransferResponse	Root object container wrapping the synchronous status of the submitted batch payload.
CustomerBatchId	The unique batch identifier code matching the string supplied in the request envelope.
Status	The current global execution status of the batch payload submission (e.g., `Accepted`, `Processing`).
ItemsCount	Object summarizing transaction breakdown statistics. Contains: • `Total`: Total items analyzed. • `Accepted`: Items that passed core synchronous validation and entered the queue. • `Rejected`: Items flagged with critical syntax/logic errors.
Accepted	An array listing metadata records for all items successfully accepted into processing queues. Contains: • `CustomerTransactionId` • `Amount` • `Currency` • `SendMethodId` • `RecipientId`
Rejected	An array itemizing error breakdowns for transactions that failed immediate validation rules. Contains: • `CustomerTransactionId`: Identifier tracking the specific item entry. • `Key`: General error category (e.g., `INVALID_FIELD`). • `ErrorCode`: Standard HTTP error code representation (e.g., `422`). • `Field`: The dot-notated data path locating the error within your array (e.g., `Items[0].Destination.SKU`). • `Message`: Human-readable feedback describing why validation failed.
Errors	Contains system level or network error details if the request envelope validation fails globally.

To check the status of an asynchronous batch or its specific items when you are not utilizing webhooks. This endpoint returns a high-level batch summary alongside a paginated list of individual transaction statuses.

Request Parameters

Parameter	Description	Required
CustomerBatchId	The unique client-supplied batch transfer identifier passed as a path variable in the request URL.	true
recordsToSkip	The number of transaction records to bypass for pagination. Passed as a query parameter.	false
recordsToTake	The maximum number of transaction records to return per page. Passed as a query parameter.	false
history	Optional query flag. When set to `true`, the response will include the full historic audit trail of execution attempts within the `Attempts` array for each item.	false

\n\n

Response Parameters

Parameter	Description
CustomerBatchId	The unique client-supplied identifier for the batch.
Status	The current global state of the batch processing (e.g., `Processing`, `Completed`, `CompletedWithFailures`, or `Failed`).
Currency	The three-letter ISO currency code shared by all processed items in the batch.
ItemsCount	The total count of individual items included inside the batch envelope.
Items	An array containing the transaction tracking objects for the current paginated view.
CustomerTransactionId	The client-supplied unique identifier for tracking the individual transaction item.
Status	The execution state of this individual item (e.g., `Completed`, `RetainedInWallet`, or `Failed`).
RecipientId	The unique account or user identifier code tracking the transaction beneficiary.
SendMethodId	The specific delivery method identifier utilized for this transaction line item.
Amount	The value transferred to the beneficiary, returned as a decimal string.
LastUpdatedAt	An ISO 8601 timestamp tracking when the transaction's status was last modified.
Attempts	An array detailing processing attempts. Filled dynamically when the `history` parameter is active.
AttemptNo	The numerical index sequencing this execution attempt.
Result	The final outcome label of the processing attempt (e.g., `Success`, `Failed`).
ErrorCode	The internal system error code mapping to runtime outcomes (e.g., `SUCCESS`, `INSUFFICIENT_FUNDS_RUNTIME`).
CreatedAt	An ISO 8601 timestamp logging when the execution attempt was initially enqueued.
CompletedAt	An ISO 8601 timestamp logging when the engine finished execution for this attempt.
Pagination	Object container returning contextual metadata for the batch item pagination loops.
HasMore	A Boolean property stating whether additional item records remain outside the current pagination limit (true / false).
NextRecordsToSkip	The numeric skip index required on the subsequent query call to pull the next sequence of item summaries.
Errors	Contains explicit error objects detailing syntax or invalid field constraints if the GET action fails.

Number of records to skip for pagination.

\n","type":"text/plain"},"key":"recordsToSkip","value":"0"},{"description":{"content":"

Number of records to return.

\n","type":"text/plain"},"key":"recordsToTake","value":"50"},{"key":"history","value":"false"}],"variable":[{"id":"df53d11f-1e32-4768-8e4a-763d5878c292","description":{"content":"

Unique batch transfer identifier.

\n","type":"text/plain"},"type":"any","value":"BATCH-2026-Q3-01","key":"CustomerBatchId"}]}},"response":[{"id":"de4ab8cf-1432-4773-8b89-8e566198c880","name":"200 OK - Batch Transfer Status","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://xapisandbox.xtrm.com/API/v4/Fund/BatchTransfer/:CustomerBatchId?recordsToSkip=0&recordsToTake=50&history=false","host":["https://xapisandbox.xtrm.com/API/v4"],"path":["Fund","BatchTransfer",":CustomerBatchId"],"query":[{"key":"recordsToSkip","value":"0","description":"Number of records to skip for pagination."},{"key":"recordsToTake","value":"50","description":"Number of records to return."},{"key":"history","value":"false"}],"variable":[{"key":"CustomerBatchId","value":"BATCH-2026-Q3-01","description":"Unique batch transfer identifier."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"CustomerBatchId\": \"BATCH-2026-Q3-01\",\n \"Status\": \"CompletedWithFailures\",\n \"Currency\": \"USD\",\n \"ItemsCount\": 11,\n \"Items\": [\n {\n \"CustomerTransactionId\": \"TXN-2026-9906A\",\n \"Status\": \"Failed\",\n \"RecipientId\": \"SPN8888777\",\n \"SendMethodId\": \"XTR94500\",\n \"Amount\": \"100.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:49:01.1150192Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Failed\",\n \"ErrorCode\": \"BANKID_INVALID\",\n \"CreatedAt\": \"2026-06-05T20:49:01.0960844Z\",\n \"CompletedAt\": \"2026-06-05T20:49:01.1150192Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9907A\",\n \"Status\": \"Failed\",\n \"RecipientId\": \"SPN8888777\",\n \"SendMethodId\": \"XTR94500\",\n \"Amount\": \"100.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:50:36.2431000Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 2,\n \"Result\": \"Failed\",\n \"ErrorCode\": \"BANKID_INVALID\",\n \"CreatedAt\": \"2026-06-05T20:50:36.2320388Z\",\n \"CompletedAt\": \"2026-06-05T20:50:36.2431Z\"\n },\n {\n \"AttemptNo\": 1,\n \"Result\": \"Failed\",\n \"ErrorCode\": \"BANKID_INVALID\",\n \"CreatedAt\": \"2026-06-05T20:49:39.5082256Z\",\n \"CompletedAt\": \"2026-06-05T20:50:36.2431Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9908A\",\n \"Status\": \"Success\",\n \"RecipientId\": \"SPN8888776\",\n \"SendMethodId\": \"XTR94504\",\n \"Amount\": \"50.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:49:44.0208205Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Success\",\n \"ErrorCode\": \"SUCCESS\",\n \"CreatedAt\": \"2026-06-05T20:49:44.0159177Z\",\n \"CompletedAt\": \"2026-06-05T20:49:44.0208205Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9904A\",\n \"Status\": \"Success\",\n \"RecipientId\": \"SPN8888777\",\n \"SendMethodId\": \"XTR94507\",\n \"Amount\": \"50.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:49:47.1834547Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Success\",\n \"ErrorCode\": \"SUCCESS\",\n \"CreatedAt\": \"2026-06-05T20:49:47.1834547Z\",\n \"CompletedAt\": \"2026-06-05T20:49:47.1834547Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9905A\",\n \"Status\": \"Success\",\n \"RecipientId\": \"SPN8888777\",\n \"SendMethodId\": \"XTR94508\",\n \"Amount\": \"50.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:49:48.6328481Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Success\",\n \"ErrorCode\": \"SUCCESS\",\n \"CreatedAt\": \"2026-06-05T20:49:48.6328481Z\",\n \"CompletedAt\": \"2026-06-05T20:49:48.6328481Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9903A\",\n \"Status\": \"Failed\",\n \"RecipientId\": \"PAT9999888\",\n \"SendMethodId\": \"XTR94503\",\n \"Amount\": \"50.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:50:36.2535086Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Failed\",\n \"ErrorCode\": \"SKU_NOT_FOUND\",\n \"CreatedAt\": \"2026-06-05T20:50:36.2476557Z\",\n \"CompletedAt\": \"2026-06-05T20:50:36.2535086Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9901A\",\n \"Status\": \"Failed\",\n \"RecipientId\": \"SPN8888777\",\n \"SendMethodId\": \"XTR94500\",\n \"Amount\": \"100.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:51:10.7779235Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Failed\",\n \"ErrorCode\": \"BANKID_INVALID\",\n \"CreatedAt\": \"2026-06-05T20:51:10.7672875Z\",\n \"CompletedAt\": \"2026-06-05T20:51:10.7779235Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9902A\",\n \"Status\": \"Success\",\n \"RecipientId\": \"SPN8888776\",\n \"SendMethodId\": \"XTR94504\",\n \"Amount\": \"50.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:51:11.2554988Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Success\",\n \"ErrorCode\": \"SUCCESS\",\n \"CreatedAt\": \"2026-06-05T20:51:11.2516699Z\",\n \"CompletedAt\": \"2026-06-05T20:51:11.2554988Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9909A\",\n \"Status\": \"Failed\",\n \"RecipientId\": \"PAT9999888\",\n \"SendMethodId\": \"XTR94503\",\n \"Amount\": \"50.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:51:10.8377844Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Failed\",\n \"ErrorCode\": \"SKU_NOT_FOUND\",\n \"CreatedAt\": \"2026-06-05T20:51:10.8297978Z\",\n \"CompletedAt\": \"2026-06-05T20:51:10.8377844Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9910A\",\n \"Status\": \"Success\",\n \"RecipientId\": \"SPN8888777\",\n \"SendMethodId\": \"XTR94507\",\n \"Amount\": \"50.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:51:13.9489537Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Success\",\n \"ErrorCode\": \"SUCCESS\",\n \"CreatedAt\": \"2026-06-05T20:51:13.9489537Z\",\n \"CompletedAt\": \"2026-06-05T20:51:13.9489537Z\"\n }\n ]\n },\n {\n \"CustomerTransactionId\": \"TXN-2026-9911A\",\n \"Status\": \"Success\",\n \"RecipientId\": \"SPN8888777\",\n \"SendMethodId\": \"XTR94508\",\n \"Amount\": \"50.00\",\n \"LastUpdatedAt\": \"2026-06-05T20:51:15.1843569Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Success\",\n \"ErrorCode\": \"SUCCESS\",\n \"CreatedAt\": \"2026-06-05T20:51:15.1843569Z\",\n \"CompletedAt\": \"2026-06-05T20:51:15.1843569Z\"\n }\n ]\n }\n ],\n \"Pagination\": {\n \"HasMore\": false,\n \"NextRecordsToSkip\": 0\n }\n}"}],"_postman_id":"5d91c335-f463-4bb0-abe4-2598d5de8a7c"},{"name":"Batch Transfer Item Status","id":"11bfba8a-e204-4ce6-acd5-434f4982ee58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://xapisandbox.xtrm.com/API/v4/Fund/BatchTransfer/:CustomerBatchId/Items/:CustomerTransactionId?history=false","description":"

Retrieve the current status (and optional attempt history) for a single item within a specific batch transfer.

Request Parameters

\n\n

Parameter	Description	Required
CustomerBatchId	The unique client-supplied batch transfer identifier passed as a path variable in the request URL.	true
CustomerTransactionId	The unique client-supplied transaction identifier tracking the specific item within the batch, passed as a path variable in the request URL.	true
history	Optional query flag. When set to `true`, the response will include the full historic audit trail of execution attempts within the `Attempts` array for this specific item.	false

\n\n

Response Parameters

\n\n

Parameter	Description
CustomerBatchId	The unique client-supplied identifier for the batch containing this item.
CustomerTransactionId	The unique client-supplied transaction identifier tracking this item.
Status	The current execution state of this individual item (e.g., `Completed`, `RetainedInWallet`, `Failed`, `Success`).
RecipientId	The unique account or user identifier code tracking the transaction beneficiary.
SendMethodId	The specific delivery method identifier utilized for this transaction item (e.g., `XTR94500`).
Amount	The value transferred to the beneficiary, returned as a decimal string.
Currency	The standard three-letter ISO 4217 currency code utilized for the transfer.
DeliveryType	The final delivery rail classification for the payment (e.g., `Bank`, `Wallet`).
LastUpdatedAt	An ISO 8601 timestamp tracking when the transaction item's status was last modified.
Attempts	An array detailing individual processing execution logs. Filled dynamically when the `history` query parameter is active.
AttemptNo	The numerical index sequencing this specific execution attempt.
Result	The outcome label of the individual processing attempt (e.g., `Success`, `Failed`).
ErrorCode	The internal system error code mapping to runtime outcomes (e.g., `SUCCESS`, `RECIPIENT_NOT_FOUND`).
CreatedAt	An ISO 8601 timestamp logging when this execution attempt was initially enqueued.
CompletedAt	An ISO 8601 timestamp logging when the engine finished execution for this specific attempt.
Errors	Contains explicit error details if the query format validation or the GET action fails.

Unique batch transfer identifier.

\n","type":"text/plain"},"type":"any","value":"BATCH-2026-Q3-01","key":"CustomerBatchId"},{"id":"1d5a01b2-5aa3-4bf9-996f-e10c045c54c8","description":{"content":"

Unique batch transaction identifier.

\n","type":"text/plain"},"type":"any","value":"TXN-2026-9901A","key":"CustomerTransactionId"}]}},"response":[{"id":"1f42806c-1346-4716-8115-89e309021c7f","name":"200 OK - Batch Transfer Item Status (With Execution Attempts)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://xapisandbox.xtrm.com/API/v4/Fund/BatchTransfer/:CustomerBatchId/Items/:CustomerTransactionId?history=false","host":["https://xapisandbox.xtrm.com/API/v4"],"path":["Fund","BatchTransfer",":CustomerBatchId","Items",":CustomerTransactionId"],"query":[{"key":"history","value":"false"}],"variable":[{"key":"CustomerBatchId","value":"BATCH-2026-Q3-01","description":"Unique batch transfer identifier."},{"key":"CustomerTransactionId","value":"TXN-2026-9901A","description":"Unique batch transaction identifier."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"CustomerBatchId\": \"BATCH-2026-Q3-01\",\n \"CustomerTransactionId\": \"TXN-2026-9901A\",\n \"Status\": \"Success\",\n \"RecipientId\": \"PAT9999888\",\n \"SendMethodId\": \"XTR94500\",\n \"Amount\": \"100.00\",\n \"Currency\": \"USD\",\n \"DeliveryType\": \"Bank\",\n \"LastUpdatedAt\": \"2025-10-29T13:02:23.259Z\",\n \"Attempts\": [\n {\n \"AttemptNo\": 1,\n \"Result\": \"Failed\",\n \"ErrorCode\": \"RECIPIENT_NOT_FOUND\",\n \"CreatedAt\": \"2025-10-28T03:11:35.0055683Z\",\n \"CompletedAt\": \"2025-10-28T13:52:23.2597173Z\"\n },\n {\n \"AttemptNo\": 2,\n \"Result\": \"Success\",\n \"ErrorCode\": \"SUCCESS\",\n \"CreatedAt\": \"2025-10-29T13:01:35.0055683Z\",\n \"CompletedAt\": \"2025-10-29T13:02:23.2597173Z\"\n }\n ]\n}"}],"_postman_id":"11bfba8a-e204-4ce6-acd5-434f4982ee58"},{"name":"Get digital gift cards (by currency)","id":"a2131f20-6ef1-4bbf-ae56-5871c9f02c1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"GetGiftCards\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"Currency\": \"USD\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/GiftCard/GetDigitalGiftCards","description":"

Gets the list of digital gift cards supported by Xtrm. The response includes a unique SKU for each card, which is used as an input parameter for the UserWithdrawFund API call. Digital gift cards serve as an alternative fund withdrawal method for the user. Available gift cards vary by currency.

Request Parameters

\n\n

Parameter	Description	Required
Currency	The standard three-letter ISO 4217 currency code used to filter the supported digital gift cards (e.g., USD, EUR).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
terms	The legal terms, usage conditions, and boilerplate text associated with the redemption and use of the digital gift card.
brandName	The merchant or brand name of the company offering the redemption option (e.g., Amazon, Starbucks).
description	A detailed description highlighting the nature of the redeemed award, experience, or card item.
disclaimer	Important advisory notes, exceptions, or cautions regarding the use or tracking of the reward.
faceValue	The fixed currency value assigned to the face of the card (applicable if `valueType` is fixed).
maxValue	The maximum allowable currency value this variable reward can carry.
minValue	The minimum allowable currency value this variable reward can carry.
status	The current system or availability status of the reward item (e.g., Active).
countries	The list of two-character ISO country abbreviations indicating where this gift card is valid for regional use.
currencyCode	The standard three-letter ISO 4217 currency code assigned to the gift card asset.
rewardName	The complete formal description or product title of the reward item.
rewardType	The system classification for the reward type (e.g., Digital Gift Card).
sku	The unique internal Xtrm product code used as the identifier identifier in withdrawal workflows.
valueType	Specifies the value structural behavior of the asset, indicating whether it is `fixed`, `variable`, or another value pattern.
shortDescription	A brief, scannable summary detailing the nature of the redeemed award or experience.
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Discover a wide selection of premium merchandise and everyday essentials at the Acme Retail Emporium! Redeemable online and across all storefront locations.

\",\n \"disclaimer\": \"

*Acme Retail Emporium is not a sponsor of the rewards or otherwise affiliated with this program. Please visit the merchant website for additional terms and conditions.

\",\n \"shortDescription\": \"

Shop the finest collections of apparel, home goods, and electronics with the Acme Retail Emporium Gift Card.

\",\n \"terms\": \"

This card is redeemable only for merchandise and services at participating locations. Funds do not expire and no maintenance fees apply. Treat this card like cash.

\",\n \"items\": [\n {\n \"sku\": \"MOCK-SKU-1001\",\n \"rewardName\": \"Acme Retail Emporium Gift Card $25.00\",\n \"currencyCode\": \"USD\",\n \"status\": \"Active\",\n \"valueType\": \"FIXED_VALUE\",\n \"rewardType\": \"gift card\",\n \"maxValue\": 0.0,\n \"minValue\": 0.0,\n \"faceValue\": 25.0,\n \"countries\": [\n \"US\",\n \"AS\",\n \"PR\",\n \"UM\",\n \"VI\"\n ]\n },\n {\n \"sku\": \"MOCK-SKU-1002\",\n \"rewardName\": \"Acme Retail Emporium Gift Card $50.00\",\n \"currencyCode\": \"USD\",\n \"status\": \"Active\",\n \"valueType\": \"FIXED_VALUE\",\n \"rewardType\": \"gift card\",\n \"maxValue\": 0.0,\n \"minValue\": 0.0,\n \"faceValue\": 50.0,\n \"countries\": [\n \"US\",\n \"AS\",\n \"PR\",\n \"UM\",\n \"VI\"\n ]\n }\n ]\n },\n {\n \"brandName\": \"Global Bistro & Grill\",\n \"imageUrls\": [\n {\n \"Img80W\": \"https://example.com/images/brands/bistro-80w.png\",\n \"Img130w\": \"https://example.com/images/brands/bistro-130w.png\",\n \"Img200W\": \"https://example.com/images/brands/bistro-200w.png\",\n \"Img300W\": \"https://example.com/images/brands/bistro-300w.png\"\n }\n ],\n \"description\": \"

Enjoy an exceptional dining experience featuring handcrafted meals and seasonal specials. This card is valid for variable loads to match any appetite.

\",\n \"disclaimer\": \"

*Global Bistro & Grill is a registered trademark. Not redeemable for cash unless required by law.

\",\n \"shortDescription\": \"

Savor fresh flavors and premium hospitality with the Global Bistro & Grill eGift Card.

\",\n \"terms\": \"

Valid for food, beverage, and gratuity at participating corporate restaurants. Lost or stolen cards will not be replaced without proof of purchase.

\",\n \"items\": [\n {\n \"sku\": \"MOCK-SKU-2001\",\n \"rewardName\": \"Global Bistro & Grill eGift Card\",\n \"currencyCode\": \"USD\",\n \"status\": \"Active\",\n \"valueType\": \"VARIABLE_VALUE\",\n \"rewardType\": \"gift card\",\n \"maxValue\": 500.0,\n \"minValue\": 5.0,\n \"faceValue\": 0.0,\n \"countries\": [\n \"US\",\n \"AS\",\n \"PR\",\n \"UM\",\n \"VI\"\n ]\n }\n ]\n }\n ],\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": null\n }\n }\n }\n}"}],"_postman_id":"a2131f20-6ef1-4bbf-ae56-5871c9f02c1f"},{"name":"Get gift card details (by SKU)","id":"a82f77c4-5c0f-468a-b69a-ec0bc2585604","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"GetGiftCards\": {\n \"Request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"SKU\": \"MOCK-SKU-1001\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/GiftCard/GetGiftCardDetails","description":"

Gets the specifics of a gift card supported by Xtrm. The list has a unique SKU which is used as input to the UserWithdrawFund API call.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
SKU	The unique stock keeping unit (SKU) identifier for the digital gift card product.	true

\n\n

Response Parameters

\n\n

Parameter	Description
shortDescription	A brief, scannable summary detailing the nature of the redeemed award or merchant experience.
terms	The specific legal terms, usage conditions, and boilerplate text associated with redeeming and using this digital gift card.
brandName	The merchant or brand name of the company offering the gift card redemption (e.g., Amazon, Starbucks).
description	A detailed text description highlighting the nature, features, and utilization of the redeemed award item.
disclaimer	Important legal disclaimers, exceptions, or specific cautions regarding the reward asset.
minValue	The minimum allowable currency value this reward card can carry (applicable for variable value types).
status	The current system or operational availability status of the gift card product (e.g., Active).
faceValue	The fixed currency value assigned to the card asset (applicable if the card operates on a fixed value structure).
maxValue	The maximum allowable currency value this reward card can carry (applicable for variable value types).
rewardName	The complete formal product title or description of the reward card.
rewardType	The underlying system classification for this reward item (e.g., Digital Gift Card).
sku	The unique internal Xtrm product code matching the requested SKU value.
valueType	Specifies the pricing behavior of the asset, indicating whether it is `fixed`, `variable`, or another structural value pattern.
countries	A list of two-character ISO country abbreviations indicating the specific regional jurisdictions where this card is valid for use.
currencyCode	The standard three-letter ISO 4217 currency code assigned to the gift card asset.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Discover a wide selection of premium merchandise and everyday essentials at the Acme Retail Emporium! Redeemable online and across all storefront locations.

\",\n \"disclaimer\": \"

*Acme Retail Emporium is not a sponsor of the rewards or otherwise affiliated with this program. Please visit the merchant website for additional terms and conditions.

\",\n \"shortDescription\": \"

Shop the finest collections of apparel, home goods, and electronics with the Acme Retail Emporium Gift Card.

\",\n \"terms\": \"

This card is redeemable only for merchandise and services at participating locations. Funds do not expire and no maintenance fees apply. Treat this card like cash.

\",\n \"items\": [\n {\n \"sku\": \"MOCK-SKU-1001\",\n \"rewardName\": \"Acme Retail Emporium Gift Card $25.00\",\n \"currencyCode\": \"USD\",\n \"status\": \"Active\",\n \"valueType\": \"FIXED_VALUE\",\n \"rewardType\": \"gift card\",\n \"maxValue\": 0.0,\n \"minValue\": 0.0,\n \"faceValue\": 25.0\n }\n ]\n },\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": null\n }\n }\n }\n}"}],"_postman_id":"a82f77c4-5c0f-468a-b69a-ec0bc2585604"},{"name":"Get prepaid card details","id":"472bc3e1-870c-46f1-9472-a9f692007393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"GetPrepaidCards\": {\n \"Request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"SKU\": \"PREP9001\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/GiftCard/GetPrepaidCardDetails","description":"

Gets the specifics of a prepaid card supported by Xtrm. The list has a unique SKU which is used as input to the UserWithdrawFund API call.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
SKU	The unique stock keeping unit (SKU) identifier for the prepaid card product.	true

\n\n

Response Parameters

\n\n

Parameter	Description
brandName	The merchant or brand name of the company issuing the prepaid card (e.g., Visa, Mastercard).
description	A detailed text description highlighting the nature, features, and utilization of the prepaid card asset.
disclaimer	Important legal disclaimers, exceptions, or specific cautions regarding the use of this prepaid card reward.
sku	The unique internal Xtrm product code matching the requested SKU value.
valueType	Specifies the pricing behavior of the asset, indicating whether it is `fixed`, `variable`, or another structural value pattern.
countries	A list of two-character ISO country abbreviations indicating the specific regional jurisdictions where this card is valid for use.
currencyCode	The standard three-letter ISO 4217 currency code assigned to the prepaid card asset.
rewardName	The complete formal product title or description of the prepaid card reward.
rewardType	The underlying system classification for this reward item (e.g., Prepaid Card).
faceValue	The fixed currency value assigned to the card asset (applicable if the card operates on a fixed value structure).
maxValue	The maximum allowable currency value this prepaid card can carry (applicable for variable value types).
minValue	The minimum allowable currency value this prepaid card can carry (applicable for variable value types).
status	The current system or operational availability status of the prepaid card product (e.g., Active).
shortDescription	A brief, scannable summary detailing the nature of the prepaid card reward.
terms	The specific legal terms, usage conditions, and boilerplate text clauses associated with redeeming and using this prepaid card.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

A Visa Prepaid Card gives you the flexibility to shop anywhere Visa debit cards are accepted around the world. You will receive an email with instructions for selecting either a virtual or physical card. Choose a virtual card thats available immediately, or a physical card sent via mail (shipping and handling fee of $3.00 to be deducted from card balance).

You must select your card within 4 months from the date these instructions are sent via email. So make sure to keep an eye on your inbox. Once the card is redeemed, you will have 7 months to use the funds. Please note that currency conversion fees will be applied if the merchant settles in a currency other than USD.

\",\n \"disclaimer\": \"

Use your Visa prepaid card anywhere Visa debit cards are accepted around the world. Card is issued by Example Bank, N.A, Member FDIC, pursuant to a license from Visa U.S.A. Inc. Your use of the prepaid card is governed by the Cardholder Agreement, and some fees may apply. This is not a gift card. Please note that prepaid cards are subject to expiration, so pay close attention to the expiration date of the card.

\",\n \"imageUrls\": [\n {\n \"Img80W\": \"https://example.com/images/brands/visa-mock-80w.png\",\n \"Img130w\": \"https://example.com/images/brands/visa-mock-130w.png\",\n \"Img200W\": \"https://example.com/images/brands/visa-mock-200w.png\",\n \"Img300W\": \"https://example.com/images/brands/visa-mock-300w.png\"\n }\n ],\n \"shortDescription\": \"

\",\n \"terms\": \"

This reward is non-refundable. The full terms and conditions are available on the digital rewards claim site.

Your reward will be delivered via email with instructions for claiming your Visa prepaid card. You must claim your card within 4 months from the date these instructions are sent via email. Your right to the payment expires after that time. Use your Visa prepaid card anywhere Visa debit cards are accepted around the world. Card is issued by Example Bank, N.A, Member FDIC, pursuant to a license from Visa U.S.A. Inc. Your use of the prepaid card is governed by the Cardholder Agreement, and some fees may apply. This is not a gift card. Please note that prepaid cards are subject to expiration, so pay close attention to the expiration date of the card.

\",\n \"items\": [\n {\n \"sku\": \"PREP9001\",\n \"rewardName\": \"Visa® Prepaid Card USD\",\n \"currencyCode\": \"USD\",\n \"status\": \"Active\",\n \"valueType\": \"VARIABLE_VALUE\",\n \"rewardType\": \"cash equivalent\",\n \"maxValue\": 1000.0,\n \"minValue\": 5.0,\n \"faceValue\": 0.0\n }\n ]\n },\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": null\n }\n }\n }\n}"}],"_postman_id":"472bc3e1-870c-46f1-9472-a9f692007393"},{"name":"Get prepaid cards","id":"95c081ea-9ac3-44ed-bbac-1176a3d96044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"GetPrepaidCards\": {\n \"Request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"Currency\": \"USD\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/GiftCard/GetPrepaidCards","description":"

Gets the list of prepaid cards supported by Xtrm. Prepaid Card is added as an additional withdraw fund method for the user. Available prepaid cards vary by currency.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
Currency	The standard three-letter ISO 4217 currency code used to filter the supported prepaid cards (e.g., USD, EUR).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
terms	The legal terms, usage conditions, and boilerplate text clauses clauses associated with the distribution and use of the prepaid card.
brandName	The merchant network or company network brand offering the prepaid card asset (e.g., Visa, Mastercard).
description	A detailed text description highlighting the nature, utilization mechanics, and features of the prepaid card product.
disclaimer	Important legal disclaimers, exceptions, or specific warnings regarding the reward card.
faceValue	The fixed currency value assigned to the face of the card (applicable if the card operates on a fixed value structure).
maxValue	The maximum allowable currency value this variable prepaid card can carry.
minValue	The minimum allowable currency value this variable prepaid card can carry.
status	The current availability or operational state of the prepaid card product within the system (e.g., Active).
countries	A list of two-character ISO country abbreviations indicating the regional jurisdictions where this prepaid card is valid for use.
currencyCode	The standard three-letter ISO 4217 currency code assigned to the prepaid asset.
rewardName	The complete formal product title or designation tracking the prepaid card reward.
rewardType	The underlying system classification for this reward item (e.g., Prepaid Card).
sku	The unique internal Xtrm product code used as the identifier parameter in withdrawal workflows.
valueType	Specifies the pricing behavior of the asset, indicating whether it is `fixed`, `variable`, or another structural value pattern.
shortDescription	A brief, scannable summary detailing the nature of the prepaid card reward.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

\",\n \"disclaimer\": \"

\",\n \"terms\": \"

\",\n \"items\": [\n {\n \"sku\": \"PREP9001\",\n \"rewardName\": \"Visa® Prepaid Card USD\",\n \"currencyCode\": \"USD\",\n \"status\": \"Active\",\n \"valueType\": \"VARIABLE_VALUE\",\n \"rewardType\": \"cash equivalent\",\n \"maxValue\": 1000.0,\n \"minValue\": 5.0,\n \"faceValue\": 0.0,\n \"countries\": [\n \"US\",\n \"AS\",\n \"IO\",\n \"EC\",\n \"SV\",\n \"GU\",\n \"MH\",\n \"FM\",\n \"NF\",\n \"MP\",\n \"PW\",\n \"PA\",\n \"PR\",\n \"TC\",\n \"UA\",\n \"UM\",\n \"VG\",\n \"VI\",\n \"ZW\"\n ]\n }\n ]\n }\n ],\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": null\n }\n }\n }\n}"}],"_postman_id":"95c081ea-9ac3-44ed-bbac-1176a3d96044"}],"id":"13dd5f94-4200-45fd-b60a-09f299037c36","description":"

Endpoints for moving funds between entities, accounts, and wallets.

Important: You MUST process transfer calls sequentially. You must wait to receive a successful response from your current transfer call before initiating the next one.

\n","_postman_id":"13dd5f94-4200-45fd-b60a-09f299037c36","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Wallets","item":[{"name":"Book exchange (exchange currency)","id":"edbc0cfd-1e4a-4da8-88a7-5bc0cab651b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"BookExchange\": {\n \"Request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"AccountNumber\": \"SPN1111222\",\n \"FromWalletID\": \"12345\",\n \"FromCurrency\": \"USD\",\n \"ToCurrency\": \"EUR\",\n \"Amount\": \"341.25\",\n \"ToWalletID\": \"67890\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Payment/BookExchange","description":"

Exchange currency. Funds in the original currency are withdrawn from a wallet (that holds the original currency), and exchanged for funds in a second currency. Those funds are then deposited into a second wallet (that holds the new currency).

Request Parameters

\n\n

Parameter	Description	Required
ToCurrency	The standard three-letter ISO 4217 currency code for the target currency being purchased (e.g., EUR, GBP).	true
ToWalletID	The unique internal identifier or name of the destination wallet where the exchanged funds will be deposited. If omitted, the funds will default to the target currency's default wallet.	false
AccountNumber	A unique Xtrm account identifier executing the exchange, starting with `SPN` for company accounts or `PAT` for personal accounts.	true
Amount	The specific fund value to be exchanged, passed as a string. This value is denominated in the originating source currency (`FromCurrency`).	true
FromCurrency	The standard three-letter ISO 4217 currency code for the originating currency being sold (e.g., USD).	true
FromWalletID	The unique internal identifier or name of the originating wallet from which the funds will be debited.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
CreditTransactionID	The globally unique identifier generated to track the credit (deposit) transaction entry into the target destination wallet.
DebitTransactionID	The globally unique identifier generated to track the debit (withdrawal) transaction entry from the originating source wallet.
PaymentDate	The recorded timestamp indicating when the book exchange transaction was successfully processed.
PaymentStatus	The current operational status of the exchange transaction (e.g., completed, pending).
Success	Success or failure of operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetches the real-time exchange rate between two currencies. This rate is real-time, and may fluctuate slightly between a call to GetExchangeRate and BookExchange.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
FromCurrency	The standard three-letter ISO 4217 currency code for the source currency being converted from (e.g., USD).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
ToCurrency	The standard three-letter ISO 4217 currency code for the target currency being converted to (e.g., EUR).	true

\n\n

Response Parameters

\n\n

Parameter	Description
ToCurrency	The standard three-letter ISO 4217 currency code for the target currency.
Amount	The base or converted financial value matching the currency conversion layer, returned as a string.
ExchangeRate	The active real-time foreign exchange multiplier rate applied between the source and target currencies.
FromCurrency	The standard three-letter ISO 4217 currency code for the source currency.
IssuerAccountNumber	The unique Xtrm account identifier associated with the account that initiated the API call.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Create a wallet for a beneficiary company with an account-specific name and currency. This endpoint is valid only for a beneficiary company. Companies are not limited to a single wallet per currency. For a managing company or remitting company, use /Wallet/CreateCompanyWallet. For an individual beneficiary, use /Wallet/CreateUserWallet.

Request Parameters

\n\n

Parameter	Description	Required
BeneficiaryAccountNumber	The unique Xtrm account identifier for the receiving beneficiary company, starting with `SPN`.	true
EntityID	An external or internal tracking identifier used to cross-reference this wallet with a specific sub-entity, corporate partner, or unique organizational group in your native database.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
WalletCurrency	The standard three-letter ISO 4217 currency code designated for the new wallet (e.g., USD, EUR).	true
WalletName	A customized descriptive label assigned to the wallet. This name must be unique within this specific account's collection of wallets.	true
WalletType	The operational classification for the new wallet. Set to `Standard` for regular funding and debit distributions, or `Accrual` for holding pending milestone rewards and point systems.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of the operation (true / false).
WalletCurrency	The standard three-letter ISO 4217 currency code assigned to the newly created wallet.
WalletID	The globally unique asset identifier generated by Xtrm to track this newly created wallet.
WalletName	The confirmed custom label matching the wallet name specified in the request.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Create a wallet for a remitting or managing company with an account-specific name and currency. This endpoint is valid only for a remitting company or managing company.

Companies are not limited to a single wallet per currency.

For a beneficiary company, use /Wallet/CreateBeneficiaryCompanyWallet. For an individual beneficiary, use /Wallet/CreateUserWallet.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
WalletCurrency	The standard three-letter ISO 4217 currency code designated for the new wallet (e.g., USD, EUR).	true
WalletName	A customized descriptive label assigned to the wallet. This name must be unique within this specific account's collection of wallets.	true
WalletType	The operational classification for the new wallet. Set to `Standard` for regular funding and debit distributions, or `Accrual` for holding pending milestone rewards and point systems.	true
AllowAccessAccountNumber	The unique Xtrm account identifier, starting with `SPN`, specifying which company account is granted access to this wallet.	true
EntityID	An external or internal tracking identifier used to cross-reference this wallet with a specific sub-entity, corporate partner, or unique organizational group in your native database.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of the operation (true / false).
WalletCurrency	The standard three-letter ISO 4217 currency code assigned to the newly created wallet.
WalletID	The globally unique asset identifier generated by Xtrm to track this newly created wallet.
WalletName	The confirmed custom label matching the wallet name specified in the request.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Create a wallet for a beneficiary with an account-specific name and currency. This endpoint is valid only for a beneficiary user.

Although a beneficiary user may have multiple wallets, beneficiary users are limited to a single unique wallet per currency.

For a beneficiary company, use /Wallet/CreateBeneficiaryCompanyWallet.
For a remitting or managing company, use /Wallet/CreateCompanyWallet.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
UserID	The unique Xtrm account identifier for the receiving personal beneficiary, starting with `PAT`.	true
WalletCurrency	The standard three-letter ISO 4217 currency code designated for the new wallet (e.g., USD, EUR).	true
WalletName	A customized descriptive label assigned to the wallet. This name must be unique within this specific account's collection of wallets.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of the operation (true / false).
WalletCurrency	The standard three-letter ISO 4217 currency code assigned to the newly created wallet.
WalletID	The globally unique asset identifier generated by Xtrm to track this newly created wallet.
WalletName	The confirmed custom label matching the wallet name specified in the request.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Companies may fund their own company wallets using the company’s own credit card.

Note: This call is not intended to take payments from consumers; it is meant only for companies to fund their own wallets.

Request Parameters

\n\n

Parameter	Description	Required
ExpireYear	The expiration year of the credit card, formatted as a 4-digit year (e.g., 2026).	true
CVV	The Card Verification Value (CVV), a 3- or 4-digit security code located on the credit card.	true
CardToken	A secure, unique token generated to safely reference the credit/debit card data.	true
CreditCardNumber	The primary account number (PAN) of the funding credit card.	true
CreditCardType	The brand or network identifier of the credit card (e.g., Visa, Mastercard).	true
ExpireMonth	The expiration month of the credit card, formatted numerically from '1' to '12'.	true
AddressLine1	The primary billing street address associated with the credit card.	true
City	The billing city name (1 to 25 characters).	true
CountryISO2	The two-character ISO 3166-1 alpha-2 country abbreviation for the billing address.	true
PostalCode	The ZIP or postal code for the billing address.	true
State	The billing state, province, or region jurisdiction.	true
FirstName	The legal first name of the cardholder (2 to 40 characters).	true
LastName	The legal last name of the cardholder (2 to 40 characters).	true
Amount	The specific monetary value to fund into the wallet, passed as a string.	true
CurrencyCode	The standard three-letter ISO 4217 currency code for the funding transaction.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
WalletID	The unique internal identifier or name of the destination wallet to be funded.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Amount	The base amount funded into the destination wallet, returned as a string.
Currency	The standard three-letter ISO 4217 currency code of the funded amount.
Fee	The processing fee applied to the credit card transaction, returned as a string.
Success	Success or failure of the operation (true / false).
TotalAmount	The total amount charged to the card (funding amount plus fees), returned as a string.
TransactionID	The globally unique identifier generated to track this funding transaction.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API call allows companies to fund their own wallets using Bank (or systems similar to ACH) debit linked banks. Bank debit may take from 3 to 5 business days to complete

Request Parameters

\n\n

Parameter	Description	Required
WalletID	The unique internal identifier or name of the destination wallet to be funded.	true
Amount	The specific monetary value to fund into the wallet, passed as a string.	true
CurrencyCode	The standard three-letter ISO 4217 currency code for the funding transaction.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
LinkedBankID	The unique identification code for the linked bank account to be debited. You can retrieve this value by calling the `GetACHDebitLinkedBankAccounts` endpoint.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Fee	The processing fee applied to the bank debit transaction, returned as a string.
Success	Success or failure of the operation (true / false).
Status	A text string representing the current state of the ACH fund request (e.g., Pending, Completed, Failed).
TotalAmount	The total amount debited from the bank (funding amount plus fees), returned as a string.
TransactionID	The globally unique identifier generated to track this funding transaction.
Amount	The base amount funded into the destination wallet, returned as a string.
Currency	The standard three-letter ISO 4217 currency code of the funded amount.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API call allows companies to fund their own wallets using bank transfer. Fund wallet can be made by sending funds to our bank account below and vary depending on currency. After you ACH or WIRE funds, please allow 2-7 business days for them to be credited depending on your location. A pending fund transaction will appear in your account until it is completed.

Request Parameters

\n\n

Parameter	Description	Required
RequiredPaymentDate	The requested date for the payment to be initiated.	false
WalletID	The unique internal identifier or name of the destination wallet to be funded.	true
Additionalinformtaion	Optional memo or routing instructions for the bank transfer (e.g., \"Q3 Partner Funding Replenishment\").	false
Amount	The specific monetary value to fund into the wallet, passed as a string.	true
BeneficiaryAccountNumber	The unique Xtrm account identifier for the receiving company, starting with `SPN`.	true
InvoiceRequired	When set to `true`, Xtrm will automatically generate and send an invoice for this transaction via email.	false
ProgramID	An optional identifier linking this funding transaction to a specific rewards, payout, or budget program.	false
CurrencyCode	The standard three-letter ISO 4217 currency code for the funding transaction.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RequiredDepositDate	The requested date for the funds to be deposited and cleared.	false

\n\n

Response Parameters

\n\n

Parameter	Description
WalletID	The unique internal identifier or name of the destination wallet.
BankInformation	Detailed bank routing and account information for the Xtrm account where you need to send the funds.
Description	A descriptive text string (1 to 100 characters) detailing the transaction.
Method	The name of the payment method used for this transaction (e.g., Bank Transfer).
Success	Success or failure of the operation (true / false).
TotalAmount	The total amount expected to be received, including any applicable fees, returned as a string.
TransactionID	The globally unique identifier generated to track this funding transaction.
Amount	The base amount funded into the destination wallet, returned as a string.
Currency	The standard three-letter ISO 4217 currency code of the funded amount.
Fee	The processing fee applied to the bank transfer transaction, returned as a string.
Status	A text string representing the current state of the funding request. This payment remains pending until the transaction has been fully completed and cleared.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch the wallets belonging to a beneficiary

Note: If a wallet has a default bank linked and the override setting is turned off (AllowWalletLinkedBankOverride is false), any specific bank entered in subsequent transfer/withdrawal requests will be ignored, and the default linked bank will be used instead.

Request Parameters

\n\n

Parameter	Description	Required
BeneficiaryAccountNumber	The unique Xtrm account identifier for the beneficiary, starting with `SPN` for company accounts or `PAT` for personal accounts.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
ID	The unique asset identifier generated by Xtrm to track this specific wallet.
IsBankLinked	Indicates whether a bank account has been securely linked to this specific wallet (true / false).
Name	The custom descriptive label assigned to the wallet. This name is unique within this specific account's collection of wallets.
Type	The operational classification of the wallet (e.g., `Standard` or `Accrual`).
AllowWalletLinkedBankOverride	Indicates whether the system allows overriding the default linked bank account for transactions originating from this wallet (true / false).
Balance	The current available monetary balance held in the wallet, returned as a string.
Currency	The standard three-letter ISO 4217 currency code assigned to the wallet.
EntityID	An external or internal tracking identifier used to cross-reference this wallet with a specific sub-entity, corporate partner, or unique organizational group in your native database.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch the detailed breakdown of a specific company wallet transaction using its unique transaction ID.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
TransactionID	The globally unique identifier generated by Xtrm to track the specific transaction.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Field	A collection (array) containing the specific breakdown of transaction details, structured as Name/Value pairs.
Name	The programmatic key or name of the transaction detail field (e.g., Method, Status, Amount, Transferred to).
Value	The actual data value corresponding to the field's name (e.g., 40.00, Transaction Complete).
PayDirectTransactionDetails	An array containing specific direct payment information if the transaction was processed as a Pay Direct transfer.
Success	Success or failure of the operation (true / false). Returned inside the `OperationStatus` object.
Errors	Contains specific validation or execution error details if the API call fails. Returns null or empty upon a successful operation. Returned inside the `OperationStatus` object.

Get all the wallet transactions for a specified wallet.

Request Parameters

\n\n

Parameter	Description	Required
EndUTC	The end date and time for the transaction search filter, in UTC format.	false
StartUTC	The start date and time for the transaction search filter, in UTC format.	false
SearchParam	A text string used to search or filter transactions by specific keywords, names, or descriptions.	false
TransactionType	The specific type of transaction to filter by (e.g., `All`, `Credits`, `Debits`, `Currency Exchange`, `Transfer`).	false
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to skip for pagination purposes (e.g., skip 0 to start at the first record).	true
RecordsToTake	The maximum number of transaction results to return per page.	true
WalletID	The unique internal identifier of the specific wallet to retrieve transactions for.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Amount	The specific monetary value of the transaction, returned as a string.
PaymentType	The classification of the payment (e.g., Personal, credits, debits).
TransactionID	The globally unique identifier generated by Xtrm to track the specific transaction.
Balance	The remaining available monetary balance in the wallet after the transaction, returned as a string.
Currency	The standard three-letter ISO 4217 currency code for the transaction.
ProgramName	The customer-supplied name of the program associated with the transaction, if applicable.
TransactionDate	The recorded timestamp indicating when the transaction was processed.
Type	The operational type of the transaction (e.g., Credit, Debit).
description	A descriptive text string detailing the nature and purpose of the transaction.
Success	Success or failure of the operation (true / false).
RecordsToSkip	The number of records skipped in the current paginated response.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of available transaction records matching the search criteria.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Get a list of wallets for a particular company

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
WalletCurrency	The standard three-letter ISO 4217 currency code assigned to the wallet.
WalletID	The unique programmatic identifier generated by Xtrm for the wallet.
WalletName	The custom descriptive label assigned to the wallet. This name is unique within this specific account's collection of wallets.
WalletType	The operational classification of the wallet (e.g., `Standard` or `Accrual`).
AllowWalletLinkedBankOverride	Indicates whether the system allows overriding the default linked bank account for transactions originating from this wallet (true / false).
EntityID	An external or internal tracking identifier used to cross-reference this wallet with a specific sub-entity, corporate partner, or unique organizational group in your native database.
IsBankLinked	Indicates whether a bank account has been securely linked to this specific wallet (true / false).
WalletBalance	The current available monetary balance held in the wallet, returned as a string.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Get an personal account wallet balance for the specified currency

Request Parameters

\n\n

Parameter	Description	Required
UserId	The unique Xtrm account identifier for the personal account, starting with `PAT`.	true
Currency	The standard three-letter ISO 4217 currency code for the wallet (e.g., USD, EUR).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Balance	The current available balance of the wallet, returned as a raw JSON float (e.g., `1398.62`) rather than a string or integer.
Currency	The standard three-letter ISO 4217 currency code of the wallet.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Get detailed information for a specific transaction. The required TransactionID can be obtained by first querying the GetUserWalletTransactions endpoint.

Request Parameters

\n\n

Parameter	Description	Required
TransactionID	The globally unique identifier generated by Xtrm to track the specific transaction.	true
UserID	The unique Xtrm account identifier for the personal account, starting with `PAT`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Name	The programmatic key or name of the transaction detail field (e.g., Status, Amount, Method).
Value	The actual data value corresponding to the field's name.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Get a list of transactions for a specific personal account wallet. While a personal account may have multiple wallets, they are limited to one wallet per currency, which is why the WalletCurrency parameter is used to identify the target wallet.

Request Parameters

\n\n

Parameter	Description	Required
EndUTC	The end date and time for the transaction search filter, in UTC format.	false
StartUTC	The start date and time for the transaction search filter, in UTC format.	false
SearchParam	A text string used to search or filter transactions by specific keywords, names, or descriptions.	false
TransactionType	The specific type of transaction to filter by (e.g., `All`, `Credits`, `Debits`, `Currency Exchange`, `Transfer`).	false
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to skip for pagination purposes (e.g., skip 0 to start at the first record).	true
RecordsToTake	The maximum number of transaction results to return per page.	true
UserID	The unique Xtrm account identifier for the personal account, starting with `PAT`.	true
WalletCurrency	The standard three-letter ISO 4217 currency code identifying the specific user wallet to query.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of the operation (true / false).
RecordsToSkip	The number of records skipped in the current paginated response.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of available transaction records matching the search criteria.
TransactionID	The globally unique identifier generated by Xtrm to track the specific transaction.
Type	The operational type of the transaction (e.g., Credit, Debit).
description	A brief text string detailing the nature and purpose of the transaction.
Amount	The specific monetary value of the transaction, returned as a string.
CompanyName	The name of the company associated with the transaction (e.g., the remitting or funding company).
PaymentMethod	Details regarding the payment method utilized for the transaction (may return blank if not applicable).
ProgramName	The customer-supplied name of the program associated with the transaction, if applicable.
TransactionDate	The recorded timestamp indicating when the transaction was processed.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Fetch a list of transactions for a specific personal account originating from a specific remitter. The resulting records will detail the amounts sent by the remitter to the user.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
RecordsToSkip	The number of records to skip for pagination purposes (e.g., skip 0 to start at the first record).	true
RecordsToTake	The maximum number of transaction results to return per page.	true
RemitterAccountNo	The unique Xtrm account identifier for the remitting company, starting with `SPN`.	true
UserID	The unique Xtrm account identifier for the personal account, starting with `PAT`.	true
WalletCurrency	The standard three-letter ISO 4217 currency code identifying the specific user wallet to query.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Currency	The standard three-letter ISO 4217 currency code for the transaction.
Type	The operational type of the transaction (e.g., Credit, Debit).
description	A brief text string detailing the nature and purpose of the transaction.
ProgramName	The customer-supplied name of the program associated with the transaction, if applicable.
TransactionDate	The recorded timestamp indicating when the transaction was processed.
TransactionID	The globally unique identifier generated by Xtrm to track the specific transaction.
Amount	The specific monetary value of the transaction, returned as a string.
CompanyName	The name of the remitting company that initiated the transaction.
PaymentMethod	Details regarding the payment method utilized for the transaction.
Success	Success or failure of the operation (true / false).
RecordsToSkip	The number of records skipped in the current paginated response.
RecordsToTake	The maximum number of results requested per page.
RecordsTotal	The total number of available transaction records matching the search criteria.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Get the wallets for a particular user.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
UserID	The unique Xtrm account identifier for the personal account, starting with `PAT`.	true

\n\n

Response Parameters

\n\n

Parameter	Description
WalletCurrency	The standard three-letter ISO 4217 currency code assigned to the wallet.
WalletID	The unique identifier generated by Xtrm for the wallet.
WalletName	The custom descriptive label assigned to the wallet. This name is unique within this specific account's collection of wallets.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Update the display name of a specific wallet belonging to a beneficiary company. The other elements of a wallet (the WalletID and currency) cannot be changed.

Request Parameters

\n\n

Parameter	Description	Required
BeneficiaryAccountNumber	The unique Xtrm account identifier for the receiving beneficiary company, starting with `SPN`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
WalletID	The unique programmatic identifier generated by Xtrm for the wallet being updated.	true
WalletName	The new customized descriptive label to be assigned to the wallet. This name must be unique within this specific account's collection of wallets.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of the operation (true / false).
Status	A text string indicating the result of the update operation.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Change the account-specific name of a company’s wallet. The other elements of a wallet (the WalletID and currency) cannot be changed.

Request Parameters

\n\n

Parameter	Description	Required
WalletName	The new customized descriptive label to be assigned to the wallet. This name must be unique within this specific account's collection of wallets.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
WalletID	The unique programmatic identifier generated by Xtrm for the wallet being updated.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Success	Success or failure of the operation (true / false).
Status	A text string indicating the result of the update operation.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Change the account-specific name of a personal account wallet. Other elements of a wallet (the WalletID and currency) cannot be changed.

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
UserID	The unique Xtrm account identifier for the personal account, starting with `PAT`.	true
WalletID	The unique programmatic identifier generated by Xtrm for the wallet being updated.	true
WalletName	The new customized descriptive label to be assigned to the wallet. This name must be unique within this specific account's collection of wallets.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Status	A text string indicating the result of the update operation.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoints to retrieve wallet balances, fetch transaction histories, fund wallets, and update account-specific wallet names.

\n","_postman_id":"0cabf189-224d-4f8b-b506-e3b9f63e2afb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Advanced Profile","item":[{"name":"Set advanced profile","id":"c1f7e592-db5e-487a-b7c2-7c0a755a0242","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"AdvancedProfile\": {\n \"request\": {\n \"AuthorizedContactInformation\": {\n \"Address_Line_1\": \"100 Acme Way\",\n \"Business_Phone\": \"14085551234\",\n \"Citizenship\": \"US\",\n \"City\": \"San Francisco\",\n \"Country_Code2\": \"US\",\n \"Date_Of_Birth\": \"10/10/1980\",\n \"Email_Address\": \"admin@acme.com\",\n \"First_Name\": \"Jane\",\n \"Job_Title\": \"Director\",\n \"Last_Name\": \"Doe\",\n \"Postal_Code\": \"94105\",\n \"Region_Code2\": \"CA\"\n },\n \"BeneficiaryAccountNumber\": \"SPN9999888\",\n \"BusinessEntityInformation\": {\n \"Address_Line_1\": \"100 Acme Way\",\n \"Address_Line_2\": \"Building B\",\n \"Address_Line_3\": \"Suite 400\",\n \"City\": \"San Francisco\",\n \"Company_Type\": \"C Corporation\",\n \"Countries_Receiving_From\": \"US, GB\",\n \"Countries_Sending_To\": \"US, GB\",\n \"Country_Code2\": \"US\",\n \"Country_Of_Incorporation_Code2\": \"US\",\n \"Expected_Annual_Volume\": \"500000.00\",\n \"Expected_Currencies\": \"USD,CAD,GBP\",\n \"Expected_Transaction_Amount\": \"5000.00\",\n \"Fictitious_Name\": \"Acme Corp\",\n \"Identification_Number\": \"XX123456\",\n \"Identification_Type\": \"Passport\",\n \"Industry_Classification\": \"Information Technology\",\n \"Postal_Code\": \"94105\",\n \"Purpose_Of_Transactions\": \"Business to Business Vendor Payments\",\n \"Region_Code2\": \"CA\",\n \"Region_Of_Incorporation_Code2\": \"CA\",\n \"Tax_Identification_Number\": \"555-66-7777\",\n \"Website\": \"https://www.acmecorp.com\"\n },\n \"Country_Of_Registration_Code2\": \"US\",\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"OwnerInformation\": {\n \"IsEligibleOwnership\": \"true\",\n \"IsPublicallyTraded\": \"no\",\n \"Owners\": [\n {\n \"Address_Line_1\": \"100 Acme Way\",\n \"Citizenship\": \"US\",\n \"City\": \"San Francisco\",\n \"Country_Code2\": \"US\",\n \"Date_of_Birth\": \"10/10/1980\",\n \"Email_Address\": \"admin@acme.com\",\n \"First_Name\": \"Jane\",\n \"Job_Title\": \"Owner\",\n \"Last_Name\": \"Doe\",\n \"Middle_Name\": \"D\",\n \"Percentage_Owned\": \"25\",\n \"Postal_Code\": \"94105\",\n \"Region_Code2\": \"CA\"\n }\n ],\n \"Ticker_Symbol\": \"ACME\"\n },\n \"Payments_Type\": \"USA Only\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Register/CompanyAdvancedProfile","description":"

This API calls allows you to fill and submit your or your connected company’s Advanced Profile. There are 4 sections in the advanced profile: Business Entity Information, Authorized Contact Information, Director Information, and Ownership Information.

\n\n

If you are completing this form for a US company, you must complete Business Entity Information and Authorized Contact Information; the rest of the sections are not required. If you are completing this form for a non-US company, you must complete all four sections.

\n\n

Request Parameters

\n\n

Parameter	Description	Required
Address_Line_1	[Director/Owner] The primary street address for the director or owner.	false
Citizenship	[Director/Owner] The two-character ISO country code representing the director or owner's primary citizenship.	true
Country_Code2	[Director/Owner] The two-character ISO 3166-1 alpha-2 country code for the director or owner.	false
First_Name	[Director/Owner] The legal first name of the director or owner.	true
Job_Title	[Director/Owner] The professional title or role of the director or owner.	true
Business_Phone	[Business Entity] The primary contact phone number for the business.	true
City	[Director/Owner] The city of residence for the director or owner.	false
Date_Of_Birth	[Director/Owner] The director or owner's date of birth in mm/dd/yyyy format.	true
Email_Address	[Director/Owner] The direct email address for the director or owner.	true
Last_Name	[Director/Owner] The legal last name of the director or owner.	true
Postal_Code	[Director/Owner] The ZIP or postal code for the director or owner's address.	false
Region_Code2	[Director/Owner] The two-character state, province, or region abbreviation for the director or owner.	false
BeneficiaryAccountNumber	[Business Entity] The unique Xtrm account identifier for the beneficiary company, starting with `SPN`.	true
Fictitious_Name	[Business Entity] The \"Doing Business As\" (DBA) or fictitious trade name of the company.	false
Company_Type	[Business Entity] The legal structure or corporate classification of the company (e.g., LLC, Corporation).	true
Country_Of_Incorporation_Code2	[Business Entity] The two-character ISO country abbreviation where the business is officially incorporated.	true
Expected_Transaction_Amount	[Business Entity] The projected average monetary amount per transaction, represented as a numeric string.	false
Identification_Type	[Authorized Contact/Director] The type of government-issued identification provided (e.g., Passport, Driver License).	true
Region_Code2	[Business Entity] The two-character state or region abbreviation for the business's headquarters.	true
Tax_Identification_Number	[Business Entity] The official tax identifier for the company (e.g., US EIN, SSN, or international equivalent).	true
Countries_Sending_To	[Business Entity] A list of countries the business expects to remit funds to.	false
Country_Code2	[Business Entity] The two-character ISO 3166-1 alpha-2 country code for the business's headquarters.	true
Website	[Business Entity] The official website URL or domain of the company.	true
Address_Line_3	[Business Entity] Additional street address information for the business headquarters.	false
City	[Business Entity] The city where the business's headquarters is located.	true
Countries_Receiving_From	[Business Entity] A list of countries the business expects to receive funds from.	false
Expected_Annual_Volume	[Business Entity] The projected total annual processing volume, represented as a numeric string.	false
Expected_Currencies	[Business Entity] A list of currencies the business expects to transact in (e.g., USD, EUR).	false
Identification_Number	[Authorized Contact/Director] The unique alphanumeric number of the provided government-issued identification.	true
Address_Line_1	[Business Entity] The primary street address for the business's headquarters.	true
Address_Line_2	[Business Entity] Additional street address information (Suite, Floor) for the business headquarters.	false
Purpose_Of_Transactions	[Business Entity] A clear business description explaining the nature and reason for the fund transfers.	true
Region_Of_Incorporation_Code2	[Business Entity] The two-character state or region abbreviation where the business is officially incorporated.	true
Industry_Classification	[Business Entity] The general taxonomic identification or category of the business (e.g., Technology, Accommodation).	false
Postal_Code	[Business Entity] The ZIP or postal code for the business's primary headquarters.	true
Country_Of_Registration_Code2	[Business Entity] The two-character ISO country code where the business is officially registered.	true
IssuerAccountNumber	[System] The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call.	true
IsEligibleOwnership	[Ownership] Indicates whether the listed individual meets the criteria for eligible ownership (true / false).	false
IsPublicallyTraded	[Business Entity] Indicates whether the company is publicly traded ('yes' or 'no').	true
First_Name	[Authorized Contact] The legal first name of the authorized contact.	true
Job_Title	[Authorized Contact] The professional title or role of the authorized contact within the company.	true
Last_Name	[Authorized Contact] The legal last name of the authorized contact.	true
Postal_Code	[Authorized Contact] The ZIP or postal code for the authorized contact's address.	true
City	[Authorized Contact] The city of residence for the authorized contact.	true
Citizenship	[Authorized Contact] The two-character ISO country code representing the authorized contact's primary citizenship.	true
Country_Code2	[Authorized Contact] The two-character ISO 3166-1 alpha-2 country code for the authorized contact.	true
Date_of_Birth	[Authorized Contact] The authorized contact's date of birth in mm/dd/yyyy format.	true
Email_Address	[Authorized Contact] The direct professional email address for the authorized contact.	true
Middle_Name	[Authorized Contact] The legal middle name of the authorized contact person.	false
Percentage_Owned	[Ownership] The percentage of the company owned by this individual, expressed as a whole number (e.g., 25 for 25%).	true
Region_Code2	[Authorized Contact] The two-character state, province, or region abbreviation for the authorized contact.	true
Address_Line_1	[Authorized Contact] The primary street address for the authorized contact.	true
Ticker_Symbol	[Business Entity] The stock exchange ticker symbol for the company, if publicly traded.	false
Payments_Type	[Business Entity] The expected geographical scope of payments. Must be exactly 'USA Only' or 'International'.	false

\n\n

Response Parameters

\n\n

Parameter	Description
BeneficiaryID	The unique Xtrm account identifier (starting with `SPN`) for the company whose profile was updated.
Success	Success or failure of the operation (true / false).
message	A system message providing additional context regarding the submission, such as approval status or missing requirements.
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API call is used to get the status of the advanced profile application for a specific beneficiary company.

The status will be one of:

Submitted
\n
Pending
\n
Approved
\n

Request Parameters

\n\n

Parameter	Description	Required
BeneficiaryAccountNumber	The unique Xtrm account identifier for the beneficiary company whose profile status you are querying, starting with `SPN`.	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true

\n\n

Response Parameters

\n\n

Parameter	Description
BeneficiaryID	The unique Xtrm account identifier (starting with `SPN`) for the company whose profile status was queried.
Message	The current status of the advanced profile application (e.g., Submitted, Pending, or Approved).
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

This API fetches the advanced profile details for a company for which your account has read access (either your company, or a connected company).

\n\n

Request Parameters

\n\n

Parameter	Description	Required
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
BeneficiaryAccountNumber	The unique Xtrm account identifier for the beneficiary company whose profile you are querying, starting with `SPN`.	true

\n\n

Response Parameters

\n\n

Parameter	Description
Address_Line_1	[Director/Owner] The primary street address for the director or owner.
Citizenship	[Director/Owner] The two-character ISO country code representing the director or owner's primary citizenship.
Country_Code2	[Director/Owner] The two-character ISO 3166-1 alpha-2 country code for the director or owner.
First_Name	[Director/Owner] The legal first name of the director or owner.
Job_Title	[Director/Owner] The professional title or role of the director or owner.
Business_Phone	[Business Entity] The primary contact phone number for the business.
City	[Director/Owner] The city of residence for the director or owner.
Date_Of_Birth	[Director/Owner] The director or owner's date of birth in mm/dd/yyyy format.
Email_Address	[Director/Owner] The direct email address for the director or owner.
Last_Name	[Director/Owner] The legal last name of the director or owner.
Postal_Code	[Director/Owner] The ZIP or postal code for the director or owner's address.
Region_Code2	[Director/Owner] The two-character state, province, or region abbreviation for the director or owner.
BeneficiaryAccountNumber	[Business Entity] The unique Xtrm account identifier for the beneficiary company, starting with `SPN`.
Tax_Identification_Number	[Business Entity] The official tax identifier for the company (e.g., US EIN, SSN, or international equivalent).
Company_Type	[Business Entity] The legal structure or corporate classification of the company (e.g., LLC, Corporation).
FictitiousName	[Business Entity] The \"Doing Business As\" (DBA) or fictitious trade name of the company.
Identification_Type	[Authorized Contact/Director] The type of government-issued identification provided (e.g., Passport, Driver License).
Industry_Classification	[Business Entity] The general taxonomic identification or category of the business (e.g., Technology, Accommodation).
City	[Business Entity] The city where the business's headquarters is located.
Country_Code2	[Business Entity] The two-character ISO 3166-1 alpha-2 country code for the business's headquarters.
Expected_Currencies	[Business Entity] A list of currencies the business expects to transact in (e.g., USD, EUR).
Purpose_Of_Transactions	[Business Entity] A clear business description explaining the nature and reason for the fund transfers.
Region_Of_Incorporation_Code2	[Business Entity] The two-character state or region abbreviation where the business is officially incorporated.
Address_Line_1	[Business Entity] The primary street address for the business's headquarters.
Address_Line_2	[Business Entity] Additional street address information (Suite, Floor) for the business headquarters.
Address_Line_3	[Business Entity] Additional street address information for the business headquarters.
Country_Of_Incorporation_Code2	[Business Entity] The two-character ISO country abbreviation where the business is officially incorporated.
Identification_Number	[Authorized Contact/Director] The unique alphanumeric number of the provided government-issued identification.
Postal_Code	[Business Entity] The ZIP or postal code for the business's primary headquarters.
Region_Code2	[Business Entity] The two-character state or region abbreviation for the business's headquarters.
Website	[Business Entity] The official website URL or domain of the company.
Countries_Receiving_From	[Business Entity] A list of countries the business expects to receive funds from.
Countries_Sending_To	[Business Entity] A list of countries the business expects to remit funds to.
Expected_Annual_Volume	[Business Entity] The projected total annual processing volume, represented as a numeric string.
Expected_Per_Transaction_Amount	[Business Entity] The projected average monetary amount per transaction, represented as a numeric string.
Country_Of_Registration_Code2	[Business Entity] The two-character ISO country code where the business is officially registered.
IsEligibleOwnership	[Ownership] Indicates whether the listed individual meets the criteria for eligible ownership (true / false).
IsPublicallyTraded	[Business Entity] Indicates whether the company is publicly traded ('yes' or 'no').
First_Name	[Authorized Contact] The legal first name of the authorized contact.
Job_Title	[Authorized Contact] The professional title or role of the authorized contact within the company.
Last_Name	[Authorized Contact] The legal last name of the authorized contact.
Postal_Code	[Authorized Contact] The ZIP or postal code for the authorized contact's address.
City	[Authorized Contact] The city of residence for the authorized contact.
Citizenship	[Authorized Contact] The two-character ISO country code representing the authorized contact's primary citizenship.
Country_Code2	[Authorized Contact] The two-character ISO 3166-1 alpha-2 country code for the authorized contact.
Date_of_Birth	[Authorized Contact] The authorized contact's date of birth in mm/dd/yyyy format.
Email_Address	[Authorized Contact] The direct professional email address for the authorized contact.
Middle_Name	[Authorized Contact] The legal middle name of the authorized contact person.
Percentage_Owned	[Ownership] The percentage of the company owned by this individual, expressed as a whole number (e.g., 25 for 25%).
Region_Code2	[Authorized Contact] The two-character state, province, or region abbreviation for the authorized contact.
Address_Line_1	[Authorized Contact] The primary street address for the authorized contact.
Ticker_Symbol	[Business Entity] The stock exchange ticker symbol for the company, if publicly traded.
Payments_Type	[Business Entity] The expected geographical scope of payments (e.g., 'USA Only' or 'International').
Status	[System] The current approval status of the Advanced Profile Application (e.g., Pending, Approved, Declined).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

","urlObject":{"path":["Register","GetCompanyAdvancedProfileDetails"],"host":["https://xapisandbox.xtrm.com/API/v4"],"query":[],"variable":[]}},"response":[{"id":"1461aa71-1ab6-4731-929b-70ff8314be57","name":"200 OK - Get Advanced Profile Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"AdvancedProfileDetails\": {\n \"request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"BeneficiaryAccountNumber\": \"SPN9999888\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Register/GetCompanyAdvancedProfileDetails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"AdvancedProfileDetailsResponse\": {\n \"AdvancedProfileDetailsResult\": {\n \"BeneficiaryAccountNumber\": \"SPN9999888\",\n \"Country_Of_Registration_Code2\": \"US\",\n \"Payments_Type\": \"International\",\n \"Status\": \"Approved\",\n \"BusinessEntityInformation\": {\n \"Legal_Company_Name\": \"Acme Corp\",\n \"Fictitious_Name\": \"Acme Corporation\",\n \"Website\": \"https://www.acmecorp.com\",\n \"Company_Type\": \"C Corporation\",\n \"Industry_Classification\": \"Information Technology\",\n \"Country_Of_Incorporation_Code2\": \"US\",\n \"Region_Of_Incorporation_Code2\": \"CA\",\n \"Tax_Identification_Number\": \"555-66-7777\",\n \"Identification_Type\": \"Passport\",\n \"Identification_Number\": \"XX123456\",\n \"Address_Line_1\": \"100 Acme Way\",\n \"Address_Line_2\": \"Building B\",\n \"Address_Line_3\": \"Suite 400\",\n \"City\": \"San Francisco\",\n \"Country_Code2\": \"US\",\n \"Region_Code2\": \"CA\",\n \"Postal_Code\": \"94105\",\n \"Purpose_Of_Transactions\": \"Business to Business Vendor Payments\",\n \"Expected_Currencies\": \"USD,CAD,GBP\",\n \"Expected_Annual_Volume\": \"500000.00\",\n \"Expected_Per_Transaction_Amount\": \"5000.00\",\n \"Countries_Sending_To\": \"US, GB\",\n \"Countries_Receiving_From\": \"US, GB\"\n },\n \"AuthorizedContactInformation\": {\n \"Job_Title\": \"Director\",\n \"Job_Title_Other\": \"\",\n \"First_Name\": \"Jane\",\n \"Last_Name\": \"Doe\",\n \"Email_Address\": \"admin@acme.com\",\n \"Date_Of_Birth\": \"10/10/1980\",\n \"Citizenship\": \"US\",\n \"Address_Line_1\": \"100 Acme Way\",\n \"City\": \"San Francisco\",\n \"Region_Code2\": \"CA\",\n \"Country_Code2\": \"US\",\n \"Postal_Code\": \"94105\",\n \"Business_Phone\": \"14085551234\"\n },\n \"OwnerInformation\": {\n \"IsPublicallyTraded\": \"No\",\n \"IsEligibleOwnership\": true,\n \"Ticker_Symbol\": \"ACME\",\n \"Owners\": [\n {\n \"Address_Line_1\": \"100 Acme Way\",\n \"Citizenship\": \"US\",\n \"City\": \"San Francisco\",\n \"Country_Code2\": \"US\",\n \"Date_of_Birth\": \"10/10/1980\",\n \"Email_Address\": \"admin@acme.com\",\n \"First_Name\": \"Jane\",\n \"Job_Title\": \"Owner\",\n \"Last_Name\": \"Doe\",\n \"Middle_Name\": \"D\",\n \"Percentage_Owned\": \"25\",\n \"Postal_Code\": \"94105\",\n \"Region_Code2\": \"CA\"\n }\n ]\n },\n \"OperationStatus\": {\n \"Success\": true,\n \"Errors\": null\n }\n }\n }\n}"}],"_postman_id":"43123cb8-aeeb-4908-a9d6-a521d1a4b007"}],"id":"073ecfb0-c6e2-48dc-bfbd-a2f8483697de","description":"

Endpoints to submit and track the status of Advanced Profile Applications (KYC/KYB). This includes managing the Business Entity, Authorized Contact, Director, and Ownership information required to remit funds.

\n","_postman_id":"073ecfb0-c6e2-48dc-bfbd-a2f8483697de","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}},{"name":"Reports","item":[{"name":"Send beneficiary tax information to registered email","id":"8aa68e12-8052-4ab0-9ce2-3a903f3ec004","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TransferTaxInformation\": {\n \"Request\": {\n \"IssuerAccountNumber\": \"SPN1111222\",\n \"BeneficiaryAccountNumber\": \"PAT9999888\",\n \"TaxYearStartMonth\": \"5\",\n \"TaxYear\": \"2024\",\n \"EmailBody\": \"Your tax information for 2024\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Report/TransferTaxInformation","description":"

This API call allows you to send tax documents to a beneficiary's email address registered with Xtrm.

The tax form email is dispatched immediately upon making the API call, provided the user's profile contains all the necessary data to generate the document. The mandatory profile data required to produce a tax form includes the user's: Name, Date of Birth (DOB), SSN/TIN, Email, Phone number, and Address.

Request Parameters

\n\n

Parameter	Description	Required
TaxYearStartMonth	The numeric representation of the starting month of the tax year (e.g., '1' for January, '12' for December).	true
BeneficiaryAccountNumber	The unique Xtrm account identifier for the beneficiary being updated, starting with `PAT`.	true
EmailBody	A custom text string injected into the body of the email sent to the beneficiary. This can be used to add specific instructions or context. (Note: Primarily supports plain text; check with your account manager for HTML rendering capabilities).	true
IssuerAccountNumber	The unique Xtrm account identifier, starting with `SPN` for the company account associated with the credentials you are using for your API call. In case you are using Pseudo Credentials this will be the `SPN` of the company on behalf of which you are making the API call.	true
TaxYear	The four-digit reporting tax year for the requested tax documents (e.g., '2025').	true

\n\n

Response Parameters

\n\n

Parameter	Description
Message	A system message providing details on the operation's outcome, such as confirming the email was successfully dispatched or listing any missing profile data required to generate the form.
Success	Success or failure of the operation (true / false).
Errors	Contains specific validation or execution error details if the API call fails. Returns empty upon a successful operation.

Endpoint to generate and dispatch required tax documents directly to a beneficiary's registered email address based on their profile data.

\n","_postman_id":"2f6cfdf1-53ed-4033-a9ee-c774bcf267ef","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","id":"b999d270-4b9c-431b-8ef4-fb6817cfff94","name":"Xtrm 4.92.6 Doc - Revised","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]}},"variable":[{"key":"baseUrl","value":"https://xapisandbox.xtrm.com/API/v4"},{"key":"oAuth-token-Url","value":"https://xapisandbox.xtrm.com"}]}

5.0 (Nero)

Coming Soon

Release 4.92.6

New Calls

Changed Calls

Schema Changes

Announcements

New Features

Changed Functionality

Xtrm API (XAPI) Documentation

Quick Start Guide

Sandbox environment(https://sandbox.xtrm.com)

Differences from production environment

Transfer behavior in the sandbox

Sandbox setup

API Release Notes

Initial authorization token request

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Additional Details:

Additional Jurisdiction Information:

Exotic Currency Requirements:

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Additional Details:

Additional Jurisdiction Information:

Exotic Currency Requirements:

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Exotic Currency Requirements

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Response Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Response Parameters

Response Parameters

Response Parameters

Response Parameters

Request Parameters

Response Parameters

Request Parameters

Sandbox environment
(https://sandbox.xtrm.com)