Skip to main content

Input fields

actionIntent : PayoutActionIntentInput! required

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

amount : Int! required

The payout amount in the minor unit of currency.

customerReference : String! required

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

paymentDate : Date! required

The date when the payout was made.

paymentMethod : PaymentMethodInput! required

The details of the payment method used for this payout.

paymentUuid : String

If this payout is a refund, the Kraken-assigned UUID of the payment being refunded.

reference : String! required

The reference used to uniquely identify this payout.

succeededAt : DateTime! required

The timezone aware datetime when the payout succeeded.

timestamp : DateTime! required

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

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": PayoutActionIntentInput, "amount": 23, "customerReference": "federal-Mr-any-television-easy", "paymentDate": "2014-02-13", "paymentMethod": PaymentMethodInput, "paymentUuid": "69954386", "reference": "space-near-must-surface-law", "succeededAt": "1992-06-12T12:59:49.188146+00:00", "timestamp": "1989-03-18T17:30:07.473732+00:00" }