New payout

Create payout

using RestSharp;


var options = new RestClientOptions("https://api.sandbox.{id}.gr4vy.app/payouts");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"amount\": 1299,\n  \"currency\": \"USD\",\n  \"payment_service_id\": \"a7d6b829-aea5-407d-ab7f-138784b5ad2c\",\n  \"payment_method\": {\n    \"method\": \"card\",\n    \"number\": \"4111111111111111\",\n    \"expiration_date\": \"11/25\",\n    \"external_identifier\": \"card-323444\",\n    \"scheme\": \"visa\"\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.{id}.gr4vy.app/payouts"

	payload := strings.NewReader("{\n  \"amount\": 1299,\n  \"currency\": \"USD\",\n  \"payment_service_id\": \"a7d6b829-aea5-407d-ab7f-138784b5ad2c\",\n  \"payment_method\": {\n    \"method\": \"card\",\n    \"number\": \"4111111111111111\",\n    \"expiration_date\": \"11/25\",\n    \"external_identifier\": \"card-323444\",\n    \"scheme\": \"visa\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.{id}.gr4vy.app/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1299,\n  \"currency\": \"USD\",\n  \"payment_service_id\": \"a7d6b829-aea5-407d-ab7f-138784b5ad2c\",\n  \"payment_method\": {\n    \"method\": \"card\",\n    \"number\": \"4111111111111111\",\n    \"expiration_date\": \"11/25\",\n    \"external_identifier\": \"card-323444\",\n    \"scheme\": \"visa\"\n  }\n}")
  .asString();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.{id}.gr4vy.app/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 1299,
    'currency' => 'USD',
    'payment_service_id' => 'a7d6b829-aea5-407d-ab7f-138784b5ad2c',
    'payment_method' => [
        'method' => 'card',
        'number' => '4111111111111111',
        'expiration_date' => '11/25',
        'external_identifier' => 'card-323444',
        'scheme' => 'visa'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://api.sandbox.{id}.gr4vy.app/payouts"

payload = {
    "amount": 1299,
    "currency": "USD",
    "payment_service_id": "a7d6b829-aea5-407d-ab7f-138784b5ad2c",
    "payment_method": {
        "method": "card",
        "number": "4111111111111111",
        "expiration_date": "11/25",
        "external_identifier": "card-323444",
        "scheme": "visa"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 1299,
    currency: 'USD',
    payment_service_id: 'a7d6b829-aea5-407d-ab7f-138784b5ad2c',
    payment_method: {
      method: 'card',
      number: '4111111111111111',
      expiration_date: '11/25',
      external_identifier: 'card-323444',
      scheme: 'visa'
    }
  })
};

fetch('https://api.sandbox.{id}.gr4vy.app/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://api.sandbox.{id}.gr4vy.app/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 1299,
  "currency": "USD",
  "payment_service_id": "a7d6b829-aea5-407d-ab7f-138784b5ad2c",
  "payment_method": {
    "method": "card",
    "number": "4111111111111111",
    "expiration_date": "11/25",
    "external_identifier": "card-323444",
    "scheme": "visa"
  }
}
'

{
  "type": "payout",
  "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
  "merchant_account_id": "default",
  "amount": 1299,
  "currency": "USD",
  "created_at": "2022-01-01T12:00:00+00:00",
  "updated_at": "2022-01-01T12:00:00+00:00",
  "payment_service": {
    "type": "payment-service",
    "id": "stripe-card-faaad066-30b4-4997-a438-242b0752d7e1",
    "display_name": "Stripe (Main)",
    "method": "card",
    "payment_service_definition_id": "stripe-card"
  },
  "payment_service_payout_id": "example",
  "category": "online_gambling",
  "status": "pending",
  "external_identifier": "user-789123",
  "merchant": {
    "type": "merchant",
    "name": "Merchant",
    "identification_number": "<string>",
    "phone_number": "+1234567890",
    "url": "<string>",
    "statement_descriptor": "<string>",
    "merchant_category_code": "<string>",
    "address": {
      "city": "London",
      "country": "GB",
      "postal_code": "789123",
      "state": "Greater London",
      "state_code": "GB-LND",
      "house_number_or_name": "10",
      "line1": "10 Oxford Street",
      "line2": "New Oxford Court",
      "organization": "Gr4vy"
    }
  },
  "buyer": {
    "type": "buyer",
    "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
    "billing_details": {
      "type": "billing-details",
      "first_name": "John",
      "last_name": "Lunn",
      "email_address": "john@example.com",
      "phone_number": "+1234567890",
      "address": {
        "city": "London",
        "country": "GB",
        "postal_code": "789123",
        "state": "Greater London",
        "state_code": "GB-LND",
        "house_number_or_name": "10",
        "line1": "10 Oxford Street",
        "line2": "New Oxford Court",
        "organization": "Gr4vy"
      },
      "tax_id": {
        "value": "12345678931",
        "kind": "gb.vat"
      }
    },
    "display_name": "John L.",
    "external_identifier": "user-789123",
    "account_number": "1234567"
  },
  "payment_method": {
    "type": "payment-method",
    "id": "77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5",
    "approval_target": "any",
    "approval_url": "https://api.example.app.gr4vy.com/payment-methods/ffc88ec9-e1ee-45ba-993d-b5902c3b2a8c/approve",
    "country": "US",
    "currency": "USD",
    "details": {
      "bin": "412345",
      "card_type": "credit",
      "card_issuer_name": "Bank"
    },
    "expiration_date": "11/25",
    "external_identifier": "user-789123",
    "label": "1111",
    "last_replaced_at": "2023-07-26T19:23:00.000+00:00",
    "method": "card",
    "payment_account_reference": "V0010014629724763377327521982",
    "scheme": "visa",
    "fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17"
  }
}

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Missing '****' field",
  "details": [
    {
      "location": "body",
      "type": "value_error.missing",
      "pointer": "/payment_method/number",
      "message": "field required"
    }
  ]
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "No valid API authentication found",
  "details": []
}

POST

payouts

Create payout

using RestSharp;


var options = new RestClientOptions("https://api.sandbox.{id}.gr4vy.app/payouts");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"amount\": 1299,\n  \"currency\": \"USD\",\n  \"payment_service_id\": \"a7d6b829-aea5-407d-ab7f-138784b5ad2c\",\n  \"payment_method\": {\n    \"method\": \"card\",\n    \"number\": \"4111111111111111\",\n    \"expiration_date\": \"11/25\",\n    \"external_identifier\": \"card-323444\",\n    \"scheme\": \"visa\"\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.{id}.gr4vy.app/payouts"

	payload := strings.NewReader("{\n  \"amount\": 1299,\n  \"currency\": \"USD\",\n  \"payment_service_id\": \"a7d6b829-aea5-407d-ab7f-138784b5ad2c\",\n  \"payment_method\": {\n    \"method\": \"card\",\n    \"number\": \"4111111111111111\",\n    \"expiration_date\": \"11/25\",\n    \"external_identifier\": \"card-323444\",\n    \"scheme\": \"visa\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.{id}.gr4vy.app/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1299,\n  \"currency\": \"USD\",\n  \"payment_service_id\": \"a7d6b829-aea5-407d-ab7f-138784b5ad2c\",\n  \"payment_method\": {\n    \"method\": \"card\",\n    \"number\": \"4111111111111111\",\n    \"expiration_date\": \"11/25\",\n    \"external_identifier\": \"card-323444\",\n    \"scheme\": \"visa\"\n  }\n}")
  .asString();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.{id}.gr4vy.app/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 1299,
    'currency' => 'USD',
    'payment_service_id' => 'a7d6b829-aea5-407d-ab7f-138784b5ad2c',
    'payment_method' => [
        'method' => 'card',
        'number' => '4111111111111111',
        'expiration_date' => '11/25',
        'external_identifier' => 'card-323444',
        'scheme' => 'visa'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://api.sandbox.{id}.gr4vy.app/payouts"

payload = {
    "amount": 1299,
    "currency": "USD",
    "payment_service_id": "a7d6b829-aea5-407d-ab7f-138784b5ad2c",
    "payment_method": {
        "method": "card",
        "number": "4111111111111111",
        "expiration_date": "11/25",
        "external_identifier": "card-323444",
        "scheme": "visa"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 1299,
    currency: 'USD',
    payment_service_id: 'a7d6b829-aea5-407d-ab7f-138784b5ad2c',
    payment_method: {
      method: 'card',
      number: '4111111111111111',
      expiration_date: '11/25',
      external_identifier: 'card-323444',
      scheme: 'visa'
    }
  })
};

fetch('https://api.sandbox.{id}.gr4vy.app/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://api.sandbox.{id}.gr4vy.app/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 1299,
  "currency": "USD",
  "payment_service_id": "a7d6b829-aea5-407d-ab7f-138784b5ad2c",
  "payment_method": {
    "method": "card",
    "number": "4111111111111111",
    "expiration_date": "11/25",
    "external_identifier": "card-323444",
    "scheme": "visa"
  }
}
'

{
  "type": "payout",
  "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
  "merchant_account_id": "default",
  "amount": 1299,
  "currency": "USD",
  "created_at": "2022-01-01T12:00:00+00:00",
  "updated_at": "2022-01-01T12:00:00+00:00",
  "payment_service": {
    "type": "payment-service",
    "id": "stripe-card-faaad066-30b4-4997-a438-242b0752d7e1",
    "display_name": "Stripe (Main)",
    "method": "card",
    "payment_service_definition_id": "stripe-card"
  },
  "payment_service_payout_id": "example",
  "category": "online_gambling",
  "status": "pending",
  "external_identifier": "user-789123",
  "merchant": {
    "type": "merchant",
    "name": "Merchant",
    "identification_number": "<string>",
    "phone_number": "+1234567890",
    "url": "<string>",
    "statement_descriptor": "<string>",
    "merchant_category_code": "<string>",
    "address": {
      "city": "London",
      "country": "GB",
      "postal_code": "789123",
      "state": "Greater London",
      "state_code": "GB-LND",
      "house_number_or_name": "10",
      "line1": "10 Oxford Street",
      "line2": "New Oxford Court",
      "organization": "Gr4vy"
    }
  },
  "buyer": {
    "type": "buyer",
    "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
    "billing_details": {
      "type": "billing-details",
      "first_name": "John",
      "last_name": "Lunn",
      "email_address": "john@example.com",
      "phone_number": "+1234567890",
      "address": {
        "city": "London",
        "country": "GB",
        "postal_code": "789123",
        "state": "Greater London",
        "state_code": "GB-LND",
        "house_number_or_name": "10",
        "line1": "10 Oxford Street",
        "line2": "New Oxford Court",
        "organization": "Gr4vy"
      },
      "tax_id": {
        "value": "12345678931",
        "kind": "gb.vat"
      }
    },
    "display_name": "John L.",
    "external_identifier": "user-789123",
    "account_number": "1234567"
  },
  "payment_method": {
    "type": "payment-method",
    "id": "77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5",
    "approval_target": "any",
    "approval_url": "https://api.example.app.gr4vy.com/payment-methods/ffc88ec9-e1ee-45ba-993d-b5902c3b2a8c/approve",
    "country": "US",
    "currency": "USD",
    "details": {
      "bin": "412345",
      "card_type": "credit",
      "card_issuer_name": "Bank"
    },
    "expiration_date": "11/25",
    "external_identifier": "user-789123",
    "label": "1111",
    "last_replaced_at": "2023-07-26T19:23:00.000+00:00",
    "method": "card",
    "payment_account_reference": "V0010014629724763377327521982",
    "scheme": "visa",
    "fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17"
  }
}

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Missing '****' field",
  "details": [
    {
      "location": "body",
      "type": "value_error.missing",
      "pointer": "/payment_method/number",
      "message": "field required"
    }
  ]
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "No valid API authentication found",
  "details": []
}

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.

Body

application/json

Request body for creating new payout.

amount

number

required

The amount to payout.

Required range: 1 <= x <= 99999999

Example:

1299

currency

string

required

The ISO-4217 currency code for the payout.

Example:

"USD"

payment_service_id

string<uuid>

required

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

Example:

"a7d6b829-aea5-407d-ab7f-138784b5ad2c"

payment_method

Payout card payment method · object

required

Inline card details.

Payout card payment method
Payout card payment method

Show child attributes

Response

Returns the created payout.

type

enum<string>

The type of this resource. Is always payout.

Available options:

payout

Example:

"payout"

string<uuid>

The ID of a payout.

Example:

"8d3fe99b-1422-42e6-bbb3-932d95ae5f79"

merchant_account_id

string | null

The optional ID of the merchant account this payout should be assigned to.

Maximum string length: 22

Example:

"default"

amount

integer

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

currency

string

A supported ISO-4217 currency code.

Example:

"USD"

created_at

string<date-time>

The date and time when this payout was created.

Example:

"2022-01-01T12:00:00+00:00"

updated_at

string<date-time>

The date and time when this payout was created.

Example:

"2022-01-01T12:00:00+00:00"

payment_service

A payment service · object

The payment service used for this payout.

Show child attributes

payment_service_payout_id

string | null

The ID of the payout in the underlying payment service.

Example:

"example"

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Payouts

Refunds

Sessions

Settlement records

Disputes

Instruments

Vault

PSPs & Gateways

Errors

Other

Authorizations

Body

Response