Pular para o conteúdo

Receiving accounts

Manage the bank accounts your sub-tenant receives Pix payments into, and look up ISPB bank identifiers. All seven functions below accept LinaPayCredentials | TokenCredentials as their first argument.

Create a receiving account

import { createReceivingAccount } from '@lina-openx/web-lina-pay-sdk'

const account = await createReceivingAccount(credentials, {
subTenantId: 'lina',
account: {
  accountNumber: '123456',
  accountIssuer: '0001',
  accountIspb: '12345678',
  accountType: 'CACC',
},
})

List, get, update, and delete

import {
listReceivingAccounts,
getReceivingAccount,
updateReceivingAccount,
deleteReceivingAccount,
} from '@lina-openx/web-lina-pay-sdk'

const accounts = await listReceivingAccounts(credentials, { subTenantId: 'lina' })

const account = await getReceivingAccount(credentials, {
subTenantId: 'lina',
accountId: accounts[0].id,
})

const updated = await updateReceivingAccount(credentials, {
subTenantId: 'lina',
accountId: account.id,
account: { accountType: 'SVGS' },
})

await deleteReceivingAccount(credentials, {
subTenantId: 'lina',
accountId: account.id,
})

Look up bank identifiers (ISPB)

import { getBankIdentifiers, getBankIdentifier } from '@lina-openx/web-lina-pay-sdk'

const banks = await getBankIdentifiers(credentials, { search: 'nubank', limit: 5 })
// -> [{ name: 'Nu Pagamentos S.A.', ispb: '18236120' }, ...]

const one = await getBankIdentifier(credentials, { bankIspb: '18236120' })

getBankIdentifiers and getBankIdentifier hit global endpoints — they don't take a subTenantId.

Next steps