Recurring Mandate

# Flow

Flow

Note: Make sure to load the user_form_url in a redirect or popup on mobile, loading user_form_url in an iframe on mobile will cause issues.

# POST /v4/recurring-mandates

Note: This method requires special agreement with Zimpler.

Note: It can take serveral days for the mandate to be processed and the charge to be performed & the notification to come.

# REQUEST

mandate + charge:

{
  // required
  "country_code": "SE",
  "ref": "merchant-mandate-ref",
  "national_identification_number": "19810101-0000",
  "site_display_name": "Best Website.com",
  "site": "example.com",
  "success_url": "https://example.com/return_path/transaction_identifier",
  "failure_url": "https://example.com/return_path/transaction_identifier",
  "close_url": "https://example.com/return_path/transaction_identifier",
  "notification_url": "https://example.com/mandate_notification_url",
  "charge": {
    // required
    "dedup": "6a734480-a051-4a05-8405-ac2d8f49102f",
    "ref": "merchant-transaction-ref",
    "amount": "100.00",
    "currency": "SEK",
    "notification_url": "https://example.com/charge_notification_url",
    // optional
    "statement_ref": "123456", // max 6 chars
  },
  // optional
  "account_ref": "PlayerRef1234",
  "email": "bobben@example.com",
  "locale": "sv",
  "mobile_phone": "+46700000000",
  "first_name": "John",
  "last_name": "Doe",
}

mandate only:

{
  // required
  "country_code": "SE",
  "ref": "merchant-mandate-ref",
  "national_identification_number": "19810101-0000",
  "site_display_name": "Best Website.com",
  "site": "example.com",
  "success_url": "https://example.com/return_path/transaction_identifier",
  "failure_url": "https://example.com/return_path/transaction_identifier",
  "close_url": "https://example.com/return_path/transaction_identifier",
  "notification_url": "https://example.com/mandate_notification_url",
  "charge": null,
  // optional
  "account_ref": "PlayerRef1234",
  "email": "bobben@example.com",
  "locale": "sv",
  "mobile_phone": "+46700000000",
  "first_name": "John",
  "last_name": "Doe",
}

# Responses

{
  ...
  "id": "6a734480-a051-4a05-8405-ac2d8f49102f",
  "user_form_url": "https://account-sandbox.zimpler.com?code=6a734480-a051-4a05-8405-ac2d8f49102f",
}

# POST /v4/recurring-mandates/:id/charges

Note: This method requires special agreement with Zimpler.

Note: It can take serveral days for the charge to be performed & the notification to come.

# Request

{
// required
  "dedup": "6a734480-a051-4a05-8405-ac2d8f49102f",
  "ref": "merchant-transaction-ref",
  "amount": "100.00",
  "currency": "SEK",
  "notification_url": "https://example.com/charge_notification_url",
// optional
  "statement_ref": "123456", // max 6 chars
}