Payment Events
Event types and causes for payment resources.
Created#
The payment has been created.
apipayment_createdPayment created via the API.
gocardlesspayment_createdPayment created by a subscription.
apiinstalment_schedule_createdPayment created by an instalment schedule.
Customer Approval Granted#
The payment required additional approval from the customer before it could be submitted, and that approval has been granted.
customercustomer_approval_grantedThe customer granted approval for this payment
Customer Approval Denied#
The payment required additional approval from the customer before it could be submitted, and that approval has been denied.
customercustomer_approval_deniedThe customer denied approval for this payment
Submitted#
The payment has been submitted to the banks. It will be a few days until it is collected, or fails.
gocardlesspayment_submittedPayment submitted to the banks. As a result, it can no longer be cancelled.
Confirmed#
The payment has been collected from the customer's bank account, and is now being held by GoCardless. It can take up to 5 working days for a payment to be collected, and will then be held for a short time before becoming paid_out.
gocardlesspayment_confirmedEnough time has passed since the payment was submitted for the banks to return an error, so this payment is now confirmed.
Chargeback Cancelled#
The customer's bank has cancelled the chargeback request. This is almost always at the request of the customer.
bankpayment_confirmedThe chargeback for this payment was reversed
gocardlesspayment_confirmedThe chargeback for this payment was reversed
Paid Out#
The payment has left GoCardless and has been sent to the creditor's bank account.
gocardlesspayment_paid_outThe payment has been paid out by GoCardless.
Late Failure Settled#
The payment was a late failure which had already been paid out, and has been debited from a payout.
gocardlesslate_failure_settledThis late failed payment has been settled against a payout.
Chargeback Settled#
The payment was charged back, having previously been paid out, and has been debited from a payout.
gocardlesschargeback_settledThis charged back payment has been settled against a payout.
Surcharge Fee Debited#
A surcharge fee has been charged for this payment, because it failed or got charged back.
gocardlesssurcharge_fee_debitedA surcharge fee has been charged for a payment.
Failed#
The payment could not be collected, usually because the customer did not have sufficient funds available. GoCardless will automatically retry the payment if event's will_attempt_retry field is true. See the Success+ feature.
bankrefer_to_payerThe customer's account had insufficient funds to make this payment.
bankbank_account_closedThis payment failed because the customer is deceased.
bankinvalid_bank_detailsThe account number was invalid. The mandate will also be cancelled or failed.
bankinvalid_bank_detailsThe bank account specified does not exist. The mandate will also be cancelled.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankbank_account_closedThis payment has been cancelled because the account has been sold to another financial institution.
bankrefer_to_payerThis payment has been cancelled because the payer’s bank account is frozen. ACH authorization will be cancelled.
bankrefer_to_payerThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankrefer_to_payerThe payment failed but the reason for the failure was not provided, usually for regulatory reasons.
bankrefer_to_payerThe customer refused to accept this payment.
bankauthorisation_disputedThe customer claims that they asked you to cancel their mandate before you took the payment.
bankreturn_on_odfi_requestThis payment was charged back by the customer's bank, because the customer disputed authorising the transaction.
bankauthorisation_disputedThis payment has been cancelled because the payer disputes authorising its mandate.
bankauthorisation_disputedThe payment was charged back. Customer advises an authorization to debit exists, but there is an error or defect in the payment such that the entry does not conform to the terms of the authorization.
bankauthorisation_disputedThis payment was charged back because the customer disputes having authorised you to set up a mandate with them.
bankauthorisation_disputedThe customer has placed a stop on this payment and the authorisation has been cancelled. Please contact the customer to set up a new authorisation.
bankauthorisation_disputedThis payment has been cancelled because the customer disputes authorising its mandate.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankotherThere was an internal error processing this payment.
bankotherThis payment has been cancelled because the customer's bank does not support the required payment type or transaction format.
bankotherThis payment was cancelled because the return entry was not a duplicate of an entry previously returned by the RDFI.
bankotherThis payment was cancelled because the financial institution's participation has been restricted by a regulatory authority.
banktest_failureGoCardless has marked this payment as failed in sandbox to enable testing of payment failure webhooks.
bankrefer_to_payerThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankmandate_cancelledThe customer cancelled the mandate at their bank before the payment could be collected.
bankbank_account_closedThis payment failed because the customer is deceased.
bankbank_account_transferredYour customer's mandate was transferred to a new bank account, but this payment was submitted to the old account. You may wish to retry the payment once you have received a transferred webhook for the corresponding mandate.
bankauthorisation_disputedThe customer has disputed having been notified of this Direct Debit.
bankinvalid_bank_detailsThe account number was invalid. The mandate will also be cancelled or failed.
bankbank_account_closedThe customer closed their account before the payment could be taken. The mandate will also be cancelled or failed.
bankotherNo mandate was setup for this payment.
bankauthorisation_disputedThe customer has disputed that the amount taken differs from the amount they were notified of.
bankinvalid_bank_detailsThe bank account specified does not exist. The mandate will also be cancelled.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankdirect_debit_not_enabledThe bank account for this payment does not support SEPA Direct Debit. The mandate will also be cancelled.
bankaccount_blocked_for_any_financial_transactionThis payment failed because the payer's account was blocked.
bankinsufficient_fundsThe customer's account had insufficient funds to make this payment.
bankmandate_cancelledThe customer cancelled their mandate at their bank.
bankbank_account_closedThis payment failed because the customer is deceased.
bankrefer_to_payerThe payment failed but the reason for the failure was not provided, usually for regulatory reasons.
bankrefer_to_payerThe customer refused to accept this payment.
bankrefer_to_payerThe payment failed due to a restriction on Direct Debit payments from the payer's bank account.
bankotherThe customer's bank refused to accept this payment, please refer to customer.
bankotherThere was an internal error processing this payment.
bankpayment_stoppedThe payment was stopped by the payer or their bank.
bankdirect_debit_not_enabledThe payment failed due to a restriction on Direct Debit payments from the payer's bank account.
bankrefer_to_payerThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankinvalid_bank_detailsThe account number was invalid. The mandate will also be cancelled or failed.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankinvalid_bank_detailsThe account number was invalid. The mandate will also be cancelled or failed.
gocardlessotherThere was an internal error processing this payment.
bankinvalid_bank_detailsThe bank account specified does not exist. The mandate will also be cancelled.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankbank_account_closedThis payment failed because the customer is deceased.
bankinvalid_bank_detailsThe account number was invalid. The mandate will also be cancelled or failed.
bankrefer_to_payerThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankotherThere was an internal error processing this payment.
bankinvalid_bank_detailsThe account number was invalid. The mandate will also be cancelled or failed.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankinvalid_bank_detailsThe bank account specified does not exist. The mandate will also be cancelled.
bankrefer_to_payerThe customer refused to accept this payment.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankrefer_to_payerThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankotherThis payment was canceled because the customer cancelled the mandate at their bank.
bankinvalid_bank_detailsThe bank account specified does not exist. The mandate will also be cancelled.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankinvalid_bank_detailsThe bank account specified does not exist. The mandate will also be cancelled.
bankrefer_to_payerThe customer's account had insufficient funds to make this payment.
bankrefer_to_payerThe customer refused to accept this payment.
bankrefer_to_payerThe payment failed due to a restriction on Direct Debit payments from the payer's bank account.
bankrefer_to_payerThe customer's account had insufficient funds to make this payment.
bankinvalid_bank_detailsThe account number was invalid. The mandate will also be cancelled or failed.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankrefer_to_payerThe payment failed due to a restriction on Direct Debit payments from the payer's bank account.
bankbank_account_closedThis payment failed because the customer is deceased.
bankrefer_to_payerThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankotherThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankotherThe customer disputes having authorised you to set up a mandate with them.
bankotherThe payment failed but the reason for the failure was not provided, usually for regulatory reasons.
bankotherThe payment failed but the reason for the failure was not provided, usually for regulatory reasons.
bankinsufficient_fundsThe customer's account had insufficient funds to make this payment.
bankbank_declined_paymentPayment declined by the bank.
bankdaily_payment_limit_reachedPayment exceeds the daily payment limit for this payer, imposed by the bank.
bankinsufficient_payment_permissionsPayment denied due to missing approvals from the bank.
bankpayment_violated_mandate_parametersThe payment failed due to a violation of the associated mandate consent parameters.
bankotherThe payment failed but the reason for the failure was not provided, usually for regulatory reasons.
bankinsufficient_fundsThe customer's account had insufficient funds to make this payment.
bankotherThe payment failed but the reason for the failure was not provided, usually for regulatory reasons.
bankinsufficient_fundsThe customer's account had insufficient funds to make this payment.
bankotherThe payment failed but the reason for the failure was not provided, usually for regulatory reasons.
bankinsufficient_fundsThe customer's account had insufficient funds to make this payment.
bankclosed_debtor_account_numberThis payment failed because the payer's account was closed.
bankaccount_details_changedThis payment failed because the payer's account was changed to a different account.
bankblocked_accountThis payment failed because the payer's account was blocked.
bankunsuccessful_direct_debitThis payment could not be completed due to an unsuccessful transaction against the mandate.
banklimit_exceededThis payment exceeds the maximum limit set by the bank for this payer.
bankmandate_expiredThe mandate for this payment has expired.
bankbank_system_processing_errorThe customer's bank refused to accept this payment, please refer to customer.
bankmaximum_number_of_dd_transactions_exceededThe payment failed due to a violation of the associated mandate consent parameters.
bankmaximum_dd_transaction_amount_exceededThe payment failed due to a violation of the associated mandate consent parameters.
bankinvalid_bank_detailsPayId is no longer valid, modify the mandate with the correct PayId.
bankpayment_violated_mandate_parametersThe payment failed due to a violation of the associated mandate consent parameters.
gocardlessno_status_updatePayment automatically failed after 24h without status update from bank
Charged Back#
The customer asked their bank to refund the payment under the Direct Debit Guarantee, and it has been returned to the customer.
bankauthorisation_disputedThis payment was charged back by the customer's bank, because the customer disputed authorising the transaction.
bankrefund_requestedThis payment was charged back by the customer's bank at the customer's request within the 8 week cool-off period.
bankmandate_cancelledThis payment was charged back because the mandate was withdrawn.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankreturn_on_odfi_requestThis payment was charged back by the customer's bank, because the customer disputed authorising the transaction.
bankauthorisation_disputedThe customer has disputed that the amount taken differs from the amount they were notified of.
bankauthorisation_disputedThe customer has disputed having been notified of this Direct Debit.
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.
bankmandate_cancelledThis payment was charged back by the customer's bank, because the customer disputed authorising the transaction.
bankrefund_requestedThis payment was charged back by the customer's bank at the customer's request within the 8 week cool-off period.
bankrefund_requestedThis payment was charged back by the customer's bank at the customer's request within the 8 week cool-off period.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankmandate_cancelledThe customer cancelled their mandate at their bank.
bankotherThe payment was charged back.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankotherThe customer has disputed that the amount taken differs from the amount they were notified of.
bankotherThe customer has disputed having been notified of this Direct Debit.
bankmandate_cancelledThis payment was charged back because the mandate was withdrawn.
Cancelled#
The payment was cancelled.
bankbank_account_closedThis payment was cancelled because the customer is deceased.
bankrefer_to_payerThis payment has been cancelled because the bank details for its mandate are incorrect.
bankbank_account_closedThis payment has been cancelled because the bank account it was going to be taken from has been closed.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
bankrefer_to_payerThis payment has been cancelled because the bank account it was going to be taken from does not support Direct Debit.
bankauthorisation_disputedThis payment has been cancelled because the payer disputes authorising its mandate.
bankrefer_to_payerThis payment has been cancelled because its mandate was cancelled.
bankmandate_cancelledThis payment has been cancelled because its mandate was cancelled.
bankotherThere was an internal error processing this payment.
gocardlessinstalment_schedule_cancelledpayment_cancelled_at_request
apipayment_cancelledThis payment was cancelled at your request.
apimandate_cancelledThe mandate for this payment was cancelled at your request.
apiinstalment_schedule_cancelledpayment_cancelled_at_request
apibank_account_closedThe bank account for this payment was disabled at your request.
bankmandate_cancelledThe mandate for this payment was cancelled at a bank branch.
bankbank_account_closedThe mandate for this payment was cancelled as the customer's bank account has been closed.
bankbank_account_transferredThe mandate for this payment was cancelled as the customer asked their bank to transfer the mandate to a new account, but the bank has failed to send GoCardless the new bank details.
bankauthorisation_disputedThe customer disputes authorising this mandate.
bankbank_account_closedThis payment was cancelled because the customer is deceased.
bankbank_account_closedThis payment was cancelled because the customer closed their bank account before it could be collected.
bankrefer_to_payerThis payment was canceled because the customer cancelled the mandate at their bank.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
bankbank_account_closedThis payment has been cancelled because the bank account it was going to be taken from has been closed.
bankdirect_debit_not_enabledThis payment has been cancelled because the bank account it was going to be taken from does not support Direct Debit.
bankaccount_blocked_for_any_financial_transactionThis payment failed because the payer's account was blocked.
bankauthorisation_disputedThis payment has been cancelled because the payer disputes authorising its mandate.
bankmandate_cancelledThis payment has been cancelled because the payer disputes authorising its mandate.
bankauthorisation_disputedThis payment has been cancelled because the customer disputes authorising its mandate.
bankbank_account_closedThis payment has been cancelled because the bank account it was going to be taken from has been closed.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are not valid.
bankbank_account_transferredThis payment has been cancelled because the customer requested their bank transfer their Direct Debit to a new account but the bank did not send GoCardless the new bank details.
bankdirect_debit_not_enabledThis payment has been cancelled because the bank account for its mandate does not support Direct Debit.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are not valid.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankinvalid_bank_detailsThis payment has been cancelled because the customer requested their bank transfer their Direct Debit to a new account but the bank did not send GoCardless the new bank details.
bankrefer_to_payerThis payment was canceled because the customer cancelled the mandate at their bank.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankbank_account_closedThe bank account for this payment has been closed. The mandate will also be cancelled.
bankinvalid_bank_detailsThe bank account specified does not exist. The mandate will also be cancelled.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankotherThe customer disputes having authorised you to set up a mandate with them.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
bankbank_account_closedThis payment has been cancelled because the bank account it was going to be taken from has been closed.
bankbank_account_closedThis payment was cancelled because the customer is deceased.
bankotherThis payment has been cancelled because the customer disputes authorising its mandate.
bankauthorisation_disputedThis payment has been cancelled because the customer disputes authorising its mandate.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankmandate_cancelledThis mandate was cancelled by the customer or their bank.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
bankdirect_debit_not_enabledThis payment has been cancelled because the bank account for its mandate does not support Direct Debit.
bankpayment_stoppedThe payment was stopped by the payer or their bank.
bankbank_account_closedThis payment was canceled because the customer cancelled the mandate at their bank.
bankbank_account_closedThis payment was canceled because the customer cancelled the mandate at their bank.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
bankotherAn error was received from the banks while setting up the mandate for this payment.
bankauthorisation_disputedThe customer disputes having authorised you to set up a mandate with them.
bankmandate_cancelledThis payment has been cancelled because its mandate was cancelled.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
bankauthorisation_disputedThis payment has been cancelled because the customer disputes authorising its mandate.
bankbank_account_closedThis payment has been cancelled because the bank account it was going to be taken from has been closed.
bankbank_account_closedThis payment was cancelled because the customer is deceased.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
bankrefer_to_payerThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
bankbank_account_closedThis payment was canceled because the customer cancelled the mandate at their bank.
bankinvalid_bank_detailsThis payment has been cancelled because the bank details for its mandate are incorrect.
gocardlessmandate_expiredThe mandate expired before the payment could be collected.
bankrefer_to_payerThe customer's bank wasn't able to pay the Direct Debit. This is almost always due to insufficient funds, but is occasionally used as a catch-all for other failures.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankmandate_cancelledThis payment was canceled because the customer cancelled the mandate at their bank.
bankmandate_suspended_by_payerThe mandate for this payment was suspended by the payer.
gocardlessmandate_cancelledThe mandate for this payment was cancelled at your request.
gocardlessmandate_cancelledThe mandate expired before the payment could be collected.
bankreturn_on_odfi_requestThe payment was cancelled because of an ODFI return request.
bankrefer_to_payerThis payment has been cancelled because the payer’s bank account is frozen. ACH authorization will be cancelled.
gocardlessinitial_one_off_payment_failedThis mandate has been cancelled because the initial faster payment failed
Resubmission Requested#
A request to resubmit the payment was made by the payment retry endpoint. This can also mean that the payment was automatically scheduled for resubmission by GoCardless, if you have opted in for the Success+ feature.
apipayment_retriedAn attempt to retry this payment was requested.
gocardlesspayment_autoretriedThe payment was scheduled for resubmission automatically by GoCardless.
Sds Settlement Delayed#
We are withholding this payment from same-day settlement due to a higher possibility of failure.
gocardlesssds_settlement_delayedWe are withholding this payment from same-day settlement due to a higher possibility of failure.