Pular para o conteúdo

Get user accounts

Lists the payer accounts, balances, and details shared under the data consent of the Linked journey (Smart Pix). Like the consent route, this is an authenticated proxy to Data Link using the service's own IAM credentials.

The userId comes from the data consent — read it from Get data consent. Use the returned list to let the payer choose the account that will fund the Sweeping transfers.

GET/api/v1/linked-journey/accounts/{userId}

List user accounts by userId

Retrieves the accounts shared by the payer at Data Link, with balances and account details.

Auth: Bearer Token

Path parameters

1 campo
userId●
pathstring · uuid

User identifier at Data Link, returned by Get data consent.

Headers

2 campos
X-Client-IP●
headerstring

IP address of the end user.

subTenantId
headerstring

Optional; kept for consistency with the other routes of the journey. It is not forwarded to Data Link on this GET.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/linked-journey/accounts/283f1e2e-0d99-46e9-a4a6-91e41add490c' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'X-Client-IP: 200.150.100.50' \
  --header 'subTenantId: 1f2b6a1c-6a3e-4b1a-9f0e-6f0b1a2c3d4e'

Response

200Account list returned successfully.
Response body
object
  • dataarray of objectsrequired

    Accounts shared by the payer.

    • itemobject
  • messagestring

    Response message.

  • typestring

    Envelope type (for example `success`).

  • statusCodeinteger· nullable

    HTTP status code.

200 · Account list returned successfully.
{
  "type": "success",
  "message": "User accounts retrieved successfully",
  "data": [
    {
      "type": "CONTA_DEPOSITO_A_VISTA",
      "number": "94088392",
      "accountId": "291e5a29-49ed-401f-a583-193caa7aceee",
      "brandName": "Sib Bank",
      "compeCode": "123",
      "branchCode": "6272",
      "checkDigit": "4",
      "companyCnpj": "40156018000100",
      "organisationId": "74e929d9-33b6-4d85-8ba7-c146c867a817",
      "authorisationServerId": "c8f0bf49-4744-4933-8960-7add6e590841",
      "updatedAt": "2026-03-24T22:46:05.107Z",
      "balance": {
        "accountID": "0ef94d98-4369-4b27-a75b-78d99d1b5a3e",
        "availableAmount": {
          "amount": "1530.45",
          "currency": "BRL"
        },
        "blockedAmount": {
          "amount": "0.00",
          "currency": "BRL"
        },
        "automaticallyInvestedAmount": {
          "amount": "0.00",
          "currency": "BRL"
        }
      },
      "details": {
        "type": "CONTA_PAGAMENTO_PRE_PAGA",
        "number": "3782705",
        "subtype": "INDIVIDUAL",
        "currency": "BRL",
        "compeCode": "999",
        "branchCode": "1099",
        "checkDigit": "9"
      }
    }
  ]
}

Next steps