Guides
Guides
Guides

Managing off-ramp local target details

For direct implementations, manage the local bank account target details

❗️

This functionality is only for implementations in which funds are transferred directly between the beneficiary and Caliza with no intermediation from the integrator.

Overview

For implementations in which off-ramps are deposited directly in the beneficiaries' account, you can freely retrieve and update the off-ramp.

Upon update, we will ensure that the tax identifier of the new target matches the tax identifier we have on file for the beneficiary.

Updating local target for a beneficiary

The data that is submitted will vary based on the country of the beneficiary's target account.

Brazil (Pix)

curl --request PUT \
     --url https://sandbox.api.caliza.co/core-api/v1/beneficiaries/{beneficiaryId}/localTargetAccount \
     --header 'Authorization: Bearer {{YOUR_TOKEN}}' \
     --header 'Content-Type: application/json' \
     --data-raw '{
           "pixKey": "pixKey"
  }
}'

This should return a 200 if the update is successful.

Retrieve local target account details for a beneficiary

curl --request GET \
     --url https://sandbox.api.caliza.co/core-api/v1/beneficiaries/{beneficiaryId}/localTargetAccount \
     --header 'Authorization: Bearer {{YOUR_TOKEN}}' \
     --header 'Content-Type: application/json'
}'

The data that is returned will vary based on the country of the beneficiary's target account.

Brazil (Pix)

{
  "CPF": "xxx456xxx",
  "institutionName": "Banco de Brazil",
  "agency": "5",
  "accountNumber": "8475340-2"
}