Payment Properties |
The GoCardlessPayment type exposes the following members.
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.
|
See Also