The payment object

AttributeTypeDescription
statusstringCurrent status of the payment. Possible values: ["failed", "paid", "partial_refund", "refunded", "refund_failed", "refund_pending"]
uidstringPodium unique identifier for payment.
createdAtstringWhen the payment was made.
updatedAtstringWhen the payment was updated.
bankAccountLast4stringLast four digits of the bank account used if bank transfers are used to make a payment.
bankAccountNamestringName of the banking institute used if bank transfers are used to make a payment.
cardBrandstringCard brand used if a card is used to make a payment.
cardFundingstringCard type used if a card is used to make a payment.
cardLast4stringLast four digits of the card used if a card is used to make a payment.
declineCodestringCode returned by the payment processor if a card was used and the payment was declined.
declineCodeMessagestringA more descriptive message about the declideCode attribute.
feeintegerTransaction fee removed at the time of the transaction, represented in cents.
feeBillingTypestringHow the transaction fee is billed.
feeCollectedAtstringWhen the transaction fee was collected.
interchangeFeeintegerTransaction fee that is removed at the beginning of the following month if a merchant is on Interchange+, represented in cents.
paidWithCardOnFilebooleanWhether the payment was made with a card on file.
refundsarrayA refund can be for the full or partial amount of the payment. Thus there can be multiple refunds per transaction.
refunds[].reasonstringGeneric reason for why the refund was intiated. Possible values: ["accidental_charge", "canceled", "duplicate", "fraudulent", "requested_by_customer", "other"]
refunds[].statusstringCurrent status of the refund. Possible values: ["failed_charge_for_pending_refund_disputed", "failed_expired_or_cancelled", "failed_lost_or_stolen", "failed_unknown", "succeeded"]
refunds[].amountintegerAmount refunded on an invoice, represented in cents.
refunds[].createdAtstringWhen the refund was initiated.
refunds[].notesarray[string]Detailed note for why the refund was initiated.
refunds[].settledAtstringWhen the refund was fully completed. Refunds can take 5-10 days to appear in the customer’s bank account.
settledAtstringWhen the money from the transaction was transferred into the merchant’s bank account.
{
  "status": "failed",
  "uid": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2015-01-23T23:50:07Z",
  "updatedAt": "2015-01-23T23:50:07Z",
  "bankAccountLast4": "1234",
  "bankAccountName": "The Bank",
  "cardBrand": "visa",
  "cardFunding": "CREDIT",
  "cardLast4": "4242",
  "declineCode": "card_not_supported",
  "declineCodeMessage": "The card does not support this type of purchase.",
  "fee": 99,
  "feeBillingType": "MONTHLY",
  "feeCollectedAt": "2015-01-23T23:50:07Z",
  "interchangeFee": 50,
  "paidWithCardOnFile": true,
  "refunds": [
    {
      "reason": "accidental_charge",
      "status": "failed_charge_for_pending_refund_disputed",
      "amount": 100,
      "createdAt": "2015-01-23T23:50:07Z",
      "notes": [
        "The product did not function properly."
      ],
      "settledAt": "2015-01-23T23:50:07Z"
    }
  ],
  "settledAt": "2015-01-23T23:50:07Z"
}