Stripe Connect e a API Charges

Saiba como o Connect permite que você faça cobranças e emita transferências para contas conectadas. Suas configurações nestas opções determinam suas tarifas na Stripe.

O Connect usa três abordagens para criar pagamentos para uma conta conectada. Para saber mais sobre os diferentes tipos de cobranças do Connect, consulte a documentação sobre como escolher sua abordagem. Suas configurações nestas opções determinam suas tarifas na Stripe.

Esta página só explica como fazer chamadas para a API Charges para contas conectadas. Confira as páginas dos links para saber mais sobre chamadas para outras APIs ou operações relacionadas.

Cobranças diretas

Para criar uma cobrança direta na conta conectada, crie um objeto Charge e acrescente o cabeçalho Stripe-Account com o valor do ID da conta conectada:

curl https://api.stripe.com/v1/charges \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d amount=1000 \
  -d currency=usd \
  -d source=tok_visa

O exemplo usa um token de teste – tok_visa –, mas você pode criar um token com um cartão de teste com Stripe.js e Elements.

Consulte Aceitar um pagamento para saber detalhes.

Coletar tarifas da plataforma em cobranças diretas

Com o Connect, sua plataforma pode cobrar a tarifa da plataforma sobre cobranças diretas. Para avaliar a tarifa da plataforma sobre uma cobrança, envie um valor opcional inteiro positivo para application_fee_amount.

curl https://api.stripe.com/v1/charges \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d amount=1000 \
  -d currency=usd \
  -d source=tok_visa \
  -d application_fee_amount=123

Consulte Cobranças diretas para saber mais sobre disponibilidade de transferências, reembolsos e muito mais.

Cobranças de destino

Para criar uma cobrança de destino, passe o ID da conta conectada no atributo transfer_data[destination]:

curl https://api.stripe.com/v1/charges \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=1000 \
  -d currency=usd \
  -d source=tok_visa \
  -d "transfer_data[destination]"=
{{CONNECTED_ACCOUNT_ID}}

O exemplo usa um token de teste – tok_visa –, mas você pode criar um token com um cartão de teste com Stripe.js e Elements.

Consulte Aceitar um pagamento para saber detalhes.

Coletar tarifas sobre cobranças de destino com application_fee_amount

Ao criar cobranças de destino com application_fee_amount, o valor total da cobrança é imediatamente transferido da plataforma para a conta transfer_data[destination] depois que a cobrança é capturada. A application_fee_amount (com teto no valor total da cobrança) é transferida de volta à plataforma em seguida.

curl https://api.stripe.com/v1/charges \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=1000 \
  -d currency=usd \
  -d source=tok_visa \
  -d application_fee_amount=123 \
  -d "transfer_data[destination]"=
{{CONNECTED_ACCOUNT_ID}}

Para melhorar a experiência de relatório, um objeto de tarifa da plataforma é criado depois que a tarifa da plataforma é coletada. Use a propriedade amount no objeto de tarifa da plataforma para criar relatórios. Você pode acessar esses objetos com o endpoint Tarifas da plataforma.

Coletar tarifas sobre cobranças de destino com transfer_data[amount]

Você também pode usar transfer_data[amount] para coletar uma tarifa.

O valor transfer_data[amount] é um número inteiro positivo no valor da cobrança a ser transferida para transfer_data[destination]. Você subtrai a tarifa da sua plataforma do valor da cobrança e passa o resultado desse cálculo como transfer_data[amount]:

curl https://api.stripe.com/v1/charges \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=1000 \
  -d currency=usd \
  -d source=tok_visa \
  -d "transfer_data[amount]"=877 \
  -d "transfer_data[destination]"=
{{CONNECTED_ACCOUNT_ID}}

Consulte Cobranças de destino para saber mais sobre disponibilidade de transferências, reembolsos e muito mais.

Cobranças e transferências separadas

Para criar uma cobrança e configurar a transferência correspondente, crie um transfer_group e atribua a cobrança ao transfer_group.

# Create a Charge:
curl https://api.stripe.com/v1/charges \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "amount"=10000 \
  -d "currency"="usd" \
  -d "source"="tok_visa" \
  -d "transfer_group"="{ORDER10}"

# Create a Transfer to a connected account (later):
curl https://api.stripe.com/v1/transfers \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "amount"=7000 \
  -d "currency"="usd" \
  -d "destination"="{{CONNECTED_STRIPE_ACCOUNT_ID}}" \
  -d "transfer_group"="{ORDER10}"

# Create a second Transfer to another connected account (later):
curl https://api.stripe.com/v1/transfers \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "amount"=2000 \
  -d "currency"="usd" \
  -d "destination"="{{OTHER_CONNECTED_STRIPE_ACCOUNT_ID}}" \
  -d "transfer_group"="{ORDER10}"

O exemplo usa um token de teste – tok_visa –, mas você pode criar um token com um cartão de teste com Stripe.js e Elements.

Consulte Aceitar um pagamento para mais informações.

Usar on_behalf_of com cobranças e transferências separadas

Com cobranças e transferências separadas, por padrão:

• As cobranças são compensadas no país da plataforma
• A estrutura de tarifas do país da plataforma é aplicada
• Os dados da plataforma aparecem no extrato do cartão do cliente

Para usar o país da conta conectada e exibir os dados dela, use o argumento on_behalf_of.

curl https://api.stripe.com/v1/charges \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=1000 \
  -d currency=usd \
  -d source=tok_visa \
  -d on_behalf_of=
{{CONNECTED_ACCOUNT_ID}}

Consulte Criar cobranças e transferências separadas para obter informações sobre disponibilidade de transferências, reembolsos e muito mais.