Sign in
Mandates

Creates a Direct Debit mandate.

<b>Authorization</b>: End user or Merchant token is required.

<b>User permissions required</b>: CanCreateMandates

post/api/v1/mandates

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/mandates
  • Auth: API key in header Authorization

Request body

merchantIDstring uuid required

Merchant ID that this mandate is associated with.

firstNamestring required

Customer's first name.

lastNamestring required

Customer's last name.

addressLine1string required

First line of the customer's address.

addressLine2string nullable

Second line of the customer's address. Optional.

postalCodestring required

Customer's postal code.

citystring required

Customer's city.

countryCodestring required

2-character country code of the customer's bank account.

ibanstring nullable

IBAN of the customer's bank account in case of EUR account.

accountNumberstring nullable

Account number of the customer's bank account in case of GBP account.

sortCodestring nullable

Sort code of the customer's bank account in case of GBP account.

emailAddressstring email required

Customer's email address.

referencestring nullable

Field that you can use as reference.

isRecurringboolean nullable

Indicates whether this mandate is single-use or recurring.

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC' required

Currency of the mandate.

Response

OK

idstring uuid

Internal ID of the mandate.

merchantIDstring uuid

Internal ID of this mandate's merchant.

supplierName'None' | 'CyberSource' | 'Checkout' | 'Stripe' | 'Modulr' | 'Plaid' | 'Yapily' | 'Nofrixion' | 'Bitcoin' | 'BitcoinTestnet' | 'BankingCircle' | 'BankingCircleAgency' | 'Simulator' | 'Lightning' | 'LightningTestnet' | 'BankingCircleDirectDebit' | 'Technoxander' nullable

Name of the supplier used to create this mandate.

supplierMandateIDstring nullable

ID that the supplier assigned to this mandate.

supplierBankAccountIDstring nullable

ID that the supplier assigned to this mandate's bank account.

supplierCustomerIDstring nullable

ID that the supplier assigned to this mandate's customer.

customerFirstNamestring nullable

Customer's first name.

customerLastNamestring nullable

Customer's last name.

customerCountryCodestring nullable

Customer's country of residence code.

customerCountryNamestring nullable

Customer's country of residence.

customerCitystring nullable

Customer's city of residence.

customerEmailAddressstring nullable

Customer's email address.

customerIbanstring nullable

Customer's IBAN in case of EUR account.

customerAccountNumberstring nullable

Customer's account number in case of GBP account.

customerSortCodestring nullable

Customer's sort code in case of GBP account.

referencestring nullable

Reference assigned to this mandate.

isRecurringboolean

Whether this mandate is single-use or recurring.

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC'

Currency of this mandate.

approvedAtstring date-time nullable

Date at which the supplier approved this mandate.

supplierStatusstring nullable

Last status that the supplier reported for this mandate.

status'Unknown' | 'Pending' | 'Active' | 'Expired' | 'Failed'

General status of this mandate.

insertedstring date-time

The timestamp this mandate was created at.

lastUpdatedstring date-time

The timestamp this mandate was last updated at.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.