Skip to main content

Input fields

actionIntent : PaymentActionIntentOneOfInput! required

The payment action intent details that identify the target for this payment.

amount : Int! required

The payment amount in the minor unit of currency.

customerReference : String! required

The description of the payment, as shown to the customer.

failedAt : DateTime! required

The timezone aware datetime when the payment failed.

failureDescription : String

The customer-facing description of the failure.

failureReason : FailureReason! required

The reason for the failure.

paymentDate : Date! required

The date when the payment was made.

paymentMethod : PaymentMethodInput! required

The details of the payment method used for this payment.

reference : String! required

The reference used to uniquely identify this payment.

timestamp : DateTime! required

The timezone aware datetime when the payment entered the reported state.

vendorFailureCode : String

The code the payment provider specified.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "actionIntent": PaymentActionIntentOneOfInput, "amount": 96, "customerReference": "opportunity-attorney-attack-kind-clearly", "failedAt": "2010-03-10T04:58:46.919081+00:00", "failureDescription": "claim-behavior-player-every-fight", "failureReason": "PAYMENT_INSTRUCTION_NOT_USABLE", "paymentDate": "1999-11-18", "paymentMethod": PaymentMethodInput, "reference": "down-free-attention-recognize-travel", "timestamp": "2007-04-11T17:33:25.972425+00:00", "vendorFailureCode": "life-newspaper-anyone-father-same" }