Skip to main content

Refund

A refund against a payment intent.

type Refund {
amount: Money
charge: Charge
createdAt: ISO8601DateTime!
customer: Customer!
description: String
exchangeRate: Float
externalId: String
id: GlobalID!
metadata: Metadata
paymentIntent: PaymentIntent!
recordStatus: RecordStatus
source: ChargeSource
status: RefundStatus
updatedAt: ISO8601DateTime
}

Fields​

Refund.amount ● Money object types​

The refund's amount.

Refund.charge ● Charge object types​

The charge the refund is for.

Refund.createdAt ● ISO8601DateTime! non-null scalar types​

The date and time when the refund was created.

Refund.customer ● Customer! non-null object types​

The customer the refund belongs to.

Refund.description ● String scalar types​

The refund's description.

Refund.exchangeRate ● Float scalar types​

The exchange rate from the shop's currency to the refund's currency.

Refund.externalId ● String scalar types​

The refund's ID in an external system.

Refund.id ● GlobalID! non-null scalar types​

The refund's ID.

Refund.metadata ● Metadata scalar types​

Key/value pairs for storing extra information about the refund.

Refund.paymentIntent ● PaymentIntent! non-null object types​

The payment intent the refund belongs to.

Refund.recordStatus ● RecordStatus enum types​

Whether Submarine processed the refund or recorded one processed elsewhere.

Refund.source ● ChargeSource enum types​

The system that initiated the refund.

Refund.status ● RefundStatus enum types​

The refund's status.

Refund.updatedAt ● ISO8601DateTime scalar types​

The date and time when the refund was last updated.

Returned By​

refund query

Member Of​

Charge object ● PaymentIntent object ● RefundConnection object ● RefundEdge object