início

Getting Started

Barte Api

Basic Orders
- Criação de uma ordem básicapost
API de Planos
API de SubSeller
API de Pedidos (Work In Progress)
API de Compradores
API de clientes na Yuno
- Criar cliente na Yuno.post
API de Cobranças
API de Assinaturas
API de criação de link de pagamento

início

Getting Started

Barte Api

Basic Orders
- Criação de uma ordem básicapost
API de Planos
API de SubSeller
API de Pedidos (Work In Progress)
API de Compradores
API de clientes na Yuno
- Criar cliente na Yuno.post
API de Cobranças
API de Assinaturas
API de criação de link de pagamento

Criação de uma ordem básica

post https://sandbox-api.barte.com/v2/orders/basic

Este endpoint permite criar uma ordem básica vinculada ao seller e cliente autenticados.
Ele também utiliza o cabeçalho de idempotência para garantir que a mesma ordem não seja criada duas vezes,
mesmo em cenários de reenvio de requisições.

URL Expired

The URL for this request expired after 30 days.

Body Params

Dados da requisição para criar a ordem.

startDate

date

required

value

number

required

installments

int32

required

≥ 1

title

string

required

description

string

payment

object

required

uuidBuyer

string

required

metadata

array of objects

metadata

attemptReference

string

urlCallBack

string

subSellerPaymentRequest

object

Headers

x-idempotency-key

string

x-ip-origin-request

string

Responses

Response body

object

uuid

string

required

status

string

required

SENT LATE PARTIALLY_PAID PAID CANCELED ABANDONED REFUND CHARGEBACK PRE_AUTHORIZED INVALID

title

string

required

description

string

value

number

required

installments

int32

required

startDate

date

required

payment

string

required

PIX BANK_SLIP CREDIT_CARD CREDIT_CARD_EARLY_BUYER CREDIT_CARD_EARLY_SELLER DEBIT_CARD CREDIT_CARD_EARLY_MIXED GOOGLE_PAY APPLE_PAY INVALID

customer

object

required

uuid

string

document

string

required

type

string

required

documentCountry

string

name

string

required

string

required

phone

string

required

alternativeEmail

string

integrationCustomerId

string

idempotencyKey

string

subSellerPaymentResponse

array of objects

subSellerPaymentResponse

object

subSellerPaymentResponse

array of objects

subSellerPaymentResponse

object

idSubSeller

int32

required

name

string

paymentValue

number

paymentType

string

PERCENTAGE FIXED

amountForSubSeller

number

amountForSubSellers

number

charges

array of objects

charges

object

uuid

string

required

title

string

required

expirationDate

string

required

paidDate

string

value

number

required

paymentMethod

string

required

PIX BANK_SLIP CREDIT_CARD CREDIT_CARD_EARLY_BUYER CREDIT_CARD_EARLY_SELLER DEBIT_CARD CREDIT_CARD_EARLY_MIXED GOOGLE_PAY APPLE_PAY INVALID

status

string

required

SCHEDULED LATE PAID CANCELED PAID_MANUALLY ABANDONED REFUND FAILED CHARGEBACK DISPUTE PRE_AUTHORIZED INVALID

customer

object

required

interestAmount

number

bankSlipBarcode

string

bankSlip

string

pixCode

string

pixQRCodeImage

string

chargebackDeadline

date

authorizationCode

string

authorizationNsu

string

metadata

array of objects

metadata

object

key

string

required

value

string

required

sellerDetails

object

int32

required

documentType

string

required

documentNumber

string

required

name

string

required

string

required

website

string

required

industry

string

required

merchantCategoryCode

string

required

country

string

required

countryCode

string

required

phoneNumber

string

required

400

Erro de validação. Verifique os dados enviados.

Response body

object

uuid

string

required

status

string

required

SENT LATE PARTIALLY_PAID PAID CANCELED ABANDONED REFUND CHARGEBACK PRE_AUTHORIZED INVALID

title

string

required

description

string

value

number

required

installments

int32

required

startDate

date

required

payment

string

required

PIX BANK_SLIP CREDIT_CARD CREDIT_CARD_EARLY_BUYER CREDIT_CARD_EARLY_SELLER DEBIT_CARD CREDIT_CARD_EARLY_MIXED GOOGLE_PAY APPLE_PAY INVALID

customer

object

required

uuid

string

document

string

required

type

string

required

documentCountry

string

name

string

required

string

required

phone

string

required

alternativeEmail

string

integrationCustomerId

string

idempotencyKey

string

subSellerPaymentResponse

array of objects

subSellerPaymentResponse

object

subSellerPaymentResponse

array of objects

subSellerPaymentResponse

object

idSubSeller

int32

required

name

string

paymentValue

number

paymentType

string

PERCENTAGE FIXED

amountForSubSeller

number

amountForSubSellers

number

charges

array of objects

charges

object

uuid

string

required

title

string

required

expirationDate

string

required

paidDate

string

value

number

required

paymentMethod

string

required

PIX BANK_SLIP CREDIT_CARD CREDIT_CARD_EARLY_BUYER CREDIT_CARD_EARLY_SELLER DEBIT_CARD CREDIT_CARD_EARLY_MIXED GOOGLE_PAY APPLE_PAY INVALID

status

string

required

SCHEDULED LATE PAID CANCELED PAID_MANUALLY ABANDONED REFUND FAILED CHARGEBACK DISPUTE PRE_AUTHORIZED INVALID

customer

object

required

interestAmount

number

bankSlipBarcode

string

bankSlip

string

pixCode

string

pixQRCodeImage

string

chargebackDeadline

date

authorizationCode

string

authorizationNsu

string

metadata

array of objects

metadata

object

key

string

required

value

string

required

sellerDetails

object

int32

required

documentType

string

required

documentNumber

string

required

name

string

required

string

required

website

string

required

industry

string

required

merchantCategoryCode

string

required

country

string

required

countryCode

string

required

phoneNumber

string

required

Response body

object

uuid

string

required

status

string

required

SENT LATE PARTIALLY_PAID PAID CANCELED ABANDONED REFUND CHARGEBACK PRE_AUTHORIZED INVALID

title

string

required

description

string

value

number

required

installments

int32

required

startDate

date

required

payment

string

required

PIX BANK_SLIP CREDIT_CARD CREDIT_CARD_EARLY_BUYER CREDIT_CARD_EARLY_SELLER DEBIT_CARD CREDIT_CARD_EARLY_MIXED GOOGLE_PAY APPLE_PAY INVALID

customer

object

required

uuid

string

document

string

required

type

string

required

documentCountry

string

name

string

required

string

required

phone

string

required

alternativeEmail

string

integrationCustomerId

string

idempotencyKey

string

subSellerPaymentResponse

array of objects

subSellerPaymentResponse

object

subSellerPaymentResponse

array of objects

subSellerPaymentResponse

object

idSubSeller

int32

required

name

string

paymentValue

number

paymentType

string

PERCENTAGE FIXED

amountForSubSeller

number

amountForSubSellers

number

charges

array of objects

charges

object

uuid

string

required

title

string

required

expirationDate

string

required

paidDate

string

value

number

required

paymentMethod

string

required

PIX BANK_SLIP CREDIT_CARD CREDIT_CARD_EARLY_BUYER CREDIT_CARD_EARLY_SELLER DEBIT_CARD CREDIT_CARD_EARLY_MIXED GOOGLE_PAY APPLE_PAY INVALID

status

string

required

SCHEDULED LATE PAID CANCELED PAID_MANUALLY ABANDONED REFUND FAILED CHARGEBACK DISPUTE PRE_AUTHORIZED INVALID

customer

object

required

interestAmount

number

bankSlipBarcode

string

bankSlip

string

pixCode

string

pixQRCodeImage

string

chargebackDeadline

date

authorizationCode

string

authorizationNsu

string

metadata

array of objects

metadata

object

key

string

required

value

string

required

sellerDetails

object

int32

required

documentType

string

required

documentNumber

string

required

name

string

required

string

required

website

string

required

industry

string

required

merchantCategoryCode

string

required

country

string

required

countryCode

string

required

phoneNumber

string

required

500

Erro interno do servidor. Contate o suporte.

Updated 3 months ago

Getting Started

API de Planos

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://sandbox-api.barte.com/v2/orders/basic \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "payment": {
8
    "method": "PIX"
9
  }
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 3 months ago

Getting Started

API de Planos

Did this page help you?

início
Getting Started

Barte Api
Basic Orders
Criação de uma ordem básicapost
API de Planos
Cria um planopost
Busca todos os planos do usuário logado.get
Atualiza um plano pelo seu ID.put
Busca um plano pelo seu IDget
API de SubSeller
Buscar SubSeller pelo IDget
Calcular valores de splitpatch
Atualizar conta bancária do SubSellerpatch
Ativar ou desativar subSellerpatch
Atualizar endereço do SubSellerpatch
Atualizar contato do SubSellerpatch
Atualizar informações do SubSellerpatch
Ativar o split no provedor de pagamentopost
Criar um SubSellerpost
Listar SubSellersget
API de Pedidos (Work In Progress)
/v2/orders/installments-paymentget
Cancela um pedido pelo seu ID.delete
Busca um pedido pelo seu IDget
Atualiza a description e/ou metadata pelo UUID.patch
Cria um pedidopost
Busca todas os pedidos do usuário logado.get
API de Compradores
Cria um compradorpost
Busca todos os compradores do usuário logado.get
Atualiza um comprador pelo seu ID.put
Busca um comprador pelo seu IDget
API de clientes na Yuno
Criar cliente na Yuno.post
API de Cobranças
Cancela uma cobrança pelo seu ID.delete
Busca uma cobrança pelo seu IDget
Busca todas as cobranças do usuário logado.get
/v2/charges/{uuid}/chargebackpatch
Estorna uma cobrança pelo seu ID.patch
Captura cobranças pré-aprovadaspost
API de Assinaturas
Desativa uma assinatura pelo seu ID.delete
Busca uma assinatura pelo seu IDget
Atualiza o valor base de uma assinatura pelo seu ID.patch
Cria uma assinaturapost
Busca todas as assinaturas do usuário logado.get
API de criação de link de pagamento
Consulta parcelasget
Retorna o máximo de parcelasget
Criar link de pagamento.post
Buscar links de pagamento por tipoget
Deletar um link de pagamento por id.delete
Atualizar link de pagamento.put
Busca um link de pagamentoget

início
Getting Started

Barte Api
Basic Orders
Criação de uma ordem básicapost
API de Planos
Cria um planopost
Busca todos os planos do usuário logado.get
Atualiza um plano pelo seu ID.put
Busca um plano pelo seu IDget
API de SubSeller
Buscar SubSeller pelo IDget
Calcular valores de splitpatch
Atualizar conta bancária do SubSellerpatch
Ativar ou desativar subSellerpatch
Atualizar endereço do SubSellerpatch
Atualizar contato do SubSellerpatch
Atualizar informações do SubSellerpatch
Ativar o split no provedor de pagamentopost
Criar um SubSellerpost
Listar SubSellersget
API de Pedidos (Work In Progress)
/v2/orders/installments-paymentget
Cancela um pedido pelo seu ID.delete
Busca um pedido pelo seu IDget
Atualiza a description e/ou metadata pelo UUID.patch
Cria um pedidopost
Busca todas os pedidos do usuário logado.get
API de Compradores
Cria um compradorpost
Busca todos os compradores do usuário logado.get
Atualiza um comprador pelo seu ID.put
Busca um comprador pelo seu IDget
API de clientes na Yuno
Criar cliente na Yuno.post
API de Cobranças
Cancela uma cobrança pelo seu ID.delete
Busca uma cobrança pelo seu IDget
Busca todas as cobranças do usuário logado.get
/v2/charges/{uuid}/chargebackpatch
Estorna uma cobrança pelo seu ID.patch
Captura cobranças pré-aprovadaspost
API de Assinaturas
Desativa uma assinatura pelo seu ID.delete
Busca uma assinatura pelo seu IDget
Atualiza o valor base de uma assinatura pelo seu ID.patch
Cria uma assinaturapost
Busca todas as assinaturas do usuário logado.get
API de criação de link de pagamento
Consulta parcelasget
Retorna o máximo de parcelasget
Criar link de pagamento.post
Buscar links de pagamento por tipoget
Deletar um link de pagamento por id.delete
Atualizar link de pagamento.put
Busca um link de pagamentoget

201Ordem criada com sucesso.

401Não autorizado. O token de autenticação não foi fornecido ou é inválido.

403Proibido. O usuário autenticado não tem permissão para acessar este recurso.