Agreement Object

{
    "handle": "am_a004X9KLljBVOOwoPNNJoEPp",
    "scheme": "nets-ls",
    "test": true,
    "state": "Active",
    "metaData": {
        "CreditorNumber": "12345",
        "CvrNumber": "12345678"
    }
}

Attributes

handle (string) A unique handle of the agreement.

scheme (string) Name of the scheme associated to the agreement. Metadata will apply specific to the scheme.

test (boolean) If true the agreement is used to test purpose. All associated payments will not occur in real time.

state (string) Active. The agreement is active. InActive. The agreement has been terminated.

metaData (object) An object specifying data of the given scheme. See scheme attribute.