XAPI Console

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.

Token Generation

Enter JSON to Generate Token:

Request Format

URL: https://xapisandbox.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

Refresh Token

Enter JSON to Refresh Token:

Request Format

URL: https://xapisandbox.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

Create User

Enter JSON String for Create User:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/CreateUser
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "createUser": {
        "request": {
            "issuerAccountNumber" : "SPN Account Number",
            "legalFirstName": "First Name",
            "legalLastName": "Last Name",
            "emailAddress": "Email Address",
            "emailNotification" :"true/false",
            "mobilePhone": "Mobile Number",
            "taxId": "Tax ID",
            "dateOfBirth": {
                "day": "DD",
                "month": "MM",
                "year": "YYYY"
            },
            "address": {
                "addressLine1": "Address1",
                "addressLine2": "Address2",
                "aptSuitNum": "Apartment or Suit Number",
                "city": "City",
                "countryISO2": "Two-letter ISO country code",
                "postalCode": "Postal Code",
                "region": "Region"
            }
        }
    }
}

Update User

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/UpdateUser
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "updateUser": {
         "request": {
            "issuerAccountNumber": "SPN Account Number",
            "userId":"PAT Account Number",
            "legalFirstName": "First Name",
            "legalLastName": "Last Name",
            "taxId": "Tax ID",
            "dateOfBirth": {
                "day": "DD",
                "month": "MM",
                "year": "YYYY"
            },
            "address": {
                "addressLine1": "Address1",
                "addressLine2": "Address2",
                "aptSuitNum": "Apartment or Suit Number",
                "city": "City",
                "countryISO2": "Two-letter ISO country code",
                "postalCode": "Postal Code",
                "region": "Region"
            }
        }
    }
}

Fetch Personal Beneficiaries

Enter JSON String for fetching beneficiaries:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Beneficiary/GetPersonalBeneficiaries
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "getPersonalBeneficiaries": {
    "request": {
      "issuerAccountNumber": "SPN Account Number",
      "pagination": {
        "recordsToSkip": "1",
        "recordsToTake": "10"
      }
    }
  }
}

Check User Exist

Enter JSON String to check beneficiary exist:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Beneficiary/CheckUserExist
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "checkUserExist":{  
    "request":{  
      "issuerAccountNumber":"SPN Account Number",
      "email":"Email Address"
    }
  }
}

Fetch Linked Bank Accounts

Enter JSON String for fetching linked bank accounts:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/GetLinkedBankAccounts
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "getLinkedBankAccounts": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "recipientUserId": "SPN/PAT Account Number"
        }
    }
}

Fetch Bank Debit Linked Bank Accounts

Enter JSON String for fetching Bank Debit linked bank accounts:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/GetACHDebitLinkedBankAccounts
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "getACHDebitLinkedBankAccounts": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "RecipientUserId": "SPN / PAT Account Number"
        }
    }
}

Search Bank by BIC

Enter JSON String to Search Bank:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/SearchBankbyBIC
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "SearchBankByBIC":{
    "request":{
      "IssuerAccountNumber":"SPN Account Number",
      "BankCountryISO2":"Two-letter ISO country code",
      "SWIFTBIC":"Bank SWIFTBIC",
      "Pagination":{
        "RecordsToSkip":1,
        "RecordsToTake":10
      }
    }
  }
}

Search Bank by National ID

Enter JSON String to Search Bank:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/SearchBankByNationalID
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "SearchBankByNationalID":{
    "request":{
      "IssuerAccountNumber":"SPN Account Number",
      "BankCountryISO2":"Two-letter ISO country code",
      "NationalID":"Institution national ID",
      "Pagination":{
        "RecordsToSkip":1,
        "RecordsToTake":10
      }
    }
  }
}

Validate IBAN

Enter JSON String to Search Bank:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/ValidateIBAN
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "ValidateIBAN":{
    "request":{
      "IssuerAccountNumber":"SPN1883466",
      "BankCountryISO2":"Two-letter ISO country code",
      "IBAN":"IBAN Account Number"
    }
  }
}

Fetch Bank Withdraw Types

Enter JSON String to Get Bank Withdraw Types:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/GetBankWithdrawTypes
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "GetBankWithdrawTypes":{  
    "request":{  
      "issuerAccountNumber":"SPN Account Number",
      "CountryISO2":"Two-letter ISO country code"
    }
  }
}

Fetch Bank Validation Rules

Enter JSON String to Get Bank Validation Rules:

Request Format

                            URL: https://xapisandbox.xtrm.com/API/v4/Bank/GetBankValidationRules
                            Method: Post
                            Header: -u "Authorization:" "bearer string"
                            Content-Type: application/json
                            Request Param:
        {
          "GetBankValidationRules":{
            "request":{
              "issuerAccountNumber":"SPN Account Number",
              "RecipientUserId":"Recipient User Account Number",
              "CountryISO2":"Two-letter ISO country code",
              "BeneficiaryCountryISO2":"Two-letter ISO country code",
              "Currency":"Three-letter currency code",
              "WithdrawType":"Bank withdrawtype LV, HV, ACH or Wire"
            }
          }
        }

Link Bank Beneficiary

Enter JSON String to Link Bank Beneficiary:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/LinkBankBeneficiary
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "LinkBankBeneficiary":{  
    "request":{  
      "issuerAccountNumber":"SPN Account Number",
      "UserID":"PAT Account Number",
      "Beneficiary":{  
        "BeneficiaryDetails":{  
          "BeneficiaryInformation":{  
            "ContactName":"Beneficiary Contact Name",
            "PhoneNumber":"Beneficiary Phone Number",
            "AddressLine1":"Beneficiary Address Line1",
            "AddressLine2":"Beneficiary Address Line2",
            "City":"Beneficiary City",
            "Region":"Beneficiary Region",
            "PostalCode":"Beneficiary PostalCode",
            "CountryISO2":"Two-letter ISO country code"
          }
        },
        "BankDetails":{  
          "BeneficiaryBankInformation":{  
            "InstitutionName":"Name of the institution",
            "WithdrawType":"Bank Withdraw Type",
            "Currency":"Three-letter currency code",
            "SWIFTBIC":"Unique identifier for the bank",
            "AccountNumber":"Bank account number",
            "RoutingNumber":"Bank routing code/National Bank Code",
            "CountryISO2":"Two-letter ISO country code",
            "RegulatoryFields":[
                {
                    "Key":"Field Name",
                    "Value":"Field Value"
                }
            ]
          }
        }
      }
    }
  }
}

Link Debit Bank Beneficiary

Enter JSON String to Link Bank Debit Beneficiary:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/LinkACHDebitBankBeneficiary
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "LinkACHDebitBankBeneficiary":{  
    "request":{  
      "issuerAccountNumber":"SPN Account Number",
      "UserID":"SPN/PAT Account Number",
      "Beneficiary":{  
        "BeneficiaryDetails":{  
          "BeneficiaryInformation":{  
            "ContactName":"Beneficiary Contact Name",
            "PhoneNumber":"Beneficiary Phone Number",
            "AddressLine1":"Beneficiary Address Line1",
            "AddressLine2":"Beneficiary Address Line2",
            "City":"Beneficiary City",
            "Region":"Beneficiary Region",
            "PostalCode":"Beneficiary PostalCode",
            "CountryISO2":"Two-letter ISO country code"
          }
        },
        "BankDetails":{  
          "BeneficiaryBankInformation":{  
            "InstitutionName":"Name of the institution",
            "AccountType":"SAVINGS / BUSINESS / CHECKING",
            "Currency":"Three-letter currency code",
            "SWIFTBIC":"Unique identifier for the bank",
            "AccountNumber":"Bank account number",
            "RoutingNumber":"Bank routing code/National Bank Code",
            "CountryISO2":"Two-letter ISO country code",
            "RegulatoryFields":[
                {
                    "Key":"Field Name",
                    "Value":"Field Value"
                }
            ]
          }
        }
      }
    }
  }
}

Release Bank Beneficiary

Enter JSON String to Link Bank Debit Beneficiary:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/ReleaseACHDebitMicrodeposit
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
	"ReleaseACHDebitMicrodeposit": {
		"Request": {
			"issuerAccountNumber":"SPN Account Number",
			"UserID":"SPN/PAT Account Number",
			"BeneficiaryBankID": "Beneficiary ACH link bank ID"
		}
	}
}

Verify Bank Beneficiary

Enter JSON String to Link Bank Debit Beneficiary:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/VerifyACHDebitMicrodeposit
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
	"VerifyACHDebitMicrodeposit": {
		"Request": {
			"issuerAccountNumber":"SPN Account Number",
			"UserID":"SPN/PAT Account Number",
			"BeneficiaryBankID": "Beneficiary ACH link bank ID",
			"Amount_1": "0.07",
			"Amount_2": "0.15"
		}
	}
}

Delete Bank Beneficiary

Enter JSON String to Delete Bank Beneficiary:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Bank/DeleteBankBeneficiary
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "DeleteBankBeneficiary": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "RecipientAccountNumber": "SPN/PAT Account Number",
            "BeneficiaryBankID": "Beneficiary Bank ID"			
        }
    }
}

Fetch Linked Card

Enter JSON String for fetching linked cards:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Card/GetLinkedCards
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetLinkedCardAccounts": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "userid": "SPN/PAT Account Number"
        }
    }
}

Link Card

Enter JSON String to Link Card:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Card/LinkCard
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
"LinkCard":{
    "request": {
        "issueraccountnumber": "SPN Account Number",
        "userid": "SPN/PAT Account Number",
        "linkcardtype":"transfer / identity",
            "card": {
                "firstname": "Beneficiary First Name",
                "lastname": "Beneficiary Last Name",
                "addressline1":"Beneficiary Address line 1",
                "addressline2":"Beneficiary Address line 2",
                "city":"Beneficiary City",
                "state":"Beneficiary Region",
                "countrycode2":"Two-letter ISO country code",
                "postalcode":"Beneficiary PostalCode",
                "nameoncard":"Beneficary Full Name",
                "cardtype":"Card Type",
                "cardno":"Card Number",
                "expmonth":"Expiry Month 00",
                "expyear":"Expiry Year",
                "cvv":"Security Code"
				}
        }
    }
}

Delete Card

Enter JSON String to Delete Card:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Card/DeleteCard
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "DeleteCard": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "userid": "SPN/PAT Account Number",
            "CardToken": "Beneficiary Card Token"			
        }
    }
}

Fetch Payment Methods

Enter JSON String for fetching payment methods:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Payment/GetPaymentMethods
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{}

Fetch User Payment Methods

Enter JSON String for fetching user payment methods:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Payment/GetUserPaymentMethods
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{}

Fetch Beneficiary Company Payment Methods

Enter JSON String for fetching user payment methods:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4.01/Payment/GetBeneficiaryCompanyPaymentMethods
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{}

Fetch User Wallet Balance

Enter JSON String for fetching user wallet balance:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetUserWalletBalance
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetUserWalletBalance": {
        "request": {
           "issuerAccountNumber": "SPN Account Number",
            "UserID": "PAT Account Number",
            "Currency": "Currency Code"
        }
    }
}

Fetch Company Wallets

Enter JSON String for fetching Company Wallets:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetCompanyWallets
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetCompanywallets": {
        "request": {
            "issuerAccountNumber": "SPN Account Number"
        }
    }
}

Fetch Beneficiary Wallets

Enter JSON String for fetching Beneficiary Wallets:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetBeneficiaryWallets
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "GetBeneficiaryWallets":{  
    "request":{  
      "issuerAccountNumber":"SPN Account Number",
      "BeneficiaryAccountNumber":"SPN Account Number"
    }
  }
}

Create User Wallet

Enter JSON String for creating user wallet:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/CreateUserWallet
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "CreateUserWallet": {
    "request": {
        "issuerAccountNumber":"SPN Account Number",
        "UserID": "PAT Account Number",
        "WalletName": "Wallet Name",
        "WalletCurrency": "Currency Code"
    }
  }
}

Create Company Wallet

Enter JSON String for creating Company wallet:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/CreateCompanyWallet
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "CreateCompanyWallet": {
    "request": {
    	"issuerAccountNumber":"SPN Account Number",
    	"WalletName": "Wallet Name",
        "WalletCurrency": "Currency Code",
        "WalletType":"Standard/Accrual",
        "AllowAccessAccountNumber":"Allow Access SPN Account Number"
    }
  }
}

Create Beneficiary Company Wallet

Enter JSON String for creating Company wallet:

Request Format

URL: https://xapisandbox.xtrm.com/API/V4.01/Wallet/CreateBeneficiaryCompanyWallet
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "CreateBeneficiaryCompanyWallet": {
    "request": {
    	"issuerAccountNumber":"SPN Account Number",
        "BeneficiaryAccountNumber":"SPN Account Number",
    	"WalletName": "Wallet Name",
        "WalletCurrency": "Currency Code",
        "WalletType":"Standard/Accrual"
    }
  }
}

Update User Wallet

Enter JSON String for creating user wallet:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/UpdateUserWallet
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "UpdateUserWallet": {
    "Request": {
        "issuerAccountNumber": "SPN Account Number",
        "UserID": "PAT Account Number",
        "WalletID": "Wallet ID",
        "WalletName": "Wallet Name"
    }
  }
}

Update Company Wallet

Enter JSON String for creating Company wallet:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/updatecompanywallet
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "UpdateCompanyWallet": {
    "Request": {
        "issuerAccountNumber": "SPN Account Number",
        "WalletID": "Wallet ID",
        "WalletName": "Wallet Name"
    }
  }
}

Update Beneficiary Company Wallet

Enter JSON String for creating Company wallet:

Request Format

URL: https://xapisandbox.xtrm.com/API/V4.01/Wallet/updateBeneficiarycompanywallet
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "UpdateBeneficiaryCompanyWallet": {
    "Request": {
        "issuerAccountNumber": "SPN Account Number",
        "BeneficiaryAccountNumber":"SPN Account Number",
        "WalletID": "Wallet ID",
        "WalletName": "Wallet Name"
    }
  }
}

Fetch User Wallet Transactions

Enter JSON String for creating user wallet:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetUserWalletTransactions
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetUserWalletTransactions": {
    "Request": {
      "issuerAccountNumber": "SPN Account Number",
      "UserID": "PAT Account Number",
      "WalletCurrency": "Currency Code",
      "Filters" :
       {
          "DateRange" : {
          "StartUTC": "Start date with format mm/dd/yyyy",
          "EndUTC": "End date with format mm/dd/yyyy"
        },
           "TransactionType": "All, Credits, Debits, Currency Exchange, Transfer",
           "SearchParam": "Search text"
       },
       "Pagination": {
          "RecordsToSkip": "1",
          "RecordsToTake": "10"
      }
    }
  }
}

Fetch User Wallet Transactions Details

Enter JSON String for creating User Wallet Transaction Details:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetUserWalletTransactionDetails
Method: Post
Header:                                
-u "Authorization:" "bearer string"
Request Param:
{
  "GetUserTransactionDetails": {
    "Request": {
      "issuerAccountNumber": "SPN Account Number",
      "UserID": "PAT Account Number",
      "TransactionID": "Transaction ID"
    }
  }
}

Fetch Company Wallet Transactions

Enter JSON String for creating Company wallet:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetCompanyWalletTransactions
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetCompanyWalletTransactions": {
    "Request": {
      "issuerAccountNumber": "SPN Account Number",
      "WalletID": "Wallet ID",
      "Filters" :
       {
          "DateRange" : {
          "StartUTC": "Start date with format mm/dd/yyyy",
          "EndUTC": "End date with format mm/dd/yyyy"
        },
           "TransactionType": "All, Pending, Credits, Debits, Currency Exchange, Transfer",
           "SearchParam": "Searcg Text"
       },
      "Pagination": {
        "RecordsToSkip": "1",
        "RecordsToTake": "10"
      }
    }
  }
}

Fetch Company Wallet Transactions Details

Enter JSON String for creating Company Wallet Transaction Details:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetCompanyWalletTransactionDetails
Method: Post
Header:                                
-u "Authorization:" "bearer string"
Request Param:
{
  "GetCompanyTransactionDetails": {
    "Request": {
      "issuerAccountNumber": "SPN Account Number",
      "TransactionID": "Transaction ID"
    }
  }
}

Fund Company Wallet Using Credit Card

Enter JSON String to fund a Company Wallet Using Credit Card:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/FundCompanyWalletUsingCreditCard
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "FundCompanyWalletUsingCreditCardRequest": {
    "Request": {
      "PaymentDetails": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "Amount": "Amount",
        "CurrencyCode": "Currency Code",
        "WalletID": "Wallet ID"
      },
      "PayerInformation": {
        "FirstName": "First Name",
        "LastName": "Last Name"
      },
      "PayerBillingAddress":{
       "AddressLine1":"Address 1",
       "City":"City",
       "State":"State",
       "CountryISO2":"Country Code",
       "PostalCode":"Postal Code"
      },
      "CreditCardDetails":{
       "CardToken":"Use GetLinkedCards to get CardToken",
       "ExpireMonth":"Expire Month",
       "ExpireYear":"Expire Year",
       "CreditCardNumber":"Credit Card Number",
       "CreditCardType":"Visa Card/Master Card/Amex Card",
       "CVV":"CVV"
      }
       
      }
    }
  }

Fund Wallet Using Bank Debit

Enter JSON String to fund a User Wallet Using Credit Card:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/FundWalletUsingACHDebit
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "FundWalletUsingACHDebitRequest": {
    "Request": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "Amount": "Amount",
        "CurrencyCode": "Currency Code",
        "WalletID": "Wallet ID",
        "LinkedBankID": "Linked Bank ID"
      }
    }
  }

Fund Wallet Using Bank Transfer

Enter JSON String to Fund a Wallet Using Bank Transfer:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/FundWalletUsingBankTransfer
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "FundWalletUsingBankTransfer": {
    "Request": {
        "IssuerAccountNumber": "SPN Issuer Account Number",
        "BeneficiaryAccountNumber": "SPN Issuer Account Number",
        "Amount": "Amount",
        "CurrencyCode": "Currency Code",
        "WalletID": "Wallet ID",
        "ProgramID": "Program ID",
        "InvoiceRequired": "true/false",
        "PurchaseOrderNumber": "Purchase order number",
        "RequiredDepositDate": "Deposit Date",
        "RequiredPaymentDate": "Expected payment date",
        "Additionalinformtaion": "Fund notes"
      }
    }
  }

Fetch User Wallets

Enter JSON String for fetching User Wallets:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetUserWallets
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetUserWallets": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "UserID":"PAT Account Number"
        }
    }
}

Get Exchange Rate

Enter JSON String to Get Exchange Rate:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Payment/GetExchangeRate
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
                                {  
  "GetExchangeRate":{  
    "Request":{  
      "issuerAccountNumber":"SPN Account Number",
      "FromCurrency":"Currency code",
      "ToCurrency":"Currency code"
    }
  }
}

Book Exchange

Enter JSON String to Book Exchange:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Payment/BookExchange
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "BookExchange":{  
    "Request":{  
      "issuerAccountNumber":"SPN Account Number",
      "AccountNumber":"SPN/PAT Account Number",
      "FromWalletID":"SPN/PAT Wallet ID",
      "ToWalletID":"SPN/PAT Wallet ID",
      "FromCurrency":"Currency code",
      "ToCurrency":"Currency code",
      "Amount":"Amount",
      "OTP":"six digit integer"
    }
  }
}

Fetch User Wallet Transactions by Remitter

Enter JSON String to Fetch user wallet transactions by remitter:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Wallet/GetUserWalletTransactionsByRemitter
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetUserWalletTransactionsByRemitter": {
    "Request": {
      "issuerAccountNumber": "SPN Account Number",
      "UserID": "PAT Account Number",
      "RemitterAccountNo": "SPN Account Number",
      "WalletCurrency": "Currency Code",
     "Pagination": {
        "RecordsToSkip": "1",
        "RecordsToTake": "10"
      }
    }
  }
}

Transfer Fund

Enter JSON String to transfer fund:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Fund/TransferFund
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "TransferFund": {
    "request": {
      "Transaction": {
        "issuerAccountNumber": "SPN Account Number",
        "PaymentType": "Personal",
        "PaymentMethodId": "Use 'GetUserPaymentMethods' to get PaymentMethodID",
        "ProgramId": "Use 'GetPrograms' to get Program ID",
        "WalletID": "Use 'GetCompanyWallets' to get WalletID",
        "PaymentDescription": "Payment Description",
        "PaymentCurrency":"Currency Code",
        "EmailNotification" :"true/false",        
        "TransactionDetails": 
          [{
            "IssuerTransactionId": "Unique ID",
            "PaymentAmount": "Payment Amount",
            "PartnerAccountNumber": "SPN Account Number",
            "RecipientUserId": "PAT Account Number",
            "UserLinkedBankID": "Use 'GetLinkedBankAccounts' to get UserLinkedBankID",
            "UserPayPalEmailID": "User PayPal Email ID",
            "UserPrepaidVisaEmailID": "User Prepaid Virtual Visa Email ID",
            "UserGiftCardEmailID":"User Digital Gift Card Email ID",
            "sku": "Use 'GetDigitalGiftCards' to get sku",
            "DealRegId": "Deal_Reg_ID",
            "Comment": "Comment",
            "BeneficiaryCheckCountryCodeISO2":"Two-letter ISO country code",
            "BeneficiaryCheckName":"Check Name",
            "BeneficiaryCheckCity":"City",
            "BeneficiaryCheckState":"State",
            "BeneficiaryCheckAddresss1":"Address Line 1",
            "BeneficiaryCheckAddresss2":"Address Line 2",
            "BeneficiaryCheckPostalCode":"Postal Code",
            "BeneficiaryCheckMemo":"Check memo",
            "BeneficiaryCheckReference":"Check reference",
            "CardToken":"Bank transfer rapid - token"
          }]
      }
    }
  }
}

User Withdraw Fund

Enter JSON String to user withdraw fund:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Fund/UserWithdrawFund
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "UserWithdrawFund": {
    "request": {
        "issuerAccountNumber": "SPN Account Number",
        "UserID": "PAT Account Number",
        "Amount": "Payment Amount",     
        "Currency":"Currency Code",  
        "PaymentMethodId": "Use 'GetUserPaymentMethods' to get PaymentMethodID",       
        "UserLinkedBankID": "Use 'GetLinkedBankAccounts' to get UserLinkedBankID",
        "UserPayPalEmailID": "User PayPal Email ID",
        "UserPrepaidVisaEmailID": "User Prepaid Virtual Visa Email ID",
        "UserGiftCardEmailID":"User Digital Gift Card Email ID",
        "CardToken":"Bank transfer rapid - token",
        "sku":"Use 'GetDigitalGiftCards' to get sku",
        "OTP":"six digit integer",
        "SendTransferCodetoEmail":"true/false",
        "SendTransferCodetoMobile":"true/false",
        "EmailNotification":true
    }
  }
}

Transfer Fund to Company

Enter JSON String to transfer fund to company:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Fund/TransferFundtoCompany
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "TransferFundtoCompany":{  
    "request":{  
      "issuerAccountNumber":"SPN Account Number",
      "PaymentType":"Company",
      "PaymentMethodId":"Use 'GetPaymentMethods' to get PaymentMethodID",
      "ProgramId":"Use 'GetPrograms' to get Program ID",
      "WalletID":"Use 'GetCompanyWallets' to get WalletID",
      "Description":"Payment Description",
      "Currency":"Three-letter currency code",
      "Amount":"Payment Amount",
      "EmailNotification":"true/false",
      "IssuerTransactionId":"",		
      "BeneficiaryAccountNumber":"SPN Account Number",
      "BeneficiaryWalletID":"Use 'GetBeneficiaryWallets' to get WalletID",
      "BeneficiaryLinkedBankID":"Use 'GetLinkedBankAccounts' to get LinkedBankID",
      "BeneficiaryPayPalEmailID":"Beneficiary PayPal Email ID",
      "BeneficiaryCheckCountryCodeISO2":"Two-letter ISO country code",
      "BeneficiaryCheckName":"Check Name",
      "BeneficiaryCheckCity":"City",
      "BeneficiaryCheckState":"State",
      "BeneficiaryCheckAddresss1":"Address Line 1",
      "BeneficiaryCheckAddresss2":"Address Line 2",
      "BeneficiaryCheckPostalCode":"Postal Code",
      "BeneficiaryCheckMemo":"Check memo",
      "BeneficiaryCheckReference":"Check reference",
      "CardToken":"Bank transfer rapid - token"
    }
  }
}

Beneficiary Company Withdraw Fund

Enter JSON String to user withdraw fund:

Request Format

URL: https://xapisandbox.xtrm.com/API/V4.01/Fund/BeneficiaryCompanyWithdrawFund
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "BeneficiaryCompanyWithdrawFund": {
    "request": {
        "issuerAccountNumber": "SPN Account Number",                
        "Currency":"Currency Code",  
        "Amount": "Payment Amount",    
        "PaymentMethodId": "Use 'GetBeneficiaryCompanyPaymentMethods' to get PaymentMethodID",       
        "BeneficiaryAccountNumber":"SPN Account Number",
        "BeneficiaryWalletID":"Use 'GetBeneficiaryWallets' to get WalletID",
        "BeneficiaryLinkedBankID":"Use 'GetLinkedBankAccounts' to get LinkedBankID",
        "BeneficiaryCardToken":"Use 'GetLinkedCards' to get CardToken",
        "OTP":"six digit integer",
        "SendTransferCodetoEmail":"true/false",
        "SendTransferCodetoMobile":"true/false",
        "EmailNotification":true
    }
  }
}

Transfer Fund User to Company Using Credit Card

Enter JSON String to Transfer Fund User to Company Using:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Fund/TransferFundUsertoCompanyUsingCC
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "TransferFundUsertoCompanyUsingCC": {
    "Request": {
      "PaymentDetails": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "UserID":"PAT Issuer Account Number",
        "UserWalletID":"User Wallet ID",
        "CompanyAccountNumber":"SPN Issuer Account Number",
        "CompanyWalletID":"Company Wallet ID",
        "Amount": "Amount",
        "CurrencyCode": "Currency Code",
        "Description": "Fund Description"
      },
      "PayerInformation": {
        "FirstName": "First Name",
        "LastName": "Last Name"
      },
      "PayerBillingAddress":{
       "Address1":"Address 1",
       "City":"City",
       "State":"State",
       "CountryISO2":"Country Code",
       "PostalCode":"Postal Code"
      },
      "CreditCardDetails":{
       "ExpireMonth":"Expire Month",
       "ExpireYear":"Expire Year",
       "CreditCardNumber":"Credit Card Number",
       "CreditCardType":"Visa Card/Master Card/Amex Card",
       "CVV":"CVV"
      }
       
      }
    }
  }

Transfer wallet to wallet

Enter JSON String to Transfer Fund User to Company Using:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Fund/TransferFundWallettoWallet
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "TransferFundWallettoWallet": {
    "Request": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "FromAccountNumber":"SPN/PAT Issuer Account Number",
        "FromWalletID":"SPN/PAT Wallet ID",
        "ToAccountNumber":"SPN/PAT Issuer Account Number",
        "ToWalletID":"SPN/PAT Wallet ID",
        "Currency": "Currency Code",
        "Amount": "Amount",        
        "OTP": "six digit integer",
        "Description":"Description" 
      }
    }
  }

Transfer to dynamic user account

Enter JSON String to Transfer Fund to Dynamic User Account Using:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Fund/TransferFundDynamicAccountCreateUser
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "TransferFundToDynamicAccountUser": {
    "Request": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "FromAccountNumber":"SPN Issuer Account Number",
        "FromWalletID":"SPN Wallet ID",
        "RecipientFirstName":"User First Name(Optional)", 
        "RecipientLastName":"User Last Name(Optional)",
        "RecipientEmail":"User Email",
        "Currency": "Currency Code",
        "Amount": "Amount",
        "Description":"Description"
      }
    }
  }

Fetch Digital Gift Cards

Enter JSON String to Get Digital Gift Card Using:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/GiftCard/GetDigitalGiftCards
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetGiftCards": {
    "Request": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "Currency": "Currency Code" ,
         "Pagination": {
            "RecordsToSkip": "1",
            "RecordsToTake": "10"
          }
      }
    }
  }

Fetch Digital Gift Card Details

Enter JSON String to Fetch Digital Gift Card Details Using:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/GiftCard/GetGiftCardDetails
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetGiftCards": {
    "Request": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "SKU": "SKU ID"
      }
    }
  }

Fetch Prepaid Gift Cards

Enter JSON String to Get Prepaid Gift Card Using:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/GiftCard/GetPrepaidCards
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetPrepaidCards": {
    "Request": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "Currency": "Currency Code" ,
         "Pagination": {
            "RecordsToSkip": "1",
            "RecordsToTake": "10"
          }
      }
    }
  }

Fetch Prepaid Gift Card Details

Enter JSON String to Fetch Prepaid Gift Card Details Using:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/GiftCard/GetPrepaidCardDetails
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetPrepaidCards": {
    "Request": {
        "issuerAccountNumber": "SPN Issuer Account Number",
        "SKU": "SKU ID"
      }
    }
  }

Fetch Connected Fund Details

Enter JSON String for fetching fund requests details:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Fund/GetConnectedCompanyFundRequest
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetConnectedFundRequestDetails": {
    "Request": {
      "issuerAccountNumber": "SPN Account Number",
      "BeneficiaryAccountNumber": "SPN Account Number",
      "PaymentType": "ALL/Credits/Debits",
      "FromDate": "mm/dd/yyyy",
      "ToDate": "mm/dd/yyyy",
     "Pagination": {
        "RecordsToSkip": "1",
        "RecordsToTake": "10"
      }
    }
  }
}

Get Company Fees

Enter JSON String for fetching fund requests details:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Fund/GetCompanyFees
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetCompanyFees": {
    "Request": {
      "IssuerAccountNumber": "SPN Account Number",
      "BeneficiaryAccountNumber": "SPN Account Number",
      "CurrencyCode": "Currency Code"
    }
  }
}

Fetch Beneficiaries

Enter JSON String for fetching beneficiaries:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Beneficiary/GetBeneficiaries
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetBeneficiaries": {
    "request": {
      "issuerAccountNumber": "SPN Account Number",
      "Pagination": {
        "RecordsToSkip": "1",
        "RecordsToTake": "10"
      }
    }
  }
}

Create Beneficiary

Enter JSON String for creating beneficiary:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Beneficiary/CreateBeneficiary
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "CreateBeneficiary": {
    "Request": {
      "issuerAccountNumber": "SPN Account Number",
      "BeneficiaryCompanyName": "Company Name",
      "WebAddress": "Website URL",
      "BeneficiaryCompanyAdminDetails": {
      	"AdminEmail":"Email ID",
        "EmailNotification" :"true/false",
      	"AdminFirstName":"First Name",
        "AdminLastName":"Last Name",
        "AdminMobileNumber":"Mobile Number",
        "City":"City",
        "countryISO2": "Two-letter ISO country code",
        "Region":"Region",
         "PostalCode":"Postal Code"
      },
      "SalesProgramDetails": {
        "PartnerAccountManager": "Partner Account Manager",
        "SalesforcePartnerID": "Salesforce Partner ID",
        "OtherPartnerID": "Other Partner ID",
        "Region": "Region",
        "PartnerLevel": "Partner Level"
      }
    }
  }
}

Update Beneficiary

Enter JSON String for updating beneficiary:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Beneficiary/UpdateBeneficiary
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "UpdateBeneficiary": {
    "Request": {
      "issuerAccountNumber": "SPN Account Number",
      "BeneficiaryID":"Beneficiary SPN Account Number",
      "BeneficiaryCompanyName": "Company Name",
      "WebAddress": "Website URL",
      "BeneficiaryCompanyAdminDetails": {
      	"AdminFirstName":"First Name",
        "AdminLastName":"Last Name",
        "City":"City",
        "countryISO2": "Two-letter ISO country code",
        "Region":"Region",
        "PostalCode":"Postal Code"
      },
      "SalesProgramDetails": {
        "PartnerAccountManager": "Partner Account Manager",
        "SalesforcePartnerID": "Salesforce Partner ID",
        "OtherPartnerID": "Other Partner ID",
        "Region": "Region",
        "PartnerLevel": "Partner Level"
      }
    }
  }
}

Check Beneficiary Exist

Enter JSON String to check beneficiary exist:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Beneficiary/CheckBeneficiaryExist
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "CheckBeneficiaryExist":{  
    "request":{  
      "issuerAccountNumber":"SPN Account Number",
      "CompanyName":"Company Name"
    }
  }
}

Company Type

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/GetAdvancedContactCompanyType
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "CompanyType":{  
    "request":{  
      "CountryISO2":"Use 'GetAdvancedContactCountry' to get CountryCode"
    }
  }
}

NAICS

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/GetNaics
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{}

Job Titles

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/GetAdvancedContactJobTitles
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{}

Identification Type

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/GetIdentificationType
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{}

Advanced Contact Country

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/GetAdvancedContactCountry
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{}

Advanced Contact State

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/GetAdvancedContactState
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "AdvancedContactState":{  
    "request":{  
      "CountryCode":"Use 'GetAdvancedContactCountry' to get CountryCode"
    }
  }
}

Advanced Profile

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/CompanyAdvancedProfile
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "AdvancedProfile":{
        "request":{
            "issuerAccountNumber":"SPN Account Number",
            "BeneficiaryAccountNumber":"Beneficiary SPN Account Number",
            "Country_Of_Registration_Code2":"Use 'GetAdvancedContactCountry' to get Country",
            "Payments_Type": "USA Only / International",
            "BusinessEntityInformation": {
               "Fictitious_Name":"Fictitious Name",
               "Website":"Website",
               "Company_Type":"Use 'GetAdvancedContactCompanyType' to get company type",
               "Industry_Classification":"Use 'GetNAICS' to get NAICS",
               "Country_Of_Incorporation_Code2":"Use 'GetAdvancedContactCountry' to get Country",
               "Region_Of_Incorporation_Code2":"Use 'GetAdvancedContactState' to get Region",
               "Tax_Identification_Number":"Tax Identification Number",
               "Identification_Type":"Identification Type",
               "Identification_Number":"Identification Number",
               "Address_Line_1":"Address Line 1",
               "Address_Line_2":"Address Line 2",
               "Address_Line_3":"Address Line 3",
               "City":"City",
               "Country_Code2":"Use 'GetAdvancedContactCountry' to get Country",
               "Region_Code2":"Use 'GetAdvancedContactState' to get Region",
               "Postal_Code":"Contact Zip",
               "Purpose_Of_Transactions" : "Purpose of transactions",
               "Expected_Currencies" : "Expected currencies",
               "Expected_Annual_Volume" : "Expected Annual Income",
               "Expected_Transaction_Amount" : "Expected Transaction Amount",
               "Countries_Sending_To" : "Countries sending to",
               "Countries_Receiving_From" : "Countries receiving from"
            },
            "AuthorizedContactInformation": {
                "Job_Title":"Use 'GetAdvancedContactJobTitles' to get Job Title",
                "First_Name":"First Name",
                "Last_Name":"Last Name",
                "Email_Address":"Primary Email Address",
                "Date_Of_Birth":"Date Of Birth",
                "Citizenship":"Citizenship",
                "Address_Line_1":"Contact Address 1",
                "City":"Identification City",
                "Region_Code2":"Use 'GetAdvancedContactState' to get Region",
                "Country_Code2":"Use 'GetAdvancedContactCountry' to get Country",
                "Postal_Code":"Contact Zip",
                "Business_Phone":"Contact Business Phone"
            },
            "OwnerInformation":{
            "IsPublicallyTraded":"yes/no. If "no" then owner information is required",
            "Ticker_Symbol":"Ticker symbol",
            "Owners": [
            {
                "Job_Title":"Use 'GetAdvancedContactJobTitles' to get Job Title",
                "Percentage_Owned":"Percentage Owned",
                "First_Name":"First Name",
                "Middle_Name":"Middle Name",
                "Last_Name":"Last Name",
                "Email_Address":"Primary Email Address",
                "Date_of_Birth":"Date of Birth",
                "Citizenship":"Nationality",
                "Address_Line_1":"Address 1",
                "City":"City",
                "Country_Code2":"Use 'GetAdvancedContactCountry' to get Country",
                "Region_Code2":"Use 'GetAdvancedContactState' to get Region",
                "Postal_Code":"Postal Code"
            }
            ]
          }
        }
    }
}

Advanced Profile Status

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/CompanyAdvancedProfileStatus
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
	"AdvancedProfileStatus":{
		"request":{
			"issuerAccountNumber":"SPN Account Number",
			"BeneficiaryAccountNumber":"Beneficiary SPN Account Number"
		}
	}
}

Advanced Profile Details

Enter JSON String for updating an existing user:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Register/GetCompanyAdvancedProfileDetails
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
	"AdvancedProfileDetails":{
		"request":{
			"issuerAccountNumber":"SPN Account Number",
			"BeneficiaryAccountNumber":"Beneficiary SPN Account Number"
		}
	}
}

Fetch Entities

Enter JSON String for fetching Entities:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Beneficiary/GetEntities
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetEntities": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",
            "UserID": "SPN Account Number",
            "Pagination": {
                "RecordsToSkip": 1,
                "RecordsToTake": 10
            }
        }
    }
}

Fetch Programs

Enter JSON String for fetching programs:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Programs/GetPrograms
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetPrograms": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "Pagination": {
                "RecordsToSkip": 1,
                "RecordsToTake": 10
            }
        }
    }
}

Program Category

Enter JSON String To Fetch Program Category:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Programs/ProgramCategory
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetProgramCategory": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "Pagination": {
                "RecordsToSkip": 1,
                "RecordsToTake": 10
            }
        }
    }
}

Program Type

Enter JSON String to Fetch Program Type:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Programs/ProgramType
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetProgramType": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "CategoryID": "Use 'ProgramCategory' to get Program Category ID",
            "Pagination": {
                "RecordsToSkip": 1,
                "RecordsToTake": 10
            }
        }
    }
}

Create program

Enter JSON String for Create Program:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Programs/CreateProgram
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "CreateProgram": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "Description":"Program Name",
            "TransactionCategoryID":"Use 'ProgramCategory' to get Program Category ID",
            "TransactionSubCategoryID":"Use 'ProgramType' to get Program Sub Category ID",
            "IsClaim":boolean,
            "ClaimAmount":"Claim Amount",
            "CurrencyCode":"Currency Code"
        }
    }
}

Update Program

Enter JSON String for Update Program:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Programs/UpdateProgram
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "UpdateProgram": {
        "request": {
            "issuerAccountNumber": "SPN Account Number",
            "ProgramID":"Program ID",
            "Description":"Program Name",
            "TransactionCategoryID":"Use 'ProgramCategory' to get Program Category ID",
            "TransactionSubCategoryID":"Use 'ProgramType' to get Program Sub Category ID",
            "IsClaim":boolean,
            "ClaimAmount":"Claim Amount",
            "CurrencyCode":"Currency Code"
        }
    }
}

Get OTP Authorized Vendor

Enter JSON String for Get OTP:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/OTP/GetOTPAuthorizedVendor
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetOTPAuthorizedVendor": {
    "request": { 
    	"issuerAccountNumber": "SPN Account Number",
    	"RecipientUserId":"PAT Account Number"
    }
  }
}

Validate OTP Authorized Vendor

Enter JSON String for Get OTP:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/OTP/ValidateOTPAuthorizeVendor
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "ValidateOTPAuthorizeVendor": {
    "request": { 
    	"issuerAccountNumber": "SPN Account Number",
    	"RecipientUserId":"PAT Account Number",
    	"OneTimePassword":"One Time Password"
    	
    }
  }
}

Get Connected Status

Enter JSON String for Get OTP:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/OTP/GetConnectedStatus
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetConnectedStatus": {
    "request": { 
       "issuerAccountNumber": "SPN Account Number",
       "UserID":"PAT Account Number/SPN Account Number"    	
    }
  }
}

Tax Information

Enter JSON String for fetching fund requests details:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/Report/TransferTaxInformation
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "TransferTaxInformation": {
        "request": {
            "IssuerAccountNumber" : "SPN Account Number",
            "BeneficiaryAccountNumber" : "PAT Account Number",
            "TaxYearStartMonth" : "Tax start month number 1 - 12",
            "TaxYear" : "Tax Year",
            "EmailBody" : "Email body"
        }
    }
}

Countries

Enter JSON String for fetching fund requests details:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/General/GetCountry
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{}

States

Enter JSON String for fetching fund requests details:

Request Format

URL: https://xapisandbox.xtrm.com/API/v4/General/GetState
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetState": {
        "request": {
            "IssuerAccountNumber" : "SPN Account Number",
            "CountryID" : "CountryID from GetCountry"
        }
    }
}