Create same-currency outgoing payout or withdrawal

curl --request POST \
  --url https://public-test.blips.network/transfer-out \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "019542f5-b3e7-1d02-0000-000000000001",
  "source": {
    "accountId": "a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
  },
  "destination": {
    "accountId": "e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"
  },
  "amount": 12550,
  "description": "Customer withdrawal"
}
'

import requests

url = "https://public-test.blips.network/transfer-out"

payload = {
    "customerId": "019542f5-b3e7-1d02-0000-000000000001",
    "source": { "accountId": "a12dcbd6-dced-4ec4-b756-3c3a9ea3d123" },
    "destination": { "accountId": "e85dcbd6-dced-4ec4-b756-3c3a9ea3d965" },
    "amount": 12550,
    "description": "Customer withdrawal"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: '019542f5-b3e7-1d02-0000-000000000001',
    source: {accountId: 'a12dcbd6-dced-4ec4-b756-3c3a9ea3d123'},
    destination: {accountId: 'e85dcbd6-dced-4ec4-b756-3c3a9ea3d965'},
    amount: 12550,
    description: 'Customer withdrawal'
  })
};

fetch('https://public-test.blips.network/transfer-out', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-test.blips.network/transfer-out",
  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([
    'customerId' => '019542f5-b3e7-1d02-0000-000000000001',
    'source' => [
        'accountId' => 'a12dcbd6-dced-4ec4-b756-3c3a9ea3d123'
    ],
    'destination' => [
        'accountId' => 'e85dcbd6-dced-4ec4-b756-3c3a9ea3d965'
    ],
    'amount' => 12550,
    'description' => 'Customer withdrawal'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://public-test.blips.network/transfer-out"

	payload := strings.NewReader("{\n  \"customerId\": \"019542f5-b3e7-1d02-0000-000000000001\",\n  \"source\": {\n    \"accountId\": \"a12dcbd6-dced-4ec4-b756-3c3a9ea3d123\"\n  },\n  \"destination\": {\n    \"accountId\": \"e85dcbd6-dced-4ec4-b756-3c3a9ea3d965\"\n  },\n  \"amount\": 12550,\n  \"description\": \"Customer withdrawal\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://public-test.blips.network/transfer-out")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"019542f5-b3e7-1d02-0000-000000000001\",\n  \"source\": {\n    \"accountId\": \"a12dcbd6-dced-4ec4-b756-3c3a9ea3d123\"\n  },\n  \"destination\": {\n    \"accountId\": \"e85dcbd6-dced-4ec4-b756-3c3a9ea3d965\"\n  },\n  \"amount\": 12550,\n  \"description\": \"Customer withdrawal\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-test.blips.network/transfer-out")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"019542f5-b3e7-1d02-0000-000000000001\",\n  \"source\": {\n    \"accountId\": \"a12dcbd6-dced-4ec4-b756-3c3a9ea3d123\"\n  },\n  \"destination\": {\n    \"accountId\": \"e85dcbd6-dced-4ec4-b756-3c3a9ea3d965\"\n  },\n  \"amount\": 12550,\n  \"description\": \"Customer withdrawal\"\n}"

response = http.request(request)
puts response.read_body

{
  "type": "OUTGOING",
  "status": "COMPLETED",
  "customerId": "019542f5-b3e7-1d02-0000-000000000001",
  "platformCustomerId": "partner_cust_9f8b2c7d",
  "source": {
    "accountId": "a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
  },
  "destination": {
    "accountId": "e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"
  },
  "amount": 12550,
  "currency": "USD",
  "description": "Customer withdrawal",
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z",
  "settledAt": "2025-07-21T17:32:28Z",
  "id": "gpid_transfer_out_001"
}

POST

transfer-out

Create same-currency outgoing payout or withdrawal

curl --request POST \
  --url https://public-test.blips.network/transfer-out \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "019542f5-b3e7-1d02-0000-000000000001",
  "source": {
    "accountId": "a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
  },
  "destination": {
    "accountId": "e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"
  },
  "amount": 12550,
  "description": "Customer withdrawal"
}
'

import requests

url = "https://public-test.blips.network/transfer-out"

payload = {
    "customerId": "019542f5-b3e7-1d02-0000-000000000001",
    "source": { "accountId": "a12dcbd6-dced-4ec4-b756-3c3a9ea3d123" },
    "destination": { "accountId": "e85dcbd6-dced-4ec4-b756-3c3a9ea3d965" },
    "amount": 12550,
    "description": "Customer withdrawal"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: '019542f5-b3e7-1d02-0000-000000000001',
    source: {accountId: 'a12dcbd6-dced-4ec4-b756-3c3a9ea3d123'},
    destination: {accountId: 'e85dcbd6-dced-4ec4-b756-3c3a9ea3d965'},
    amount: 12550,
    description: 'Customer withdrawal'
  })
};

fetch('https://public-test.blips.network/transfer-out', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-test.blips.network/transfer-out",
  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([
    'customerId' => '019542f5-b3e7-1d02-0000-000000000001',
    'source' => [
        'accountId' => 'a12dcbd6-dced-4ec4-b756-3c3a9ea3d123'
    ],
    'destination' => [
        'accountId' => 'e85dcbd6-dced-4ec4-b756-3c3a9ea3d965'
    ],
    'amount' => 12550,
    'description' => 'Customer withdrawal'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://public-test.blips.network/transfer-out"

	payload := strings.NewReader("{\n  \"customerId\": \"019542f5-b3e7-1d02-0000-000000000001\",\n  \"source\": {\n    \"accountId\": \"a12dcbd6-dced-4ec4-b756-3c3a9ea3d123\"\n  },\n  \"destination\": {\n    \"accountId\": \"e85dcbd6-dced-4ec4-b756-3c3a9ea3d965\"\n  },\n  \"amount\": 12550,\n  \"description\": \"Customer withdrawal\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://public-test.blips.network/transfer-out")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"019542f5-b3e7-1d02-0000-000000000001\",\n  \"source\": {\n    \"accountId\": \"a12dcbd6-dced-4ec4-b756-3c3a9ea3d123\"\n  },\n  \"destination\": {\n    \"accountId\": \"e85dcbd6-dced-4ec4-b756-3c3a9ea3d965\"\n  },\n  \"amount\": 12550,\n  \"description\": \"Customer withdrawal\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-test.blips.network/transfer-out")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"019542f5-b3e7-1d02-0000-000000000001\",\n  \"source\": {\n    \"accountId\": \"a12dcbd6-dced-4ec4-b756-3c3a9ea3d123\"\n  },\n  \"destination\": {\n    \"accountId\": \"e85dcbd6-dced-4ec4-b756-3c3a9ea3d965\"\n  },\n  \"amount\": 12550,\n  \"description\": \"Customer withdrawal\"\n}"

response = http.request(request)
puts response.read_body

{
  "type": "OUTGOING",
  "status": "COMPLETED",
  "customerId": "019542f5-b3e7-1d02-0000-000000000001",
  "platformCustomerId": "partner_cust_9f8b2c7d",
  "source": {
    "accountId": "a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
  },
  "destination": {
    "accountId": "e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"
  },
  "amount": 12550,
  "currency": "USD",
  "description": "Customer withdrawal",
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z",
  "settledAt": "2025-07-21T17:32:28Z",
  "id": "gpid_transfer_out_001"
}

Authorizations

Authorization

string

header

required

Integration-key Basic Auth (clientId:clientSecret) as documented in docs/public/AUTHENTICATION.md.

Headers

Idempotency-Key

string

Optional idempotency key for safely retrying the same outgoing transfer request.

Body

application/json

customerId

string

required

BLIPS customer UUID that owns the internal source account and bound external destination account.

source

object

required

Customer internal source account that funds the same-currency outgoing payout.

Show child attributes

destination

object

required

Bound external destination account that receives the same-currency payout.

Show child attributes

amount

integer

required

Outgoing payout or withdrawal amount in minor units.

Required range: x >= 1

description

string

Optional payout description stored with the transfer.

Response

Same-currency outgoing payout / withdrawal created.

string

required

Public identifier for the created same-currency outgoing payout or withdrawal.

type

enum<string>

required

Same-currency outgoing transfer type for this endpoint.

Available options:

OUTGOING

status

enum<string>

required

Current same-currency outgoing payout or withdrawal status.

Available options:

PENDING,

PROCESSING,

COMPLETED,

FAILED

customerId

string

required

BLIPS customer UUID that owns the transfer.

platformCustomerId

string

required

Platform-side customer identifier echoed from the bound customer.

source

object

required

Customer internal source account.

Show child attributes

destination

object

required

Bound external destination account.

Show child attributes

amount

integer

required

Same-currency transfer amount in minor units.

Required range: x >= 1

currency

string

required

ISO 4217 currency code shared by the source and destination accounts.

description

string | null

required

Optional payout description echoed from the create request when present.

createdAt

string<date-time>

required

Creation timestamp.

updatedAt

string<date-time>

required

Last update timestamp.

settledAt

string<date-time> | null

required

Settlement timestamp when the outgoing payout has completed.

Reference Overview

Platform Setup / Credentials

Customers

Accounts

Same-Currency Transfers

Cross-Currency Transfers

Transactions

Sandbox APIs

Create same-currency outgoing payout or withdrawal

Authorizations

Headers

Body

Response