Skip to content

TheM.remittance Reference

Constructor

The parent TheM class contains functionality enabling the initialization of any TheM subclass or submodule instance by simply calling TheM.doInit('subclassName'), where the input string is a case sensitive space-delimited string containing the names of all submodules that may be required in the current session. Most TheM subclasses also require the 'common' submodule. It is common to initialize the target submodule and any other submodule dependencies concurrently. The following example will initialize a new instance of the necessary submodules using a proxy constructor in TheM parent class.

TheM.doInit('subclassName1 subclassName2 subclassName3 etc');

Example

TheM.doInit('common user accounts cards beneficiaries fxrates restrictions remittance');

Properties

Property table for TheM.remittance

Property Description Required Schema
newRemittance Gets (returns) a new Remittance instance. For example, remittanceName = TheM.remittance.newRemittance will create a new instance named 'remittanceName'. Set required properties like remittanceName.transactionTypeId = 'USA_wire'. Once all required properties are set and valid, the remittance can be submitted to the server by calling TheM.remittance.doSubmit(remittanceName). Yes {
  "title": "TheM.remittance.newRemittance",
  "type": "object",
  "description": "Gets (returns) a new Remittance
instance. For example, remittanceName&nbsp;=<br/>TheM.remittance.newRemittance will create a new
instance named 'remittanceName'. Set required
properties like
remittanceName.transactionTypeId&nbsp;=<br/>'USA_wire'. Once all required properties are set
and valid, the remittance can be submitted to the
server by calling
TheM.remittance.doSubmit(remittanceName).",
  "$comment": "getter",
  "examples": [
    {
      "AFiRemittanceId":
"jb17199168600718m6acjetf8ub0z2ehhjfx9fv70c1o
a3y73pmq5t8",
      "isValid": false,
      "other": {}
    }
  ],
  "nullable": false
}
validator Gets (returns) an instance of the RemittanceValidationClass. This instance can be used to validate the current Remittance. Yes {
  "title": "TheM.remittance.validator",
  "type": "object",
  "description": "Gets (returns) an instance of the
RemittanceValidationClass. This instance can be
used to validate the current Remittance.",
  "$comment": "getter",
  "examples": [
    null
  ],
  "nullable": false
}

Methods

Method Name Parameter Descriptions Description Example
doSubmit 
[
  {
    "title": "givenRemittance",
    "type": "object",
    "nullable": false,
    "example": {
      "AFiRemittanceId":
"jb17199168600718m6acjetf8ub0z
2ehhjfx9fv70c1oa3y73pmq5t8",
      "amount": 10.01,
      "beneficiary": {},
      "currency": "USD",
      "isValid": true,
      "narrativeDebit": "Transfer to
beneficiary",
      "other": {
        "additionalProperty": "value of
additionalProperty"
      },
      "sourceAccount": {},
      "transactionTypeId": "USA",
      "validationMessage": ""
    }
  }
]
 The doSubmit method will submit the given Remittance instance to the server. TheM.remittance.doSubmit(
  {
    "AFiRemittanceId": "jb17199168600718m6acjetf8ub0z2ehhjfx9fv70c1oa3y73pmq5t8",
    "amount": 10.01,
    "beneficiary": {},
    "currency": "USD",
    "isValid": true,
    "narrativeDebit": "Transfer to beneficiary",
    "other": {
      "additionalProperty": "value of additionalProperty"
    },
    "sourceAccount": {},
    "transactionTypeId": "USA",
    "validationMessage": ""
  }
);

Submodules

Submodule Name Link
Remittance Remittance
RemittanceValidationClass RemittanceValidationClass