Skip to main content

PaymentExternalTransactionCreateInput

No description

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

Fields​

PaymentExternalTransactionCreateInput.amount ● Float! non-null scalar​

The transaction amount. Positive for a payment: a positive amount is matched to an order, a negative one to a return.

PaymentExternalTransactionCreateInput.currency ● String! non-null scalar​

The transaction currency, as an ISO 4217 code.

PaymentExternalTransactionCreateInput.exchangeRate ● Float scalar​

The exchange rate reported by the payment provider.

PaymentExternalTransactionCreateInput.fees ● [PaymentExternalTransactionCreateFeeInput!] list input​

Creates provider fee rows for the transaction. Each fee requires amount and currency; description and exchangeRate are optional provider details.

PaymentExternalTransactionCreateInput.merchantCode ● String! non-null scalar​

The code of the payment merchant that owns the transaction.

PaymentExternalTransactionCreateInput.number ● String! non-null scalar​

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

PaymentExternalTransactionCreateInput.provider ● String! non-null scalar​

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

PaymentExternalTransactionCreateInput.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.

PaymentExternalTransactionCreateInput.status ● PaymentExternalTransactionStatusInput! non-null enum​

The transaction status: pended for transactions waiting capture, completed for captured transactions, failed for failed transactions.

PaymentExternalTransactionCreateInput.timestamp ● ISO8601DateTime! non-null scalar​

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

Member Of​

paymentExternalTransactionCreate mutation