Field descriptions:
defaultServiceType
: the default service type to use for the EFT collections of this mandate, can be changed on the collection request. Accepted values: ONEDAY, TWODAY, SAMEDAY
profileCode
: The profile code to create this mandate for. Ensure that the token (JWT) used for this request has access to this profile code, otherwise you will get a HTTP 400 response ("Profile code does not exist")
externalReference
: A unique reference, which can later be queried for this mandate. If this value is not unique you will get a HTTP 400 response ("Mandate with this external reference already exists")
abbreviatedName
: The abbreviated name or "short name" that will be used for this mandate.
contractReference
: The contract reference used for collections made from this mandate. See contract reference on collections.
debtor
: Debtor (money deducted from) details are set in this object.
creditor
: Creditor (money added to) details are set in this object.
releaseDate
: The date on which this mandate should be expired.
firstCollectionDate
: The date on which the first collection for this mandate should happen. This should only be set if this day is different to the collectionDay
.
firstCollectionAmountCents
: The collection amount for the first collection. This should only be set if firstCollectionDate
is set.
frequency
: The frequency at which collections will occur for this mandate. Accepted values: WEEKLY, MONTHLY or YEARLY.
ultimateCreditor
: This is used when you want this mandate's collections to be automatically be settled to a separate creditor account, after collection into the ordinary creditor account.
entryClass
: Used by the bank to categorise the mandate.
collectionDay
: The day on which to collect for this mandate. This does not mean that collections will automatically be created for this mandate, the Collections API must still be called to create collections for this mandate.
amountCents
: The amount (in cents) to collect for this mandate.
currency
: The currency to use for money collected with this mandate. Accepted values: ZAR
autoCollect
: This feature is not supported yet, please set to false
or leave unset.
verifyAccount
: NB: This incurs additional costs. Whether to verify the debtor's account details using the bank's Account Verification Service.