Skip to content

payoutcreate.md

Latest commit

 

History

History
37 lines (30 loc) · 10.4 KB

payoutcreate.md

File metadata and controls

37 lines (30 loc) · 10.4 KB

PayoutCreate

PayoutCreate

Represents the data required to create a new payout.

Example Usage

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

let value: PayoutCreate = {
  amount: 1299,
  currency: "EUR",
  paymentServiceId: "ed8bd87d-85ad-40cf-8e8f-007e21e55aad",
  paymentMethod: {
    number: "4242424242424242",
    expirationDate: "12/30",
  },
};

Fields

Field Type Required Description Example
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
currency string ✔️ The ISO-4217 currency code for this payout. Example 1: EUR
Example 2: GBP
Example 3: USD
paymentServiceId string ✔️ The ID of the payment service to use for the payout. ed8bd87d-85ad-40cf-8e8f-007e21e55aad
paymentMethod components.PayoutCreatePaymentMethod ✔️ The type of payment method to send funds too.
category components.PayoutCategory ➖ The type of payout to process. online_gambling
externalIdentifier string ➖ A value that can be used to match the payout against your own records. payout-12345
buyerId string ➖ The id of a stored buyer to use for this payout Use this instead of the buyer or buyer_external_identifier. fe26475d-ec3e-4884-9553-f7356683f7f9
buyer components.GuestBuyer ➖ Inline buyer details for the payout. Use this instead of the buyer_id or buyer_external_identifier.
buyerExternalIdentifier string ➖ The external_identifier of a stored buyer to use for this payout. Use this instead of the buyer_id or buyer. buyer-12345
merchant components.PayoutMerchant ➖ Merchant information for the source of the payout.
connectionOptions components.PayoutConnectionOptions ➖ Optional fields for processing payouts on specific payment services.