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/Register/CreateUser
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "CreateUser": {
        "request": {
            "IssuerAccountNumber" : "SPN Account Number",
            "LegalFirstName": "firstname",
            "LegalLastName": "lastname",
            "EmailAddress": "email_address",
            "EmailNotification" :"true/false",
            "MobilePhone": "mobile_phone",
            "TaxId": "tax_id",
            "DateOfBirth": {
                "Day": "DD",
                "Month": "MM",
                "Year": "YYYY"
            },
            "Address": {
                "AddressLine1": "address1",
                "AddressLine2": "address2",
                "AptSuitNum": "apartmentorsuitnumber",
                "City": "city",
                "Country": "Country",
                "CountryISO2": "currency_code",
                "PostalCode": "postal_code",
                "Region": "region"
            }
        }
    }
}

Update User

Enter JSON String for updating an existing user:

Request Format

URL: https:xapisandbox.xtrm.com/API/Register/UpdateUser
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "UpdateUser": {
         "request": {
            "IssuerAccountNumber": "SPN Account Number",
            "UserId":"string",
            "LegalFirstName": "firstname",
            "LegalLastName": "lastname",
            "TaxId": "tax_id",
            "DateOfBirth": {
                "Day": "DD",
                "Month": "MM",
                "Year": "YYYY"
            },
            "Address": {
                "AddressLine1": "address1",
                "AddressLine2": "address2",
                "AptSuitNum": "apartmentorsuitnumber",
                "City": "city",
                "Country": "Country",
                "CountryISO2": "currency_code",
                "PostalCode": "postal_code",
                "Region": "region"
            }
        }
    }
}

Fetch Personal Beneficiaries

Enter JSON String for fetching beneficiaries:

Request Format

URL: https:xapisandbox.xtrm.com/API/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/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/Bank/GetLinkedBankAccounts
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
    "GetLinkedBankAccounts": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",
            "RecipientUserId": "PAT Account Number"
        }
    }
}

Search Bank

Enter JSON String to Search Bank:

Request Format

URL: https:xapisandbox.xtrm.com/API/Bank/SearchBank
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "SearchBanks":{  
    "request":{  
      "IssuerAccountNumber":"SPN Account Number",
      "BankName":"Name of the Institution",
      "CountryISO2":"Two-letter ISO country code",
      "City":"City",
      "Pagination":{  
        "RecordsToSkip":1,
        "RecordsToTake":10
      }
    }
  }
}

Fetch Bank Withdraw Types

Enter JSON String to Get Bank Withdraw Types:

Request Format

URL: https:xapisandbox.xtrm.com/API/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 Dynamic Validation Rules

Enter JSON String to Get Bank Dynamic Validation Rules:

Request Format

URL: https:xapisandbox.xtrm.com/API/Bank/GetBankDynamicValidationRules
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "GetBankDynamicValidationRules":{  
    "request":{  
      "IssuerAccountNumber":"SPN Account Number",
      "CountryISO2":"Two-letter ISO country code",
      "Currency":"Three-letter currency code",
      "BankWithdrawType":"Bank Withdraw Type"
    }
  }
}

Create Bank Beneficiary

Enter JSON String to Create Bank Beneficiary:

Request Format

URL: https:xapisandbox.xtrm.com/API/Bank/CreateBankBeneficiary
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "CreateBankBeneficiary":{  
    "request":{  
      "IssuerAccountNumber":"SPN Account Number",
      "UserID":"PAT Account Number",
      "Beneficiary":{  
        "BeneficiaryDetails":{  
          "BeneficiaryInformation":{  
            "BeneficiaryContactName":"Beneficiary Contact Name",
            "BeneficiaryWithdrawCurrency":"Three-letter currency code",
            "WithdrawType":"Bank Withdraw Type",
            "BeneficiaryPhoneNumber":"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",
            "SWIFTBIC":"Unique identifier for the bank",
            "BeneficiaryAccountNumber":"Bank account number",
            "RoutingNumber":"Bank routing code/National Bank Code",
            "BranchName":"Bank Branch Name",
            "AddressLine1":"Bank Address Line1",
            "CountryISO2":"Two-letter ISO country code"
          }
        },
        "RegulatoryFields":{  
          "RegulatoryField":[  
            {  
              "FieldName":"Name of the regulatory field",
              "FieldValue":"Value of the regulatory field"
            }
          ]
        }
      }
    }
  }
}

Fetch Payment Methods

Enter JSON String for fetching payment methods:

Request Format

URL: https:xapisandbox.xtrm.com/API/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/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/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/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/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/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/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/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/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/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/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/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/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",
     "Pagination": {
        "RecordsToSkip": "1",
        "RecordsToTake": "10"
      }
    }
  }
}

Fetch Company Wallet Transactions

Enter JSON String for creating Company wallet:

Request Format

URL: https:xapisandbox.xtrm.com/API/Wallet/GetCompanyWalletTransactions
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{
  "GetCompanyWalletTransactions": {
    "Request": {
      "IssuerAccountNumber": "SPN Account Number",
      "WalletID": "Wallet ID",
     "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/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/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":{
       "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",
       "CVV":"CVV"
      }
       
      }
    }
  }

Fetch User Wallets

Enter JSON String for fetching User Wallets:

Request Format

URL: https:xapisandbox.xtrm.com/API/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"
        }
    }
}

Transfer Fund

Enter JSON String to transfer fund:

Request Format

URL: https:xapisandbox.xtrm.com/API/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 'GetPaymentMethods' 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",
            "DealRegId": "Deal_Reg_ID",
            "Comment": "Comment"
          }
        ]
      }
    }
  }
}

User Withdraw Fund

Enter JSON String to user withdraw fund:

Request Format

URL: https:xapisandbox.xtrm.com/API/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"
       
    }
  }
}

Transfer Fund to Company

Enter JSON String to transfer fund to company:

Request Format

URL: https:xapisandbox.xtrm.com/API/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"
    }
  }
}

Beneficiary Company Withdraw Fund

Enter JSON String to user withdraw fund:

Request Format

URL: https:xapisandbox.xtrm.com/API/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",
        "OTP":"six digit integer"
    }
  }
}

Fetch Beneficiaries

Enter JSON String for fetching beneficiaries:

Request Format

URL: https:xapisandbox.xtrm.com/API/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/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",
        "Country":"Country",
        "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/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",
        "Country":"Country",
        "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/Beneficiary/CheckBeneficiaryExist
Method: Post
Header: -u "Authorization:" "bearer string"
Content-Type: application/json
Request Param:
{  
  "CheckBeneficiaryExist":{  
    "request":{  
      "IssuerAccountNumber":"SPN Account Number",
      "CompanyName":"Company Name"
    }
  }
}

Fetch Programs

Enter JSON String for fetching programs:

Request Format

URL: https:xapisandbox.xtrm.com/API/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/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/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/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/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/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/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"
    	
    }
  }
}