Class: GoCardlessPro::Resources::PayerAuthorisation
- Inherits:
-
Object
- Object
- GoCardlessPro::Resources::PayerAuthorisation
- Defined in:
- lib/gocardless_pro/resources/payer_authorisation.rb
Overview
Payer Authorisation resource acts as a wrapper for creating customer, bank account and mandate details in a single request. PayerAuthorisation API enables the integrators to build their own custom payment pages.
The process to use the Payer Authorisation API is as follows:
1. Create a Payer Authorisation, either empty or with already available
information
2. Update the with additional information or fix any
mistakes
3. Submit the authorisation, after the payer has reviewed their
information
4. [coming soon] Redirect the payer to the verification mechanisms from
the response of the Submit request (this will be introduced as a non-breaking change)
5. Confirm the to indicate that the resources can be
created
After the Payer Authorisation is confirmed, resources will eventually be created as it’s an asynchronous process.
To retrieve the status and ID of the linked resources you can do one of the following: <ol>
<li> Listen to <code> payer_authorisation_completed </code> <a
href=“#appendix-webhooks”> webhook</a> (recommended)</li>
<li> Poll the GET <a
href=“#payer-authorisations-get-a-single-payer-authorisation”> endpoint</a></li>
<li> Poll the GET events API
https://api.gocardless.com/events?payer_authorisation={id}&action=completed
</li> </ol>
<p class=“notice”>
Note that the `create` and `update` endpoints behave differently than
other existing `create` and `update` endpoints. The Payer Authorisation
is still saved if incomplete data is provided.
We return the list of incomplete data in the `incomplete_fields` along
with the resources in the body of the response.
<br><br>
The API is designed to be flexible and allows you to collect information
in multiple steps without storing any sensitive data in the browser or in your servers. </p>
Defined Under Namespace
Classes: Links
Instance Attribute Summary collapse
-
#bank_account ⇒ Object
readonly
Returns the value of attribute bank_account.
-
#created_at ⇒ Object
readonly
Returns the value of attribute created_at.
-
#customer ⇒ Object
readonly
Returns the value of attribute customer.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#incomplete_fields ⇒ Object
readonly
Returns the value of attribute incomplete_fields.
-
#mandate ⇒ Object
readonly
Returns the value of attribute mandate.
-
#status ⇒ Object
readonly
Returns the value of attribute status.
Instance Method Summary collapse
- #api_response ⇒ Object
-
#initialize(object, response = nil) ⇒ PayerAuthorisation
constructor
Initialize a payer_authorisation resource instance.
-
#links ⇒ Object
Return the links that the resource has.
-
#to_h ⇒ Object
Provides the payer_authorisation resource as a hash of all its readable attributes.
Constructor Details
#initialize(object, response = nil) ⇒ PayerAuthorisation
Initialize a payer_authorisation resource instance
72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 72 def initialize(object, response = nil) @object = object @bank_account = object['bank_account'] @created_at = object['created_at'] @customer = object['customer'] @id = object['id'] @incomplete_fields = object['incomplete_fields'] @links = object['links'] @mandate = object['mandate'] @status = object['status'] @response = response end |
Instance Attribute Details
#bank_account ⇒ Object (readonly)
Returns the value of attribute bank_account.
62 63 64 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 62 def bank_account @bank_account end |
#created_at ⇒ Object (readonly)
Returns the value of attribute created_at.
63 64 65 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 63 def created_at @created_at end |
#customer ⇒ Object (readonly)
Returns the value of attribute customer.
64 65 66 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 64 def customer @customer end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
65 66 67 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 65 def id @id end |
#incomplete_fields ⇒ Object (readonly)
Returns the value of attribute incomplete_fields.
66 67 68 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 66 def incomplete_fields @incomplete_fields end |
#mandate ⇒ Object (readonly)
Returns the value of attribute mandate.
67 68 69 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 67 def mandate @mandate end |
#status ⇒ Object (readonly)
Returns the value of attribute status.
68 69 70 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 68 def status @status end |
Instance Method Details
#api_response ⇒ Object
86 87 88 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 86 def api_response ApiResponse.new(@response) end |
#links ⇒ Object
Return the links that the resource has
91 92 93 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 91 def links @payer_authorisation_links ||= Links.new(@links) end |
#to_h ⇒ Object
Provides the payer_authorisation resource as a hash of all its readable attributes
96 97 98 |
# File 'lib/gocardless_pro/resources/payer_authorisation.rb', line 96 def to_h @object end |