Create a payout

Creates a new payout.

POST /payouts

C#

C#

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Payouts.CreateAsync(payoutCreate: new PayoutCreate() {
    Amount = 1299,
    Currency = "EUR",
    PaymentServiceId = "ed8bd87d-85ad-40cf-8e8f-007e21e55aad",
    PaymentMethod = PayoutCreatePaymentMethod.CreatePaymentMethodStoredCard(
        new PaymentMethodStoredCard() {
            Id = "852b951c-d7ea-4c98-b09e-4a1c9e97c077",
        }
    ),
});

// handle response

201

{
  "amount": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "payment_method": {
    "method": "<string>",
    "type": "payment-method",
    "approval_url": "https://gr4vy.app/redirect/12345",
    "country": "US",
    "currency": "USD",
    "details": {
      "bin": "<string>",
      "card_type": "<string>",
      "card_issuer_name": "<string>"
    },
    "expiration_date": "12/30",
    "fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17",
    "label": "1234",
    "last_replaced_at": "2013-07-16T19:23:00.000+00:00",
    "mode": "card",
    "scheme": "visa",
    "id": "852b951c-d7ea-4c98-b09e-4a1c9e97c077",
    "approval_target": "any",
    "external_identifier": "card-12345",
    "payment_account_reference": "V0010014629724763377327521982"
  },
  "payment_service": {
    "payment_service_definition_id": "<string>",
    "type": "payment-service",
    "id": "b6c9eb12-2b62-4103-99b9-e3efc94e396d",
    "method": "card",
    "display_name": "Nuvei"
  },
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "type": "payout",
  "id": "6f96a57e-a35b-4f98-b192-d298995f811a",
  "buyer": {
    "type": "buyer",
    "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
    "display_name": "John Doe",
    "external_identifier": "buyer-12345",
    "billing_details": {
      "first_name": "John",
      "last_name": "Doe",
      "email_address": "[e-mail]",
      "phone_number": "[phone]",
      "address": {
        "city": "San Jose",
        "country": "US",
        "postal_code": "94560",
        "state": "California",
        "state_code": "US-CA",
        "house_number_or_name": "10",
        "line1": "Stafford Appartments",
        "line2": "29th Street",
        "organization": "Gr4vy"
      },
      "tax_id": {
        "value": "<string>",
        "kind": "<string>"
      }
    },
    "account_number": "<string>"
  },
  "category": "online_gambling",
  "external_identifier": "payout-12345",
  "merchant": {
    "name": "<string>",
    "identification_number": "<string>",
    "phone_number": "<string>",
    "url": "<string>",
    "merchant_category_code": "<string>",
    "type": "merchant",
    "statement_descriptor": "Winnings",
    "address": {
      "city": "San Jose",
      "country": "US",
      "postal_code": "94560",
      "state": "California",
      "state_code": "US-CA",
      "house_number_or_name": "10",
      "line1": "Stafford Appartments",
      "line2": "29th Street",
      "organization": "Gr4vy"
    }
  },
  "merchant_account_id": "default",
  "payment_service_payout_id": "pout-12345"
}

This endpoint requires the payouts.write scope.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-gr4vy-merchant-account-id · string

The ID of the merchant account to use for this request.

Example:

"default"

Body

application/json

PayoutCreate

Represents the data required to create a new payout.

amount · integer · required

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.

Required range: 0 <= x <= 99999999

Example:

1299

currency · string · required

The ISO-4217 currency code for this payout.

Pattern: ^[A-Z]{3}$

Examples:

"EUR"

"GBP"

"USD"

payment_service_id · string<uuid> · required

The ID of the payment service to use for the payout.

Example:

"ed8bd87d-85ad-40cf-8e8f-007e21e55aad"

payment_method · PaymentMethodCard · object · required

The type of payment method to send funds too.

PaymentMethodCard

PaymentMethodStoredCard

Show child attributes

category · string | null

The type of payout to process.

Example:

"online_gambling"

external_identifier · string | null

A value that can be used to match the payout against your own records.

Required string length: 1 - 200

Example:

"payout-12345"

buyer_id · string<uuid> | null

The id of a stored buyer to use for this payout Use this instead of the buyer or buyer_external_identifier.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

buyer · GuestBuyer · object

Inline buyer details for the payout. Use this instead of the buyer_id or buyer_external_identifier.

Show child attributes

buyer_external_identifier · string | null

The external_identifier of a stored buyer to use for this payout. Use this instead of the buyer_id or buyer.

Required string length: 1 - 200

Example:

"buyer-12345"

merchant · PayoutMerchant · object

Merchant information for the source of the payout.

Show child attributes

connection_options · PayoutConnectionOptions · object

Optional fields for processing payouts on specific payment services.

Show child attributes

Response

201

application/json

Successful Response

PayoutSummary

Represents a summary of a payout.

amount · integer · required

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.

Example:

1299

created_at · string<date-time> · required

The date this payout was created at.

Example:

"2013-07-16T19:23:00.000+00:00"

currency · string · required

A supported ISO-4217 currency code.

Pattern: ^[A-Z]{3}$

Examples:

"EUR"

"GBP"

"USD"

payment_method · TransactionPaymentMethod · object · required

The payment method used for this payout.

Show child attributes

payment_service · PayoutPaymentService · object · required

The payment service used for this payout.

Show child attributes

status · string · required

The status of the payout.

Example:

"succeeded"

updated_at · string<date-time> · required

The date this payout was last updated at.

Example:

"2013-07-16T19:23:00.000+00:00"

type · string · default: payout

Always payout.

Allowed value: "payout"

Example:

"payout"

id · string<uuid> | null

The ID for the payout.

Example:

"6f96a57e-a35b-4f98-b192-d298995f811a"

buyer · TransactionBuyer · object

The buyer used for this payout.

Show child attributes

category · string | null

The type of payout to process.

Example:

"online_gambling"

external_identifier · string | null

The merchant identifier for this payout.

Required string length: 1 - 200

Example:

"payout-12345"

merchant · PayoutMerchantSummary · object

The merchant details associated to this payout.

Show child attributes

merchant_account_id · string | null

The ID of the merchant account this payout was created for.

Example:

"default"

payment_service_payout_id · string | null

The ID of the payout in the underlying payment service.

Required string length: 1 - 200

Example:

"pout-12345"