Transfer

Prepare a transfer

Validates recipient details and creates a transfer preparation. First step in the two-phase transfer process.

Supported Methods

PIX Key: Using recipient’s PIX key
PIX EMV: Using QR code or copy-paste string
PIX Account: Using bank account details
TED: Electronic transfer to other banks
Same Bank: Internal bank transfers
Same Company: Between your organization’s accounts

Flow

Prepare - Validate recipient (this endpoint)
Confirm - Execute with amount

Returns transferId for use in Confirm transfer.

POST

transfers

prepare

Prepare a transfer

curl --request POST \
  --url http://api.obsidiam.com/transfers/prepare \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "organizationId": "<string>",
  "method": "<string>",
  "pixKey": "<string>"
}
'

{
  "transferId": "<string>",
  "beneficiaryDocument": "<string>",
  "bankName": "<string>"
}

Body

application/json

accountId

string

required

Minimum string length: 1

organizationId

string

required

Minimum string length: 1

method

string

required

Allowed value: "pix-key"

pixKey

string

required

Minimum string length: 1

Response

default - application/json

transferId

string

required

Transfer ID for confirmation

beneficiaryDocument

string

required

Recipient CPF or CNPJ

bankName

string

required

Recipient bank name

Confirm transfer Executes a prepared transfer with the final amount. **Second step** in the two-phase transfer process. #### Processing Times - **PIX**: Instant (24/7) - **TED**: Same-day during business hours - **Same Bank/Company**: Immediate #### Requirements - TRANSFER permission - Valid `transferId` from [Prepare transfer](/api-reference/transfer/prepare-a-transfer) - Sufficient account balance - Within transfer limits

⌘I

Prepare a transfer

curl --request POST \
  --url http://api.obsidiam.com/transfers/prepare \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "organizationId": "<string>",
  "method": "<string>",
  "pixKey": "<string>"
}
'

{
  "transferId": "<string>",
  "beneficiaryDocument": "<string>",
  "bankName": "<string>"
}

Endpoints

Body

Response