Skip to content

payoutsummary.md

Latest commit

 

History

History
45 lines (38 loc) · 13.5 KB

payoutsummary.md

File metadata and controls

45 lines (38 loc) · 13.5 KB

PayoutSummary

PayoutSummary

Represents a summary of a payout.

Example Usage

import { PayoutSummary } from "@gr4vy/sdk/models/components";

let value: PayoutSummary = {
  amount: 1299,
  createdAt: new Date("2013-07-16T19:23:00.000+00:00"),
  currency: "EUR",
  paymentMethod: {
    method: "thaiqr",
  },
  paymentService: {
    paymentServiceDefinitionId: "nuvei-card",
  },
  status: "failed",
  updatedAt: new Date("2013-07-16T19:23:00.000+00:00"),
};

Fields

Field Type Required Description Example
type "payout" ➖ Always payout. payout
id string ➖ The ID for the payout. 6f96a57e-a35b-4f98-b192-d298995f811a
amount number ✔️ The monetary amount for this payout, in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99. 1299
buyer components.TransactionBuyer ➖ The buyer used for this payout.
category components.PayoutCategory ➖ The type of payout to process. online_gambling
createdAt Date ✔️ The date this payout was created at. 2013-07-16T19:23:00.000+00:00
currency string ✔️ A supported ISO-4217 currency code. Example 1: EUR
Example 2: GBP
Example 3: USD
externalIdentifier string ➖ The merchant identifier for this payout. payout-12345
merchant components.PayoutMerchantSummary ➖ The merchant details associated to this payout.
merchantAccountId string ➖ The ID of the merchant account this payout was created for. default
paymentMethod components.TransactionPaymentMethod ✔️ N/A
paymentService components.PayoutPaymentService ✔️ N/A
paymentServicePayoutId string ➖ The ID of the payout in the underlying payment service. pout-12345
status components.PayoutStatus ✔️ N/A
updatedAt Date ✔️ The date this payout was last updated at. 2013-07-16T19:23:00.000+00:00