Visão Geral sobre Pagamento

Em nossos pedidos e cobranças, dentro possuímos o nó payment responsável pelas instruções de pagamento podendo comportar os meios de pagamento: credit_card, voucher, boleto, bank_transfer e safetypay. Especificamente para pedidos está disponível também o meio de pagamento checkout.

O objeto pagamento tem as seguintes propriedades:

Atributos

Tipo

Descrição

payment_method

string

Meio de pagamento. Valores possíveis: credit_card,debit_card, boleto, voucher, bank_transfer, safety_pay, checkout, cash, pix.

credit_card

object

Dados sobre o pagamento com cartão de crédito (obrigatório caso o payment_method seja credit_card). Saiba mais sobre pagamentos com cartão de crédito.

debit_card

object

Dados sobre o pagamento com cartão de débito (obrigatório caso o payment_method seja debit_card). Saiba mais sobre pagamentos com cartão de débito.

voucher

object

Dados sobre o pagamento com voucher (obrigatório caso o payment_method seja voucher). Saiba mais sobre pagamentos com voucher.

boleto

object

Dados sobre o pagamento com boleto (obrigatório caso o payment_method seja boleto). Saiba mais sobre pagamentos com boleto.

bank_transfer

object

Dados sobre o pagamento com transferência entre contas bancárias. (obrigatório caso o payment_method seja bank_transfer). Saiba mais sobre pagamentos com transferência entre contas.

checkout

object

Dados sobre o pagamento com checkout. (obrigatório caso o payment_method seja checkout). Este método está disponível apenas para pedidos. Saiba mais sobre pagamentos com meio de pagamento checkout.

cash

object

Dados sobre o pagamento com cash (obrigatório caso o payment_method seja cash). Saiba mais sobre pagamentos com cash.

Pix

object

Dados sobre o pagamento com pix (obrigatório caso o payment_method seja pix). Saiba mais sobre pagamentos com pix

amount

integer

Valor da cobrança em centavos

metadata

object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento. Saiba mais sobre metadata

gateway_affiliation_id

string

Código da afiliação no gateway