Skip to main content

PaymentExternalTransactionRefundInput

No description

input PaymentExternalTransactionRefundInput {
  amount: Float!
  currency: String!
  exchangeRate: Float
  fees: [PaymentExternalTransactionRefundFeeInput!]
  number: String!
  provider: String!
  referenceCode: String!
  status: PaymentExternalTransactionStatusInput!
  timestamp: ISO8601DateTime!
}

Fields​

PaymentExternalTransactionRefundInput.amount ● Float! non-null scalar​

The refund amount, negative. A negative amount is matched to a return, never to an order.

PaymentExternalTransactionRefundInput.currency ● String! non-null scalar​

The transaction currency, as an ISO 4217 code.

PaymentExternalTransactionRefundInput.exchangeRate ● Float scalar​

The exchange rate reported by the payment provider.

PaymentExternalTransactionRefundInput.fees ● [PaymentExternalTransactionRefundFeeInput!] list input​

Creates fee rows on the refund transaction, not on the original transaction.

PaymentExternalTransactionRefundInput.number ● String! non-null scalar​

The transaction number/ID assigned by the payment provider. Unique within the merchant: submitting a duplicate fails validation.

PaymentExternalTransactionRefundInput.provider ● String! non-null scalar​

The payment provider/method name (for example visa).

PaymentExternalTransactionRefundInput.referenceCode ● String! non-null scalar​

References the order or the repayment request (return) the transaction belongs to: send its number. When the code matches an existing order (or return) and the OMS internal checks find the transaction consistent with it, the two records are linked — see the order and repaymentRequest fields on the transaction.

PaymentExternalTransactionRefundInput.status ● PaymentExternalTransactionStatusInput! non-null enum​

The refund transaction status. Follows the same status and timestamp mapping used by transaction creation.

PaymentExternalTransactionRefundInput.timestamp ● ISO8601DateTime! non-null scalar​

The event timestamp. Mapped to startedAt, transactedAt or failedAt depending on the submitted status, as in transaction creation.

Member Of​

paymentExternalTransactionRefund mutation