Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Beneficiary

Preview beneficiary transfer (supports PIX and other methods)

post/v0.2.4/beneficiary/preview

Request body

methodstring required

Payment method

countrystring required

Country code

currencystring required

Currency code

pixKeystring

PIX key (required for PIX transfers)

pixKeyType'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP'

Type of PIX key (optional for PIX)

protocol'pix_ind'

Transfer protocol (for PIX)

Example request

{
  "method": "pix_ind",
  "country": "BR",
  "currency": "BRL",
  "pixKey": "1a717532-2ae7-4b11-b1bd-2ff5559f4d52",
  "pixKeyType": "EVP"
}

Response

Transfer preview retrieved successfully

statusstring
messagestring
dataobject

Preview data varies by payment method

Example response

{
  "status": "success",
  "message": "PIX transfer preview retrieved successfully"
}