Objects

The Mandate object

Fields of the Mandate object.

Returned by getList mandates for customer postCreate mandate for customer getShow mandate for customer

Attributes

id string required
method string required

One of directdebit creditcard
status string required

One of valid invalid pending
custom_mandate_reference string nullable
signature_date string nullable
details object required
8 child attributes
- consumer_name string nullable
- consumer_account string nullable
- consumer_bic string nullable
- card_holder string nullable
- card_number string nullable
- card_expiry_date string nullable
- card_label string nullable
- card_fingerprint string nullable

The Mandate object

{
    "id": "mdt_abc123",
    "method": "directdebit",
    "status": "valid",
    "custom_mandate_reference": "MY-REF-001",
    "signature_date": "2025-01-15",
    "details": {
        "consumer_name": "John Doe",
        "consumer_account": "NL55INGB0000000000",
        "consumer_bic": "INGBNL2A",
        "card_holder": "J. Doe",
        "card_number": "6787",
        "card_expiry_date": "2028-12-31",
        "card_label": "Mastercard",
        "card_fingerprint": "Fh94dX2V"
    }
}