openapi: 3.2.0 info: title: Citi Paymentservices API version: 1.0.0 description: 'Operations tagged Paymentservices across 3 of this provider''s published API definitions: Static.yaml, citi-due-date-openapi.yaml, citi-immediate-openapi.yaml. Each path carries the servers of the definition it was published in.' servers: - url: https://tts.apib2b.citi.com/citiconnect/prod/ description: production gateway url - url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/ description: sandbox url - url: https://tts.sit.apib2b.citi.com/citiconnect/sit5/ description: dev gateway url tags: - name: Payment Services paths: /paymentservices/collections/qrcodes: post: summary: This API has an ability to create a QR Code for user which will allow their… description: 'QR Code Creation API has an ability to create a QR Code for user and is supported JSON format. This API can be initiated by forming a well-defined POST request. Finally, you encrypt the payload, place it in your request and send it via your application. Content-Type : Supports application/json. Authorization: The OAuth Token prefixed with Bearer and space in between.' operationId: qrCodeCreation parameters: - $ref: '#/components/parameters/ClientId' - $ref: '#/components/parameters/CountryCode' - $ref: '#/components/parameters/ApiVersion' - $ref: '#/components/parameters/PaymentMethod' - $ref: '#/components/parameters/Language' requestBody: description: Describes the QR Code creation APIs request body fields. content: application/json: schema: oneOf: - $ref: '#/components/schemas/BrazilStaticQRCodeRequest' examples: BrazilStaticQRCodeExample: $ref: '#/components/examples/BrazilStaticQRCodeExample' required: true responses: '201': $ref: '#/components/responses/CreatedResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '405': $ref: '#/components/responses/MethodNotAllowed' '415': $ref: '#/components/responses/UnsupportedMediaType' '500': $ref: '#/components/responses/InternalServerError' '503': $ref: '#/components/responses/ServiceUnavailable' '504': $ref: '#/components/responses/GatewayTimeout' security: - oAuth2: - paymentservices tags: - Payment Services servers: - url: https://tts.apib2b.citi.com/citiconnect/prod/ description: production gateway url - url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/ description: sandbox url /paymentservices/collections/qrcodes/cobv/{txid}: parameters: - $ref: '#/components/parameters/TxId' - $ref: '#/components/parameters/ClientId_2' put: summary: Create collection with due date operationId: dynamicCollectionCreateWithDueDate security: - cobVWriteSample: - cobv.write description: Endpoint to create a collection with due date. requestBody: $ref: '#/components/requestBodies/CobVBody' responses: '201': $ref: '#/components/responses/CobVGeradaCreateResponse' '400': $ref: '#/components/responses/RequisicaoInvalida' '401': $ref: '#/components/responses/AcessoNegado1' '403': $ref: '#/components/responses/AcessoNegado' '404': $ref: '#/components/responses/NaoEncontrado' '405': $ref: '#/components/responses/MetodoInvalido' '415': $ref: '#/components/responses/MidiaInvalida' '500': $ref: '#/components/responses/ServicoIndisponivel1' '503': $ref: '#/components/responses/ServicoIndisponivel' tags: - Payment Services patch: parameters: - $ref: '#/components/parameters/CNPJ' summary: Update collection with due date operationId: dynamicCollectionUpdateWithDueDate security: - cobVWriteSample: - cobv.write requestBody: $ref: '#/components/requestBodies/CobVBodyRevisada' responses: '200': $ref: '#/components/responses/CobVGeradaUpdateResponse' '400': $ref: '#/components/responses/RequisicaoInvalida' '401': $ref: '#/components/responses/AcessoNegado1' '403': $ref: '#/components/responses/AcessoNegado' '404': $ref: '#/components/responses/NaoEncontrado' '405': $ref: '#/components/responses/MetodoInvalido' '415': $ref: '#/components/responses/MidiaInvalida' '500': $ref: '#/components/responses/ServicoIndisponivel1' '503': $ref: '#/components/responses/ServicoIndisponivel' tags: - Payment Services get: parameters: - $ref: '#/components/parameters/TxId' - $ref: '#/components/parameters/CNPJQuery' - $ref: '#/components/parameters/Revisao' - $ref: '#/components/parameters/ClientId_2' summary: Retrieve specific collection with due date details operationId: dynamicCollectionInquiryWithDueDate security: - cobVReadSample: - cobv.read description: Endpoint intended to retrieve details for a collection with due date through a specific TXID. responses: '200': $ref: '#/components/responses/CobVCompletaResponse' '400': $ref: '#/components/responses/RequisicaoInvalida' '401': $ref: '#/components/responses/AcessoNegado1' '403': $ref: '#/components/responses/AcessoNegado' '404': $ref: '#/components/responses/NaoEncontrado' '405': $ref: '#/components/responses/MetodoInvalido' '500': $ref: '#/components/responses/ServicoIndisponivel1' '503': $ref: '#/components/responses/ServicoIndisponivel' tags: - Payment Services servers: - url: https://tts.sit.apib2b.citi.com/citiconnect/sit5/ description: dev gateway url - url: https://tts.apib2b.citi.com/citiconnect/prod/ description: production gateway url - url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/ description: 'sbox url ' /paymentservices/collections/qrcodes/cobv: get: parameters: - $ref: '#/components/parameters/Inicio' - $ref: '#/components/parameters/Fim' - $ref: '#/components/parameters/CPF' - $ref: '#/components/parameters/CNPJ' - $ref: '#/components/parameters/LocationPresente' - $ref: '#/components/parameters/Status' - $ref: '#/components/parameters/loteCobVId' - $ref: '#/components/parameters/PaginaAtual' - $ref: '#/components/parameters/ItensPorPagina' - $ref: '#/components/parameters/ClientId_2' summary: Retrieve a list of collection items with due date operationId: dynamicCollectionInquiryListWithDueDate security: - cobVReadSample: - cobv.read description: Endpoint to query outstanding collections through parameters like start date, end date, taxpayer ID (CPF/CNPJ) and status. responses: '200': $ref: '#/components/responses/CobsVConsultadasResponse' '400': $ref: '#/components/responses/RequisicaoInvalida' '401': $ref: '#/components/responses/AcessoNegado1' '403': $ref: '#/components/responses/AcessoNegado' '404': $ref: '#/components/responses/NaoEncontrado' '405': $ref: '#/components/responses/MetodoInvalido' '500': $ref: '#/components/responses/ServicoIndisponivel1' '503': $ref: '#/components/responses/ServicoIndisponivel' tags: - Payment Services servers: - url: https://tts.sit.apib2b.citi.com/citiconnect/sit5/ description: dev gateway url - url: https://tts.apib2b.citi.com/citiconnect/prod/ description: production gateway url - url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/ description: 'sbox url ' /paymentservices/collections/qrcodes/cob/{txid}: parameters: - $ref: '#/components/parameters/TxId' - $ref: '#/components/parameters/ClientId_3' put: summary: Create immediate Collection operationId: dynamicCollectionCreation security: - cobWriteSample: - cob.write description: Endpoint to create an Immediate collection. requestBody: $ref: '#/components/requestBodies/CobBody' responses: '201': $ref: '#/components/responses/CobGeradaResponse' '400': $ref: '#/components/responses/RequisicaoInvalida' '401': $ref: '#/components/responses/AcessoNegado1' '403': $ref: '#/components/responses/AcessoNegado' '404': $ref: '#/components/responses/NaoEncontrado' '405': $ref: '#/components/responses/MetodoInvalido' '415': $ref: '#/components/responses/MidiaInvalida' '500': $ref: '#/components/responses/ServicoIndisponivel1' '503': $ref: '#/components/responses/ServicoIndisponivel' tags: - Payment Services get: parameters: - $ref: '#/components/parameters/Revisao' - $ref: '#/components/parameters/CNPJ' summary: See Immediate Collection operationId: dynamicCollectionInquiry security: - cobReadSample: - cob.read description: Endpoint intended to retrieve details for a Collection using a specific TXID. responses: '200': $ref: '#/components/responses/CobCompletaResponse' '401': $ref: '#/components/responses/AcessoNegado1' '403': $ref: '#/components/responses/AcessoNegado' '404': $ref: '#/components/responses/NaoEncontrado' '405': $ref: '#/components/responses/MetodoInvalido' '500': $ref: '#/components/responses/ServicoIndisponivel1' '503': $ref: '#/components/responses/ServicoIndisponivel' tags: - Payment Services patch: parameters: - $ref: '#/components/parameters/CNPJ' summary: Update immediate Collection operationId: dynamicCollectionUpdate security: - cobWriteSample: - cob.write description: Endpoint to update an Immediate collection. requestBody: $ref: '#/components/requestBodies/CobBodyRevisada' responses: '200': $ref: '#/components/responses/CobGeradaResponse' '400': $ref: '#/components/responses/RequisicaoInvalida' '401': $ref: '#/components/responses/AcessoNegado1' '403': $ref: '#/components/responses/AcessoNegado' '404': $ref: '#/components/responses/NaoEncontrado' '405': $ref: '#/components/responses/MetodoInvalido' '415': $ref: '#/components/responses/MidiaInvalida' '500': $ref: '#/components/responses/ServicoIndisponivel1' '503': $ref: '#/components/responses/ServicoIndisponivel' tags: - Payment Services servers: - url: https://tts.sit.apib2b.citi.com/citiconnect/sit5/ description: dev gateway url - url: https://tts.apib2b.citi.com/citiconnect/prod/ description: production gateway url - url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/ description: 'sbox url ' /paymentservices/collections/qrcodes/cob: parameters: - $ref: '#/components/parameters/ClientId_3' get: parameters: - $ref: '#/components/parameters/Inicio' - $ref: '#/components/parameters/Fim' - $ref: '#/components/parameters/CPF' - $ref: '#/components/parameters/CNPJ' - $ref: '#/components/parameters/LocationPresente' - $ref: '#/components/parameters/Status_2' - $ref: '#/components/parameters/PaginaAtual' - $ref: '#/components/parameters/ItensPorPagina' summary: See Immediate Collection List operationId: dynamicCollectionInquiryList security: - cobReadSample: - cob.read description: Endpoint intended to check a Collection through parameters such as start date, end date, taxpayer ID (CPF/CNPJ) and status. responses: '200': $ref: '#/components/responses/CobsConsultadasResponse' '401': $ref: '#/components/responses/AcessoNegado1' '403': $ref: '#/components/responses/AcessoNegado' '404': $ref: '#/components/responses/NaoEncontrado' '405': $ref: '#/components/responses/MetodoInvalido' '500': $ref: '#/components/responses/ServicoIndisponivel1' '503': $ref: '#/components/responses/ServicoIndisponivel' tags: - Payment Services servers: - url: https://tts.sit.apib2b.citi.com/citiconnect/sit5/ description: dev gateway url - url: https://tts.apib2b.citi.com/citiconnect/prod/ description: production gateway url - url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/ description: 'sbox url ' components: schemas: BrazilStaticQRCodeResponse: type: object description: Describes the QR Code Creation APIs response fields when user initiated request is with country BR, payment method PIX and language Portuguese. required: - txid - qrcode properties: txid: type: string pattern: ^[a-zA-Z0-9 ]{1,25}$ maxLength: 25 description: Identical to the one informed with input parameter valor: type: string pattern: ^[0-9]{1,10}.[0-9][0-9]$ description: Collection amount, identical to that received qrcode: type: string maxLength: 300 description: QR code string representation, EMV standard PortugeseErrorDetail: type: object description: Describes the reason for errors when user initiated request is with country BR, payment method PIX and language Portuguese. properties: razao: type: string maxLength: 150 description: this field is used to describe the reason for failure. propriedade: type: string maxLength: 30 description: this field is used to show above reason is for this Property name valor: type: string maxLength: 12 description: Property value BrazilstaticQRCodeErrorResponse: type: object description: Describes the QR Code Creation APIs error response fields when user initiated request is with country BR, payment method PIX and language Portuguese. required: - type - title - status properties: type: type: string maxLength: 77 description: Reference URI that identifies the type of problem. According to RFC 7807. title: type: string maxLength: 50 description: message for error. status: type: string maxLength: 3 description: HTTP status code returned. detail: type: string maxLength: 150 description: Complete description of the problem. corelationId: type: string maxLength: 40 description: unique id to which will allocate to every request when request come to us. violacoes: type: array maxItems: 10 items: $ref: '#/components/schemas/PortugeseErrorDetail' BrazilStaticQRCodeRequest: type: object description: Describes the Brazil QR Code Creation APIs request fields.This Schema is applicable only when country is BR, payment method is PIX and language is Portuguese. required: - chave properties: txid: type: string pattern: ^[a-zA-Z0-9 ]{1,25}$ maxLength: 25 description: Transaction identifier (the purpose of this field is to be an element that allows the recipient's PSP to present the payment reconciliation functionality to the recipient user). chave: type: string maxLength: 77 description: Pix alias registered in the DICT that will be used for the collection. This key will be read by the payer's PSP application for consultation with the DICT, which will return information that will identify the recipient of the collection. infoAdicionais: type: string maxLength: 72 description: Additional information that will be displayed to the Payer when reading the QR code. valor: type: string pattern: ^[0-9]{1,10}.[0-9][0-9]$ description: Collection amount. The decimal separator is the period character. Thousands separator not applicable. nomeBeneficiario: type: string pattern: ^[a-zA-Z0-9 ]{1,25}$ maxLength: 25 description: Beneficiary / recipient name cidadeBeneficiario: type: string pattern: ^[a-zA-Z0-9 ]{1,15}$ maxLength: 15 description: City where the transaction is made or city of the recipients bank counter saque: type: string default: '0' enum: - '0' - '1' description: identify the static qrcode for withdrawal
1 - this qr code request is for the purpose of saque
0 - this qr code is not for the withdrawal purpose and this will be default CobVValor: type: object title: Valor da cobrança com vencimento description: Collection amount. properties: original: type: string title: Valor pattern: \d{1,10}\.\d{2} description: Valor original da cobrança. multa: type: object required: - modalidade - valorPerc title: Multa aplicada description: Penalty applied to collection properties: modalidade: type: integer format: int32 title: Modalidade da multa minimum: 1 maximum: 2 description:
DescriptionDomain
Value Fixo1
percentage2
valorPerc: type: string title: Valor da multa absoluta description: Penalty in absolute or percentage amount, according to "amount.fine.modality". pattern: \d{1,10}\.\d{2} juros: type: object required: - modalidade - valorPerc title: Juro aplicado description: Interest applied to collection properties: modalidade: type: integer format: int32 minimum: 1 maximum: 8 title: Modalidade de juros description: Interest rate, according to the domain table.
DescriptionDomain
Value (calendar days)1
Percentage per day (calendar days)2
Percentage per month (calendar days)3
Percentage per year (calendar days)4
Value (working days)5
Percentage per day (working days)6
Percentage per month (working days)7
Percentage per year (working days)8
valorPerc: type: string title: Valor pattern: \d{1,10}\.\d{2} abatimento: title: Abatimento aplicado required: - modalidade - valorPerc description: Deduction applied to collection properties: modalidade: type: integer format: int32 minimum: 1 maximum: 2 title: Modalidade de abatimentos description: Deduction modality, according to the table of Domains.
DescriptionDomain
Fixed Value1
Percentage2
valorPerc: type: string title: Abatimentos description: Deductions applied to the collection, in absolute value or as a percentage of the original value of the collection. pattern: \d{1,10}\.\d{2} desconto: title: Descontos aplicados required: - modalidade description: Discounts applied to collection allOf: - type: object properties: modalidade: type: integer format: int32 minimum: 1 maximum: 6 title: Modalidade de descontos description: Discount modality, according to the domain table.
DescriptionDomain
Fixed Value until[s] informed date[s]1
Percentage until the date informed2
Amount in advance day corrido3
Amount in advance business day4
Percentage in calendar day advance5
Percentage in business day advance6
oneOf: - type: object properties: descontoDataFixa: title: Lista de Descontos description: Absolute discounts applied to the collection. type: array minItems: 1 maxItems: 3 uniqueItems: true items: required: - data - valorPerc allOf: - properties: data: title: Data limite para o desconto absoluto da cobrança description: Discounts for prepayment, with a fixed date. Matrix with up to three elements, each element consisting of a pair "date and value Perc", to establish percentage or absolute discounts, up to that payment date. This is a date, in the format `YYYY-MM-DD`, according to ISO 8601. The discount date must be earlier than the collection due date. type: string format: date example: '2020-04-01' - properties: valorPerc: type: string title: Valor do desconto absoluto description: Discount in absolute amount or percentage per day, business or consecutive, according to value.discount.modality pattern: \d{1,10}\.\d{2} - type: object required: - valorPerc properties: valorPerc: type: string title: Abatimentos description: Deductions applied to the collection, in absolute value or as a percentage of the original value of the collection. pattern: \d{1,10}\.\d{2} Revisao: type: integer format: int32 title: Revisão description: 'Denotes the collection review version. Always starts at zero. Always increments 1. This should increase whenever a collection item is updated. The `loc` field change is not considered an update and therefore does not trigger an increment to the version number. The `loc` field does not change the collection itself. It is not necessary to store the history of changes in the `loc` field for a given collection. For the other fields of the collection, history is recorded.' PixValorDesconto: type: object properties: desconto: type: object required: - valor properties: valor: type: string title: Valor relativo a desconto. description: Discount amount. pattern: \d{1,10}\.\d{2} CobsVConsultadas: type: object title: Cobranças com vencimento consultadas required: - parametros - cobs properties: parametros: $ref: '#/components/schemas/ParametrosConsultaCob' cobs: type: array title: Lista de cobranças items: allOf: - $ref: '#/components/schemas/CobVCompleta' - required: - status - txid - idCob CobVCompleta: title: Cobrança com vencimento completa required: - status allOf: - $ref: '#/components/schemas/CobVSolicitada' - $ref: '#/components/schemas/CobVGerada' - type: object properties: pix: type: array title: Pix recebidos items: allOf: - $ref: '#/components/schemas/Pix' - type: object properties: txid: allOf: - $ref: '#/components/schemas/TxId' - pattern: '[a-zA-Z0-9]{26,35}' - type: object properties: status: $ref: '#/components/schemas/CobrancaStatus' TxId: type: string title: Id da Transação description: Field `txid` determines the transaction identifier for reconciliation purposes. In pacs.008 it is referenced as `TransactionIdentification ` or `idConciliacaoRecebedor`. The txid is retrieved by the payer’s PSP application and, after the payment is confirmed, it is sent to SPI via pacs.008. A pacs.008 is also sent to the receiver’s PSP, containing the txid in addition to all the usual payment information. Upon receiving the payment with txid, the receiver's PSP may inform the creditor to reconcile. The contents of this field are provided exclusively by the collector, who is the ultimate responsible for them. The txid should be unique by collector’s CPF/CNPJ. The receiving PSP is responsible for validating this rule in the API. pattern: '[a-zA-Z0-9]{26,35}' PixValorTroco: type: object properties: troco: type: object required: - valor - modalidadeAgente - prestadorDoServicoDeSaque properties: valor: type: string title: Valor do Troco Pix description: Amount of Change Pix. pattern: \d{1,10}\.\d{2} modalidadeAgente: type: string title: Modalidade do Agente description: '##### Agent Type
ACRONYMDescription
AGTECBusiness Establishment Agent
AGTOTOther Type of Legal Entity Agent
' enum: - AGTEC - AGTOT prestadorDoServicoDeSaque: type: string title: Facilitador de Serviço de Saque pattern: \d{8} description: Withdrawal Service Provider ISPB DadosRecebedor: type: object required: - logradouro - cidade - uf - cep properties: recebedor: description: The receiving object organizes the information about the creditor of the collection. oneOf: - $ref: '#/components/schemas/PessoaFisica' - type: object allOf: - $ref: '#/components/schemas/PessoaJuridica' - type: object properties: nomeFantasia: type: string title: Nome fantasia description: Fantasy name. maxLength: 200 allOf: - required: - logradouro - cidade - uf - cep - $ref: '#/components/schemas/DadosComplementaresPessoa' DadosComplementaresPessoa: type: object properties: logradouro: type: string title: Logradouro description: User address. maxLength: 200 cidade: type: string title: Cidade description: User city. maxLength: 200 uf: type: string title: UF description: UF of the user. maxLength: 2 cep: type: string title: CEP description: User zip code. maxLength: 8 EndToEndId: type: string title: Id fim a fim da transação description: EndToEndIdentification that carries over PACS002, PACS004 and PACS008 pattern: '[a-zA-Z0-9]{32}' minLength: 32 maxLength: 32 PixValorOriginal: type: object properties: original: type: object required: - valor properties: valor: type: string title: Valor original description: Original Pix value. pattern: \d{1,10}\.\d{2} ParametrosConsultaCob: type: object title: Parâmetros de Consulta de Cobrança description: '[DEPRECATED] Parameters used to carry out collection items query.' required: - inicio - fim - paginacao properties: inicio: type: string format: date-time title: Data de Início description: Starting date used in the query. Complies with RFC 3339. example: '2020-04-01T00:00:00Z' fim: type: string format: date-time title: Data de Fim description: End date used in the query. Complies with RFC 3339. example: '2020-04-01T17:00:00Z' cpf: type: string title: CPF pattern: /^\d{11}$/ description: Filter by the CPF of the debtor. It cannot be used at the same time as the CNPJ. cnpj: type: string title: CNPJ pattern: /^\d{14}$/ description: Filter by the debtor's CNPJ. It cannot be used at the same time as the CPF. locationPresente: type: boolean description: Filter by the existence of linked location. status: type: string title: Status do registro da cobrança description: Filter by collection status. paginacao: $ref: '#/components/schemas/Paginacao' Problema: type: object required: - type - title - status properties: type: type: string format: uri description: Reference URI identifying the type of issue. As per RFC 7807. example: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado title: type: string description: A short description of the problem. example: Not found status: type: integer description: HTTP code of status returned. example: 404 detail: type: string description: Full description of the problem. correlationId: type: string description: Issue correlation identifier for support purposes violacoes: type: array items: $ref: '#/components/schemas/Violacao' Pix: type: object title: Pix required: - endToEndId - valor - horario - pagador properties: endToEndId: $ref: '#/components/schemas/EndToEndId' txid: allOf: - $ref: '#/components/schemas/TxId' - pattern: '[a-zA-Z0-9]{1,35}' valor: type: string title: Valor do Pix. pattern: \d{1,10}\.\d{2} description: Valor do Pix. componentesValor: type: object title: Informações sobre o valor do Pix description: "The purpose of this framework is to explain the elements that make up the Pix amount, including information on fines, interest, discounts, and deductions when Pix is related to overdue collections.\n\nStructure rules:\n- Pix `value` is equal to:\n - (`original.amount` + `withdrawal.amount` + `change.amount`) + `fine.amount` + `interest.amount` – `rebate.amount` – `discount.amount`\n considering only the fields that are present for each type of paid collection.\n- The `withdrawal` and `change` structures will only be returned when the Pix is relative to a Cashout Pix or Change Pix, respectively, and\nthe other structures (`interest`, `fine`, `rebate` and `discount`) will only be relevant to the Pix of payments of collections due.\n- There cannot be simultaneously a substructure of type `withdrawal` and another of type `change`;\n- There is no restriction on the order of substructures.\n\nIn the case of a Pix Withdraw, you can return `original` with value=0.00 (zero) since the sum will be respected, or you can omit the\noriginal substructure. In the case of a Pix Swap or a collection payment due date, the `original` substructure will always be\ngift.\n\n#### Valid examples:\nExample of valid fills.\n\n- **Pix para pagamento de cobrança imediata (sem saque ou troco).**\n ```\n ...\n \"componentsValue\": {\n \"original\": {\n \"value\": \"100.00\"\n }\n }\n ...\n ```\n- **Pix Saque.**\n ```\n ...\n \"componentsValue\": {\n \"withdraw\": {\n \"value\": \"100.00\",\n \"agent modality\": \"AGPSS\",\n \"Withdrawal Service Provider\": \"12345678\"\n }\n }\n ...\n ```\n- **Pix para pagamento de cobrança imediata com saque (pode vir original.valor=0.00).**\n ```\n ...\n \"componentsValue\": {\n \"original\": {\n \"value\": \"0.00\"\n },\n \"withdraw\": {\n \"value\": \"100.00\",\n \"agent modality\": \"AGPSS\",\n \"Withdrawal Service Provider\": \"12345678\"\n }\n }\n ...\n ```\n- **Pix Troco.**\n ```\n ...\n \"componentsValue\": {\n \"original\": {\n \"value\": \"80.00\"\n },\n \"Thing\": {\n \"value\": \"20.00\",\n \"agent modality\": \"AGTEC\",\n \"Withdrawal Service Provider\": \"12345678\"\n }\n }\n ...\n ```\n- **Pix para pagamento de cobrança imediata com troco (ordem não importa).**\n ```\n ...\n \"componentsValue\": {\n \"Thing\": {\n \"value\": \"20.00\",\n \"agent modality\": \"AGTEC\",\n \"Withdrawal Service Provider\": \"12345678\"\n },\n \"original\": {\n \"value\": \"80.00\"\n }\n }\n ...\n ```\n- **Pix para pagamento de cobrança com vencimento de R$100,00 considerando-se um atraso de 2 dias a uma multa de 3% e juros de 1% ao dia. O valor do Pix será R$105,00.**\n ```\n ...\n \"componentsValue\": {\n \"original\": {\n \"value\": \"100.00\"\n },\n \"traffic ticket\": {\n \"value\": \"3.00\"\n },\n \"fees\": {\n \"value\": \"2.00\"\n }\n }\n ...\n ```\n#### Invalid examples:\nNon-exhaustive examples of invalid fills.\n- **`original.valor maior que 0.00 (zero) e saque juntos**\n ```\n ...\n \"componentsValue\": {\n \"original\": {\n \"value\": \"80.00\"\n },\n \"withdraw\": {\n \"value\": \"20.00\",\n \"agent modality\": \"AGPSS\",\n \"Withdrawal Service Provider\": \"12345678\"\n }\n }\n ...\n ```\n- **dois elementos de saque**\n ```\n ...\n \"componentsValue\": [\n \"withdraw\": {\n \"value\": \"20.00\",\n \"agent modality\": \"AGPSS\",\n \"Withdrawal Service Provider\": \"12345678\"\n },\n \"withdraw\": {\n \"value\": \"10.00\",\n \"agent modality\": \"AGPSS\",\n \"Withdrawal Service Provider\": \"12345678\"\n }\n ]\n ...\n ```\n- **saque e troco simultaneamente**\n ```\n ...\n \"componentsValue\": {\n \"original\": {\n \"value\": \"60.00\"\n },\n \"withdraw\": {\n \"value\": \"20.00\",\n \"agent modality\": \"AGPSS\",\n \"Withdrawal Service Provider\": \"12345678\"\n },\n \"Thing\": {\n \"value\": \"20.00\",\n \"agent modality\": \"AGTEC\",\n \"Withdrawal Service Provider\": \"12345678\"\n }\n }\n ...\n ```" anyOf: - $ref: '#/components/schemas/PixValorOriginal' - $ref: '#/components/schemas/PixValorSaque' - $ref: '#/components/schemas/PixValorTroco' - $ref: '#/components/schemas/PixValorJuros' - $ref: '#/components/schemas/PixValorMulta' - $ref: '#/components/schemas/PixValorAbatimento' - $ref: '#/components/schemas/PixValorDesconto' chave: type: string title: Chave DICT do recebedor description: '# Creditor DICT alias * Creditor alias field as assigned in the respective PACS008. * Aliases types can be: phone, email, cpf/cnpj or EVP. * The format of the aliases can be found in the section "Formatting DICT aliases in BR Code" of the [Pix Initiation Standards Manual](https://www.bcb.gov.br/estabilidadefinanceira/pix). ' maxLength: 77 horario: type: string format: date-time title: Horário description: Time the Pix was processed on the PSP. infoPagador: type: string title: Informação livre do pagador maxLength: 140 devolucoes: type: array title: Devoluções items: $ref: '#/components/schemas/Devolucao' CobVGerada: type: object title: Cobrança com vencimento gerada description: Collection item with due date created or updated via API required: - location - txid - devedor - calendario - revisao - status - valor - chave - recebedor allOf: - type: object properties: calendario: required: - validadeAposVencimento title: Calendário description: The fields nested under the calendar identifier organize information regarding collection-related dates. allOf: - $ref: '#/components/schemas/CobCriacao' - $ref: '#/components/schemas/CobDataDeVencimento' txid: $ref: '#/components/schemas/TxId' revisao: $ref: '#/components/schemas/Revisao' - $ref: '#/components/schemas/DadosRecebedor' - type: object properties: loc: required: - id - txid - tipoCob - criacao allOf: - $ref: '#/components/schemas/PayloadLocation' - type: object properties: status: $ref: '#/components/schemas/CobrancaStatus' - type: object properties: valor: required: - original allOf: - $ref: '#/components/schemas/CobVValor' - $ref: '#/components/schemas/CobBaseCopiaCola' PessoaJuridica: type: object required: - cnpj - nome title: Pessoa Jurídica properties: cnpj: type: string title: CNPJ pattern: /^\d{14}$/ description: User's CNPJ. nome: type: string title: Nome description: User's Nome. maxLength: 200 Inicio: type: string title: Data de início description: Filters records whose creation date is greater than or equal to the start date. Complies with RFC 3339.It should be in ISO_DATE(yyyy-MM-dd'T'HH:mm:ss.SSSZ) format example: '2021-10-01T00:01:54.876Z' Violacao: type: object title: Violações properties: razao: type: string title: Descrição do erro description: Error description example: Valor da cobrança não pode ser 0.00 propriedade: type: string title: Nome da propriedade description: Property name example: cob.chave valor: type: string title: Valor da propriedade description: Property Value example: 061996671234 CobCriacao: type: object title: Criação required: - criacao properties: criacao: type: string format: date-time title: Data de Criação description: Timestamp that indicates when the collection item was created. Complies with the format defined in RFC 3339. DevolucaoNatureza: type: string title: Natureza da Devolução description: 'Indicates the nature of the return. A return can be related to a regular Pix, or to a Withdrawal/Change Pix. In the absence of this field the nature must be interpreted as being of a common Pix (ORIGINAL). Natures are defined as follows: - `ORIGINAL`: when the return refers to a common Pix or the purchase amount in a Pix Troca; - `RETIRADA`: when the return refers to a Cash Out Pix or the amount of change in a Pix Change. - `MED_OPERACIONAL`: when the return occurs within the MED due to operational failure and refers to a common Pix (`BE08`); - `MED_FRAUDE`: when the return occurs within the MED on grounds of suspected fraud and refers to a common Pix (`FR01`). ' enum: - ORIGINAL - RETIRADA - MED_OPERACIONAL - MED_FRAUDE Paginacao: type: object title: Paginação required: - paginaAtual - itensPorPagina - quantidadeDePaginas - quantidadeTotalDeItens properties: paginaAtual: type: integer title: Página atual description: Retrieved page number. minimum: 0 itensPorPagina: type: integer title: Itens por página description: Number of records returned on the page. minimum: 1 quantidadeDePaginas: type: integer title: Quantidade de páginas description: Number of pages available for consultation. minimum: 1 quantidadeTotalDeItens: type: integer title: Quantidade total de itens description: Total amount of items available according to the parameters informed. minimum: 0 PessoaFisica: type: object required: - cpf - nome title: Pessoa Física properties: cpf: type: string title: CPF pattern: /^\d{11}$/ description: User's CPF. nome: type: string title: Nome description: Username. maxLength: 200 CobVSolicitada: type: object title: Cobrança com vencimento solicitada description: Data sent to create or update the collection with due date via API required: - valor - chave - devedor - calendario allOf: - type: object properties: calendario: title: Calendário description: Fields nested under the calendar identifier organize information regarding collection-related dates. allOf: - $ref: '#/components/schemas/CobDataDeVencimento' - $ref: '#/components/schemas/DadosDevedor' - type: object properties: loc: allOf: - $ref: '#/components/schemas/PayloadLocationCob' - type: object properties: valor: allOf: - required: - original - $ref: '#/components/schemas/CobVValor' - $ref: '#/components/schemas/CobBase' CobBaseCopiaCola: type: object title: Cobrança Base com Copia e Cola description: Attributes common to all collection entities that have Copy and Paste information allOf: - type: object properties: pixCopiaECola: type: string title: Pix Copia e Cola correspondente à cobrança. description: This field returns the QR code string representation for a copy & paste operation. maxLength: 512 - $ref: '#/components/schemas/CobBase' CobVRevisada: type: object title: Cobrança com vencimento revisada description: Data sent for review of the collection item with due date via API allOf: - type: object properties: calendario: title: Calendário description: Fields nested under the calendar identifier organize information regarding collection-related dates. allOf: - $ref: '#/components/schemas/CobDataDeVencimento' - $ref: '#/components/schemas/DadosDevedor' - type: object properties: loc: allOf: - $ref: '#/components/schemas/PayloadLocationCob' - type: object properties: status: type: string title: Status do registro da cobrança enum: - REMOVIDA_PELO_USUARIO_RECEBEDOR - type: object properties: valor: $ref: '#/components/schemas/CobVValor' - $ref: '#/components/schemas/CobBase' PixValorSaque: type: object properties: saque: type: object required: - valor - modalidadeAgente - prestadorDoServicoDeSaque properties: valor: type: string title: Valor do Saque Pix description: Pix Withdrawal Value Pix pattern: \d{1,10}\.\d{2} modalidadeAgente: type: string title: AgentModalidade do Agente description: '##### Agent Type
ACRONYMDescription
AGTECBusiness Establishment Agent
AGTOTOther Type of Legal Entity Agent
AGPSSAgent Withdrawal Service Provider< /td>
' enum: - AGTEC - AGTOT - AGPSS prestadorDoServicoDeSaque: type: string title: Facilitador de Serviço de Saque pattern: \d{8} description: Withdrawal Service Provider ISPB PixValorAbatimento: type: object properties: abatimento: type: object required: - valor properties: valor: type: string title: Valor relativo a abatimento. description: Rebate amount. pattern: \d{1,10}\.\d{2} CobBase: type: object title: Cobrança Base description: Attributes common to all collection entities properties: chave: type: string title: Chave DICT do recebedor description: 'PIX Alias - Determines the alias registered in DICT, which will be used for the collection. This alias will be submitted by the payer’s PSP applications to DICT, which will return the translated information that will identify the collection creditor. *The aliases can be of the following types: phone number, e-mail address, taxpayer ID (CPF/CNPJ) or EVP.* The aliases formats can be found in [Standards Manual for starting Pix](https://www.bcb.gov.br/estabilidadefinanceira/pagamentosinstantaneos).' maxLength: 77 solicitacaoPagador: type: string title: Solicitação ao pagador description: This optional field determines a text to be presented to the payer so that he can enter related information, in free format, to be sent to the recipient. This text will be filled, in pacs.008, by the payer's PSP, in the RemittanceInformation field. The length of the field in pacs.008 is limited to 140 characters. maxLength: 140 infoAdicionais: type: array title: Informações adicionais description: Each respective additional information contained in the list (name and amount) must be presented to the payer. maximum: 50 items: type: object required: - nome - valor properties: nome: type: string title: Nome description: Field name. maxLength: 50 valor: type: string title: Valor description: Field data. maxLength: 200 Fim: type: string title: Data de fim description: Filters records whose creation date is less than or equal to the end date. Complies with RFC 3339.It should be in ISO_DATE(yyyy-MM-dd'T'HH:mm:ss.SSSZ) format example: '2021-10-02T00:01:54.876Z' CobrancaStatus: type: string title: Status do registro da cobrança. description: ' Collection registration status. Not to be confused with its payment status, like paid, overdue, expired, for instance. The statuses are defined in this way: - `ATIVA`: indicates that the collection item was generated and is active (not yet been paid or removed); - `CONCLUIDA`: indicates that the collection item is no longer active and therefore will not accept further payments; - `REMOVIDO_PELO_USUARIO_RECEBEDOR`: indicates that the collection item was removed by the creditor; and - `REMOVIDO_PELO_PSP`: indicates that the collection item was removed by the PSP.' enum: - ATIVA - CONCLUIDA - REMOVIDA_PELO_USUARIO_RECEBEDOR - REMOVIDA_PELO_PSP PixValorJuros: type: object properties: juros: type: object required: - valor properties: valor: type: string title: Valor relativo aos juros. description: Interest amount. pattern: \d{1,10}\.\d{2} DevolucaoId: type: string title: Id da Devolução description: Location ID to be informed in the collection item creation. pattern: '[a-zA-Z0-9]{1,35}' PayloadLocationId: type: integer format: int64 title: Id da location description: Identifier of the location to be informed when creating the collection. CNPJ: type: string title: número de identificação fiscal description: "# Tax identification identifier\n Field `taxid` determines the tax identification number.\n" pattern: ^[0-9]{14}$ DadosDevedor: type: object properties: devedor: description: The debtor object organizes information about the collection debtor. oneOf: - $ref: '#/components/schemas/PessoaFisica' - $ref: '#/components/schemas/PessoaJuridica' allOf: - type: object properties: email: type: string title: Email description: User email. - $ref: '#/components/schemas/DadosComplementaresPessoa' CobDataDeVencimento: type: object title: Data de Vencimento required: - dataDeVencimento properties: dataDeVencimento: type: string format: date title: Data de vencimento da cobrança description: This is a date, in the format `YYYY-MM-DD`, as per ISO 8601. It is the collection due date. The collection can be paid with no late payment penalty or interest up to this date, at any time of the day. example: '2020-04-01' validadeAposVencimento: type: integer format: int32 title: Validade após vencimento description: ' It is the number of calendar days after calendario.dateDeVencimento, in which the collection can be technically paid (with or without late payment penalties or interest). Whenever the due date falls on a weekend or a holiday for the paying user, it must be automatically extended to the first subsequent business day. all fields that make reference to this date (`PostExpiration validity`; `discount`; `interest` and `fine`) must assume this extension, when applicable. To illustrate how it works, here are some examples, where: - ``(#)`` represents the due date; - ``(*)`` represents the date adjusted in terms of non-working days; - the ``()`` correspond to the additional days of validity for the payment. Exemplo A: ```txt Expiration Date: 2020-10-20, Tuesday. validityAfter Expiration: 4 Trying to pay on the day 2020-10-20, Tuesday: accepted. (#)(*) Trying to pay on the day 2020-10-21, Wednesday: accepted. (1) Trying to pay on 2020-10-22, Thursday: accepted. (two) Trying to pay on the day 2020-10-23, Friday: accepted. (3) Attempts to pay on 2020-10-24, Saturday: accepted. Attempts to pay on the day 2020-10-25, Sunday: accepted. (Holiday) Trying to pay on 2020-10-26, Monday: accepted. (4) Trying to pay on 2020-10-27, Tuesday: denied. ``` Exemplo B: ```txt Expiration Date: 2020-12-25, Friday, holiday. validityAfterExpiration: 0 Attempts to pay on the day 2020-12-25, Friday: accepted. (#)(Holiday) Attempts to pay on 2020-12-26, Saturday: accepted. Attempts to pay on 2020-12-27, Sunday: accepted. Trying to pay on the day 2020-12-28, Monday: accepted. (*) Trying to pay on 2020-12-29, Tuesday: denied. ``` Exemplo C: ```txt Expiration Date: 2020-12-25, Friday, holiday. validityAfter Expiration: 1 Attempts to pay on the day 2020-12-25, Friday: accepted. (#)(Holiday) Attempts to pay on 2020-12-26, Saturday: accepted. Attempts to pay on 2020-12-27, Sunday: accepted. Trying to pay on the day 2020-12-28, Monday: accepted. (*) Trying to pay on 2020-12-29, Tuesday: accepted. (1) Trying to pay on the day 2020-12-30, Wednesday: denied. ``` Exemplo D: ```txt Expiration Date: 2020-12-25, Friday, holiday. validityAfter Expiration: 3 Attempts to pay on the day 2020-12-25, Friday: accepted. (#)(Holiday) Attempts to pay on 2020-12-26, Saturday: accepted. Attempts to pay on 2020-12-27, Sunday: accepted. Trying to pay on the day 2020-12-28, Monday: accepted. (*) Trying to pay on 2020-12-29, Tuesday: accepted. (1) Attempts to pay on the day 2020-12-30, Wednesday: accepted. (two) Trying to pay on 2020-12-31, Thursday: accepted. (3) Trying to pay on 2021-01-01, Friday: denied. ``` Exemplo E: ```txt Expiration Date: 2020-12-25, Friday, holiday. validityAfter Expiration: 4 Attempts to pay on the day 2020-12-25, Friday: accepted. (#)(Holiday) Attempts to pay on 2020-12-26, Saturday: accepted. Attempts to pay on 2020-12-27, Sunday: accepted. Trying to pay on the day 2020-12-28, Monday: accepted. (*) Trying to pay on 2020-12-29, Tuesday: accepted. (1) Attempts to pay on the day 2020-12-30, Wednesday: accepted. (two) Trying to pay on 2020-12-31, Thursday: accepted. (3) Trying to pay on 2021-01-01, Friday: accepted. (Holiday) Attempts to pay on 2021-01-02, Saturday: accepted. Attempts to pay on 2021-01-03, Sunday: accepted. Trying to pay on 2021-01-04, Monday: accepted. (4) Trying to pay on 2021-01-05, Tuesday: denied. ``` Exemplo F: ```txt Expiration Date: 2021-08-27, Friday. validityAfter Expiration: 5 Trying to pay on the day 2020-08-27, Friday: accepted. (#)(*) Attempts to pay on the day 2020-08-28, Saturday: accepted. (1) Attempts to pay on the day 2020-08-29, Sunday: accepted. (two) Trying to pay on the day 2020-08-30, Monday: accepted. (3) Trying to pay on 2020-12-31, Tuesday: accepted. (4) Attempts to pay on the day 2020-12-01, Wednesday: accepted. (5) Trying to pay on 2020-12-02, Thursday: denied. ``` Exemplo G: ```txt Expiration Date: 2021-08-28, Saturday. validityAfter Expiration: 5 Attempts to pay on the day 2020-08-28, Saturday: accepted. (#) Attempts to pay on the day 2020-08-29, Sunday: accepted. Trying to pay on the day 2020-08-30, Monday: accepted. (*) Trying to pay on the day 2020-08-31, Tuesday: accepted. (1) Trying to pay on the day 2020-09-01, Wednesday: accepted. (two) Trying to pay on 2020-09-02, Thursday: accepted. (3) Trying to pay on the day 2020-09-03, Friday: accepted. (4) Trying to pay on the day 2020-09-04, Saturday: accepted. Trying to pay on the day 2020-09-05, Sunday: accepted. Trying to pay on the day 2020-09-06, Monday: accepted. (5) ```' default: 30 PixValorMulta: type: object properties: multa: type: object required: - valor properties: valor: type: string title: Valor relativo a multa. description: Fine amount. pattern: \d{1,10}\.\d{2} Devolucao: type: object title: Devolução required: - id - rtrId - valor - horario - status properties: id: $ref: '#/components/schemas/DevolucaoId' rtrId: type: string title: RtrId description: ReturnIdentification transiting PACS004. example: D12345678202009091000abcde123456 pattern: '[a-zA-Z0-9]{32}' minLength: 32 maxLength: 32 valor: type: string title: Valor a devolver. pattern: \d{1,10}\.\d{2} description: Amount to return. natureza: $ref: '#/components/schemas/DevolucaoNatureza' descricao: type: string title: Mensagem ao pagador relativa à devolução. maxLength: 140 description: The optional `description` field determines a text to be displayed to the payer containing information about the payment return. This text will be filled in, in pacs.004, by the recipient's PSP, in the field RemittanceInformation. The field size in pacs.004 is limited to 140 characters. horario: type: object properties: solicitacao: type: string format: date-time title: Horário de solicitação description: Time when the payment return was requested on the PSP. liquidacao: type: string format: date-time title: Horário de liquidacao description: Time the payment return was settled on the PSP. status: type: string title: Status description: Return status. enum: - EM_PROCESSAMENTO - DEVOLVIDO - NAO_REALIZADO motivo: type: string title: Descrição do status. description: '# Payment Return Status Optional field that can be used by the receiving PSP to detail the reasons the return has reached the status in question. It can be used, for example, to detail the reason why the return was not carried out. ' maxLength: 140 PayloadLocation: type: object title: Location do Payload description: Payload location identifier. required: - id - location - tipoCob - criacao properties: id: $ref: '#/components/schemas/PayloadLocationId' location: type: string title: Localização do payload description: Payload location to be provided when creating the collection item. maxLength: 77 format: uri example: pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002 tipoCob: type: string title: Tipo da cobrança enum: - cob - cobv criacao: type: string format: date-time title: Data de Criação description: Payload location creation Date and time. Complies with RFC 3339. PayloadLocationCob: type: object title: Location do Payload required: - id - tipoCob description: Identifier of the payload location. properties: id: $ref: '#/components/schemas/PayloadLocationId' CobCompleta: title: Cobrança imediata completa required: - status allOf: - $ref: '#/components/schemas/CobSolicitada' - $ref: '#/components/schemas/CobGerada' - type: object properties: status: type: string title: Bill Status enum: - ATIVA - CONCLUIDA - REMOVIDA_PELO_USUARIO_RECEBEDOR - REMOVIDA_PELO_PSP - type: object properties: pix: type: array title: Pix received items: allOf: - $ref: '#/components/schemas/Pix_2' - type: object properties: txid: allOf: - $ref: '#/components/schemas/TxId_2' - pattern: '[a-zA-Z0-9]{26,35}' Revisao_2: type: integer format: int32 title: Revisão description: '# The `review` field Denotes the collection review version. Always starts at zero. Always increments 1. This should increase whenever a collection item is updated. The `loc` field change is not considered an update and therefore does not trigger an increment to the version number. The `loc` field does not change the collection itself. It is not necessary to store the history of changes in the `loc` field for a given collection. For the other fields of the collection, history is recorded. ' readOnly: true TxId_2: type: string title: Id da Transação description: "# Transaction identifier\n Field `txid` determines the transaction identifier for reconciliation purposes. In pacs.008 it is referenced as `TransactionIdentification ` or `idConciliacaoRecebedor`. The txid is retrieved by the payer’s PSP application and, after the payment is confirmed, it is sent to SPI via pacs.008. A pacs.008 is also sent to the receiver’s PSP, containing the txid in addition to all the usual payment information. Upon receiving the payment with txid, the receiver's PSP may inform the creditor to reconcile. The contents of this field are provided exclusively by the collector, who is the ultimate responsible for them. The txid should be unique by collector’s CPF/CNPJ. The receiving PSP is responsible for validating this rule in the API.\n" pattern: '[a-zA-Z0-9]{26,35}' PixValorTroco_2: type: object properties: troco: type: object required: - valor - modalidadeAgente - prestadorDoServicoDeSaque properties: valor: type: string title: Valor do Troco Pix description: Amount of Change Pix. pattern: \d{1,10}\.\d{2} modalidadeAgente: type: string title: Modalidade do Agente description: '##### Agent Type
ACRONYMDescription
AGTECBusiness Establishment Agent
AGTOTOther Type of Legal Entity Agent
AGPSSAgent Withdrawal Service Provider< /td>
' enum: - AGTEC - AGTOT - AGPSS prestadorDoServicoDeSaque: type: string title: Prestador do Serviço de Saque pattern: \d{8} description: Withdrawal Service Provider ISPB CobRevisada: type: object title: Cobrança imediata revisada description: Data sent to create or change Immediate collection via API Pix allOf: - type: object properties: calendario: title: Calendário description: The fields nested under the calendar identifier organize information regarding collection-related dates. allOf: - $ref: '#/components/schemas/CobExpiracao' - type: object properties: devedor: description: The fields nested under object debtor are optional and identify the debtor, i.e., the person or institution who owes the debt. They do not necessarily identify who will effectively make the payment. A CPF can be the debtor, but another CPF effectively makes the payment. Field `devedor.cpf` and field `devedor.cnpj` are not allowed to be completed at the same time. If field `devedor.cnpj` is completed, then, field `devedor.cpf` cannot be completed, and vice-versa. If field `devedor.nome` is completed, then, there must be or a `devedor.cpf` or a field `devedor.cnpj` completed. oneOf: - $ref: '#/components/schemas/PessoaFisica' - $ref: '#/components/schemas/PessoaJuridica_2' - type: object properties: loc: allOf: - $ref: '#/components/schemas/PayloadLocationCob_2' - type: object properties: status: type: string title: Status do registro da cobrança enum: - REMOVIDA_PELO_USUARIO_RECEBEDOR - type: object properties: valor: $ref: '#/components/schemas/CobValor' - $ref: '#/components/schemas/CobBase_2' ParametrosConsultaCob_2: type: object title: Parâmetros de Consulta de Cobrança description: '[DEPRECATED] Parameters used to carry out collection items query.' required: - inicio - fim - paginacao properties: inicio: type: string format: date-time title: Data de Início description: Starting date used in the query. Complies with RFC 3339. example: '2020-04-01T00:00:00Z' fim: type: string format: date-time title: Data de Fim description: End date used in the query. Complies with RFC 3339. example: '2020-04-01T17:00:00Z' cpf: type: string title: CPF pattern: /^\d{11}$/ description: Filter by the CPF of the debtor. It cannot be used at the same time as the CNPJ. cnpj: type: string title: CNPJ pattern: /^\d{14}$/ description: Filter by the debtor's CNPJ. It cannot be used at the same time as the CPF. locationPresente: type: boolean description: Filter by the existence of linked location. status: type: string title: Status do registro da cobrança description: Filter by collection item status. paginacao: $ref: '#/components/schemas/Paginacao' Pix_2: type: object title: Pix required: - endToEndId - valor - horario properties: endToEndId: $ref: '#/components/schemas/EndToEndId' txid: allOf: - $ref: '#/components/schemas/TxId_2' - pattern: '[a-zA-Z0-9]{1,35}' valor: type: string title: Valor do Pix. pattern: \d{1,10}\.\d{2} description: Pix value. componentesValor: type: object title: Informações sobre o valor do Pix description: "The purpose of this framework is to explain the compositional elements of the Pix value.\n\nStructure rules:\n- The `value` of the Pix is ​​equal to the sum of the `value` fields of the substructures that make up this structure;\n- There cannot be simultaneously a substructure of the `draw` type and another of the `change` type;\n- There is no restriction on the order of substructures.\n\nIn case of withdrawal with withdrawal, you can return\n `original` with value=0.00 (zero) since the sum will be respected, or you can omit\n the `original` substructure. In the case of change the `original` substructure will always be present.\n\n#### Valid examples:\nExample of valid completions.\n\n- **immediate collection (without cash withdrawal or change)**\n ```\n ...\n \"componentesValor\": [\n {\n \"tipo\": \"ORIGINAL\",\n \"valor\": \"100.00\"\n }\n ]\n ...\n ```\n- **Immediate collection with cash withdrawal**\n ```\n ...\n \"componentesValor\": [\n {\n \"tipo\": \"SAQUE\",\n \"valor\": \"100.00\"\n } \n ]\n ...\n ```\n- **Immediate collection with cash withdrawal (it may show type=ORIGINAL and value=0.00)**\n ```\n ...\n \"componentesValor\": [\n {\n \"tipo\": \"ORIGINAL\",\n \"valor\": \"0.00\"\n },\n {\n \"tipo\": \"SAQUE\",\n \"valor\": \"100.00\"\n }\n ]\n ...\n ```\n- **Immediate collection with change**\n ```\n ...\n \"componentesValor\": [\n {\n \"tipo\": \"ORIGINAL\",\n \"valor\": \"80.00\"\n },\n {\n \"tipo\": \"TROCO\",\n \"valor\": \"20.00\"\n }\n ]\n ...\n ```\n - **Immediate collection with change (the order does not matter)**\n ```\n ...\n \"componentesValor\": [\n {\n \"tipo\": \"TROCO\",\n \"valor\": \"20.00\"\n },\n {\n \"tipo\": \"ORIGINAL\",\n \"valor\": \"80.00\"\n }\n ]\n ...\n ```\n#### Invalid examples:\n Non-exhaustive examples, of invalid completions.\n - **`ORIGINAL` with value higher than 0.00 (zero) and `SAQUE` together**\n ```\n ...\n \"componentesValor\": [\n {\n \"tipo\": \"ORIGINAL\",\n \"valor\": \"80.00\"\n },\n {\n \"tipo\": \"SAQUE\",\n \"valor\": \"20.00\"\n }\n ]\n ...\n ```\n - **two `SAQUE` elements**\n ```\n ...\n \"componentesValor\": [\n {\n \"tipo\": \"SAQUE\",\n \"valor\": \"20.00\"\n },\n {\n \"tipo\": \"SAQUE\",\n \"valor\": \"10.00\"\n }\n ]\n ...\n ```\n - **Immediate collection with `SAQUE` and `TROCO`**\n ```\n ...\n \"componentesValor\": [\n {\n \"tipo\": \"ORIGINAL\",\n \"valor\": \"60.00\"\n },\n {\n \"tipo\": \"SAQUE\",\n \"valor\": \"20.00\"\n },\n {\n \"tipo\": \"TROCO\",\n \"valor\": \"20.00\"\n }\n ]\n ...\n ```" anyOf: - $ref: '#/components/schemas/PixValorOriginal' - $ref: '#/components/schemas/PixValorSaque_2' - $ref: '#/components/schemas/PixValorTroco_2' - $ref: '#/components/schemas/PixValorJuros' - $ref: '#/components/schemas/PixValorMulta' - $ref: '#/components/schemas/PixValorAbatimento' - $ref: '#/components/schemas/PixValorDesconto' chave: type: string title: Chave DICT do recebedor description: '# Creditor DICT alias * Creditor alias field as assigned in the respective PACS008. * Aliases types can be: phone, email, cpf/cnpj or EVP. * The format of the aliases can be found in the section "Formatting DICT aliases in BR Code" of the [Pix Initiation Standards Manual](https://www.bcb.gov.br/estabilidadefinanceira/pix). ' maxLength: 77 horario: type: string format: date-time title: Horário description: Time the Pix was processed on the PSP. infoPagador: type: string title: Informação livre do pagador maxLength: 140 devolucoes: type: array title: Devoluções items: $ref: '#/components/schemas/Devolucao_2' PessoaJuridica_2: type: object required: - cnpj - nome title: Pessoa Jurídica properties: cnpj: type: string title: CNPJ pattern: /^\d{14}$/ description: User's CNPJ. nome: type: string title: Nome description: User's Name. maxLength: 200 CobSolicitada: type: object title: Cobrança imediata solicitada description: Data sent to create or change Immediate collection via API Pix required: - valor - chave - calendario allOf: - type: object properties: calendario: title: Calendário description: The fields nested under the calendar identifier organize information regarding collection-related dates. allOf: - $ref: '#/components/schemas/CobExpiracao' - type: object properties: devedor: description: The fields nested under object debtor are optional and identify the debtor, i.e., the person or institution who owes the debt. They do not necessarily identify who will effectively make the payment. A CPF can be the debtor, but another CPF effectively makes the payment. Field `devedor.cpf` and field `devedor.cnpj` are not allowed to be completed at the same time. If field `devedor.cnpj` is completed, then, field `devedor.cpf` cannot be completed, and vice-versa. If field `devedor.nome` is completed, then, there must be or a `devedor.cpf` or a field `devedor.cnpj` completed. oneOf: - $ref: '#/components/schemas/PessoaFisica' - $ref: '#/components/schemas/PessoaJuridica_2' - type: object properties: loc: allOf: - $ref: '#/components/schemas/PayloadLocationCob_2' - type: object properties: valor: allOf: - $ref: '#/components/schemas/CobValor' - required: - original - $ref: '#/components/schemas/CobBase_2' CobExpiracao: type: object title: Expiração" properties: expiracao: type: integer format: int32 title: Tempo de vida da cobrança, especificado em segundos. description: 'Collection item lifetime, specified in seconds from the creation date (Calendario.criacao) ' example: '3600' default: 86400 CobBaseCopiaCola_2: type: object title: Cobrança Base com Copia e Cola description: Attributes common to all Billing entities that have Copy and Paste information allOf: - type: object properties: pixCopiaECola: type: string title: Pix Copia e Cola correspondente à cobrança. description: This field returns the QR code string representation for a copy & paste operation. maxLength: 512 - $ref: '#/components/schemas/CobBase_2' CobsConsultadas: type: object title: Cobranças imediatas consultadas required: - parametros - cobs properties: parametros: $ref: '#/components/schemas/ParametrosConsultaCob_2' cobs: type: array title: Lista de cobranças items: allOf: - $ref: '#/components/schemas/CobCompleta' - required: - status - txid - idCob PixValorSaque_2: type: object properties: saque: type: object required: - valor - modalidadeAgente - prestadorDoServicoDeSaque properties: valor: type: string title: Pix Cashout Value description: PixValor do Saque Pix pattern: \d{1,10}\.\d{2} modalidadeAgente: type: string title: AgentModalidade do Agente description: '##### Agent Type
ACRONYMDescription
AGTECBusiness Establishment Agent
AGTOTOther Type of Legal Entity Agent
AGPSSAgent Withdrawal Service Provider< /td>
' enum: - AGTEC - AGTOT - AGPSS prestadorDoServicoDeSaque: type: string title: Prestador do Serviço de Saque pattern: \d{8} description: Withdrawal Service Provider ISPB CobBase_2: type: object title: Cobrança Base description: Atributos comuns a todas entidades de Cobrança properties: chave: type: string title: Chave DICT do recebedor description: 'PIX Alias - Determines the alias registered in DICT, which will be used for the collection. This alias will be submitted by the payer’s PSP applications to DICT, which will return the translated information that will identify the collection creditor. *The aliases can be of the following types: phone number, e-mail address, taxpayer ID (CPF/CNPJ) or EVP.* The aliases formats can be found in [Standards Manual for starting Pix](https://www.bcb.gov.br/estabilidadefinanceira/pagamentosinstantaneos).' maxLength: 77 solicitacaoPagador: type: string title: Solicitação ao pagador description: Field solicitacaoPagador, optional, determines a text to be presented to the payer so that he/she may type a correlate information, in free format, to be sent to the receiver. Such text will be completed, in pacs.008, by the payer’s PSP, in field RemittanceInformation . The field size in pacs.008 is limited to 140 characters. maxLength: 140 infoAdicionais: type: array title: Informações adicionais description: Each respective additional information contained in the list (name and value) must be presented to the payer. maximum: 50 items: type: object required: - nome - valor properties: nome: type: string title: Nome description: Name of field. maxLength: 50 valor: type: string title: Valor description: Field data. maxLength: 200 CobGerada: type: object title: Cobrança imediata gerada description: Immediate collection data created or changed via API Pix required: - txid - calendario - revisao - status - valor - chave allOf: - type: object properties: calendario: required: - expiracao title: Calendário description: Fields nested under the calendar identifier organize information regarding collection-related dates. allOf: - $ref: '#/components/schemas/CobCriacao' - $ref: '#/components/schemas/CobExpiracao' txid: $ref: '#/components/schemas/TxId_2' revisao: $ref: '#/components/schemas/Revisao_2' - type: object properties: devedor: description: The fields nested under object debtor are optional and identify the debtor, i.e., the person or institution who owes the debt. They do not necessarily identify who will effectively make the payment. A CPF can be the debtor, but another CPF effectively makes the payment. Field `devedor.cpf` and field `devedor.cnpj` are not allowed to be completed at the same time. If field `devedor.cnpj` is completed, then, field `devedor.cpf` cannot be completed, and vice-versa. If field `devedor.nome` is completed, then, there must be or a `devedor.cpf` or a field `devedor.cnpj` completed. oneOf: - $ref: '#/components/schemas/PessoaFisica' - $ref: '#/components/schemas/PessoaJuridica_2' - type: object properties: loc: required: - id - location - tipoCob - criacao allOf: - $ref: '#/components/schemas/PayloadLocation_2' - type: object properties: location: type: string title: Localização do payload description: Payload location to be provided when creating the collection item. maxLength: 77 format: uri example: pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002 readOnly: true - type: object properties: status: type: string title: Status da Cobrança enum: - ATIVA - CONCLUIDA - REMOVIDA_PELO_USUARIO_RECEBEDOR - REMOVIDA_PELO_PSP - type: object properties: valor: required: - original allOf: - $ref: '#/components/schemas/CobValor' - $ref: '#/components/schemas/CobBaseCopiaCola_2' DevolucaoId_2: type: string title: Id da location description: Location identifier to be informed in the collection item creation. pattern: '[a-zA-Z0-9]{1,35}' CobValor: type: object title: Valor da cobrança imediata description: Collection item amount. properties: original: type: string title: Valor pattern: \d{1,10}\.\d{2} description: Collection item base amount. modalidadeAlteracao: type: integer format: int32 minimum: 0 maximum: 1 title: Modalidade de alteração description: This determines if the effective due amount of the collection item can be changed by the payer. 0 if not allowed and 1 if allowed. If not provided it will be considered 0. retirada: description: "It is an optional structure related to the concept of receiving cash. Only one grouping at a time is allowed, when there is `draw` there is no `change` and vice versa.\n\nWhen an Immediate collection has a `withdrawal` structure, it ceases to be considered common Pix and becomes a Cash Pix category.\n\nIn order for the completion of the `withdrawal` object to be considered valid, the following rules apply:\n- the `modalidadeAgente` and `providerDoServicoDeSaque` fields are **required**;\n- when `withdrawal` is present, the collection must comply with the following conditions:\n - The field `valor.original` must be filled with **value equal to 0.00 (zero)**;\n - The field `valor.modalidadeAlteracao` must have the value 0 (zero) explicitly, or implicitly (by not filling it out).\n- when `change` is present, the collection must comply with the following conditions:\n - The field `valor.original` must be filled with **value greater than 0.00 (zero)**;\n - The field `valor.modalidadeAlteracao` must have the value 0 (zero) explicitly, or implicitly (by not filling it out).\n\n**IMPORTANT**: When using `withdrawal` or `change`, it will not be allowed to change the `original.value` received. In the presence of `draw` or `change`, the receipt of the `valor.modalidadeAlteracao` field with value 1 (one) is considered an error.\n\n#### Valid examples:\n Considering the fields of structure `value` and predicate 'present', the result of which is true when the\n indicated structure is found, we have:\n - 1 - **collection with fixed value** (conditions: valor.original > 0 && valor.modalidadeAlteração = 0 &&\n !present(valor.retirada))\n ```\n ...\n \"value\": {\n \"original\": \"10.00\"\n },\n ...\n ```\n - 2 - **collection with changeable value** (conditions: valor.original >= 0.00 && modalidadeAlteração = 1\n && !present(valor.retirada))\n ```\n ...\n \"value\": {\n \"original\": \"10.00\",\n \"modalidadeAlteracao\": 1\n },\n ```\n - 3 - **cash withdrawal with fixed value** (conditions: valor.original = 0.00 && valor.modalidadeAlteração\n = 0 && presente(valor.retirada.saque) && valor.retirada.saque.valor > 0 &&\n valor.retirada.saque.modalidadeAlteracao = 0)\n ```\n ...\n \"value\": {\n \"original\": \"0.00\",\n \"withdrawal\": {\n \"cash withdrawal\": {\n \"value\": \"5.00\"\n }\n }\n },\n ...\n ```\n - 4 - **cash withdrawal with changeable value** (conditions: valor.original = 0.00 &&\n valor.modalidadeAlteração = 0 && presente(valor.retirada.saque) && valor.retirada.saque.valor >= 0 &&\n valor.retirada.saque.modalidadeAlteracao = 1)\n ```\n ...\n \"value\": {\n \"original\": \"0.00\",\n \"withdrawal\": {\n \"cash withdrawal\": {\n \"value\": \"5.00\",\n \"modalidadeAlteracao\": 1,\n }\n }\n },\n ...\n ```\n - 5 - **collection with fixed change** (conditions: valor.original > 0.00 && valor.modalidadeAlteração = 0 &&\n presente(valor.retirada.troco) && valor.retirada.troco.valor > 0 && valor.retirada.troco.modalidadeAlteracao = 0)\n ```\n ...\n \"value\": {\n \"original\": \"10.00\",\n \"withdrawal\": {\n \"change\": {\n \"value\": \"5.00\"\n }\n }\n \n },\n ...\n ```\n - 6 - **collection with changeable change** (conditions: valor.original > 0.00 && valor.modalidadeAlteração = 0\n && present(valor.retirada.troco) && valor.retirada.troco.valor >= 0 && valor.retirada.troco.modalidadeAlteracao = 1)\n ```\n ...\n \"value\": {\n \"original\": \"10.00\",\n \"change\": {\n \"value\": \"0.00\",\n \"modalidadeAlteracao\": 1\n }\n },\n ...\n ```\n #### Invalid examples:\n Below are some examples which **are not valid**. It is worth noting that this listing is not intended to be\n complete, being just a reference for some possible errors.\n - 1 - **collection with cash withdrawal and change together** (both of them cannot occur at the same time)\n ```\n ...\n \"value\": {\n \"original\": \"100.00\",\n \"withdrawal\": {\n \"cash withdrawal\": {\n \"value\": \"50.00\"\n },\n \"change\": {\n \"value\": \"30.00\"\n }\n }\n },\n ...\n ```\n - 2 - **cash withdrawal with valor.original higher than 0.00 (zero)** (cash withdrawal requires valor.original =\n 0.00)\n ```\n ...\n \"value\": {\n \"original\": \"10.00\",\n \"withdrawal\": {\n \"cash withdrawal\": {\n \"value\": \"5.00\"\n }\n }\n },\n ...\n ```\n - 3 - **change with valor.original equal to 0.00 (zero)** (for having a change, there must be valor.original > 0.00)\n ```\n ...\n \"value\": {\n \"original\": \"0.00\",\n \"withdrawal\": {\n \"change\": {\n \"value\": \"5.00\"\n \n }\n }\n },\n ...\n ```\n - 4 - **cash withdrawal with changeable valor.original** (the valor.original cannot be changed in the\n presence of cash withdrawal)\n ```\n ...\n \"value\": {\n \"original\": \"0.00\",\n \"modalidadeAlteracao\": 1,\n \"withdrawal\": {\n \"cash withdrawal\": {\n \"value\": \"5.00\",\n \"modalidadeAlteracao\": 1,\n }\n }\n },\n ...\n ```\n - 5 - **change with changeable valor.original** (the valor.original cannot be changed in the presence of change)\n ```\n ...\n \"value\": {\n \"original\": \"0.00\",\n \"modalidadeAlteracao\": 1,\n \"withdrawal\": {\n \"cash withdrawal\": {\n \"value\": \"5.00\",\n \"modalidadeAlteracao\": 1,\n }\n }\n },\n ...\n ```\n" title: Informações de retirada type: object oneOf: - type: object properties: saque: type: object title: Saque required: - valor - modalidadeAgente - prestadorDoServicoDeSaque description: Information related to the cash withdrawal properties: valor: type: string title: Valor do saque pattern: \d{1,10}\.\d{2} description: Value of the cash withdrawal conducted modalidadeAlteracao: type: integer format: int32 minimum: 0 maximum: 1 default: 0 title: Modalidade de alteração do saque description: Cash withdrawal value change modality. When not completed, the assumed value is 0 (zero). modalidadeAgente: type: string title: Modalidade do Agente description: '##### Agent Type
ACRONYMDescription
AGTECBusiness Establishment Agent
AGTOTOther Type of Legal Entity Agent
AGPSSAgent Withdrawal Service Provider< /td>
' enum: - AGTEC - AGTOT - AGPSS prestadorDoServicoDeSaque: type: string title: Prestador do Serviço de Saque pattern: \d{8} description: Withdrawal Service Provider ISPB - type: object properties: troco: type: object title: Troco required: - valor - modalidadeAgente - prestadorDoServicoDeSaque description: Change related information properties: valor: type: string title: Valor do troco pattern: \d{1,10}\.\d{2} description: Value of the change conducted modalidadeAlteracao: type: integer format: int32 minimum: 0 maximum: 1 default: 0 title: Modalidade de alteração do troco description: Change value alteration modality. When not completed, the assumed value is 0 (zero). modalidadeAgente: type: string title: Modalidade do Agente description: '##### Agent Type
ACRONYMDescription
AGTECBusiness Establishment Agent
AGTOTOther Type of Legal Entity Agent
AGPSSAgent Withdrawal Service Provider< /td>
' enum: - AGTEC - AGTOT - AGPSS prestadorDoServicoDeSaque: type: string title: Prestador do Serviço de Saque pattern: \d{8} description: Withdrawal Service Provider ISPB Devolucao_2: type: object title: Devolução required: - id - rtrId - valor - horario - status properties: id: $ref: '#/components/schemas/DevolucaoId_2' rtrId: type: string title: RtrId description: ReturnIdentification transiting PACS004. example: D12345678202009091000abcde123456 pattern: '[a-zA-Z0-9]{32}' minLength: 32 maxLength: 32 valor: type: string title: Valor a devolver. pattern: \d{1,10}\.\d{2} description: Amount to return. natureza: $ref: '#/components/schemas/DevolucaoNatureza' descricao: type: string title: Mensagem ao pagador relativa à devolução. maxLength: 140 description: The optional `description` field determines a text to be displayed to the payer containing information about the return. This text will be filled in, in pacs.004, by the recipient's PSP, in the field RemittanceInformation. The field size in pacs.004 is limited to 140 characters. horario: type: object properties: solicitacao: type: string format: date-time title: Horário de solicitação description: Time at which the return was requested on the PSP. liquidacao: type: string format: date-time title: Horário de liquidacao description: Time the return was settled on the PSP. status: type: string title: Status description: Return status. enum: - EM_PROCESSAMENTO - DEVOLVIDO - NAO_REALIZADO motivo: type: string title: Descrição do status. description: '# Return Status Optional field that can be used by the receiving PSP to detail the reasons the return has reached the status in question. It can be used, for example, to detail the reason why the return was not carried out. ' maxLength: 140 PayloadLocation_2: type: object title: Location do Payload description: Identifier of the payload location. required: - id - location - tipoCob - criacao properties: id: $ref: '#/components/schemas/PayloadLocationId' location: type: string title: Localização do payload description: Payload location to be provided when creating the collection item. maxLength: 77 format: uri example: pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002 readOnly: true tipoCob: type: string title: Tipo da cobrança enum: - cob - cobv criacao: type: string format: date-time title: Creation Date description: Date and time location was created. Complies with RFC 3339. readOnly: true PayloadLocationCob_2: type: object title: Location do Payload required: - id description: Identifier of the payload location. properties: id: $ref: '#/components/schemas/PayloadLocationId' parameters: ApiVersion: name: api_version in: query description: Users input of api version that is intended for their business purpose. Please contact Implementation team during onboarding to know the current default version. schema: type: string example: '1.0' maxLength: 3 Language: name: language in: query description: This field is used to mention language used in request body fields. schema: type: string maxLength: 10 example: PT PaymentMethod: name: payment_method in: query description: This field is used to identify method of payment used to initiate a payment. schema: type: string maxLength: 10 example: PIX CountryCode: name: country_code in: query description: a two-letter code (alpha-2) which is used to represent the country. This country_code field is used to identify particular request to create QR Code is for which country. required: true schema: type: string maxLength: 2 example: BR ClientId: name: client_id in: query description: Unique reference which was shared during CitiConnect API on-boarding (ClientId-which used during oauth token generation) required: true schema: type: string example: 898918181818181aczta CNPJQuery: name: cnpj in: query required: false schema: $ref: '#/components/schemas/CNPJ' PaginaAtual: in: query name: paginacao.paginaAtual required: false schema: type: integer format: int32 title: Página atual minimum: 0 default: 0 description: Page to be returned by the query. If not informed, the PSP will assume it will be 0. CPF: name: cpf in: query schema: type: string title: CPF pattern: ^[0-9]{11}$ description: Filter by the CPF of the debtor. It cannot be used at the same time as the CNPJ. TxId: name: txid in: path required: true schema: $ref: '#/components/schemas/TxId' ItensPorPagina: in: query name: paginacao.itensPorPagina required: false schema: type: integer format: int32 title: Itens por Página minimum: 1 maximum: 1000 default: 100 description: Maximum number of records returned on each page. Only the last page can contain a smaller amount of records. Fim: name: fim in: query required: true schema: $ref: '#/components/schemas/Fim' CNPJ: name: cnpj in: query schema: type: string title: CNPJ pattern: ^[0-9]{14}$ description: Filter by the debtor's CNPJ. It cannot be used at the same time as the CPF. Inicio: name: inicio in: query required: true schema: $ref: '#/components/schemas/Inicio' Revisao: name: revisao in: query required: false schema: $ref: '#/components/schemas/Revisao' Status: name: status in: query schema: type: string title: Status do registro da cobrança description: Filter by collection status. loteCobVId: name: loteCobVId in: query schema: type: integer format: int32 title: Id do lote de cobrança com vencimento description: Due collection batch id. LocationPresente: name: locationPresente in: query schema: type: boolean ClientId_2: name: client_id in: query description: Unique reference which was shared during CitiConnect API on-boarding(ClientId-which used during oauth token generation) required: true schema: type: string example: 898918181818181aczta Status_2: name: status in: query schema: type: string title: Status do registro da cobrança description: Filter by collection item status. ClientId_3: name: client_id in: query description: Unique reference which was shared during CitiConnect API on-boarding(ClientId-which used during oauth token generation) required: true schema: type: string example: 898918181818181aczta responses: Unauthorized: description: Unauthorized content: application/json: schema: oneOf: - $ref: '#/components/schemas/BrazilstaticQRCodeErrorResponse' examples: UnauthorizedExampleInPortugese: $ref: '#/components/examples/UnauthorizedExampleInPortugese' BadRequest: description: Bad Request content: application/json: schema: oneOf: - $ref: '#/components/schemas/BrazilstaticQRCodeErrorResponse' examples: BadRequestExampleInPortugese: $ref: '#/components/examples/BadRequestExampleInPortugese' CreatedResponse: description: Created content: application/json: schema: oneOf: - $ref: '#/components/schemas/BrazilStaticQRCodeResponse' examples: CreatedResponseExample: $ref: '#/components/examples/BrazilStaticQRCodeOKResponseExample' GatewayTimeout: description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/BrazilstaticQRCodeErrorResponse' examples: GatewayTimeoutExampleInPortugese: $ref: '#/components/examples/GatewayTimeoutExampleInPortugese' ServiceUnavailable: description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/BrazilstaticQRCodeErrorResponse' examples: ServiceUnavailableExampleInPortugese: $ref: '#/components/examples/ServiceUnavailableExampleInPortugese' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/BrazilstaticQRCodeErrorResponse' examples: ForbiddenExampleInPortugese: $ref: '#/components/examples/ForbiddenExampleInPortugese' MethodNotAllowed: description: Method Not Allowed content: application/json: schema: oneOf: - $ref: '#/components/schemas/BrazilstaticQRCodeErrorResponse' examples: MethodNotAllowedExampleInPortugese: $ref: '#/components/examples/MethodNotAllowedExampleInPortugese' InternalServerError: description: Internal Server Error content: application/json: schema: oneOf: - $ref: '#/components/schemas/BrazilstaticQRCodeErrorResponse' examples: InternalServerErrorExampleInPortugese: $ref: '#/components/examples/InternalServerErrorExampleInPortugese' UnsupportedMediaType: description: Unsupported Media Type content: application/json: schema: oneOf: - $ref: '#/components/schemas/BrazilstaticQRCodeErrorResponse' examples: UnsupportedMediaTypeExampleInPortugese: $ref: '#/components/examples/UnsupportedMediaTypeExampleInPortugese' AcessoNegado1: description: Authenticated participant request that violates some authorization rule. content: application/problem+json: schema: $ref: '#/components/schemas/Problema' examples: exemplo1: $ref: '#/components/examples/AcessoNegadoExample2' RequisicaoInvalida: description: Request with invalid format. content: application/problem+json: schema: $ref: '#/components/schemas/Problema' examples: exemplo1: $ref: '#/components/examples/RequisicaoInvalidaCobExample1' CobsVConsultadasResponse: description: Immediate collection data content: application/json: schema: $ref: '#/components/schemas/CobsVConsultadas' examples: getCobs1: $ref: '#/components/examples/getCobsV1' CobVCompletaResponse: description: Immediate collection data with due date. content: application/json: schema: $ref: '#/components/schemas/CobVCompleta' examples: retorno1: $ref: '#/components/examples/cobResponse4' NaoEncontrado: description: Requested resource not found. content: application/problem+json: schema: $ref: '#/components/schemas/Problema' examples: exemplo1: $ref: '#/components/examples/NaoEncontradoExample1' MetodoInvalido: description: Request sent with invalid method content: application/problem+json: schema: $ref: '#/components/schemas/Problema' examples: exemplo1: $ref: '#/components/examples/MetodoInvalidoExample1' CobVGeradaCreateResponse: description: Collection item with due date created content: application/json: schema: $ref: '#/components/schemas/CobVGerada' examples: retorno1: $ref: '#/components/examples/cobResponse4' CobVGeradaUpdateResponse: description: Collection item with due date updated content: application/json: schema: $ref: '#/components/schemas/CobVGerada' examples: retorno1: $ref: '#/components/examples/cobResponse4' ServicoIndisponivel1: description: Service is not currently available. Requested service may be under maintenance or out of working window. content: application/problem+json: schema: $ref: '#/components/schemas/Problema' examples: exemplo1: $ref: '#/components/examples/ServicoIndisponivelExample2' ServicoIndisponivel: description: Service is not currently available. Requested service may be under maintenance or out of working window. content: application/problem+json: schema: $ref: '#/components/schemas/Problema' examples: exemplo1: $ref: '#/components/examples/ServicoIndisponivelExample1' MidiaInvalida: description: Request sent with unsupported media content: application/problem+json: schema: $ref: '#/components/schemas/Problema' examples: exemplo1: $ref: '#/components/examples/MidiaInvalidaExample1' AcessoNegado: description: Authenticated participant request that violates some authorization rule. content: application/problem+json: schema: $ref: '#/components/schemas/Problema' examples: exemplo1: $ref: '#/components/examples/AcessoNegadoExample1' CobCompletaResponse: description: Immediate collection data. content: application/json: schema: $ref: '#/components/schemas/CobCompleta' examples: retorno1: $ref: '#/components/examples/cobResponse1' retorno2: $ref: '#/components/examples/cobResponse2' retorno3: $ref: '#/components/examples/cobResponse5' retorno4: $ref: '#/components/examples/cobResponse6' retorno5: $ref: '#/components/examples/cobResponse7' CobGeradaResponse: description: Immediate collection created/updated content: application/json: schema: $ref: '#/components/schemas/CobGerada' examples: retorno1: $ref: '#/components/examples/cobResponse3' CobsConsultadasResponse: description: Immediate collection data content: application/json: schema: $ref: '#/components/schemas/CobsConsultadas' examples: getCobs1: $ref: '#/components/examples/getCobs1' getCobs2: $ref: '#/components/examples/getCobs2' examples: UnauthorizedExampleInPortugese: value: type: https://pix.bcb.gov.br/api/v2/error/AcessoNegado title: Acesso Negado status: 401 detail: Requisição de participante autenticado que viola alguma regra de autorização. corelationId: f481ace0-c3e6-426f-a3a8-f9b3ee279562 BrazilStaticQRCodeExample: value: txid: QR00012346789079769986667 chave: '12345678901234' infoAdicionais: Valor com desconto valor: '120.90' nomeBeneficiario: John Heten cidadeBeneficiario: Sao Paulo saque: '1' BrazilStaticQRCodeOKResponseExample: value: txid: QR00012346789079769986667 valor: '120.90' qrcode: 00020126580014BR.GOV.BCB.PIX0136115d2b81-1744-4567-867d-ba2fdb47f53c5204000053039865406112.505802BR5925URBANIA GatewayTimeoutExampleInPortugese: value: type: https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel title: Serviço Indisponível status: 504 detail: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento corelationId: f481ace0-c3e6-426f-a3a8-f9b3ee279562 UnsupportedMediaTypeExampleInPortugese: value: type: https://pix.bcb.gov.br/api/v2/error/midianaosuportada title: Midia invalida status: 415 detail: Requisição enviada com midia não suportada corelationId: f481ace0-c3e6-426f-a3a8-f9b3ee279562 violacoes: - razao: Midia não suportada InternalServerErrorExampleInPortugese: value: type: https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel title: Serviço Indisponível status: 500 detail: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento corelationId: f481ace0-c3e6-426f-a3a8-f9b3ee279562 MethodNotAllowedExampleInPortugese: value: type: https://pix.bcb.gov.br/api/v2/error/Metodoinvalido title: Metodo invalido status: 405 detail: Requisição enviada com metodo invalido corelationId: f481ace0-c3e6-426f-a3a8-f9b3ee279562 violacoes: - razao: Metodo Invalido BadRequestExampleInPortugese: value: type: https://pix.bcb.gov.br/api/v2/error/cobEstaticoOperacaoInvalida title: cobranca invalida status: 400 detail: A requisição que busca criar uma cobrança para pagamento imediato estático não respeita o schema ou está semanticamente errada corelationId: f481ace0-c3e6-426f-a3a8-f9b3ee279562 violacoes: - razao: O campo chave não respeita o schema propriedade: cobestatico.chave ServiceUnavailableExampleInPortugese: value: type: https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel title: Serviço Indisponível status: 503 detail: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento corelationId: f481ace0-c3e6-426f-a3a8-f9b3ee279562 ForbiddenExampleInPortugese: value: type: https://pix.bcb.gov.br/api/v2/error/AcessoNegado title: Acesso Negado status: 403 detail: Requisição de participante autenticado que viola alguma regra de autorização. corelationId: f481ace0-c3e6-426f-a3a8-f9b3ee279562 AcessoNegadoExample1: summary: Example Request 1 Error value: type: https://pix.bcb.gov.br/api/v2/error/AcessoNegado title: Acesso Negado status: 403 detail: Requisição de participante autenticado que viola alguma regra de autorização. cobBody4: summary: 'Collection Review Example #2' value: valor: original: '567.89' solicitacaoPagador: Informar cartão fidelidade cobBody7: summary: 'Collection Review Example #1' value: loc: id: 789 devedor: logradouro: Alameda Souza, Numero 80, Bairro Braz cidade: Recife uf: PE cep: '70011750' cpf: '12345678909' nome: Francisco da Silva valor: original: '123.45' solicitacaoPagador: Cobrança dos serviços prestados. NaoEncontradoExample1: summary: Example Request 1 Error value: type: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado title: Não Encontrado status: 404 detail: Entidade não encontrada. cobResponse4: summary: 'Example of collection due #1' value: calendario: criacao: '2020-09-09T20:15:00.358Z' dataDeVencimento: '2020-12-31' validadeAposVencimento: 30 txid: 7978c0c97ea847e78e8849634473c1f1 revisao: 0 loc: id: 789 location: pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25 tipoCob: cobv status: ATIVA devedor: logradouro: Alameda Souza, Numero 80, Bairro Braz cidade: Recife uf: PE cep: '70011750' cpf: '12345678909' nome: Francisco da Silva recebedor: logradouro: Rua 15 Numero 1200, Bairro São Luiz cidade: São Paulo uf: SP cep: '70800100' cnpj: '56989000019533' nome: Empresa de Logística SA valor: original: '123.45' chave: 5f84a4c5-c5cb-4599-9f13-7eb4d419dacc solicitacaoPagador: Cobrança dos serviços prestados. ServicoIndisponivelExample2: summary: Example Request 1 Error value: type: https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel title: Serviço Indisponível status: 500 detail: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento. ServicoIndisponivelExample1: summary: Example Request 1 Error value: type: https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel title: Serviço Indisponível status: 503 detail: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento. cobBody5: summary: 'Collection Review Example #3' value: status: REMOVIDA_PELO_USUARIO_RECEBEDOR getCobsV1: summary: Example of the return of the due date collection query 1 value: parametros: inicio: '2020-04-01T00:00:00Z' fim: '2020-04-01T23:59:59Z' paginacao: paginaAtual: 0 itensPorPagina: 100 quantidadeDePaginas: 1 quantidadeTotalDeItens: 1 cobs: - calendario: criacao: '2020-09-09T20:15:00.358Z' dataDeVencimento: '2020-12-31' validadeAposVencimento: 30 txid: 7978c0c97ea847e78e8849634473c1f1 revisao: 0 loc: id: 789 location: pix.example.com/qr/c2/cobv/9d36b84fc70b478fb95c12729b90ca25 tipoCob: cobv status: ATIVA devedor: logradouro: Alameda Souza, Numero 80, Bairro Braz cidade: Recife uf: PE cep: '70011750' cpf: '12345678909' nome: Francisco da Silva recebedor: logradouro: Rua 15 Numero 1200, Bairro São Luiz cidade: São Paulo uf: SP cep: '70800100' cnpj: '56989000019533' nome: Empresa de Logística SA valor: original: '123.45' chave: 5f84a4c5-c5cb-4599-9f13-7eb4d419dacc solicitacaoPagador: Cobrança dos serviços prestados. cobBody1: summary: 'Example of creating a QR code collection #1' value: calendario: dataDeVencimento: '2020-12-31' validadeAposVencimento: 30 loc: id: 789 devedor: logradouro: Alameda Souza, Numero 80, Bairro Braz cidade: Recife uf: PE cep: '70011750' cpf: '12345678909' nome: Francisco da Silva valor: original: '123.45' multa: modalidade: '2' valorPerc: '15.00' juros: modalidade: '2' valorPerc: '2.00' desconto: modalidade: '1' descontoDataFixa: - data: '2020-11-30' valorPerc: '30.00' chave: 5f84a4c5-c5cb-4599-9f13-7eb4d419dacc solicitacaoPagador: Cobrança dos serviços prestados. MetodoInvalidoExample1: summary: Request sent with invalid method value: type: https://pix.bcb.gov.br/api/v2/error/Metodoinvalido title: Metodo invalido status: 405 detail: Requisição enviada com metodo invalido RequisicaoInvalidaCobExample1: summary: 'Example Request Error #1' value: type: https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida title: Cobrança inválida. status: 400 detail: A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o _schema_ ou está semanticamente errada. violacoes: - razao: O campo cob.valor.original não respeita o _schema_. propriedade: cob.valor.original MidiaInvalidaExample1: summary: Request sent with unsupported media value: type: https://pix.bcb.gov.br/api/v2/error/midianaosuportada title: Midia invalida status: 415 detail: Requisição enviada com midia não suportada violacoes: - razao: Midia não suportada AcessoNegadoExample2: summary: Example Request 1 Error value: type: https://pix.bcb.gov.br/api/v2/error/AcessoNegado title: Acesso Negado status: 401 detail: Requisição de participante autenticado que viola alguma regra de autorização. AcessoNegadoExample1_2: summary: 'Example Request #1 Error' value: type: https://pix.bcb.gov.br/api/v2/error/AcessoNegado title: Acesso Negado status: 403 detail: Requisição de participante autenticado que viola alguma regra de autorização. NaoEncontradoExample1_2: summary: 'Example Request #1 Error' value: type: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado title: Não Encontrado status: 404 detail: Entidade não encontrada. cobResponse7: summary: 'Example #3 of Immediate collection with Cash Pix' value: calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 33beb661beda44a8928fef47dbeb2dc5 revisao: 0 loc: id: 1004 location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 tipoCob: cob location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '10.00' modalidadeAlteracao: 0 retirada: troco: valor: '0.00' modalidadeAlteracao: 1 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 cobResponse5: summary: Example of Immediate collection with Cash Pix value: calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 33beb661beda44a8928fef47dbeb2dc5 revisao: 0 loc: id: 1004 location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 tipoCob: cob location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '0.00' modalidadeAlteracao: 0 retirada: saque: valor: '5.00' modalidadeAlteracao: 0 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 cobBody3: summary: 'Collection Review Example #1' value: loc: id: 7768 devedor: cpf: '12345678909' nome: Francisco da Silva valor: original: '123.45' solicitacaoPagador: Cobrança dos serviços prestados. cobBody9: summary: 'Example #3 of creation of Immediate collection with Cash Pix' value: devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '10.00' modalidadeAlteracao: 0 retirada: troco: valor: '0.00' modalidadeAlteracao: 1 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 ServicoIndisponivelExample2_2: summary: 'Example Request #1 Error' value: type: https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel title: Serviço Indisponível status: 500 detail: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento. cobResponse1: summary: 'Example #1 of Immediate collection' value: calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 7978c0c97ea847e78e8849634473c1f1 revisao: 0 loc: id: 789 location: pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25 tipoCob: cob location: pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '37.00' modalidadeAlteracao: 1 chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 solicitacaoPagador: Serviço realizado. infoAdicionais: - nome: Campo 1 valor: Informação Adicional1 do PSP-Recebedor - nome: Campo 2 valor: Informação Adicional2 do PSP-Recebedor ServicoIndisponivelExample1_2: summary: 'Example Request #1 Error' value: type: https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel title: Serviço Indisponível status: 503 detail: Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento. cobResponse3: summary: Example value: calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 7978c0c97ea847e78e8849634473c1f1 revisao: 1 loc: id: 7768 location: pix.example.com/qr/b1/9d36b84fc70b478fb95c12729b90ca25 tipoCob: cob location: pix.example.com/qr/v1/9d36b84fc70b478fb95c12729b90ca25 status: ATIVA devedor: cpf: '12345678909' nome: Francisco da Silva valor: original: '123.45' modalidadeAlteracao: 0 chave: a1f4102e-a446-4a57-bcce-6fa48899c1d1 solicitacaoPagador: Cobrança dos serviços prestados. RequisicaoInvalidaCobExample1_2: summary: 'Example Request #1 Error' value: type: https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida title: Cobrança inválida. status: 400 detail: A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o _schema_ ou está semanticamente errada. violacoes: - razao: O campo cob.valor.original não respeita o _schema_. propriedade: cob.valor.original cobBody6: summary: Example of creation of Immediate collection with Cash Pix value: devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '0.00' modalidadeAlteracao: 0 retirada: saque: valor: '5.00' modalidadeAlteracao: 0 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 getCobs2: summary: 'Example #2 of Immediate collection Inquiry' value: parametros: inicio: '2020-04-01T00:00:00Z' fim: '2020-04-01T23:59:59Z' paginacao: paginaAtual: 0 itensPorPagina: 100 quantidadeDePaginas: 1 quantidadeTotalDeItens: 1 cobs: - calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 7978c0c97ea847e78e8849634473c1f1 revisao: 1 loc: id: 789 location: pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25 tipoCob: cob location: pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '37.00' modalidadeAlteracao: 1 chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 solicitacaoPagador: Serviço realizado. infoAdicionais: - nome: Campo 1 valor: Informação Adicional1 do PSP-Recebedor - nome: Campo 2 valor: Informação Adicional2 do PSP-Recebedor cobResponse6: summary: 'Example #2 of Immediate collection with Cash Pix' value: calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 33beb661beda44a8928fef47dbeb2dc5 revisao: 0 loc: id: 1004 location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 tipoCob: cob location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '0.00' modalidadeAlteracao: 0 retirada: saque: valor: '20.00' modalidadeAlteracao: 1 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 cobBody2: summary: 'Example #1 of creating Immediate collection' value: calendario: expiracao: 3600 devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '37.00' modalidadeAlteracao: 1 chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 solicitacaoPagador: Serviço realizado. infoAdicionais: - nome: Campo 1 valor: Informação Adicional1 do PSP-Recebedor - nome: Campo 2 valor: Informação Adicional2 do PSP-Recebedor cobResponse2: summary: 'Example #2 of Immediate collection' value: calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 655dfdb1a4514b8fbb58254b958913fb revisao: 1 loc: id: 567 location: pix.example.com/qr/1dd7f893a58e417287028dc33e21a403 location: pix.example.com/qr/1dd7f893a58e417287028dc33e21a403 status: CONCLUIDA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '100.00' modalidadeAlteracao: 0 chave: 40a0932d-1918-4eee-845d-35a2da1690dc solicitacaoPagador: Informar cartão fidelidade pix: - endToEndId: E12345678202009091221kkkkkkkkkkk txid: 655dfdb1a4514b8fbb58254b958913fb valor: '110.00' horario: '2020-09-09T20:15:00.358Z' infoPagador: 0123456789 devolucoes: - id: 123ABC rtrId: Dxxxxxxxx202009091221kkkkkkkkkkk valor: '10.00' horario: solicitacao: '2020-09-09T20:15:00.358Z' status: EM_PROCESSAMENTO AcessoNegadoExample2_2: summary: 'Example Request #1 Error' value: type: https://pix.bcb.gov.br/api/v2/error/AcessoNegado title: Acesso Negado status: 401 detail: Requisição de participante autenticado que viola alguma regra de autorização. cobBody8: summary: 'Example #2 of creation of immediate collection with Cash Pix' value: devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '0.00' modalidadeAlteracao: 0 retirada: saque: valor: '20.00' modalidadeAlteracao: 1 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 getCobs1: summary: 'Example #1 of Immediate collection Inquiry' value: parametros: inicio: '2020-04-01T00:00:00Z' fim: '2020-04-02T10:00:00Z' paginacao: paginaAtual: 0 itensPorPagina: 100 quantidadeDePaginas: 1 quantidadeTotalDeItens: 2 cobs: - calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 7978c0c97ea847e78e8849634473c1f1 revisao: 0 loc: id: 789 location: pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25 tipoCob: cob location: pix.example.com/qr/9d36b84fc70b478fb95c12729b90ca25 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '37.00' modalidadeAlteracao: 1 chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 solicitacaoPagador: Serviço realizado. infoAdicionais: - nome: Campo 1 valor: Informação Adicional1 do PSP-Recebedor - nome: Campo 2 valor: Informação Adicional2 do PSP-Recebedor - calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 655dfdb1a4514b8fbb58254b958913fb revisao: 1 loc: id: 567 location: pix.example.com/qr/1dd7f893a58e417287028dc33e21a403 location: pix.example.com/qr/1dd7f893a58e417287028dc33e21a403 status: CONCLUIDA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '100.00' modalidadeAlteracao: 0 chave: 40a0932d-1918-4eee-845d-35a2da1690dc solicitacaoPagador: Informar cartão fidelidade pix: - endToEndId: E12345678202009091221kkkkkkkkkkk txid: 655dfdb1a4514b8fbb58254b958913fb valor: '110.00' horario: '2020-09-09T20:15:00.358Z' infoPagador: 0123456789 devolucoes: - id: 123ABC rtrId: Dxxxxxxxx202009091221kkkkkkkkkkk valor: '10.00' horario: solicitacao: '2020-09-09T20:15:00.358Z' status: EM_PROCESSAMENTO - calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 33beb661beda44a8928fef47dbeb2dc5 revisao: 0 loc: id: 1004 location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 tipoCob: cob location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '0.00' modalidadeAlteracao: 0 retirada: saque: valor: '5.00' modalidadeAlteracao: 0 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 - calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 33beb661beda44a8928fef47dbeb2dc5 revisao: 0 loc: id: 1004 location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 tipoCob: cob location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '0.00' modalidadeAlteracao: 0 retirada: saque: valor: '20.00' modalidadeAlteracao: 1 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 - calendario: criacao: '2020-09-09T20:15:00.358Z' expiracao: 3600 txid: 33beb661beda44a8928fef47dbeb2dc5 revisao: 1 loc: id: 1004 location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 tipoCob: cob location: pix.example.com/qr/7faa6893c4e64893a503baf0d40af213 status: ATIVA devedor: cnpj: '12345678000195' nome: Empresa de Serviços SA valor: original: '10.00' modalidadeAlteracao: 0 retirada: troco: valor: '0.00' modalidadeAlteracao: 1 modalidadeAgente: AGPSS prestadorDoServicoDeSaque: '12345678' chave: 7d9f0335-8dcc-4054-9bf9-0dbd61d36906 requestBodies: CobVBody: description: Data for generating the collection item with due date. required: true content: application/json: schema: $ref: '#/components/schemas/CobVSolicitada' examples: exemplo1: $ref: '#/components/examples/cobBody1' CobVBodyRevisada: description: Data for updating the collection item. required: true content: application/json: schema: $ref: '#/components/schemas/CobVRevisada' examples: exemplo1: $ref: '#/components/examples/cobBody7' exemplo2: $ref: '#/components/examples/cobBody4' exemplo3: $ref: '#/components/examples/cobBody5' CobBody: description: Data for generating Immediate collection. required: true content: application/json: schema: $ref: '#/components/schemas/CobSolicitada' examples: exemplo1: $ref: '#/components/examples/cobBody2' exemplo2: $ref: '#/components/examples/cobBody6' exemplo3: $ref: '#/components/examples/cobBody8' exemplo4: $ref: '#/components/examples/cobBody9' CobBodyRevisada: description: Data for updating Immediate collection. required: true content: application/json: schema: $ref: '#/components/schemas/CobRevisada' examples: exemplo1: $ref: '#/components/examples/cobBody3' exemplo2: $ref: '#/components/examples/cobBody4' exemplo3: $ref: '#/components/examples/cobBody5' securitySchemes: clientCredentials: type: oauth2 description: 'All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token. ' flows: authorizationCode: authorizationUrl: /authenticationservices/v3/oauth/token tokenUrl: /authenticationservices/v3/oauth/token scopes: paymentservices: Grant read-only access to payment services cobVWriteSample: type: oauth2 flows: clientCredentials: tokenUrl: /authenticationservices/v3/oauth/token scopes: cobv.write: Authenticates to update collection with due date cobVReadSample: type: oauth2 flows: clientCredentials: tokenUrl: /authenticationservices/v3/oauth/token scopes: cobv.read: Authenticates to retrieve collection item with due date cobWriteSample: type: oauth2 flows: clientCredentials: tokenUrl: /authenticationservices/v3/oauth/token scopes: cob.write: Permission to change Immediate collection cobReadSample: type: oauth2 flows: clientCredentials: tokenUrl: /authenticationservices/v3/oauth/token scopes: cob.read: Permission to consult Immediate collection x-refined-from: - Static.yaml - citi-due-date-openapi.yaml - citi-immediate-openapi.yaml