v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Incluir cobrança no pedido

Enquanto um pedido estiver aberto, é possível adicionar novas cobranças utilizando o order_id na criação de uma cobrança.

post/charges

Request body

order_idstring required

Código do pedido

amountinteger required

Valor da cobrança em centavos

paymentobject required

Dados sobre pagamento. Saiba mais sobre pagamentos

due_atstring date

Data de vencimento da cobrança.

customer_idstring

Código do cliente.

customerobject

Dados do cliente. Se nem o customer_id nem o customer forem informados, será considerado o mesmo cliente do pedido. Saiba mais sobre clientes

metadatastring

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

Response

200

idstring

codestring

gateway_idstring

amountinteger

statusstring

currencystring

payment_methodstring

due_atstring

paid_atstring

created_atstring

updated_atstring

Example response

{
  "id": "ch_xyRZw5XCLhl3ENjP",
  "code": "LM4AVYSYQ9",
  "gateway_id": "769e2123-a634-46dc-8bba-529bba7fb726",
  "amount": 2990,
  "status": "paid",
  "currency": "BRL",
  "payment_method": "credit_card",
  "due_at": "2017-04-05T00:00:00",
  "paid_at": "2017-04-05T05:51:44",
  "created_at": "2017-04-05T05:51:37",
  "updated_at": "2017-04-05T05:51:37",
  "order": {
    "id": "or_gnvV6V1VTgspL4JB",
    "code": "MW6JTXGA2V",
    "amount": 2990,
    "currency": "BRL",
    "status": "pending",
    "created_at": "2017-04-05T05:51:09",
    "updated_at": "2017-04-05T05:51:09"
  },
  "customer": {
    "id": "cus_o9m12XMfrWtYKdLM",
    "name": "Tony Stark",
    "email": "e44655d3-455a-47bd-a86b-4f537aad95b5@avengers.com",
    "created_at": "2017-04-05T05:51:09",
    "updated_at": "2017-04-05T05:51:09"
  },
  "last_transaction": {
    "id": "tran_Bo9LkGUjjiBXLpWk",
    "transaction_type": "credit_card",
    "funding_source": "prepaid",
    "gateway_id": "3b0764c0-6940-4961-bac1-db5be550448a",
    "amount": 2990,
    "status": "captured",
    "success": true,
    "installments": 1,
    "statement_descriptor": "AVENGERS",
    "acquirer_name": "simulator",
    "acquirer_affiliation_code": "MUNDI",
    "acquirer_tid": "270896",
    "acquirer_nsu": "813228",
    "acquirer_auth_code": "984353",
    "acquirer_message": "Stone|Transação autorizada com sucesso",
    "acquirer_return_code": "0",
    "operation_type": "auth_and_capture",
    "credit_card": {
      "id": "card_09eV0PrfQKClNVOd",
      "last_four_digits": "8229",
      "brand": "Amex",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2030,
      "status": "active",
      "created_at": "2017-04-05T05:51:37",
      "updated_at": "2017-04-05T05:51:37",
      "billing_address": {
        "zip_code": "90265",
        "city": "Malibu",
        "state": "CA",
        "country": "US",
        "line_1": "10880, Malibu Point, Malibu Central"
      }
    },
    "created_at": "2017-04-05T05:51:37",
    "updated_at": "2017-04-05T05:51:37"
  }
}