Skip to main content
POST
https://api.owem.com.br
/
v4
/
i
/
bank-accounts
/
{accountId}
/
transfer
/
external
External Transfer
curl --request POST \
  --url https://api.owem.com.br/v4/i/bank-accounts/{accountId}/transfer/external \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pixKey": "<string>",
  "amount": 123,
  "description": "<string>",
  "externalId": "<string>",
  "test": true,
  "testStatus": "<string>"
}
'
{
  "requestId": "a111b222-c333-4d44-8e55-f66677788899",
  "success": true,
  "size": 1,
  "data": {
    "metadata": {
      "idempotencyKey": "TX-202512241200-ABC123XYZ"
    },
    "type": "debit",
    "reason": "pix_out:processing",
    "status": "succeeded",
    "grossAmount": 125.75,
    "feeAmount": 0.08,
    "netAmount": 125.83,
    "externalId": "TX-20251224-EXAMPLE-001",
    "endToEndId": "E123456789202512240000000000001",
    "parentEndToEndId": null,
    "entryId": null,
    "requestId": "02000000-1111-2222-3333-444444444444",
    "userId": "usr_abc123def",
    "accountId": "123456789012",
    "createdAt": 1766523042000,
    "createdDate": "2025-12-24",
    "updatedAt": 1766523042000,
    "updatedDate": "2025-12-24",
    "payer": {
      "ispb": "12345678",
      "personType": "company",
      "cpfCnpj": "XX123456000XXX",
      "name": "EXAMPLE COMPANY LTD",
      "agency": "0001",
      "accountType": "checking",
      "accountNumber": "123456789012"
    },
    "receiver": {
      "ispb": "87654321",
      "personType": "company",
      "cpfCnpj": "XX654321000XXX",
      "name": "DESTINATION COMMERCIAL LTD",
      "agency": "0001",
      "accountType": "checking",
      "accountNumber": "765432"
    },
    "id": "E123456789202512240000000000001",
    "idempotencyKey": "debit:pix_out:processing:E123456789202512240000000000001"
  }
}

​
Purpose

Sends funds from an Owem account to an external bank account via PIX. The API registers the operation in the Ledger and immediately returns the initial status. In case of processing, settlement is asynchronous.

​
Authentication

​
Authorization
string
required
Basic Auth required in format: Basic {Base64(API_KEY:API_SECRET)}

​
Path Parameters

​
accountId
string
required
Source account at Owem (12 digits)

​
Request Body

​
pixKey
string
required
Destination PIX key (phone, email, CPF/CNPJ, or random key)
​
amount
number
required
Amount in BRL (> 0, two decimal places)
​
description
string
Free-text for identification (max 140 characters)
​
externalId
string
Unique identifier defined by the client for idempotency
​
test
boolean
Defines if this is a test request (does not affect real balance)
​
testStatus
string
Simulated status when test: true. Values: processing, succeeded, failed

​
Response

​
requestId
string
UUID for tracking
​
success
boolean
Operation status
​
size
number
Number of returned items
​
data
object
{
  "requestId": "a111b222-c333-4d44-8e55-f66677788899",
  "success": true,
  "size": 1,
  "data": {
    "metadata": {
      "idempotencyKey": "TX-202512241200-ABC123XYZ"
    },
    "type": "debit",
    "reason": "pix_out:processing",
    "status": "succeeded",
    "grossAmount": 125.75,
    "feeAmount": 0.08,
    "netAmount": 125.83,
    "externalId": "TX-20251224-EXAMPLE-001",
    "endToEndId": "E123456789202512240000000000001",
    "parentEndToEndId": null,
    "entryId": null,
    "requestId": "02000000-1111-2222-3333-444444444444",
    "userId": "usr_abc123def",
    "accountId": "123456789012",
    "createdAt": 1766523042000,
    "createdDate": "2025-12-24",
    "updatedAt": 1766523042000,
    "updatedDate": "2025-12-24",
    "payer": {
      "ispb": "12345678",
      "personType": "company",
      "cpfCnpj": "XX123456000XXX",
      "name": "EXAMPLE COMPANY LTD",
      "agency": "0001",
      "accountType": "checking",
      "accountNumber": "123456789012"
    },
    "receiver": {
      "ispb": "87654321",
      "personType": "company",
      "cpfCnpj": "XX654321000XXX",
      "name": "DESTINATION COMMERCIAL LTD",
      "agency": "0001",
      "accountType": "checking",
      "accountNumber": "765432"
    },
    "id": "E123456789202512240000000000001",
    "idempotencyKey": "debit:pix_out:processing:E123456789202512240000000000001"
  }
}

​
Status Codes

HTTPDescription
200Transfer registered
400Invalid parameter (pixKey, amount, etc.)
401Invalid credentials
403IP not allowlisted
404accountId not found
422Insufficient balance or limit exceeded
429Rate limit exceeded
500Internal error

​
Transfer Status

StatusDescription
processingRegistered, awaiting bank confirmation
succeededTransfer confirmed
failedFailed (invalid key, bank rejection)

​
Request Examples

{
  "pixKey": "[email protected]",
  "amount": 125.75,
  "description": "Supplier Payment #123",
  "externalId": "TX-20251224-EXAMPLE-001"
}
Use externalId to ensure idempotency and operation traceability.
Operations with test: true do not affect balance, do not generate Ledger entries, and do not trigger real PIX integration.