Developers
Docs
  • Introduction
  • Welcome
  • Getting Started
    • Authentication
    • Errors
    • Idempotency
    • Pagination
    • Metadata
    • Versioning
    • Traceability
    • Limitations
  • API
    • API reference
      • Agreements
        • Agreement Object
        • List agreements
        • Get agreement
        • Get template
        • Create agreement
      • ApiKeys
        • ApiKey object
      • Customers
        • Customer object
        • List customers
        • Get customer
      • Mandates
        • Mandate object
      • Payments
        • Cancel
      • Webhooks
      • Merchants
        • Me
    • Specification
  • Webhooks
    • Events
Powered by GitBook
On this page
  1. API
  2. API reference
  3. Agreements

Create agreement

PreviousGet templateNextApiKeys

Last updated 2 years ago

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

Request Body

Name
Type
Description

scheme*

String

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

meta*

Collection

Key-value data for the given scheme. Use 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"
    }
}
HEAD Get template