v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Editar cartão de cobrança

Esse recurso só pode ser chamado quando o cartão a ser editado teve a transação não autorizada.

patch/charges/{charge_id}/card

Path parameters

charge_idstring required

Código da cobrança.

Request body

update_subscriptionstring

Indica se o cartão da assinatura deve ser atualizado

card_idstring

Código do cartão.

card_tokenstring

Token do cartão

initiated_typestring

Identificador do tipo de transação avulsa. Valores possíveis: partial_shipment (Remessa Parcial), related_or_delayed_charge (Cobrança Atrasada), no_show (Multa) ou retry (Retentativa). Mais detalhes.

recurrence_modelstring

Identificador do tipo de recorrência. Valores possíveis: standing_order (Ordem Permanente), instalment (Parcelamento) ou subscription (Assinatura convencional com valor e frequência fixa). Mais detalhes.

Response

200

idstring

codestring

amountinteger

paid_amountinteger

statusstring

currencystring

payment_methodstring

paid_atstring

created_atstring

updated_atstring

Example response

{
  "id": "ch_B4rpRdfBxsVv0NQo",
  "code": "98ZZUL0F8Z",
  "amount": 1490,
  "paid_amount": 1490,
  "status": "paid",
  "currency": "BRL",
  "payment_method": "credit_card",
  "paid_at": "2019-01-22T14:40:47Z",
  "created_at": "2019-01-22T14:39:35Z",
  "updated_at": "2019-01-22T14:40:47Z",
  "customer": {
    "id": "cus_PYwJvWgOTmiqvW8m",
    "name": "Tony Stark",
    "email": "toinhodalua@nasa.com",
    "created_at": "2019-01-18T11:50:37Z",
    "updated_at": "2019-01-18T15:46:38Z"
  },
  "last_transaction": {
    "id": "tran_jad0jXPhotb2eNkr",
    "transaction_type": "credit_card",
    "funding_source": "prepaid",
    "gateway_id": "6f2db50c-cb32-4211-bd71-3450e4b900f7",
    "amount": 1490,
    "status": "captured",
    "success": true,
    "installments": 1,
    "statement_descriptor": "AVENGERS",
    "acquirer_tid": "d2b3e1ab-1b24-4d66-93c8-b304776cd782",
    "acquirer_nsu": "d2b3e1ab-1b24-4d66-93c8-b304776cd782",
    "acquirer_auth_code": "743",
    "acquirer_message": "Transação capturada com sucesso",
    "acquirer_return_code": "00",
    "operation_type": "auth_and_capture",
    "card": {
      "id": "card_jdK2O53TqfnxwRDY",
      "first_six_digits": "400000",
      "last_four_digits": "0010",
      "brand": "Visa",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2030,
      "status": "active",
      "type": "credit",
      "created_at": "2019-01-18T12:25:41Z",
      "updated_at": "2019-01-22T14:39:01Z",
      "billing_address": {
        "zip_code": "90265",
        "city": "Malibu",
        "state": "CA",
        "country": "US",
        "line_1": "10880, Malibu Point, Malibu Central"
      }
    },
    "created_at": "2019-01-22T14:40:47Z",
    "updated_at": "2019-01-22T14:40:47Z",
    "gateway_response": {
      "code": "200"
    }
  },
  "metadata": {
    "code": "123"
  }
}