Skip to main content

PaymentExternalTransaction

A payment transaction recorded through the API by a payment gateway integration (see the paymentExternalTransaction* mutations).

type PaymentExternalTransaction implements Transaction {
amount: Float
createdAt: ISO8601DateTime
currency: String
disputes: [Dispute!]
exchangeRate: Float
failedAt: ISO8601DateTime
fees: [PaymentTransactionFee!]
id: ID
merchant: PaymentMerchant
number: String
order: Order
referenceCode: String
refundTransactions: [Transaction!]
repaymentRequest: RepaymentRequest
saleTransaction: Transaction
startedAt: ISO8601DateTime
status: PaymentTransactionStatus
transactedAt: ISO8601DateTime
updatedAt: ISO8601DateTime
}

Fields​

PaymentExternalTransaction.amount ● Float scalar​

The transaction amount. Positive for payments; a negative amount is a refund.

PaymentExternalTransaction.createdAt ● ISO8601DateTime scalar​

When the record was created.

PaymentExternalTransaction.currency ● String scalar​

The transaction currency, as an ISO 4217 code.

PaymentExternalTransaction.disputes ● [Dispute!] list interface​

The disputes linked to the transaction (for example chargebacks opened by the payment provider).

PaymentExternalTransaction.exchangeRate ● Float scalar​

The exchange rate reported by the payment provider, when available.

PaymentExternalTransaction.failedAt ● ISO8601DateTime scalar​

When the transaction failed. Set from the timestamp submitted with a failed status.

PaymentExternalTransaction.fees ● [PaymentTransactionFee!] list object​

The provider fee rows recorded for the transaction.

PaymentExternalTransaction.id ● ID scalar​

The unique identifier of the record.

PaymentExternalTransaction.merchant ● PaymentMerchant object​

The payment merchant that owns the transaction.

PaymentExternalTransaction.number ● String scalar​

The transaction number/ID assigned by the payment provider.

PaymentExternalTransaction.order ● Order object​

The order the transaction is linked to, when the transaction has been matched through its referenceCode. Null otherwise.

PaymentExternalTransaction.referenceCode ● String scalar​

References the order or the repayment request (return) the transaction belongs to.

PaymentExternalTransaction.refundTransactions ● [Transaction!] list interface​

The refund transactions of this transaction: child transactions linked to the original payment.

PaymentExternalTransaction.repaymentRequest ● RepaymentRequest object​

The repayment request (return) the transaction is linked to, when the transaction has been matched through its referenceCode. Null otherwise.

PaymentExternalTransaction.saleTransaction ● Transaction interface​

For a refund transaction, the original sale transaction being refunded.

PaymentExternalTransaction.startedAt ● ISO8601DateTime scalar​

When the transaction was started. Set from the timestamp submitted with a pended status.

PaymentExternalTransaction.status ● PaymentTransactionStatus enum​

The transaction status.

PaymentExternalTransaction.transactedAt ● ISO8601DateTime scalar​

When the transaction was completed. Set from the timestamp submitted with a completed status.

PaymentExternalTransaction.updatedAt ● ISO8601DateTime scalar​

When the record was last updated.

Interfaces​

Transaction interface​

The fields shared by every payment transaction, whatever the gateway that recorded it. Returned by paymentTransaction and paymentTransactions; the concrete type tells the source (for example PaymentExternalTransaction for the transactions recorded through the API).

Returned By​

paymentExternalTransaction query ● paymentExternalTransactionCreate mutation ● paymentExternalTransactionRefund mutation ● paymentExternalTransactionUpdate mutation

Member Of​

PaymentExternalDispute object ● PaymentExternalTransactionConnection object ● PaymentExternalTransactionEdge object