Skip to main content

ClientRefundInitiateInput

No description

input ClientRefundInitiateInput {
  paymentRequestId: ID!
  amount: MoneyInput!
  reason: RefundReason!
  nonce: String!
  beneficiaryReference: String!
  clearingType: ClearingType
  externalReference: String
}

Fields​

ClientRefundInitiateInput.paymentRequestId ● ID! non-null scalar​

ClientRefundInitiateInput.amount ● MoneyInput! non-null input​

ClientRefundInitiateInput.reason ● RefundReason! non-null enum​

ClientRefundInitiateInput.nonce ● String! non-null scalar​

Randomly generated unique string to ensure idempotency

ClientRefundInitiateInput.beneficiaryReference ● String! non-null scalar​

Must be between 1 and 30 characters. The reference that will be displayed on the refunded users statement

ClientRefundInitiateInput.clearingType ● ClearingType enum​

Affects how soon the refund will be paid out

ClientRefundInitiateInput.externalReference ● String scalar​

A reference field for tracking the refund in external systems. Must be at most 100 characters.