Criar Split de Pagamento

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Esse é o endpoint destinado a solicitação de criação de pré-autorização ou autorização de um split de arranjo de pagamento.

Para criar um pagamento com split, é necessário fazer um POST para o recurso Sales informando no payload o valor da transação em amount, e as informações do pagamento dentro dos objetos payment e customer conforme o exemplo.
É também necessário um array de splits com no mínimo dois objetos representando os integrantes do split. O primeiro objeto do array DEVE ter o atributo merchantType definido como PRIMARY, e seu atributo recipientToken DEVE representar o accessToken vinculado ao lojista onde a transação ocorreu. Os demais objetos terão o atributo merchantType como SECONDARY e seu recipientToken referente ao accessToken de outro lojista que deseja participar do split.

OBSERVAÇÕES:

  • O array de splits só aceita um único integrante como PRIMARY.
  • O integrante PRIMARY NÃO pode receber menos que 1% da transação.
  • A soma de entre todos os integrantes do split NÃO pode ser diferente do valor líquido da transação.
Body Params
int32
required

Valor do pagamento em centavos sem vírgula e ponto.

string

Seu número de identificação da compra/Número do pedido.

string

Seu número de identificação adicional da compra/Número do pedido.

payment
object
required

Informações do pagamento, modelo de autorização e fluxo a ser executado.

customer
object
required

Informações relacionados ao cliente vinculado ao pagamento.

metadata
array of objects

O parâmetro metadata permite que os usuários anexem informações adicionais a uma transação. Isso pode incluir qualquer par de chave-valor que forneça contexto ou detalhes adicionais sobre a transação. O metadata não é utilizado pela API para processar a transação, mas pode ser útil para o registro do usuário ou para a integração com outros sistemas.

metadata
splits
array of objects
required

Informações do Split de Pagamento. Informar caso seja uma operação de Split de Pagamento.

splits*
Headers
string
required

Chave de integração única gerado pela Autenticação de Pagamento (PayAuth) para o estabelecimento.

Formato
Bearer <access_token>

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json