--- title: "PostChargeRequest" url: "https://devcenter.stone.com.br/apis/stone-online-legacy/versions/4fb6db99-cd62-490f-8c0f-b04e7c2acd41/schemas/PostChargeRequest" --- > Full API specification: https://devcenter.stone.com.br/apis/stone-online-legacy/versions/4fb6db99-cd62-490f-8c0f-b04e7c2acd41.md # PostChargeRequest ## OpenAPI definition ```yaml openapi: 3.0.3 info: title: Stone Online · API (Legado) version: 1.0.0 servers: - url: https://payments.stone.com.br/v1 description: Payment API Production Server components: schemas: PostChargeRequest: type: object required: - payment_method - amount - initiator_id - local_datetime properties: payment_method: type: string description: Payment method da charge enum: - card amount: type: integer format: int64 description: Valor requisitado na cobrança em centavos. currency_code: type: string minLength: 3 maxLength: 3 description: Código da moeda de autorização da transação. Padrão ISO 3 dígitos. Quando não informado será considerado o valor default 986 (BRL). initiator_id: type: string maxLength: 123 description: Identificador externo (cliente) que pode ser utilizado em reversões e consultas. reference_id: type: string maxLength: 128 description: Identificador externo, geralmente relacionado a um pedido ou outra referência do cliente, apenas em fluxos informacionais. local_datetime: type: string format: yyyy-MM-ddTHH:mm:ss description: Data e hora da operação utilizando o fuso horário do local do dispositivo no formato ISO8601. channel: type: string enum: - standalone_device - standalone_mobile - website - app - payment_link description: > Canal de interação utilizado pelo cliente na inicialização da transação: * `standalone_device` - Dispositivos que processam a transação de forma autônoma e direta (ex. POS). * `standalone_mobile` - Dispositivos mobile que processam a transação de forma autônoma e direta (ex. TapPhone). * `website` - Transações realizadas via ecommerce. * `app` - Transações realizadas via aplicativo. * `payment_link` - Obrigatório para transações realizadas através de link de pagamento. card_transaction: description: Informações específicas para transações utilizando o método de pagamento cartão type: object required: - type - card - operation_type properties: type: type: string enum: - credit - debit - voucher description: Tipo de cartão está sendo utilizado na cobrança. operation_type: type: string default: auth_and_capture enum: - pre-auth - auth_only - auth_and_capture description: > Informa qual tipo de operação será realizada na autorização: * `pre_auth`: Indica uma pré-autorização que ficará aberta à captura por 30 dias. * `auth_only`: Indica uma autorização padrão, ficando aberta à captura por 07 dias. * `auth_and_capture`: Indica que a captura será realiza de forma automática e imeditada. installments: type: integer format: int32 default: 0 minimum: 0 maximum: 99 description: Quantidade de parcelas da cobrança. Para cobranças à vista o valor deverá ser 0 installments_type: type: string default: none enum: - none - issuer - merchant description: | Indicação de quem oferece o parcelamento; * `issuer`: Parcelamento oferecido pelo emissor (com juros). * `merchant`: Parcelamento oferecido pelo lojista (sem juros). * `none`: Sem parcelamento (à vista). statement_descriptor: type: string maxLength: 35 description: Informação adicional apresentada na filipeta para o comprador final. Em geral o nome fantasia do cliente. currency_conversion: type: object required: - token - currency_code - converted_amount properties: token: type: string description: Token contendo os dados da conversão da moeda. currency_code: type: string minLength: 3 maxLength: 3 description: Código da moeda de autorização da transação no cartão do portador. Padrão ISO 3 dígitos converted_amount: type: number format: int32 description: Valor da transação na moeda de autorização do portador. card: type: object required: - number - expiration_date - token - entry_mode properties: number: type: string format: int32 minLength: 8 maxLength: 19 description: Número do cartão (PAN) sendo utilizado na cobrança. OBRIGATÓRIO caso não seja informado um payment_token. expiration_date: type: string format: YYMM description: Data de expiração do cartão utilizando o formato ano e mês "YYMM". OBRIGATÓRIO caso não seja informado um payment_token. entry_mode: type: string enum: - magstripe - emv - emv_contacless - contactless - qr_code - manual - credentials_on_file description: > Método pelo qual foi realizada a leitura dos dados do cartão: * `magstripe`: Leitura da tarja magnética. * `emv`: Leitura por inserção de ICC, sendo os dados no padrão EMV. * `emv_contactless`: Leitura por aproximação, sendo os dados no padrão EMV. * `contactless`: Leitura por aproximação com tecnologia NFC ou bluetooth, por exemplo, em padrões não EMV. * `qr_code`: Leitura por código QR exibido em um terminal de pagamento.. * `manual`: Dados inseridos manualmente através de uma plataforma de pagamento. * `credentials_on_file`: Dados armazenados previamente. holder_name: type: string description: Nome do portador do cartão. holder_document_number: type: string description: Número do documento do portador do cartão. cvv: type: string format: int32 maxLength: 4 description: Código de segurança do cartão. emv_data: type: string description: Dados no padrão EMV obtidos do chip do cartão. track_1: type: string description: Trilha 1 de dados do cartão. track_2: type: string description: Trilha 2 de dados do cartão. track_3: type: string description: Trilha 3 de dados do cartão. sequence_number: type: string description: Identifica um cartão dentro de um conjunto de cartões com o mesmo número de cartão (PAN). fallback: type: boolean default: false description: Indicação se está sendo utilizado o entry_mode de fallback. token: type: object description: Objeto que contém os dados de tokenização do cartão na bandeira. OBRIGATÓRIO caso não seja informado um número de cartão aberto (number) e data de expiração. required: - number - expiration_date properties: number: type: string description: Token gerado pela bandeira. expiration_date: type: string format: YYMM description: Data de expiração do token utilizando o formato ano e mês "YYMM". cryptogram: type: string description: Criptograma do Token. eci: type: string description: | Resultado da autenticação do token: * `02` ou `05`: OK. * `01` ou `06`: Attempted. * `00` ou `07`: Failed. requestor_id: type: string description: Identificador do requerente do Token. brand: type: string enum: - visa - mastercard - amex - hipercard - elo - jcb - aura - dinners description: Bandeira do cartão. authentication: type: object required: - type properties: type: type: string enum: - offline_pin - online_pin - wallet - emv_3ds description: > Método de autenticação do titular do cartão: * `offline_pin`: Autenticação do PIN no ICC do cartão. * `online_pin`: Autenticação criptografada e verificada pelo emissor do cartão. * `wallet`: Autenticação baseada em uma carteira digital. * `emv_3ds`: Autenticação baseada no padrão 3DS online_pin: type: object description: Dados da autenticação criptografada e verificada pelo emissor do cartão. required: - algorithm properties: algorithm: type: string enum: - dukpt_3des description: Algoritmo de criptografia utilizado na senha do cliente. ksi: type: string format: binary example: "2020080303" description: Identificação usada para derivar uma chave única de uma chave mestra fornecida para os dados proteção. ksn: type: string format: binary example: 398A00137C description: Chave de criptografia de chave criptografada. pin_block: type: string format: binary example: 9DDBB990C440FB0D description: Dados criptografados, resultado da criptografia de conteúdo. wallet: type: object description: Dados da autenticação realizada pela carteira digital. properties: cryptogram: type: string description: Criptograma gerado pelo carteira digital. eci: type: string description: | Resultado da autenticação: * `02` ou `05`: OK. * `01` ou `06`: Attempted. * `00` ou `07`: Failed. enum: - "00" - "01" - "02" - "05" - "06" - "07" type: type: string enum: - applepay - googlepay - clicktopay description: Tipo da Wallet emv_3ds: type: object description: Dados da autenticação realizada pelo serviço de 3DS. required: - directory_server_id - cryptogram properties: directory_server_id: type: string description: O identificador da transação gerado pelo servidor de 3DS. cryptogram: type: string description: Criptograma gerado pelo serviço de 3DS. eci: type: string description: | Resultado da autenticação: * `02` ou `05`: OK. * `01` ou `06`: Attempted. * `00` ou `07`: Failed. * `DATA_ONLY`: Data Only. enum: - "00" - "01" - "02" - "05" - "06" - "07" - DATA_ONLY status: type: string description: > Resultado da autenticação: * `Y`: Authentication Verification Successful. * `N`: Not Authenticated / Account Not Verified; * `U`: Authentication / Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq. * `A`: Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided. * `R`: Authentication / Account Verification Rejected; Issuer is rejecting authentication/verification and request that auth. * `I`: Data Only. enum: - Y - N - U - A - R - I version: type: string description: Versão do 3DS. Exemplo `VRS21` para indicar 3D Secure 2.1. xid: type: string description: ID de 3DS retornado no processo de autenticação. merchant_category_code: type: string description: Código de categoria do lojista ou sublojista relacionado à cobrança. sub_merchant: type: object description: Dados do cliente que possui o cadastro com a adquirente e está utilizando um facilitador de pagamento. required: - id - document - document_type properties: id: type: string description: Identificador do sublojista atribuído pela Subadquirente. payment_facilitator_id: type: string description: Cadastro do facilitador de pagamento junto as bandeiras. name: type: string description: Nome do sublojista, para fins informacionais na fatura do comprador. Quando informado tem prioridade sobre o _statement_descriptor_. document: type: string minLength: 8 maxLength: 14 description: Documento do sublojista cadastrado com a adquirente, sem separadores. document_type: type: string enum: - cpf - cnpj - passport description: Tipo de documento usado no cadastro com a adquirente. email: type: string description: Endereço eletrônico do sublojista. phone_number: type: string description: Número de telefone do sublojista. site: type: string description: Endereço do ecommerce do sublojista. legal_name: type: string description: Razão social do sublojista. address: type: object description: Endereço de cobrança do sublojista. properties: street: type: string description: Rua do endereço. number: type: string description: Número do endereço. complement: type: string description: Campo para adicionar informações complementares do endereço. city: type: string description: Cidade do endereço. state: type: string description: Estado do endereço. district: type: string description: Bairro do endereço. country_code: type: string default: "076" description: Codigo do pais. Padrão ISO 3166. Quando não informado será considerado o valor default "076" (Brasil) zip_code: type: string description: Código portal do endereço, sem separadores ou espaçamento. gateway_id: type: string description: Identificador do gateway de pagamentos utilizado pelo sublojista initiator: type: object description: Indicador de inicialização de transação properties: initiating_entity: type: string description: > Indica o agente iniciador da transação: * `account_holder`: Indica a participação ativa do comprador na inicialização. * `merchant`: Indica a inicialização pelo lojista. enum: - account_holder - merchant initiating_reason: type: string description: > Indica o tipo de transação realizada: * `credentials_on_file`: Transação com credencial (dados de cartão) armazenada (MIT/CIT). * `standing_order`: Ordem Permanente (MIT/CIT). * `subscription`: Assinatura (MIT/CIT). * `installment`: Parcelado (MIT/CIT). * `partial_shipment`: Remessa Parcial (MIT/CIT). * `delayed_charge`: Cobrança atrasada (MIT/CIT). * `no_show`: No show - Multa (MIT/CIT). * `retry`: Reenvio (MIT/CIT). * `deferred_payment`: Pagamento diferido (Mobilidade Urbana). * `debit_recovery`: Recuperação de débito (Mobilidade Urbana). * `installment_payment`: Parcelamento através de mecanismo de recorrência. São realizadas N transações espalhadas por um período de tempo ao invés de uma transação parcelada em N vezes. Esse modelo é utilizado para sensibilizar o saldo do portador de forma parcial ao invés de o valor total de uma só vez. * `marketplace`: Aceitante indireto que oferece sua plataforma de marca. * `peer_to_peer`: Transação que transfere fundos de/para usuários registrados de uma carteira digital. * `stage_back_to_back`: Transação para gerar fundos na carteira digital para o pagamentos de compras e serviços em tempo real. * `stored_value`: Transação que gera fundos na carteira digital para pagamentos subsequentes para um ou vários beneficiários finais. * `bill_payment`: Pagamento de fatura. enum: - credentials_on_file - standing_order - subscription - installment - partial_shipment - delayed_charge - no_show - retry - deferred_payment - debit_recovery - installment_payment - marketplace - peer_to_peer - stage_back_to_back - stored_value - bill_payment - card_funds_transfer first_transaction: type: object description: Dados relacionados a transação original. properties: brand_transaction_id: type: string description: Identificador da transação original no Emissor. transaction_id: type: string description: Identificador da transação original emitido pelo provedor (Adquirente). partner_platform_id: type: string description: Identificador do cliente em provedores externos. print_line_size: type: integer format: int32 minimum: 1 maximum: 999 description: Limite máximo de caracteres por linha na impressão da filipeta. payee: type: object description: Dados para transações de aporte de recursos. properties: destination_type: type: string description: Tipo de destino da transação. enum: - digital_wallet destination_name: type: string description: Nome do destino do aporte de fundos. name: type: string description: Nome do destinatário. document: type: string description: Número do documento do destinatário. document_type: type: string description: Tipo de documento do destinatário. enum: - cpf - cnpj customer: type: object description: Dados do cliente que está realizando a compra. properties: name: type: string description: Nome do cliente. document: type: string description: Número do documento do cliente. document_type: type: string description: Tipo de documento do cliente. enum: - cpf - cnpj - passport email: type: string description: Endereço eletrônico do cliente. phone: type: object description: Número de telefone do cliente. properties: country: type: string description: Código do país do telefone. area: type: string description: Código de área do telefone. number: type: string description: Número do telefone. type: type: string description: Tipo do telefone. enum: - home - work - mobile items: type: array description: Lista de itens da compra. items: type: object properties: amount: type: integer format: int64 description: Preço unitário do item em centavos. description: type: string description: Descrição do item. quantity: type: integer format: int32 description: Quantidade do item. code: type: string description: Código do item. ```