Pular para o conteúdo principal
API docs by Redocly

Accounts API

Download OpenAPI specification:Download

ONZ offers extensive integrations for financial services. Through its RESTful API platform, ONZ enables businesses to create tailor-made products that cater to the specific requirements of their customers. Our API documentation provides in-depth details about the different endpoints accessible through the ONZ APIs.

Each endpoint's documentation encompasses:

  • A description of its functionality.
  • The mandatory and optional parameters, along with any formatting constraints.
  • Necessary headers.
  • Exemplary responses for both successful and unsuccessful requests.

    • Corporate Onboard Into BaaS Platform

    Before starting the integration:
    1. Request a account create on Finance platform;
    2. Create your API credencials on Finance platform (main menu "Configurações" -> "API Contas" -> "Nova credencial")
    3. Request the integration digital certificate

    Authentication

    The procedures within this section manage the utilization of authentication tokens to validate the caller's credentials. To access data in our services, it's essential to provide the correct valid credentials. Below, you'll find a guide on obtaining a valid token and determining its ongoing validity with each inquiry.

    Get an access token.

    The initial step in utilizing the corporate API is the authentication process. During this step, the authorization server will validate the client's credentials and then issue a token.

    The ONZ API employs OAuth 2.0 Bearer Tokens for request authentication. Every API request necessitates inclusion of a bearer token. After obtaining the access token, you can utilize any of the API endpoints outlined below (based on the scopes granted to your app), incorporating the access token within the HTTP Authorization Header.

    Scopes
    Scopes establish the extent of access that a token will possess in relation to resources within the ONZ platform.

    Resource Read Scope Write Scope Accessible Using
    Pix pix.read pix.write Corporate token
    Billets billets.read billets.write Corporate token
    Webhook webhook.read webhook.write Corporate token
    Transactions transactions.read Corporate token
    Account account.read Corporate token
    Infractions infractions.read infractions.write Corporate token
    Request Body schema:
    required
    clientId
    required
    string <uuid>
    clientSecret
    required
    string
    grantType
    required
    string
    Default: "client_credentials"
    scope
    string

    Responses

    Response Schema: application/json
    tokenType
    string
    expiresAt
    integer <int32>
    refreshExpiresIn
    integer <int32>
    notBeforePolicy
    integer <int32>
    accessToken
    string
    scope
    string

    Request samples

    Content type
    {
    • "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    • "clientSecret": "string",
    • "grantType": "client_credentials",
    • "scope": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "tokenType": "string",
    • "expiresAt": 0,
    • "refreshExpiresIn": 0,
    • "notBeforePolicy": 0,
    • "accessToken": "string",
    • "scope": "string"
    }

    Accounts

    The Account API provides endpoints for managing account-related entities on your account, like trasactions and balances.

    Get customer account transactions.

    Authorizations:
    OAuth2
    query Parameters
    event_date_start
    required
    string <date-time>

    Minimal date of query range (ISO 8601)

    event_date_end
    required
    string <date-time>

    Maximal date of query range (ISO 8601)

    page_offset
    integer >= 1
    Default: 1

    Start position in pagination

    page_limit
    integer [ 1 .. 100 ]
    Default: 10

    Maximum resources per page

    sort_by
    string
    Default: "EVENT_DATE"
    Enum: "EVENT_DATE" "AMOUNT"

    Parameter using to sort data

    sort_order
    string
    Default: "ASC"
    Enum: "ASC" "DESC"

    Define order direction

    filter
    string

    Filter transactions by payer or payee document number

    Responses

    Response Schema: application/json
    object (MetaPagination)

    The pagination object is used to paginate the results of a request. It contains information about the total number of items available, the number of items returned in the response, the number of items per page, and the current page number.

    Array of objects (TransactionData)

    Response samples

    Content type
    application/json
    {
    • "meta": {
      },
    • "data": [
      ]
    }

    Get details of transaction.

    Authorizations:
    OAuth2
    path Parameters
    transactionId
    required
    number

    Id of transaction

    Responses

    Response Schema: application/json
    Array
    eventDate
    string <date-time>
    id
    string <number>
    idempotencyKey
    string
    endToEndId
    string (EndToEndId)

    The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

    txId
    string (TxId)

    The "txId" field is a unique identifier generated by the Pix system to uniquely identify and monitor transactions.

    status
    string (OperationStatus)
    Enum: "CANCELED" "PROCESSING," "LIQUIDATED," "REFUNDED," "PARTIALLY_REFUNDED,"
    transactionType
    string (TransactionType)
    Enum: "PIX" "BILLET"
    MANU"MANU" (any) or DICT"DICT" (any) or INIC"INIC" (any) or QRDN"QRDN" (any) or QRES"QRES" (any) (LocalInstrumentType)
    object (DebtorData)
    object (CreditorData)
    creditDebitType
    string
    Enum: "CREDIT" "DEBIT"
    object
    Array of objects (RefundsData)
    remittanceInformation
    string (RemittanceInformation)

    It must be filled in whenever the paying user includes any additional information in a payment to be sent to the recipient.

    AB03"AB03" (any) or AB09"AB09" (any) or AB11"AB11" (any) or AC03"AC03" (any) or AC06"AC06" (any) or AC07"AC07" (any) or AC14"AC14" (any) or AG03"AG03" (any) or AG12"AG12" (any) or AG13"AG13" (any) or AGNT"AGNT" (any) or AM01"AM01" (any) or AM02"AM02" (any) or AM04"AM04" (any) or AM09"AM09" (any) or AM12"AM12" (any) or AM18"AM18" (any) or BE01"BE01" (any) or BE05"BE05" (any) or BE17"BE17" (any) or CH11"CH11" (any) or CH16"CH16" (any) or DS04"DS04" (any) or DS0G"DS0G" (any) or DS24"DS24" (any) or DS27"DS27" (any) or DT02OperationStatus"DT02" (any) or DT05"DT05" (any) or ED05"ED05" (any) or FF07"FF07" (any) or FF08"FF08" (any) or MD01"MD01" (any) or OZ01"OZ01" (any) or RC09"RC09" (any) or RC10"RC10" (any) or RR04"RR04" (any) or SL02"SL02" (any) (PixErrorCode)
    createdAt
    string <date-time>

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Get customer account balance.

    Authorizations:
    OAuth2

    Responses

    Response Schema: application/json
    Array of objects (BalanceData)
    Array
    eventDate
    string <date-time>
    object

    Response samples

    Content type
    application/json
    {
    • "data": [
      ]
    }

    Pix

    You can use the ONZ Payments API to make payments through Pix - the brazilian instant payment - using an Pix key, an QRCode or creditor bank account data.

    About Pix keys

    Pix key is the most common way of identifying the recipient of the amount being transferred. Using the Pix key, the identification process is greatly simplified, as it is not necessary to provide the bank details of the recipients. The payment system provides different types of keys, and the same person can have more than one of them.
    Pix key type Description Format validation
    CPF Tax number ^[0-9]{11}$
    CNPJ Business person tax number ^[0-9]{14}$
    Phone number Phone number ^+[1-9][0-9]\d{1,14}$
    Address e-mail Address e-mail ^[a-z0-9.!#$&'*+\\\\/=?^_`{|}~-]+@[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*$
    EVP (Random Key) Random key (generation by Banco Central do Brasil) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    QRCode (Copia e cola)

    The Pix payment system also provides that payment can be made using a code known as "Copia e cola" (copy and paste), a code that follows the standardization established by the Central Bank of Brazil and that can be expressed through a QRCode.

    Recipient's bank details

    As a third option, payment can be made by informing the recipient's bank details.

    Initiate a payment by QR Code.

    This endpoint allows the request of a Pix payment order (cash-out) using data that follow the specifications of the Banco Central do Brasil and that can be expressed in a QRCode. This data is also known as 'Copy and paste', as it can be copied in text format and inserted as the creditor's identifier.

    Authorizations:
    OAuth2
    header Parameters
    x-idempotency-key
    required
    string

    Unique request identifier to support idempotency.

    Request Body schema: application/json
    required
    qrCode
    required
    string
    creditorDocument
    string
    priority
    string
    Enum: "HIGH" "NORM"

    When the parameter is set to 'HIGH,' it is processed instantly (bypassing the processing queue). The value 'HIGH' is only allowed when the 'creditorDocument' field is defined.

    description
    string
    paymentFlow
    string (PaymentFlowType)
    Enum: "INSTANT" "APPROVAL_REQUIRED"

    Default value is INSTANT.

    • INSTANT - Payment will happen immediately
    • APPROVAL_REQUIRED - Payment only will happen when the order was approved.
    expiration
    integer <int64> (PixCashOutExpiration) [ 1 .. 10800 ]

    Maximum time (seconds) that an operation can remain in the queue waiting for processing before being cancelled.

    required
    object
    ispbDeny
    Array of strings (IspbDenyList)

    List of codes ISPB (Identificador de Sistema de Pagamentos Brasileiro) to which payments will not be allowed.

    Responses

    Request samples

    Content type
    application/json
    {
    • "qrCode": "string",
    • "creditorDocument": "string",
    • "priority": "HIGH",
    • "description": "string",
    • "paymentFlow": "INSTANT",
    • "expiration": 600,
    • "payment": {
      },
    • "ispbDeny": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "endToEndId": "string",
    • "eventDate": "2019-08-24T14:15:22Z",
    • "id": 0,
    • "payment": {
      },
    • "type": "string"
    }

    Initiate a payment using bank information.

    This endpoint allows requesting a Pix payment order (cash-out) using the creditor's bank details (ISPB code, document, branch, account number, account type, name).

    Authorizations:
    OAuth2
    header Parameters
    x-idempotency-key
    required
    string

    Unique request identifier to support idempotency.

    Request Body schema: application/json
    required
    priority
    string
    Enum: "HIGH" "NORM"

    When the parameter is set to 'HIGH,' it is processed instantly (bypassing the processing queue). The value 'HIGH' is only allowed when the 'creditorDocument' field is defined.

    description
    string
    paymentFlow
    string (PaymentFlowType)
    Enum: "INSTANT" "APPROVAL_REQUIRED"

    Default value is INSTANT.

    • INSTANT - Payment will happen immediately
    • APPROVAL_REQUIRED - Payment only will happen when the order was approved.
    expiration
    integer <int64> (PixCashOutExpiration) [ 1 .. 10800 ]

    Maximum time (seconds) that an operation can remain in the queue waiting for processing before being cancelled.

    required
    object (CreditorData)
    required
    object
    ispbDeny
    Array of strings (IspbDenyList)

    List of codes ISPB (Identificador de Sistema de Pagamentos Brasileiro) to which payments will not be allowed.

    Responses

    Request samples

    Content type
    application/json
    {
    • "priority": "HIGH",
    • "description": "string",
    • "paymentFlow": "INSTANT",
    • "expiration": 600,
    • "creditorAccount": {
      },
    • "payment": {
      },
    • "ispbDeny": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "endToEndId": "string",
    • "eventDate": "2019-08-24T14:15:22Z",
    • "id": 0,
    • "payment": {
      },
    • "type": "string"
    }

    Initiate a payment by Pix key.

    This endpoint allows requesting a Pix payment order (cash-out) using any of the allowed types of pix key: CPF, CNPJ, address e-mail, phone number, EVP (random key).

    Authorizations:
    OAuth2
    header Parameters
    x-idempotency-key
    required
    string

    Unique request identifier to support idempotency.

    Request Body schema: application/json
    required
    pixKey
    required
    string

    Any of allowed keys: CPF, CNPJ, address e-mail, phone number, EVP (random key).

    creditorDocument
    string
    priority
    string
    Enum: "HIGH" "NORM"

    When the parameter is set to 'HIGH,' it is processed instantly (bypassing the processing queue). The value 'HIGH' is only allowed when the 'creditorDocument' field is defined.

    description
    string
    paymentFlow
    string (PaymentFlowType)
    Enum: "INSTANT" "APPROVAL_REQUIRED"

    Default value is INSTANT.

    • INSTANT - Payment will happen immediately
    • APPROVAL_REQUIRED - Payment only will happen when the order was approved.
    expiration
    integer <int64> (PixCashOutExpiration) [ 1 .. 10800 ]

    Maximum time (seconds) that an operation can remain in the queue waiting for processing before being cancelled.

    required
    object
    ispbDeny
    Array of strings (IspbDenyList)

    List of codes ISPB (Identificador de Sistema de Pagamentos Brasileiro) to which payments will not be allowed.

    Responses

    Request samples

    Content type
    application/json
    {
    • "pixKey": "string",
    • "creditorDocument": "string",
    • "priority": "HIGH",
    • "description": "string",
    • "paymentFlow": "INSTANT",
    • "expiration": 600,
    • "payment": {
      },
    • "ispbDeny": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "endToEndId": "string",
    • "eventDate": "2019-08-24T14:15:22Z",
    • "id": 0,
    • "payment": {
      },
    • "type": "string"
    }

    Get transaction details by end-to-end-id.

    Authorizations:
    OAuth2
    path Parameters
    endToEndId
    required
    string

    EndToEndId of the pix

    Responses

    Response Schema: application/json
    object (PixDataProperties)
    id
    number <integer>
    idempotencyKey
    string, (IdempotencyKey)

    The idempotency key is a unique identifier associated with each request. By using this key, the system can identify whether a request with the same key has been processed previously, avoiding duplication.

    endToEndId
    string (EndToEndId)

    The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

    pixKey
    string
    transactionType
    string (TransactionType)
    Enum: "PIX" "BILLET"
    status
    string (OperationStatus)
    Enum: "CANCELED" "PROCESSING," "LIQUIDATED," "REFUNDED," "PARTIALLY_REFUNDED,"
    AB03"AB03" (any) or AB09"AB09" (any) or AB11"AB11" (any) or AC03"AC03" (any) or AC06"AC06" (any) or AC07"AC07" (any) or AC14"AC14" (any) or AG03"AG03" (any) or AG12"AG12" (any) or AG13"AG13" (any) or AGNT"AGNT" (any) or AM01"AM01" (any) or AM02"AM02" (any) or AM04"AM04" (any) or AM09"AM09" (any) or AM12"AM12" (any) or AM18"AM18" (any) or BE01"BE01" (any) or BE05"BE05" (any) or BE17"BE17" (any) or CH11"CH11" (any) or CH16"CH16" (any) or DS04"DS04" (any) or DS0G"DS0G" (any) or DS24"DS24" (any) or DS27"DS27" (any) or DT02OperationStatus"DT02" (any) or DT05"DT05" (any) or ED05"ED05" (any) or FF07"FF07" (any) or FF08"FF08" (any) or MD01"MD01" (any) or OZ01"OZ01" (any) or RC09"RC09" (any) or RC10"RC10" (any) or RR04"RR04" (any) or SL02"SL02" (any) (PixErrorCode)
    creditDebitType
    string (creditDebitType)
    Enum: "CREDIT" "DEBIT"
    MANU"MANU" (any) or DICT"DICT" (any) or INIC"INIC" (any) or QRDN"QRDN" (any) or QRES"QRES" (any) (LocalInstrumentType)
    createdAt
    string <date-time>
    object (CreditorData)
    object (DebtorData)
    remittanceInformation
    string (RemittanceInformation)

    It must be filled in whenever the paying user includes any additional information in a payment to be sent to the recipient.

    txId
    string

    The txId is generated by the Pix system and serves to uniquely identify and monitor transactions.

    object
    Array of objects (RefundsData)

    Response samples

    Content type
    application/json
    {
    • "data": {
      }
    }

    Get transaction details by idempotency key.

    Authorizations:
    OAuth2
    path Parameters
    idempotencyKey
    required
    string

    Idempotency Key of the pix

    Responses

    Response Schema: application/json
    object (PixDataProperties)
    id
    number <integer>
    idempotencyKey
    string, (IdempotencyKey)

    The idempotency key is a unique identifier associated with each request. By using this key, the system can identify whether a request with the same key has been processed previously, avoiding duplication.

    endToEndId
    string (EndToEndId)

    The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

    pixKey
    string
    transactionType
    string (TransactionType)
    Enum: "PIX" "BILLET"
    status
    string (OperationStatus)
    Enum: "CANCELED" "PROCESSING," "LIQUIDATED," "REFUNDED," "PARTIALLY_REFUNDED,"
    AB03"AB03" (any) or AB09"AB09" (any) or AB11"AB11" (any) or AC03"AC03" (any) or AC06"AC06" (any) or AC07"AC07" (any) or AC14"AC14" (any) or AG03"AG03" (any) or AG12"AG12" (any) or AG13"AG13" (any) or AGNT"AGNT" (any) or AM01"AM01" (any) or AM02"AM02" (any) or AM04"AM04" (any) or AM09"AM09" (any) or AM12"AM12" (any) or AM18"AM18" (any) or BE01"BE01" (any) or BE05"BE05" (any) or BE17"BE17" (any) or CH11"CH11" (any) or CH16"CH16" (any) or DS04"DS04" (any) or DS0G"DS0G" (any) or DS24"DS24" (any) or DS27"DS27" (any) or DT02OperationStatus"DT02" (any) or DT05"DT05" (any) or ED05"ED05" (any) or FF07"FF07" (any) or FF08"FF08" (any) or MD01"MD01" (any) or OZ01"OZ01" (any) or RC09"RC09" (any) or RC10"RC10" (any) or RR04"RR04" (any) or SL02"SL02" (any) (PixErrorCode)
    creditDebitType
    string (creditDebitType)
    Enum: "CREDIT" "DEBIT"
    MANU"MANU" (any) or DICT"DICT" (any) or INIC"INIC" (any) or QRDN"QRDN" (any) or QRES"QRES" (any) (LocalInstrumentType)
    createdAt
    string <date-time>
    object (CreditorData)
    object (DebtorData)
    remittanceInformation
    string (RemittanceInformation)

    It must be filled in whenever the paying user includes any additional information in a payment to be sent to the recipient.

    txId
    string

    The txId is generated by the Pix system and serves to uniquely identify and monitor transactions.

    object
    Array of objects (RefundsData)

    Response samples

    Content type
    application/json
    {
    • "data": {
      }
    }

    Billets

    The Billets API provides endpoints for managing billets-related entities on your account.

    Initiate a payment using billet data.

    This endpoint allows requesting a billet (brazilian boleto) payment order (cash-out) using billet code (Linha digitável).
    1 - Payment will always be made using an adjusted amount (interest and fines).
    2 - Billets whose payment amount can be changed by the payer can only be paid via the web (Finance).

    Authorizations:
    OAuth2
    header Parameters
    x-idempotency-key
    required
    string

    Unique request identifier to support idempotency.

    Request Body schema: application/json
    required
    digitableCode
    required
    string

    Numeric representation of billet's barcode (Linha digitável). Only numbers.

    description
    required
    string
    paymentFlow
    string (PaymentFlowType)
    Enum: "INSTANT" "APPROVAL_REQUIRED"

    Default value is INSTANT.

    • INSTANT - Payment will happen immediately
    • APPROVAL_REQUIRED - Payment only will happen when the order was approved.
    object

    Responses

    Request samples

    Content type
    application/json
    {
    • "digitableCode": "string",
    • "description": "string",
    • "paymentFlow": "INSTANT",
    • "payment": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": 0,
    • "idempotencyKey": "string",
    • "eventDate": "2019-08-24T14:15:22Z",
    • "digitableCode": "string",
    • "description": "string",
    • "status": "CANCELED",
    • "transactionType": "PIX",
    • "creditDebitType": "CREDIT",
    • "payment": {
      }
    }

    Get a billet payment list.

    Authorizations:
    OAuth2

    Responses

    Response Schema: application/json
    object (MetaPagination)

    The pagination object is used to paginate the results of a request. It contains information about the total number of items available, the number of items returned in the response, the number of items per page, and the current page number.

    object (BilletPaymentRegisterResponse)

    Response samples

    Content type
    application/json
    {
    • "meta": {
      },
    • "data": {
      }
    }

    Get billet payment operation data by id.

    Authorizations:
    OAuth2
    path Parameters
    id
    required
    string

    Billet id

    Responses

    Response Schema: application/json
    id
    number <int64>
    idempotencyKey
    string
    eventDate
    string <date-time>
    digitableCode
    string

    Numeric representation of billet's barcode (Linha digitável).

    description
    string
    status
    string (OperationStatus)
    Default: "LIQUIDATED"
    Enum: "CANCELED" "PROCESSING," "LIQUIDATED," "REFUNDED," "PARTIALLY_REFUNDED,"
    transactionType
    string (TransactionType)
    Default: "BILLET"
    Enum: "PIX" "BILLET"
    creditDebitType
    string (creditDebitType)
    Enum: "CREDIT" "DEBIT"
    object
    object
    object (CreditorData)
    object (DebtorData)

    Response samples

    Content type
    application/json
    {
    • "id": 0,
    • "idempotencyKey": "string",
    • "eventDate": "2019-08-24T14:15:22Z",
    • "digitableCode": "string",
    • "description": "string",
    • "status": "CANCELED",
    • "transactionType": "PIX",
    • "creditDebitType": "CREDIT",
    • "payment": {
      },
    • "billetInfo": {
      },
    • "creditorAccount": {
      },
    • "debtorAccount": {
      }
    }

    Infractions

    Infractions are a means to contest a Pix operation due to fraud.

    Returns infractions opened against the customer's account.

    Authorizations:
    OAuth2
    query Parameters
    last_change_start
    required
    string <date-time>

    Minimal date of query range (ISO 8601)

    last_change_end
    required
    string <date-time>

    Maximal date of query range (ISO 8601)

    page_offset
    integer >= 1
    Default: 1

    Start position in pagination

    page_limit
    integer [ 1 .. 100 ]
    Default: 10

    Maximum resources per page

    sort_by
    string
    Default: "EVENT_DATE"
    Enum: "EVENT_DATE" "STATUS"

    Parameter using to sort data

    status
    string
    Default: "ALL"
    Enum: "ACKNOWLEDGED" "WAITING_ADJUSTMENTS" "DEFENDED" "CLOSED"

    Actual status of infraction

    Responses

    Response Schema: application/json
    object (MetaPagination)

    The pagination object is used to paginate the results of a request. It contains information about the total number of items available, the number of items returned in the response, the number of items per page, and the current page number.

    Array of objects (InfractionData)

    Response samples

    Content type
    application/json
    {
    • "meta": {
      },
    • "data": [
      ]
    }

    Get infraction data by infraction ID.

    Authorizations:
    OAuth2
    path Parameters
    infractionId
    required
    string

    Infraction ID

    Responses

    Response Schema: application/json
    object
    id
    string <uuid>
    transactionId
    number
    endToEndId
    string (EndToEndId)

    The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

    type
    string (InfractionTypes)
    Enum: "FRAUD" "REFUND_REQUEST" "REFUND_CANCELLED"
    reportedBy
    string (InfractionReportedBy)
    Enum: "DEBITED_PARTICIPANT" "CREDITED_PARTICIPANT"
    object
    reportDetails
    string
    analysisResult
    string or null (InfractionResultTypes)
    Enum: "AGREED" "DISAGREED"
    status
    string (InfractionStatus)
    Enum: "OPEN" "CLOSED" "CANCELLED" "ACKNOWLEDGED" "DEFENDED" "ANSWERED" "WAITING_ADJUSTMENTS"
    analysisDetails
    string or null
    creationDate
    string <date-time>
    lastModificationDate
    string <date-time>
    isReporter
    boolean
    Array of objects (InfractionDefenseHistoryData)

    Response samples

    Content type
    application/json
    {
    • "data": {
      }
    }

    Create a defense against an infraction.

    Authorizations:
    OAuth2
    path Parameters
    infractionId
    required
    string

    Infraction ID

    Request Body schema: multipart/form-data
    required
    defense
    string
    files
    Array of strings <binary> [ items <binary > ]

    Responses

    Response Schema: application/json
    object
    id
    string <uuid>
    transactionId
    number
    endToEndId
    string (EndToEndId)

    The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

    type
    string (InfractionTypes)
    Enum: "FRAUD" "REFUND_REQUEST" "REFUND_CANCELLED"
    reportedBy
    string (InfractionReportedBy)
    Enum: "DEBITED_PARTICIPANT" "CREDITED_PARTICIPANT"
    object
    reportDetails
    string
    analysisResult
    string or null (InfractionResultTypes)
    Enum: "AGREED" "DISAGREED"
    status
    string (InfractionStatus)
    Enum: "OPEN" "CLOSED" "CANCELLED" "ACKNOWLEDGED" "DEFENDED" "ANSWERED" "WAITING_ADJUSTMENTS"
    analysisDetails
    string or null
    creationDate
    string <date-time>
    lastModificationDate
    string <date-time>
    isReporter
    boolean
    Array of objects (InfractionDefenseHistoryData)

    Response samples

    Content type
    application/json
    {
    • "data": {
      }
    }

    Webhooks

    Use webhooks to receive information about API events as they occur. An event is an activity that happens outside of your system, such as a Pix cash-out or a receive. Webhooks allow you to build or set up integrations. When a subscribed event occurs, a notification will be posted, via HTTP, to the specified endpoint. To receive and process webhook-enabled events, configure a webhook endpoint in your environment.


    Recurring error behavior

    Range fails Action
    1 - 5 fails Queued messages will be resent after 2 minutes
    6 - 10 fails Queued messages will be resent in 15 minutes interval
    11 - 15 fails Queued messages will be resent in 60 minutes interval
    > 15 fails The webhook process will be desactived

    Get a webhooks list.

    Authorizations:
    OAuth2

    Responses

    Response Schema: application/json
    object (MetaPagination)

    The pagination object is used to paginate the results of a request. It contains information about the total number of items available, the number of items returned in the response, the number of items per page, and the current page number.

    Array of objects (WebhookData)

    Response samples

    Content type
    application/json
    {
    • "meta": {
      },
    • "data": [
      ]
    }

    Get a webhook data.

    Authorizations:
    OAuth2
    path Parameters
    webhookId
    required
    string <uuid>

    Id of webhook

    Responses

    Response Schema: application/json
    id
    string <uuid>
    type
    string (WebhookType)
    Enum: "TRANSFER" "RECEIVE" "REFUND" "CASHOUT" "INFRACTION"
    uri
    string <uri>
    enabled
    boolean

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "type": "TRANSFER",
    • "uri": "http://example.com",
    • "enabled": true
    }

    Remove a webhook.

    Cancel and remove the webhook from processing. All new hooks for the transactions are be ignored and will discard

    Authorizations:
    OAuth2
    path Parameters
    webhookId
    required
    string <uuid>

    Id of webhook

    Responses

    Response samples

    Content type
    application/json
    {
    • "type": "string",
    • "title": "string",
    • "detail": "string",
    • "instance": "string"
    }

    Create webhooks for transfer operations.

    These webhooks will be triggered when the cash-out operation has settled or been canceled.

    Authorizations:
    OAuth2
    Request Body schema: application/json
    required
    uri
    required
    string <uri>
    email
    string

    E-mail utilizado para realizar as notificações de erros de envio de webhooks

    method
    string
    Default: "POST"
    Enum: "POST" "GET" "PUT"
    enabled
    required
    boolean
    Default: true
    pauseOnFail
    boolean
    Default: true
    object

    Responses

    Response Schema: application/json
    id
    string <uuid>
    type
    string (WebhookType)
    Enum: "TRANSFER" "RECEIVE" "REFUND" "CASHOUT" "INFRACTION"
    uri
    string <uri>
    enabled
    boolean

    Callbacks

    Request samples

    Content type
    application/json
    {
    • "uri": "http://example.com",
    • "email": "string",
    • "method": "POST",
    • "enabled": true,
    • "pauseOnFail": true,
    • "headers": {
      }
    }

    Response samples

    Content type
    application/json
    {}

    Callback payload samples

    Callback
    POST: {$request.body#/uri}
    Content type
    application/json
    {
    • "data": {
      },
    • "type": "TRANSFER"
    }

    Create webhooks for receiving operations.

    These webhooks will be triggered when the cash-in operation has been settled.

    Authorizations:
    OAuth2
    Request Body schema: application/json
    required
    uri
    required
    string <uri>
    email
    string

    E-mail utilizado para realizar as notificações de erros de envio de webhooks

    method
    string
    Default: "POST"
    Enum: "POST" "GET" "PUT"
    enabled
    required
    boolean
    Default: true
    pauseOnFail
    boolean
    Default: true
    object

    Responses

    Response Schema: application/json
    id
    string <uuid>
    type
    string (WebhookType)
    Enum: "TRANSFER" "RECEIVE" "REFUND" "CASHOUT" "INFRACTION"
    uri
    string <uri>
    enabled
    boolean

    Callbacks

    Request samples

    Content type
    application/json
    {
    • "uri": "http://example.com",
    • "email": "string",
    • "method": "POST",
    • "enabled": true,
    • "pauseOnFail": true,
    • "headers": {
      }
    }

    Response samples

    Content type
    application/json
    {}

    Callback payload samples

    Callback
    POST: {$request.body#/uri}
    Content type
    application/json
    {
    • "data": {
      },
    • "type": "TRANSFER"
    }

    Create webhooks for refunding operations.

    These webhooks will be triggered when the cash-out operation has been refunded.

    Authorizations:
    OAuth2
    Request Body schema: application/json
    required
    uri
    required
    string <uri>
    email
    string

    E-mail utilizado para realizar as notificações de erros de envio de webhooks

    method
    string
    Default: "POST"
    Enum: "POST" "GET" "PUT"
    enabled
    required
    boolean
    Default: true
    pauseOnFail
    boolean
    Default: true
    object

    Responses

    Response Schema: application/json
    id
    string <uuid>
    type
    string (WebhookType)
    Enum: "TRANSFER" "RECEIVE" "REFUND" "CASHOUT" "INFRACTION"
    uri
    string <uri>
    enabled
    boolean

    Callbacks

    Request samples

    Content type
    application/json
    {
    • "uri": "http://example.com",
    • "email": "string",
    • "method": "POST",
    • "enabled": true,
    • "pauseOnFail": true,
    • "headers": {
      }
    }

    Response samples

    Content type
    application/json
    {}

    Callback payload samples

    Callback
    POST: {$request.body#/uri}
    Content type
    application/json
    {
    • "data": {
      },
    • "type": "TRANSFER"
    }

    Create webhooks for cash-out operations.

    These webhooks will be triggered when a data validation failure occurs on the cash-out operation.

    Authorizations:
    OAuth2
    Request Body schema: application/json
    required
    uri
    required
    string <uri>
    email
    string

    E-mail utilizado para realizar as notificações de erros de envio de webhooks

    method
    string
    Default: "POST"
    Enum: "POST" "GET" "PUT"
    enabled
    required
    boolean
    Default: true
    pauseOnFail
    boolean
    Default: true
    object

    Responses

    Response Schema: application/json
    id
    string <uuid>
    type
    string (WebhookType)
    Enum: "TRANSFER" "RECEIVE" "REFUND" "CASHOUT" "INFRACTION"
    uri
    string <uri>
    enabled
    boolean

    Callbacks

    Request samples

    Content type
    application/json
    {
    • "uri": "http://example.com",
    • "email": "string",
    • "method": "POST",
    • "enabled": true,
    • "pauseOnFail": true,
    • "headers": {
      }
    }

    Response samples

    Content type
    application/json
    {}

    Callback payload samples

    Callback
    POST: {$request.body#/uri}
    Content type
    application/json
    {
    • "data": {
      }
    }

    Create webhooks for infraction operations.

    These webhooks will be triggered when an infraction is opened on the customer's account.

    Authorizations:
    OAuth2
    Request Body schema: application/json
    required
    uri
    required
    string <uri>
    email
    string

    E-mail utilizado para realizar as notificações de erros de envio de webhooks

    method
    string
    Default: "POST"
    Enum: "POST" "GET" "PUT"
    enabled
    required
    boolean
    Default: true
    pauseOnFail
    boolean
    Default: true
    object

    Responses

    Response Schema: application/json
    id
    string <uuid>
    type
    string (WebhookType)
    Enum: "TRANSFER" "RECEIVE" "REFUND" "CASHOUT" "INFRACTION"
    uri
    string <uri>
    enabled
    boolean

    Callbacks

    Request samples

    Content type
    application/json
    {
    • "uri": "http://example.com",
    • "email": "string",
    • "method": "POST",
    • "enabled": true,
    • "pauseOnFail": true,
    • "headers": {
      }
    }

    Response samples

    Content type
    application/json
    {}

    Callback payload samples

    Callback
    POST: {$request.body#/uri}
    Content type
    application/json
    {
    • "data": {
      },
    • "type": "INFRACTION"
    }