Skip to main content
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"
}
'
{
  "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.

​
destination
object
required

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

​
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.

​
id
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.

​
destination
object
required

Bound external destination account.

​
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.