Pix transfer by key

Send a Pix transfer to a Pix key with an already-linked account. This is the same JSR flow as Pay a QR Code, with one difference: the consent carries the full transfer payload (amount and creditor) built from the Pix key lookup, instead of a QR Code payload.

Method sequence

enrollments.listByUserJsr(cpf, { deviceId }) — gate on an AUTHORISED enrollment.
pix.getDetails({ pixKey }) — resolve the Pix key into the payee's account so you can build the creditor.
consents.createJsr(req) — open a JSR consent with a payment carrying details, value, cpfCnpj, redirectUri, and the creditor. Returns { id, consentId, fidoSignOptions }; id is the paymentRequestId.
[device] the device produces a FIDO2 assertion from consent.fidoSignOptions.
payments.processJsr(req) — submit the assertion and riskSignals to execute the transfer.

Steps 4–5 are identical across every JSR flow — see Execute a JSR payment for the full code.

Sequence diagram

Carregando diagrama…

Pix transfer by key — resolve the key, build the creditor, consent, sign on device, execute

Code

The creditor is assembled from the pix.getDetails response, with accountPixKey set to the key you looked up.

// 1) Gate: an AUTHORISED enrollment is required
const user = await client.enrollments.listByUserJsr(cpf, { deviceId: riskSignals.deviceId });
const enrollment = user.enrollments[0];

// 2) Resolve the Pix key into the payee account
const details = await client.pix.getDetails({ pixKey });

// 3) Create the consent with the full transfer payload
const consent = await client.consents.createJsr({
enrollmentId: enrollment.enrollmentId,
payment: {
  details: 'Pix transfer',
  value: 300.06,
  cpfCnpj: cpf,
  redirectUri: 'https://app.example.com/payment-success',
  creditor: {
    name: details.account.name,
    personType: details.account.personType,
    cpfCnpj: details.account.cpfCnpj,
    accountNumber: details.account.accountNumber,
    accountIssuer: details.account.accountIssuer,
    accountPixKey: details.pixKey,
    accountIspb: details.account.accountIspb,
    accountType: details.account.accountType,
  },
},
fidoSignOptions: { platform: 'ANDROID' },
}, { clientIp });
// consent.id is the paymentRequestId — sign on device and call payments.processJsr,
// see Execute a JSR payment

// 1) Gate: an AUTHORISED enrollment is required
UserEnrollments user = client.enrollments.listByUserJsr(cpf, ListEnrollmentsQuery.deviceId(deviceId));
EnrollmentSummary enrollment = user.enrollments().get(0);

// 2) Resolve the Pix key into the payee account
PixDetails d = client.pix.getDetails(PixDetailsRequest.byKey(pixKey));
Creditor creditor = new Creditor();
creditor.name = d.account().name();
creditor.personType = d.account().personType();
creditor.cpfCnpj = d.account().cpfCnpj();
creditor.accountNumber = d.account().accountNumber();
creditor.accountIssuer = d.account().accountIssuer();
creditor.accountPixKey = d.pixKey();
creditor.accountIspb = d.account().accountIspb();
creditor.accountType = d.account().accountType();

// 3) Create the consent with the full transfer payload
JsrConsentResult consent = client.consents.createJsr(
  new CreateJsrConsentRequest()
      .enrollmentId(enrollment.enrollmentId())
      .payment(JsrPayment.transfer("Pix transfer", 300.06, cpf,
          "https://app.example.com/payment-success", creditor))
      .fidoSignOptions(new FidoSignOptionsInput("ANDROID")),
  CallOptions.clientIp(ip));
// consent.id() is the paymentRequestId — sign on device and call payments.processJsr,
// see Execute a JSR payment

// 1) Gate: an AUTHORISED enrollment is required
let user = try await client.enrollments.listByUserJsr(cpf, query: ListEnrollmentsQuery(deviceId: deviceId))
guard let enrollment = user.enrollments.first else { return }

// 2) Resolve the Pix key into the payee account
let d = try await client.pix.getDetails(.byKey(pixKey))
let creditor = Creditor(
  name: d.account.name, personType: d.account.personType, cpfCnpj: d.account.cpfCnpj,
  accountNumber: d.account.accountNumber, accountIssuer: d.account.accountIssuer,
  accountPixKey: d.pixKey, accountIspb: d.account.accountIspb, accountType: d.account.accountType)

// 3) Create the consent with the full transfer payload
let consent = try await client.consents.createJsr(
  CreateJsrConsentRequest(
      enrollmentId: enrollment.enrollmentId,
      fidoSignOptions: FidoSignOptionsInput(platform: "IOS"),
      payment: .transfer(details: "Pix transfer", value: 300.06, cpfCnpj: cpf,
                         redirectUri: "https://app.example.com/payment-success", creditor: creditor)),
  options: .clientIp(ip))
// consent.id is the paymentRequestId — sign on device and call payments.processJsr,
// see Execute a JSR payment

// 1) Gate: an AUTHORISED enrollment is required
var user = await client.Enrollments.ListByUserJsrAsync(cpf, new ListEnrollmentsQuery { DeviceId = deviceId });
var enrollment = user.Enrollments[0];

// 2) Resolve the Pix key into the payee account
var d = await client.Pix.GetDetailsAsync(PixDetailsRequest.ByKey(pixKey));
var creditor = new Creditor
{
  Name = d.Account.Name, PersonType = d.Account.PersonType, CpfCnpj = d.Account.CpfCnpj,
  AccountNumber = d.Account.AccountNumber, AccountIssuer = d.Account.AccountIssuer,
  AccountPixKey = d.PixKey, AccountIspb = d.Account.AccountIspb, AccountType = d.Account.AccountType,
};

// 3) Create the consent with the full transfer payload
var consent = await client.Consents.CreateJsrAsync(new CreateJsrConsentRequest
{
  EnrollmentId = enrollment.EnrollmentId,
  FidoSignOptions = new FidoSignOptionsInput { Platform = "ANDROID" },
  Payment = JsrPayment.ForTransfer("Pix transfer", 300.06, cpf, "https://app.example.com/payment-success", creditor),
}, CallOptions.WithClientIp(ip));
// consent.Id is the paymentRequestId — sign on device and call payments.processJsr,
// see Execute a JSR payment

Next steps

Execute a JSR payment — sign on device and run processJsr.
Pay a QR Code — the QR variant of the same flow.
Link an account — required before this flow.