Create agreement

POST https://api.debitdirect.io/agreements

Request Body

NameTypeDescription

scheme*

String

Name of scheme. i.e. 'nets-ls'

meta*

Collection

Key-value data for the given scheme. Use HEAD Get template request to get a collection for a given scheme.

test

Boolean

Default to false. If true, any associated mandate and payment will be test only.

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

Last updated