v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Configurations

Register for TED transfers

Register a client's configuration at a provider who is authorized to use the Brazil Central Bank's (BCB) payment system (SPB) for TED transfers.

TED stands for Transferência Eletrônica Disponível (Electronic transfer available) and is a Brazilian electronic funds transfer system that allows businesses and individuals to transfer funds between different banks. Pismo uses this configuration to authorize TED transfers on clients' behalf.

post/v1/provider-configuration

Request body

branchstring required

This could be a bank-assigned branch ID or the branch's ISPB number.

codestring required

Code

document_numberstring required

Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.

passwordstring required

Password

provider'HST' required

Third-party provider name

urlstring required

URL that identifies the client at the provider.

userstring required

Username

Example request

{
  "branch": "011",
  "code": "LAC_BBC",
  "document_number": "7777888hh",
  "password": "123456",
  "provider": "HST",
  "url": "https://jdspb12345678homl",
  "user": "userSpb"
}

Response

Response Body

messagestring

message

Example response

{
  "message": "Configuration saved"
}