Mandate Events
Event types and causes for mandate resources.
Created#
The mandate has been created.
apimandate_createdMandate created via the API.
gocardlessmandate_createdMandate created by a bulk change
Customer Approval Granted#
The mandate required additional approval from the customer (e.g. permission from a second signatory), and that approval has been granted.
customercustomer_approval_grantedThe customer has granted approval for this mandate
Customer Approval Skipped#
The mandate originally was believed to require additional approval from the customer (e.g. permission from a second signatory), but approval has been skipped (for example because the mandate was erroneously marked as needing a second signature).
customercustomer_approval_skippedThe customer has skipped approval for this mandate
Active#
The mandate has been successfully set up by the customer’s bank.
gocardlessmandate_activatedThe time window after submission for the banks to refuse a mandate has ended without any errors being received, so this mandate is now active.
bankmandate_activatedThe customer's bank has confirmed that this mandate has been activated.
Cancelled#
The mandate has been cancelled, either by the customer through their bank or this API, or automatically when their bank account is closed.
bankbank_account_closedThis bank account has been closed as the customer is deceased.
bankbank_account_closedThe bank account for this mandate has been closed.
bankmandate_cancelledThe mandate was cancelled at a bank branch.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankinvalid_bank_detailsThe specified bank account does not exist or was closed.
bankdirect_debit_not_enabledThe bank account does not support Direct Debit.
bankrefer_to_payerThis mandate has been cancelled because a payment under it failed.
bankreturn_on_odfi_requestmandate_cancelled_because_payment_charged_back
apimandate_cancelledThe mandate was cancelled at your request.
apibank_account_closedThe customer's account was disabled at your request.
bankmandate_cancelledThe mandate was cancelled at a bank branch.
bankbank_account_closedThis bank account has been closed as the customer is deceased.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
bankbank_account_closedThe customer's account was closed at their bank.
bankauthorisation_disputedThe customer has disputed the amount of notice specified on the mandate via their bank.
bankmandate_cancelledThe mandate was cancelled at a bank branch.
bankbank_account_closedThis mandate has been cancelled, because a payment against it indicated that the customer is deceased.
bankbank_account_closedThe bank account for this mandate has been closed.
bankrefer_to_payerThis mandate has been cancelled because a payment under it failed.
bankauthorisation_disputedThe customer claims that they asked you to cancel their mandate before you took the payment.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankinvalid_bank_detailsThe bank account specified does not exist. Any subscriptions and pending payments will also be cancelled.
bankbank_account_closedThe bank account for this mandate has been closed. Any subscriptions and pending payment will also be cancelled.
bankdirect_debit_not_enabledThe bank account for this mandate does not support SEPA direct debit. Any subscriptions and pending payments will also be cancelled.
bankaccount_blocked_for_any_financial_transactionThe bank account for this mandate was blocked. Any subscriptions and pending payments will also be cancelled.
bankmandate_cancelledA payment under this mandate failed, indicating that the mandate has been cancelled at the customer's bank. Any subscriptions and pending payments will also be cancelled.
bankbank_account_closedThis mandate has been cancelled because the customer is deceased.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankdirect_debit_not_enabledThe bank account does not support Direct Debit.
bankpayment_stoppedThe payment was stopped by the payer or their bank.
bankotherThis mandate has been cancelled because a payment under it failed.
bankbank_account_closedThe bank account for this mandate has been closed.
bankbank_account_closedThis bank account has been closed as the customer is deceased.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankinvalid_bank_detailsThe bank account specified does not exist.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankbank_account_closedThe customer's account was closed at their bank.
bankbank_account_closedThis bank account has been closed as the customer is deceased.
bankinvalid_bank_detailsThe bank account specified does not exist. Any subscriptions and pending payments will also be cancelled.
bankrefer_to_payerThere was an internal error processing this mandate.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankmandate_cancelledThe mandate was cancelled at your request.
bankmandate_cancelledThe mandate has been cancelled due to fraud.
bankmandate_cancelledThe mandate has been suspended.
bankrefer_to_payerThis mandate was cancelled by the customer or their bank.
bankinvalid_bank_detailsThis mandate was cancelled due to a Notification of Change indicating the customer's account number or branch number was incorrect, please contact the customer.
bankotherThe account associated with the customer's mandate is blocked.
bankinvalid_bank_detailsThis mandate was cancelled due to a Notification of Change indicating the customer's selected account type was incorrect, please contact the customer.
bankbank_account_closedThe customer's account was closed at their bank.
bankbank_account_closedThis mandate has been cancelled because the customer is deceased.
bankotherThe customer's account is not permitted to send funds to the beneficiary.
bankbank_account_closedThe customer's account was closed at their bank.
bankinvalid_bank_detailsThe bank account specified does not exist. Any subscriptions and pending payments will also be cancelled.
bankbank_account_closedThe customer's account was closed at their bank.
bankbank_account_closedThis bank account has been closed as the customer is deceased.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankinvalid_bank_detailsThe specified bank account does not exist or was closed.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankmandate_cancelledThis mandate was cancelled by the bank.
bankmandate_cancelledThis mandate was cancelled because the bank account has transitioned to an inactive state.
gocardlessmandate_cancelledThe mandate was cancelled at your request.
gocardlessinitial_one_off_payment_failedThis mandate has been cancelled because the initial faster payment failed
Failed#
The mandate could not be set up, generally because the specified bank account does not accept Direct Debit payments or is closed.
bankbank_account_closedThis bank account has been closed as the customer is deceased.
bankrefer_to_payerThis mandate was cancelled due to a Notification of Change indicating the customer's account number or branch number was incorrect, please contact the customer.
bankrefer_to_payerThis mandate was cancelled due to a Notification of Change indicating the customer's selected account type was incorrect, please contact the customer.
bankbank_account_closedThe bank account for this mandate has been closed.
bankmandate_cancelledThe mandate was already cancelled.
bankauthorisation_disputedThe mandate was already cancelled.
bankinvalid_bank_detailsThe specified bank account does not exist or was closed.
bankdirect_debit_not_enabledThe bank account does not support Direct Debit.
bankrefer_to_payerThis mandate has been cancelled because a payment under it failed.
bankotherThis mandate has been cancelled because a payment under it failed.
bankreturn_on_odfi_requestThe mandate has been cancelled because a payment under it was charged back.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankinvalid_bank_detailsThe specified bank account does not exist or was closed.
bankrefer_to_payerThis mandate has been cancelled because a payment under it failed.
bankbank_account_closedThe bank account for this mandate has been closed as the customer is deceased.
bankinvalid_bank_detailsThe specified bank account does not exist or was closed.
bankbank_account_closedThe customer's account was closed at their bank.
bankdirect_debit_not_enabledThe bank account does not support Direct Debit.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
bankinvalid_bank_detailsThe bank account specified does not exist.
bankdirect_debit_not_enabledThe bank account does not support Direct Debit.
bankpayment_stoppedThe payment was stopped by the payer or their bank.
bankinvalid_bank_detailsThe bank account specified does not exist. Any subscriptions and pending payments will also be cancelled.
bankotherThere was an internal error processing this mandate.
bankinvalid_bank_detailsThe bank account specified does not exist.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankbank_account_closedThe customer's account was closed at their bank.
bankbank_account_closedThis bank account has been closed as the customer is deceased.
bankinvalid_bank_detailsThe bank account specified does not exist. Any subscriptions and pending payments will also be cancelled.
bankrefer_to_payerThere was an internal error processing this mandate.
bankmandate_cancelledThe mandate has expired.
bankrefer_to_payerThere was an internal error processing this mandate.
bankinvalid_bank_detailsThe bank account specified does not exist. Any subscriptions and pending payments will also be cancelled.
bankbank_account_closedThe customer's account was closed at their bank.
bankinvalid_bank_detailsThe customer's bank account was transferred to a different bank or building society.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankotherThe customer disputes having authorised you to set up a mandate with them.
bankrefer_to_payerThis mandate has been cancelled because a payment under it failed.
bankinvalid_bank_detailsThe specified bank account does not exist or was closed.
bankbank_account_closedThe customer's account was closed at their bank.
bankbank_account_closedThis bank account has been closed as the customer is deceased.
bankrefer_to_payerThe account holder name may be different than that associated with the electronic transaction to run.
bankinvalid_bank_detailsThe bank account specified does not exist. Any subscriptions and pending payments will also be cancelled.
Transferred#
The mandate has been transferred to a different bank account either using a bank switching service (where it is supported) or with help from GoCardless Support when a customer asks to change their bank account (we can make the switch after verifying the details). The event will include links[previous_customer_bank_account] and links[new_customer_bank_account]. When using a bank switching service, the mandate may have been submitted again, depending on how the involved banks handled the transfer.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
apimandate_transferredThis mandate was transferred to a new bank account through GoCardless.
Expired#
No collection attempts were made against the mandate within the dormancy period of your service user number. As a result it has expired, and no further collections can be taken against it. If you wish to continue taking payments from this customer you should request their permission and use the reinstate endpoint.
gocardlessmandate_expiredThe mandate is being marked as expired, because no payments have been collected against it for the dormancy period of your service user number. If you have access to the mandate reinstation API endpoint, you can use this to attempt to set this mandate up again.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
gocardlessmandate_cancelledThe mandate has expired.
Submitted#
The mandate has been submitted to the banks, and should become active in a few days, unless the bank declines the request.
gocardlessmandate_submittedThe mandate has been submitted to the banks.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
Resubmission Requested#
A request to resubmit the mandate was made by the mandate reinstate endpoint.
apiresubmission_requestedAn attempt to reinstate this mandate was requested.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
bankbank_account_transferredThe customer's bank account was transferred to a different bank or building society.
Reinstated#
The mandate has become active again, after it was cancelled or expired. This can be due to the customer's bank wishing to undo a cancellation or expiry notice they sent, or because the mandate was successfully reinstated via the reinstate endpoint.
gocardlessmandate_reinstatedThe time window after submission for the banks to refuse a mandate has ended without any errors being received, so this mandate is now active.
bankmandate_reinstatedA cancelled mandate has been re-instated by the customer's bank.
Replaced#
The mandate has been cancelled and replaced by a new mandate (for example, because the creditor has moved to a new Service User Number). The event will include links[new_mandate] with the ID of the new mandate.
gocardlessscheme_identifier_changedThe creditor has changed to a different scheme identifier, so this mandate has been cancelled and replaced by a new one.
Consumed#
The mandate has been used to create a payment, and has now been consumed. It cannot be used again.
gocardlessmandate_consumedThe mandate has been used to create a payment, and has now been consumed. It cannot be used again.
Blocked#
The mandate has been blocked because the customer's details matched against an entry in either our global blocklist or the blocklist populated by you. This mandate cannot be unblocked and no payments can be created against it. If you still wish to collect payments from this customer, you will need to remove their details from any blocks you have created and ask them to set up a new mandate. If you contacted GoCardless to block the customer's details, you will need to make a request to unblock them.
gocardlessmandate_blockedThe mandate has been blocked because the customer's details matched against an entry in the blocklist populated by you.
gocardlessmandate_blocked_by_gocardlessThe mandate has been blocked because the customer's details matched against an entry in our global blocklist.