GoCardlessDeveloper Docs
Create a sandbox account

Billing Request Events

Event types and causes for billing request resources.

Created#

This billing request has been created.

gocardlessbilling_request_created

This billing request has been created.

apibilling_request_created

This billing request has been created.

payerbilling_request_created

This billing request has been created.

Flow Created#

A billing request flow has been created against this billing request.

gocardlessbilling_request_flow_created

A billing request flow has been created against this billing request.

apibilling_request_flow_created

A billing request flow has been created against this billing request.

payerbilling_request_flow_created

A billing request flow has been created against this billing request.

Flow Visited#

The billing request flow has been visited.

payerbilling_request_flow_visited

The billing request flow has been visited.

Flow Exited#

The billing request flow has been exited by the payer.

payerbilling_request_flow_exited

The billing request flow has been exited by the payer.

Collect Customer Details#

Customer details have been collected for this billing request.

apibilling_request_collect_customer_details

Customer details have been collected for this billing request.

payerbilling_request_collect_customer_details

Customer details have been collected for this billing request.

Select Institution#

Institution details have been collected for this billing request.

payerbilling_request_select_institution

Institution details have been collected for this billing request.

Collect Bank Account#

Bank account details have been collected for this billing request.

apibilling_request_collect_bank_account

Bank account details have been collected for this billing request.

payerbilling_request_collect_bank_account

Bank account details have been collected for this billing request.

Payer Details Confirmed#

Payer has confirmed all their details for this billing request.

apibilling_request_payer_details_confirmed

Payer has confirmed all their details for this billing request.

payerbilling_request_payer_details_confirmed

Payer has confirmed all their details for this billing request.

Bank Authorisation Visited#

A bank authorisation link for this billing request has been visited.

payerbilling_request_bank_authorisation_visited

A bank authorisation link for this billing request has been visited.

Bank Authorisation Authorised#

A bank authorisation for this billing request has been authorised by the payer.

payerbilling_request_bank_authorisation_authorised

A bank authorisation for this billing request has been authorised by the payer.

gocardlessbilling_request_bank_authorisation_authorised

A bank authorisation for this billing request has been authorised by the payer.

Bank Authorisation Denied#

A bank authorisation for this billing request has been denied by the payer.

payerbilling_request_bank_authorisation_denied

A bank authorisation for this billing request has been denied by the payer.

gocardlessbilling_request_bank_authorisation_denied

A bank authorisation for this billing request has been denied by the payer.

Bank Authorisation Expired#

A bank authorisation for this billing request has expired.

payerbilling_request_bank_authorisation_expired

A bank authorisation for this billing request has expired.

Bank Authorisation Failed#

A bank authorisation for this billing request has failed.

payerbilling_request_bank_authorisation_failed

A bank authorisation for this billing request has failed.

gocardlessbilling_request_bank_authorisation_failed

A bank authorisation for this billing request has failed.

gocardlessinsufficient_funds

A bank authorisation for this billing request has failed due to insufficient funds.

Fulfilled#

This billing request has been fulfilled, and the resources have been created.

gocardlessbilling_request_fulfilled

This billing request has been fulfilled, and the resources have been created.

apibilling_request_fulfilled

This billing request has been fulfilled, and the resources have been created.

Cancelled#

This billing request has been cancelled, none of the resources have been created.

gocardlessbilling_request_cancelled

This billing request has been cancelled, none of the resources have been created.

apibilling_request_cancelled

This billing request has been cancelled, none of the resources have been created.

Choose Currency#

Currency details have been collected for this billing request.

apibilling_request_choose_currency

Currency details have been collected for this billing request.

payerbilling_request_choose_currency

Currency details have been collected for this billing request.

Collect Amount#

Amount has been collected for this billing request.

payerbilling_request_collect_amount

Amount has been collected for this billing request.

Payer Geo Blocked#

Payer blocked for 24 hours for attempting to pay from an unsupported location.

payerpayer_geo_blocked

Payer blocked for 24 hours for attempting to pay from an unsupported location.

Failed#

This billing request has failed.

gocardlessbilling_request_failed

This billing request has failed.

apibilling_request_failed

This billing request has failed.