v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Editar metadados da cobrança

patch/charges/{charge_id}/metadata

Path parameters

charge_idstring required

Código da cobrança.

Request body

metadatastring required

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
created_atstring
updated_atstring

Example response

{
  "id": "ch_3rY2xJzh1FY7BZqd",
  "code": "R10KFGXIMZ",
  "gateway_id": "1805994",
  "amount": 1490,
  "status": "pending",
  "currency": "BRL",
  "payment_method": "credit_card",
  "created_at": "2017-08-08T20:22:47Z",
  "updated_at": "2017-08-08T20:22:55Z",
  "customer": {
    "id": "cus_ob5v7gCgqTx9v3gk",
    "name": "Felipe Stark",
    "email": "e8a9c04f-97f2-45f3-a1e5-90e806e3ef34@avengers.com",
    "created_at": "2017-08-08T20:22:46Z",
    "updated_at": "2017-08-08T20:22:46Z"
  },
  "last_transaction": {
    "id": "tran_YNbZPN3HmFx76znM",
    "transaction_type": "credit_card",
    "funding_source": "prepaid",
    "gateway_id": "1805994",
    "amount": 1490,
    "status": "authorized_pending_capture",
    "success": true,
    "installments": 1,
    "statement_descriptor": "AVENGERS",
    "acquirer_name": "pagarme",
    "acquirer_tid": "1805994",
    "acquirer_nsu": "1805994",
    "acquirer_return_code": "0000",
    "operation_type": "auth_only",
    "card": {
      "id": "card_D5j6xo7IpDIGxJzq",
      "first_six_digits": "455685",
      "last_four_digits": "7525",
      "brand": "Visa",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2030,
      "status": "active",
      "created_at": "2017-08-08T20:22:47Z",
      "updated_at": "2017-08-08T20:22:47Z",
      "type": "credit"
    },
    "created_at": "2017-08-08T20:22:47Z",
    "updated_at": "2017-08-08T20:22:47Z",
    "gateway_response": {
      "code": "200"
    }
  },
  "metadata": {
    "code": "12345"
  }
}