The payment object

The payment object allows you to create, update or refund payments for a transaction.

Attributes

  • *id** integer The unique id for the object.
  • *type** string
    Can be: 'card', 'stored_card', 'credit', 'manual_card', 'manual_cash', 'manual_cheque' or 'manual_transfer'.
  • *cardtype** _string
    Can be: 'visa', 'mastercard', 'discovery' or 'amex'.
  • *fundingtype** _string
    If the payment is 'card', the funding type. Can be: 'credit' or 'debit'.
  • *cardholder** string
    If the payment is 'card', the card holders name.
  • *lastfour** _string
    If the payment is 'card', the last four numbers of the card used.
  • *lastfour** _string
    If the payment is 'card', the expiry date of the card used.
  • *amount** positive float or zero
    The amount of the payment.
  • *refunded** positive float or zero
    The total quantity of the payment.
  • *remaining** positive float or zero
    The remaining amount of the payment.
  • *failedmessage** _string
    If the payment is 'card' and the payment fails, the failed message.
  • *gatewaytransaction_id** _string
    If the payment is 'card', the gateway transction id.
  • *status** boolean
    True if payment is active.