PIpismo
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

  • Base URL
    https://sandbox.pismolabs.io/bacen-spb
  • URL
    https://sandbox.pismolabs.io/bacen-spb/v1/provider-configuration
  • Auth
    HTTP bearer

Request body

branchstring required

Client organization's branch ID

codestring required

Code that identifies Pismo to the provider.

document_numberstring required

Client organization's government document number such as a Tax ID.

passwordstring required

Password

provider'JD' required

Payment provider. Right now, only JD Consultores.

urlstring required

URL that identifies the client at the provider.

userstring required

Username

Example request

{
  "branch": "1234",
  "code": "Legacy",
  "document_number": "Client CNPJ (Brazilian business tax ID)",
  "password": "123456",
  "provider": "JD",
  "url": "https://jdspb12345678homl",
  "user": "userSpb"
}

Response

Response Body

messagestring

message

Example response

{
  "message": "Configuration saved"
}

Changes

No recorded changes to this operation across all 1 revision of this API.