POST v2/{token}/transacao/cartao

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

string

Required

Body Parameters

TransacaoCartaoRequest
NameDescriptionTypeAdditional information
source

OrigemRequest

None.

amount

integer

None.

currency

string

None.

description

string

None.

on_behalf_of

string

None.

payment_type

string

None.

installment_plan

ParcelamentoRequest

None.

capture

boolean

None.

split_rules

Collection of Split

None.

Request Formats

application/json, text/json

Sample:
{
  "source": {
    "usage": "sample string 1",
    "card": {
      "card_number": "sample string 1",
      "security_code": "sample string 2",
      "expiration_month": "sample string 3",
      "expiration_year": "sample string 4",
      "holder_name": "sample string 5"
    },
    "currency": "sample string 2",
    "type": "sample string 3",
    "amount": 4
  },
  "amount": 1,
  "currency": "sample string 2",
  "description": "sample string 3",
  "on_behalf_of": "sample string 4",
  "payment_type": "sample string 5",
  "installment_plan": {
    "mode": "sample string 1",
    "number_installments": 2
  },
  "capture": true,
  "split_rules": [
    {
      "id": "sample string 1",
      "resource": "sample string 2",
      "transaction": "sample string 3",
      "recipient": "sample string 4",
      "liable": true,
      "charge_processing_fee": true,
      "charge_recipient_processing_fee": true,
      "percentage": 8.0,
      "amount": 9.0,
      "is_gross_amount": true,
      "receivable_amount": 11.0,
      "receivable_gross_amount": 12.0,
      "created_at": "sample string 13",
      "updated_at": "sample string 14"
    },
    {
      "id": "sample string 1",
      "resource": "sample string 2",
      "transaction": "sample string 3",
      "recipient": "sample string 4",
      "liable": true,
      "charge_processing_fee": true,
      "charge_recipient_processing_fee": true,
      "percentage": 8.0,
      "amount": 9.0,
      "is_gross_amount": true,
      "receivable_amount": 11.0,
      "receivable_gross_amount": 12.0,
      "created_at": "sample string 13",
      "updated_at": "sample string 14"
    }
  ]
}

application/xml, text/xml

Sample:
<TransacaoCartaoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoctusPay.Request">
  <Capturar>true</Capturar>
  <Origem>
    <Cartao>
      <card_number>sample string 1</card_number>
      <expiration_month>sample string 3</expiration_month>
      <expiration_year>sample string 4</expiration_year>
      <holder_name>sample string 5</holder_name>
      <security_code>sample string 2</security_code>
    </Cartao>
    <amount>4</amount>
    <currency>sample string 2</currency>
    <type>sample string 3</type>
    <usage>sample string 1</usage>
  </Origem>
  <Parcelamento>
    <mode>sample string 1</mode>
    <number_installments>2</number_installments>
  </Parcelamento>
  <Splits xmlns:d2p1="http://schemas.datacontract.org/2004/07/DoctusPay.Dominio">
    <d2p1:Split>
      <d2p1:Amount>9</d2p1:Amount>
      <d2p1:ChargeProcessingFee>true</d2p1:ChargeProcessingFee>
      <d2p1:ChargeRecipientProcessingFee>true</d2p1:ChargeRecipientProcessingFee>
      <d2p1:CreatedAt>sample string 13</d2p1:CreatedAt>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsGrossAmount>true</d2p1:IsGrossAmount>
      <d2p1:Liable>true</d2p1:Liable>
      <d2p1:Percentage>8</d2p1:Percentage>
      <d2p1:ReceivableAmount>11</d2p1:ReceivableAmount>
      <d2p1:ReceivableGrossAmount>12</d2p1:ReceivableGrossAmount>
      <d2p1:Recipient>sample string 4</d2p1:Recipient>
      <d2p1:Resource>sample string 2</d2p1:Resource>
      <d2p1:Transaction>sample string 3</d2p1:Transaction>
      <d2p1:UpdatedAt>sample string 14</d2p1:UpdatedAt>
    </d2p1:Split>
    <d2p1:Split>
      <d2p1:Amount>9</d2p1:Amount>
      <d2p1:ChargeProcessingFee>true</d2p1:ChargeProcessingFee>
      <d2p1:ChargeRecipientProcessingFee>true</d2p1:ChargeRecipientProcessingFee>
      <d2p1:CreatedAt>sample string 13</d2p1:CreatedAt>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsGrossAmount>true</d2p1:IsGrossAmount>
      <d2p1:Liable>true</d2p1:Liable>
      <d2p1:Percentage>8</d2p1:Percentage>
      <d2p1:ReceivableAmount>11</d2p1:ReceivableAmount>
      <d2p1:ReceivableGrossAmount>12</d2p1:ReceivableGrossAmount>
      <d2p1:Recipient>sample string 4</d2p1:Recipient>
      <d2p1:Resource>sample string 2</d2p1:Resource>
      <d2p1:Transaction>sample string 3</d2p1:Transaction>
      <d2p1:UpdatedAt>sample string 14</d2p1:UpdatedAt>
    </d2p1:Split>
  </Splits>
  <amount>1</amount>
  <currency>sample string 2</currency>
  <description>sample string 3</description>
  <on_behalf_of>sample string 4</on_behalf_of>
  <payment_type>sample string 5</payment_type>
</TransacaoCartaoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.