v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Capturar cobrança com split

Rota para capturar uma cobrança com split, definindo a regra de split e os recebedor que irão participar da divisão dos pagamentos.

post/charges/{charge_id}/capture.

Path parameters

charge_idstring required

Código da cobrança.

Request body

amountinteger

Valor a ser cancelado. Caso não seja informado, será considerado o valor total da cobrança.

Response

200

idstring

codestring

gateway_idstring

amountinteger

paid_amountinteger

statusstring

currencystring

payment_methodstring

paid_atstring

canceled_atstring

created_atstring

updated_atstring

Example response

{
  "id": "ch_WOoyJ6u3kUzGyj46",
  "code": "G11LT7MHVL",
  "gateway_id": "3910377",
  "amount": 100,
  "paid_amount": 100,
  "status": "paid",
  "currency": "BRL",
  "payment_method": "credit_card",
  "paid_at": "2018-07-11T17:08:54Z",
  "canceled_at": "2018-07-11T17:09:04Z",
  "created_at": "2018-07-11T17:08:52Z",
  "updated_at": "2018-07-11T17:09:04Z",
  "customer": {
    "id": "cus_OXr6LKGhwruEE1mj",
    "name": "Tony Stark",
    "email": "89d47975-5fb2-4452-8044-7c3be5718d53@avengers.com",
    "created_at": "2018-07-11T17:08:51Z",
    "updated_at": "2018-07-11T17:08:51Z"
  },
  "last_transaction": {
    "id": "tran_p6yAVj8S8szqAB4d",
    "transaction_type": "credit_card",
    "funding_source": "prepaid",
    "gateway_id": "3910377",
    "amount": 100,
    "status": "captured",
    "success": true,
    "acquirer_name": "pagarme",
    "acquirer_tid": "3910377",
    "acquirer_nsu": "3910377",
    "acquirer_return_code": "0000",
    "operation_type": "cancel",
    "card": {
      "id": "card_Rp2BADgtNmSpY5oW",
      "first_six_digits": "401118",
      "last_four_digits": "5580",
      "brand": "Visa",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2020,
      "status": "active",
      "type": "credit",
      "created_at": "2018-07-11T17:08:52Z",
      "updated_at": "2018-07-11T17:08:52Z"
    },
    "created_at": "2018-07-11T17:09:00Z",
    "updated_at": "2018-07-11T17:09:00Z",
    "gateway_response": {
      "code": "200"
    },
    "split": [
      {
        "id": "sr_R2qmlNaViJiLQAwg",
        "type": "percentage",
        "gateway_id": "sr_ck5gvkaia0061q36dfxqmrh1j",
        "amount": 50,
        "recipient": {
          "id": "rp_5yGwpMGckBHVYmb6",
          "name": "First recipient",
          "email": "first_recipient@mundipagg.com",
          "document": "12728994706",
          "description": "Descrição do recebedor 1",
          "type": "individual",
          "status": "active",
          "created_at": "2020-01-02T20:23:14Z",
          "updated_at": "2020-01-02T20:23:14Z"
        },
        "options": {
          "liable": true,
          "charge_processing_fee": true,
          "charge_remainder_fee": true
        }
      }
    ]
  },
  "metadata": {
    "code": "123"
  }
}