GoCardlessPayment Class |
Payment object to pass information about a payment.
Payments are taken against a mandate. Can have multiple payments against a mandate.
Corresponds directly to GoCardless Payment object https://developer.gocardless.com/api-reference/#core-endpoints-payments.
Inheritance HierarchyNamespace: NetQuarry.Services.Payment
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe GoCardlessPayment type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GoCardlessPayment |
Empty constructor.
|
| GoCardlessPayment(String) |
Constructor with idempotency key.
|
Properties| Name | Description | |
|---|---|---|
 | amount |
Amount in GBP, EUR, or SEK.
Must be greater than or equal to 0.01.
Not a GoCardless field itself. Used to set/get internal field that's an int in pence/cents/ore.
|
| amount_refunded |
Amount refunded in GBP/EUR/SEK.
Not a GoCardless field itself. Used to set/get internal field that's an int in pence/cents/ore.
|
| app_fee |
Can only be used in Create Payment API but we are NOT using it.
The amount to be deducted from the payment as the OAuth app’s fee, in GBP or EUR.
Not a GoCardless field itself. Used to set/get internal field that's an int in pence/cents.
|
| charge_date |
A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. This must be on or after the mandate’s next_possible_charge_date, and will be rolled-forwards by GoCardless if it is not a working day.
|
| created_at |
Fixed timestamp, recording when this resource was created.
|
| currency |
ISO 4217 currency code. Currently only “GBP”, “EUR”, and “SEK” are supported.
|
| description |
A human-readable description of the payment. This will be included in the notification email GoCardless sends to your customer if your organisation does not send its own notifications (see compliance requirements).
|
| id |
Unique identifier, beginning with "PM".
|
| IDEMPOTENCYKEY |
Not part of actual object sent to GoCardless. Used in HTTP header to prevent duplicating a successful request.
|
| links |
IDs of things that could be related:
When creating Payment set: mandate.
After Payment is created, GoCardless sets: creditor + payout.
|
| metadata |
Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
|
| reference |
An optional payment reference that will appear on your customer’s bank statement. For Bacs payments this can be up to 10 characters, for SEPA payments the limit is 140 characters, and for Autogiro payments the limit is 11 characters.
Restricted: You need your own Service User Number to specify a payment reference for Bacs payments.
|
| status |
One from picklist GoCardlessPaymentpayments_status.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | EqualValue |
Determines if the object value is equal to another object. If the two objects are null, then this returns true.
There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways).
If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.) |
See Also