Split Receiver

Create Split Receiver

Send a list of Split Receiver objects for creation in the Stark Bank API

post/v2/split-receiver

Request

  • Base URL
    https://api.starkbank.com
  • URL
    https://api.starkbank.com/v2/split-receiver
  • Auth
    API key in header Digital-Signature

Request body

accountNumberstring required

receiver bank account number. Use '-' before the verifier digit. ex: '876543-2'

accountTypestring required

Receiver bank account type. This parameter only has effect on Pix SplitReceivers. ex: 'checking', 'savings', 'salary' or 'payment'

bankCodestring required

Code of the receiver bank institution in Brazil. If an ISPB (8 digits) is informed, a PIX splitReceiver will be created, else a Ted will be issued. ex: '20018183' or '341'

branchCodestring required

Receiver bank account branch. Use '-' in case there is a verifier digit. ex: '1357-9'

namestring required

Receiver full name. ex: 'Anthony Edward Stark'

taxIdstring required

Receiver account tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'

tagsstring[]

list of strings for reference when searching for receivers. ex: ['seller/123456']

Response

Successful operation

object required

Changes

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