A refund of a charge on a payment method, representing an attempt to send money from a previous transaction back to the customer.
amountMonetaryThe amount that will be refunded, which can be less than or equal to the original charge amount.
createdTimestampDate and time when the refund was created.
customerCustomerThe customer that the vaulted payment method (if it exists) belongs to. Equivalent to refundedTransaction.customer (if present).
custom[CustomCollection of custom field/value pairs passed when creating the refund. Custom fields are defined in the Control Panel. For all refunds except "detached refunds", these will always be null.
descriptorTransactionFields used to define what will appear on a customer's statement (for instance, credit card or bank statement) for this refund. This will always match the descriptor from the refunded transaction (if present).
detailsRefundPayment method specific details about the refund.
disbursementDisbursementThe disbursement details associated with this refund. This field is only available after the refund is SETTLED and if you have an eligible merchant account.
idID!Non-nullUnique identifier.
legacyID!Non-nullLegacy unique identifier.
line[TransactionLine items for this refund.
merchantIDThe ID of the merchant account that processed this refund.
paymentTimestampThe refund date and time as reported by the in-store payment terminal.
paymentPaymentThe multi-use payment method that will receive the refund. Only present if a multi-use payment method was used to create the original transaction and it has not been since deleted. The details of this PaymentMethod may have changed since the transaction was created; details used for the transaction can be found in the paymentMethodSnapshot field. Equivalent to refundedTransaction.paymentMethod (if present).
paymentPaymentSnapshot of payment method details that will receive the refund, typically based on the original transaction. This will always be present. Equivalent to refundedTransaction.paymentMethodSnapshot.
processorTransactionFields describing the payment authorization processor response.
refundedTransactionThe original transaction that this refunds. If this is not present, then this refund represents a refund of a transaction that does not belong to this Braintree gateway account.
sourcePaymentHow the refund was created.
statusPaymentThe current status of this refund.
status[PaymentThe records of all statuses this refund has passed through, with additional information on why each status occurred. Returned in reverse chronological order, with the most recent event first in the list.
processorTransactionUse relevant events in statusHistory or processorAuthorizationResponse instead.
Fields describing the payment processor response.
InObjectrefundNodeInterfacePossible typePaymentInterfacePossible typeRefundObjectnodeRefundObjectrefundRefundObjectrefundRefundObjectrefundRequestObjectrefundTransactionObjectrefundsTransactionUnionUnion membertype Refund implements Node & Payment {
id: ID!
legacyId: ID!
createdAt: Timestamp
amount: MonetaryAmount
orderId: String
status: PaymentStatus
processorResponse: TransactionAuthorizationProcessorResponse @deprecated(reason: "Use relevant events in `statusHistory` or `processorAuthorizationResponse` instead.")
processorAuthorizationResponse: TransactionAuthorizationProcessorResponse
statusHistory: [PaymentStatusEvent!]
details: RefundPaymentMethodDetails
merchantAccountId: ID
source: PaymentSource
refundedTransaction: Transaction
paymentMethodSnapshot: PaymentMethodSnapshot
paymentMethod: PaymentMethod
customer: Customer
surchargeAmount: String
lineItems: [TransactionLineItem!]
customFields: [CustomField!]
descriptor: TransactionDescriptor
disbursementDetails: DisbursementDetails
paymentInitiatedAt: Timestamp
merchantId: String
}