Payment
A payment as the payment mutations return it (createPayment, refundPayment, capturePayment, cancelPayment and the send mutations). Amounts are integers in the smallest unit of the currency: cents for EUR, whole yen for JPY. To read a payment later, use charge.
type Payment {
id: ID!
amount: Int
amountEUR: Int
currency: String!
orderId: ID
storeId: ID
pointOfSaleId: ID
description: String
descriptor: String
accountId: ID!
authorizationCode: String
livemode: Boolean
status: PaymentStatus!
statusCode: String
statusMessage: String
customerId: ID
customer: Customer
sequenceId: ID
subscriptionId: ID
paymentToken: String
paymentMethod: PaymentMethod
shop: Shop
billingDetails: ContactDetails
shippingDetails: ContactDetails
refundedAmount: Int
lastRefundAmount: Int
lastRefundReason: RefundReason
cancellationReason: CancellationReason
sessionDetails: SessionDetails
traceDetails: TraceDetails
nextAction: NextAction
createdAt: AWSTimestamp
updatedAt: AWSTimestamp
pageOpenedAt: AWSTimestamp
metadata: [KeyValueItem!]
}
Fields
Payment.id ● ID! non-null scalar
Unique identifier for the payment.
Payment.amount ● Int scalar
Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).
Payment.amountEUR ● Int scalar
Amount converted to EUR, in cents.
Payment.currency ● String! non-null scalar
Three-letter ISO 4217 currency code, in uppercase. Must be a supported currency.
Payment.orderId ● ID scalar
An order ID from your system. A unique identifier that can be used to reconcile the payment with your internal system. When createPayment gets none, MONEI generates one.
Payment.storeId ● ID scalar
A unique identifier of the Store. If specified the payment is attached to this Store.
Payment.pointOfSaleId ● ID scalar
A unique identifier of the Point of Sale. If specified the payment is attached to this Point of Sale.
Payment.description ● String scalar
An arbitrary string attached to the payment. Often useful for displaying to users.
Payment.descriptor ● String scalar
Statement descriptor shown on the cardholder's bank statement (max 25 chars).
Payment.accountId ● ID! non-null scalar
Merchant account that owns the payment.
Payment.authorizationCode ● String scalar
Authorization code returned by the bank that authorized the payment (Authorization code in the dashboard).
Payment.livemode ● Boolean scalar
true for live, false for test mode.
Payment.status ● PaymentStatus! non-null enum
Current lifecycle state (Status in the dashboard).
Payment.statusCode ● String scalar
MONEI status code of the payment. E000 means approved; E001 to E004 mean pending or expired. Error groups: E1xx account, processor setup or request errors; E2xx declines by the processor or issuer; E3xx 3D Secure; E4xx fraud and risk rules; E5xx card errors; E6xx digital wallet, PayPal, Bizum and Click to Pay errors; E7xx installment financing; E999 internal error.
Payment.statusMessage ● String scalar
Human readable status message, can be displayed to a user: the English text of statusCode. For a processor the merchant holds a contract with, the text that processor returned.
Payment.customerId ● ID scalar
Customer entity the payment is linked to.
Payment.customer ● Customer object
Customer identification (email, name, phone).
Payment.sequenceId ● ID scalar
ID of the first payment of a recurring sequence. The later payments of the sequence carry the same value.
Payment.subscriptionId ● ID scalar
A unique identifier of the Subscription. If specified the payment is attached to this Subscription.
Payment.paymentToken ● String scalar
Permanent payment token of the payment method. Present when the payment was created with generatePaymentToken: true and its payment method was saved. Pass it as paymentToken to createPayment to charge the same payment method again.
Payment.paymentMethod ● PaymentMethod object
Details about the payment method at the time of the transaction.
Payment.shop ● Shop object
The shop shown to the customer on the hosted payment page: the name and country of the store of the payment, else of the business of the account.
Payment.billingDetails ● ContactDetails object
Billing information associated with the payment method at the time of the transaction.
Payment.shippingDetails ● ContactDetails object
Shipping information associated with the payment.
Payment.refundedAmount ● Int scalar
Total amount refunded so far, in the smallest currency unit. Less than amount after a partial refund.
Payment.lastRefundAmount ● Int scalar
Amount refunded by the last refund, in the smallest currency unit.
Payment.lastRefundReason ● RefundReason enum
The reason of the last refund transaction.
Payment.cancellationReason ● CancellationReason enum
The reason for canceling the Payment.
Payment.sessionDetails ● SessionDetails object
Information related to the browsing session of the user who initiated the payment.
Payment.traceDetails ● TraceDetails object
The request behind the last action on the payment (create, capture, refund or cancel): IP address, browser, the dashboard user or the masked API key, and the integration source.
Payment.nextAction ● NextAction object
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. Its redirectUrl is the payment link of a new payment. Absent on a PAYOUT payment when the caller is an OAuth application, except on a test account.
Payment.createdAt ● AWSTimestamp scalar
Creation time as a unix timestamp (seconds).
Payment.updatedAt ● AWSTimestamp scalar
Last update time as a unix timestamp (seconds).
Payment.pageOpenedAt ● AWSTimestamp scalar
When the customer first opened the hosted payment page, as a unix timestamp (seconds).
Payment.metadata ● [KeyValueItem!] list object
Merchant-defined metadata.
Returned By
activateSubscription mutation ● cancelPayment mutation ● capturePayment mutation ● createPayment mutation ● refundPayment mutation ● sendPaymentLink mutation ● sendPaymentReceipt mutation ● sendPaymentRequest mutation