We've developed the XAPI Test Console for you to get a better understanding of the types of calls possible with the XAPI. You can explore the types of calls and responses you'll use while integrating XAPI into your site, mobile app, or platform. Please don't hesitate to contact us with any questions. We're happy to get you started using the XAPI today.
This page is for the XAPI demonstration and testing purposes only. Never share or display the Platform Name or Key with anyone.
URL: https:xmadev.xtrm.com/oAuth/token Method: Post Content-Type:x-www-form-urlencoded Body: -d "grant_type=password" -u "client_id:" "string" -u "client_secret:" "string" Request Param: grant_type=password&client_id=YOUR_CLIENT_ID_FROM_XTRM&client_secret=YOUR_CLIENT_SECRET_XTRM
URL: https:xmadev.xtrm.com/oAuth/token Method: Post Content-Type:x-www-form-urlencoded Body: -d "grant_type=refresh_token" -u "refresh_token:" "string" -u "client_id:" "string" -u "client_secret:" "string" Request Param: grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN&client_id=YOUR_CLIENT_ID_FROM_XTRM&client_secret=YOUR_CLIENT_SECRET_XTRM
URL: https:xmadev.xtrm.com/api/v1/Signup/RegisterUser Method: Post Content-Type: application/json Request Param: { "first_name": "First Name", "last_name":"Last Name", "email":"Email Address" , "password":"Login Password", "mobile_no":"Mobile Number", "country_calling_flag":"Two-letter ISO country code", "calling_code":"Use 'GetCountryList' to get country calling code", "date_of_birth":"YYYY-MM-DD", "device_ip":"Device Ip", "device_browser":"Device Browser", "device_type":"Device Type", "country":"Use 'GetCountryList' to get country name", "state":"Use 'GetStateList' to get state name", "zip_code":"Zip/Postal code" }
URL: https:xmadev.xtrm.com/api/v1/Signup/VerifyPATwithOTP Method: Post Content-Type: application/json Request Param: { "account_number": "PAT Account Number", "verification_code":"verification code sent to your email", "device_ip":"Device IP", "device_browser":"Device Browser", "device_type":"Device Type" }
URL: https:xmadev.xtrm.com/api/v1/Signup/ResendOTP Method: Post Content-Type: application/json Request Param: { "account_number": "PAT Account Number", "device_ip":"Device IP", "device_browser":"Device Browser", "device_type":"Device Type" }
URL: https:xmadev.xtrm.com/api/v1/Bank/GetLinkedBankAccounts Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number": "PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Bank/GetBeneficiaryDetails Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number": "PAT Account Number", "benificiary_id": "Beneficiary Id Number" }
URL: https:xmadev.xtrm.com/api/v1/Bank/UpdateBankBeneficiary Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "beneficiary":{ "beneficiary_details":{ "beneficiary_information":{ "beneficiary_contact_name":"Beneficiary Name", "beneficiary_phone_number":"Beneficiary phone number", "address_line1":"Beneficiary Address Line1", "address_line2":"Beneficiary Address Line2", "city":"Beneficiary City", "region":"Beneficiary Region", "postalcode":"Beneficiary Postal Code", "country_ISO2":"CountryISO2" } }, "bank_details":{ "beneficiary_bank_information":{ "institution_name":"Wells Fargo", "withdraw_type":"PaymentMethod", "currency":"Bank Currency", "SWIFTBIC":"SWIFTBIC", "beneficiary_account_number":"Account Number", "routing_number":"Routing Number", "remittance_line3":"", "remittance_line4":"", "country_ISO2":"CountryISO2" } } } }
URL: https:xmadev.xtrm.com/api/v1/Bank/SearchBank Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "bank_name":"Name of the Institution", "country_ISO2":"Two-letter ISO country code" }
URL: https:xmadev.xtrm.com/api/v1/Bank/GetBankDynamicValidationRules Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "bank_withdraw_type":"Bank Withdraw Type", "country_ISO2":"Two-letter ISO country code", "bene_country_ISO2":"Two-letter ISO country code", "currency":"Three-letter currency code" }
URL: https:xmadev.xtrm.com/api/v1/Bank/GetBankWithdrawTypes Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "country_ISO2":"Two-letter ISO country code" }
URL: https:xmadev.xtrm.com/api/v1/Bank/CreateBankBeneficiary Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "beneficiary":{ "beneficiary_details":{ "beneficiary_information":{ "beneficiary_contact_name":"Beneficiary Contact Name", "beneficiary_phone_number":"Beneficiary Phone Number", "address_line1":"Beneficiary Address Line1", "address_line2":"Beneficiary Address Line2", "city":"Beneficiary City", "region":"Beneficiary Region", "postalcode":"Beneficiary Postal Code", "country_ISO2":"Two-letter ISO country code" } }, "bank_details":{ "beneficiary_bank_information":{ "institution_name":"Name of the institution", "currency":"Three-letter currency code", "SWIFTBIC":"Unique identifier for the bank", "beneficiary_account_number":"Bank account number", "routing_number":"Bank routing code/National Bank Code", "remittance_line3":"Bank Remittance Line3", "remittance_line4":"Bank Remittance Line4", "country_ISO2":"Two-letter ISO country code", "RegulatoryFields":[ { "Key":"", "Value":"" }] } } } }
URL: https:xmadev.xtrm.com/api/v1/Bank/DeleteBankBeneficiary Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "beneficiary_id":"Enter Beneficiary Id " }
URL: https:xmadev.xtrm.com/api/v1/General/GetCurrencyList Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: {}
URL: https:xmadev.xtrm.com/api/v1/Bank/GetCCBLSettings Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "country_ISO2":"country ISO2" }
URL: https:xmadev.xtrm.com/api/v1/Settings/GetLinkedCards Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number": "PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Settings/LinkCard Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "address1":"Address Line1", "address2":"Address Line2", "city":"City", "state":"State", "country":"Country", "country_code_iso2":"CountryISO2", "postal_code":"Postal Code", "credit_card_number":"Credit Card number", "credit_card_type":"Credit Card Type", "link_card_type":"identity / transfer", "name_on_card":"Card Name", "currency_code":"Three-letter currency code", "cvv":"Card CVV", "expire_month":"Card Expiry Month", "expire_year":"Card Expiry Year", "first_name":"FirstName", "last_name":"LastName" }
URL: https:xmadev.xtrm.com/api/v1/Settings/EditLinkCard Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "linkedCardId":"Credit Card Id", "account_number":"PAT Account Number", "address1":"Address Line1", "address2":"Address Line2", "city":"City", "state":"State", "country":"Country", "country_code_iso2":"CountryISO2", "postal_code":"Postal Code", "credit_card_number":"Credit Card number", "credit_card_type":"Credit Card Type", "name_on_card":"Card Name", "currency_code":"Three-letter currency code", "cvv":"Card CVV", "expire_month":"Card Expiry Month", "expire_year":"Card Expiry Year", "first_name":"FirstName", "last_name":"LastName" }
URL: https:xmadev.xtrm.com/api/v1/Settings/DeleteLinkCard Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "linkedCardId":"Credit Card Id" }
URL: https:xmadev.xtrm.com/api/v1/Settings/GetOtherLinkAccounts Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Settings/SaveOtherLinkAccounts Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "digital_giftcards_emailid":"Giftcard Email Id", "virtual_visa_emailid":"Virtual Visa Email Id" }
URL: https:xmadev.xtrm.com/api/v1/GiftCard/GetDigitalGiftCards Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "Currency":"Three-letter currency code" }
URL: https:xmadev.xtrm.com/api/v1/GiftCard/GetPrepaidGiftCards Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "Currency":"Three-letter currency code" }
URL: https:xmadev.xtrm.com/api/v1/GiftCard/GetRewardGiftCards Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "Currency":"Three-letter currency code" }
URL: https:xmadev.xtrm.com/api/v1/General/GetCountryList Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: {}
URL: https:xmadev.xtrm.com/api/v1/General/GetStateList Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "country_id":"Country Id" }
URL: https:xmadev.xtrm.com/api/v1/Payment/GetFee Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "from_account_number":"from_account_number", "to_account_number":"to_account_number. Mandatory only for Send", "currency_code":"Three-letter currency code", "amount":"amount", "transaction_type":"Either Send or Transfer", "payment_method_type":"Use 'GetUserPaymentMethods' to get payment method. Pass payment method type only for Transfer" }
URL: https:xmadev.xtrm.com/api/v1/Payment/GetPaymentMethods Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: {}
URL: https:xmadev.xtrm.com/api/v1/Profile/GetUserPersonal Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Profile/UpdateUserPersonalProfile Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "first_name":"FirstName", "last_name":"LastName", "tax_number":"Tax Number", "date_of_birth":"YYYY-MM-DD" }
URL: https:xmadev.xtrm.com/api/v1/Profile/GetUserContact Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Profile/UpdateUserContactInfo Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "address_line_1":"Address Line1", "address_line_2":"Address Line2", "appartment_number":"Appartment Number", "city":"City", "country":"Country", "state":"State", "zipcode":"Postal Code" }
URL: https:xmadev.xtrm.com/api/v1/Profile/GetUserEmployer Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/General/GetEmployers Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "search_param":"Search by name, company, email or mobile #" }
URL: https:xmadev.xtrm.com/api/v1/Profile/SaveUserEmployerInfo Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "company_account_number":"SPN Account Number", "designation":"Designation" }
URL: https:xmadev.xtrm.com/api/v1/Profile/DeleteUserEmployerInfo Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "company_account_number":"SPN Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Devices/GetDevices Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "current_page":"1", "items_per_page":"2" }
URL: https:xmadev.xtrm.com/api/v1/Devices/DeleteDevices Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "id":["Device Id"] }
URL: https:xmadev.xtrm.com/api/v1/Wallet/GetUserWallets Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Wallet/GetAvailableCurrencies Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Wallet/CreateWallet Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "currency_code":"Three-letter currency code", "wallet_name":"Wallet Name" }
URL: https:xmadev.xtrm.com/api/v1/Wallet/UpdateWallet Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "wallet_id":"Wallet Id", "wallet_name":"Wallet Name" }
URL: https:xmadev.xtrm.com/api/v1/Wallet/GetUserWalletsTransactions Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "currency":"Three-letter currency code", "current_page":"1" , "items_per_page":"2", "transaction_type":"Transaction Type", "search_param":"Search Param" }
URL: https:xmadev.xtrm.com/api/v1/Wallet/GetUserWalletTransactionDetails Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "transaction_id": Use 'GetUserWalletsTransactions' to get Transaction Id }
URL: https:xmadev.xtrm.com/api/v1/Wallet/DownloadWalletTransactionDetails Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "currency":"Three-letter currency code" }
URL: https:xmadev.xtrm.com/api/v1/Payment/SimpleSendSearch Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "search_param":"Search by name, company, email or mobile #", "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Payment/FundTransfer Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "amount":"Amount to send", "currency_code":"Three-letter currency code", "description":"Description", "from_account_number":"From Account Number", "to_account_number":"To Account Number. To Account Number or To Email Id are exclusively mandatory.", "to_email_id":"To Email Id. Use this in case of a new user." }
URL: https:xmadev.xtrm.com/api/v1/Payment/Recentpayees Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "current_page":1, "items_per_page":10 }
URL: https:xmadev.xtrm.com/api/v1/Payment/GetUserPaymentMethods Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: {}
URL: https:xmadev.xtrm.com/api/v1/Fund/UserWithdrawFund Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "amount":"Payment Amount", "from_currency":"Three-letter currency code", "to_currency":"Three-letter currency code", "payment_method_id":"Use 'GetUserPaymentMethods' to get PaymentMethodID", "user_giftcard_email_id":"Giftcard Email Id", "user_rewardcard_email_id":"Reward card Email Id", "user_linked_bank_id":"Use 'GetLinkedBankAccounts' to get UserLinkedBankID", "user_paypal_email_id":"User PayPal Email ID", "user_prepaid_visa_email_id":"User Prepaid Virtual Visa Email ID", "user_card_token":"Use 'GetLinkedCards' to get CardToken", "vSKU":"Use 'GetGiftCards' to get sku", "bAlwaysUseThisEmail":"Use True or False", "otp":"One time password for validation", "verification_method":"Verification method email/mobile" }
URL: https:xmadev.xtrm.com/api/v1/GiftCard/GetPrepaidDebitCardAvailableCurrencies Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: {}
URL: https:xmadev.xtrm.com/api/v1/GiftCard/GetDigitalGiftCardAvailableCurrencies Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: {}
URL: https:xmadev.xtrm.com/api/v1/Payment/GetExchangeRate Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "amount":"Payment Amount", "from_currency":"Three-letter currency code", "to_currency":"Three-letter currency code" }
URL: https:xmadev.xtrm.com/api/v1/Payment/GetSellingExchangeRate Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "amount":"Payment Amount", "from_currency":"Three-letter currency code", "to_currency":"Three-letter currency code" }
URL: https:xmadev.xtrm.com/api/v1/Payment/BookCurrencyExchange Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "amount":"Payment Amount", "exchange_rate":"Exchange Rate", "from_currency":"Three-letter currency code", "to_currency":"Three-letter currency code" }
URL: https:xmadev.xtrm.com/api/v1/Claims/GetClaims Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "claim_status":"Claim Status", "current_page":"1", "items_per_page":"2" }
URL: https:xmadev.xtrm.com/api/v1/Claims/GetClaimDetails Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "claim_id":"Use 'GetClaims' to get Claim Id" }
URL: https:xmadev.xtrm.com/api/v1/Claims/ChangeClaimStatus Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "claim_id":"Use 'GetClaims' to get Claim Id", "claim_status":"Claim Status", "prev_claim_status":"Previous Claim Status" }
URL: https:xmadev.xtrm.com/api/v1/Profile/GetUserAccountInfo Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Settings/ChangePassword Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "current_password":"Current Password", "new_password":"New Password" }
URL: https:xmadev.xtrm.com/api/v1/Settings/GetOTPForgotPassword Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "email_id":"Registered Email ID" }
URL: https:xmadev.xtrm.com/api/v1/Settings/ValidateOTPForgotPassword Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "verification_code":"Verification Code" }
URL: https:xmadev.xtrm.com/api/v1/Settings/ResetPassword Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "new_password":"New Password", "verification_code":"Verification Code" }
URL: https:xmadev.xtrm.com/api/v1/Profile/GetUserEmailOTP Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "new_email_id":"New Email Id", "old_email_id":"Old Email Id" }
URL: https:xmadev.xtrm.com/api/v1/Profile/UpdateUserEmail Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "new_email_id":"New Email Id", "old_email_id":"Old Email Id", "verification_code":"Verification Code" }
URL: https:xmadev.xtrm.com/api/v1/Profile/GetUserMobileOTP Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "new_mobile_code":"New Mobile Code", "new_mobile_flag":"New Mobile Flag", "new_mobile_number":"New Mobile Number", "old_mobile_code":"Old Mobile Code", "old_mobile_flag":"Old Mobile Flag", "old_mobile_number":"Old Mobile Number" }
URL: https:xmadev.xtrm.com/api/v1/Profile/UpdateUserMobile Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number", "new_mobile_code":"New Mobile Code", "new_mobile_flag":"New Mobile Flag", "new_mobile_number":"New Mobile Number", "old_mobile_code":"Old Mobile Code", "old_mobile_flag":"Old Mobile Flag", "old_mobile_number":"Old Mobile Number", "verification_code":"Verification Code" }
URL: https:xmadev.xtrm.com/api/v1/Profile/GetForceLoginOTP Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }
URL: https:xmadev.xtrm.com/api/v1/Profile/UpdateForceLoginOTP Method: Post Header: -u "Authorization:" "bearer string" Content-Type: application/json Request Param: { "account_number":"PAT Account Number" }