Criação de novo pedido de antecipação

post https://payments.zoop.ws/v1/marketplaces/{marketplaceId}/prepayments

Cria um novo pedido de antecipação, que será posteriormente simulado e terá aprovação financeira para realizar a antecipação de fato.

Path Params

marketplaceId

string

required

ID do Marketplace

Body Params

customer

string

required

ID do Seller que terá seus recebíveis antecipáveis.

prepayment_date

date

required

Data para a qual os recebíveis serão antecipados. Caso não seja preenchido, é considerado D0.

min_transaction_date

date

Apenas considerar recebíveis de vendas realizadas após esta data (inclusive). Caso não seja preenchida, é considerada a data da venda mais antiga com recebíveis não liquidados.

max_transaction_date

date

Apenas considerar recebíveis de vendas realizadas até esta data (inclusive). Caso não seja preenchida, é considerado D-1.

min_expected_date

date

Apenas considerar recebíveis cuja agenda original de liquidação seja após esta data (inclusive). Caso não seja preenchida, é considerado D+1 do campo prepayment_date. Este também é o valor mínimo para este campo.

max_expected_date

date

Apenas considerar recebíveis cuja agenda original de liquidação seja até esta data (inclusive). Caso não seja preenchida, é considerada a data de liquidação do recebível mais tardio.

receivables

array of strings

Lista de IDs de recebíveis que deverão ser incluídos na solicitação de antecipação

receivables

transactions

array of strings

Lista de IDs de transações cujos recebíveis deverão ser incluídos na solicitação de antecipação

transactions

target_amount

integer

Valor alvo, em centavos de Reais, para escolha dos recebíveis a antecipar mediante algoritmo de busca, que seleciona recebíveis incrementalmente até atingir este valor alvo, até o limite percentual da margem (campo margin). Recebíveis que façam o valor total de antecipação ultrapassar o valor alvo com a margem incluída não são incluídos na antecipação. Caso um recebível faça o valor da antecipação atingir o intervalo entre o valor alvo e a margem, o algoritmo é interrompido e a simulação é concluída com os recebíveis selecionados.

margin

float

Margem para seleção de recebíveis caso seja solicitado o filtro de valor alvo (target_amount). Caso não seja preenchido, é considerado 0.01 (1%). Isto significa que no caso de uma antecipação solicitada com target_amount de 500000 (R$5.000,00) e sem margem definida, o algoritmo selecionará recebíveis até atingir o valor de R$5.000,00, porém nunca ultrapassando o valor de R$5.050,00 (recebíveis que ultrapassariam este valor são descartados - pulados). Mesmo que o valor final seja inferior ao valor alvo solicitado, a antecipação é considerada simulada e fica apta à aprovação.

order

string

Indica a prioridade de seleção dos recebíveis na antecipação por valor alvo. Como os recebíveis são selecionados um por um até atingir-se o valor alvo, pode-se utilizar este campo para forçar uma seleção dos recebíveis que estejam vencendo primeiro (expected_date_ascending), vencendo por último (expected_date_descending) ou mesmo priorizar recebíveis de vendas mais antigas (transaction_date_ascending), o que na prática fará com que todos os recebíveis de uma venda sejam antecipados em conjunto antes de partir para os recebíveis da próxima venda (exceto se o somatório dos recebíveis de uma venda ultrapasse o limite da margem do valor alvo). Caso não seja preenchido, é considerada a ordenação expected_date_ascending

partner_fee

float

Permite que o Marketplace cadastre, ou altere, sua taxa para ser aplicada em cima da antecipação requisitada pelo Estabelacimento. Essa taxa não afeta a taxa da Zoop

entry_modes

array of strings

Lista de métodos de captura de transação que poderão ter seus recebíveis antecipados

entry_modes

auto_commit

boolean

Permite desativar o transito automático do status simulated para ready. Se a requisição enviar em seu payload auto_commit=false, o status permanecerá simulated aguardando a confirmação do usuário da API através da requisição /commit. A operação /commit transita somente do status simulated para o status ready. O valor default é true.

fail_on_receivable_invalid

boolean

Defaults to false

Com o valor default false a solicitação retornará sucesso e adicionará a resposta a propriedade rejected_transactions que conterá uma lista detalhada dos erros que invalidam as transações e/ou seus recebíveis. Com valor true, a requisição falhará e não sera criada a solicitação, a mensagem de error conterá os detalhes da invalidação para cada transação e/ou seus recebíveis.

Responses

Response body

object

string

ID da Antecipação.

customer

string

required

ID do Customer

prepayment_date

date

required

Data para a qual os recebíveis serão antecipados.

status

string

Status da solicitação de antecipação. Após sua criação, entra no status de solicitada (requested), onde fica passível de simulação por rotina automática. Após a simulação, entra no status de simulada (simulated), onde passam a ser preenchidos os campos de taxas aplicadas, valor total aplicado à antecipação e recebíveis selecionados. Fica então passível de aprovação do Financeiro da Zoop, que pode torná-la aprovada (approved) ou rejeitada (rejected) dependendo da análise. Uma vez aprovada, fica passível de realização de fato da antecipação, após o qual fica com o status de realizada (succeeded). É possível utilizar o endpoint de exclusão de solicitação a qualquer momento até sua realização, momento em que não será mais possível realizar o cancelamento. Caso seja utilizado este endpoint, o status da solicitação vai para cancelada (canceled). Caso a solicitação de antecipação não seja aprovada até a data selecionada para sua realização, a solicitação vai para o status de expirada (expired). Caso ocorra alguma situação no processo que impeça a antecipação de ser realizada (por exemplo se algum de seus recebíveis tiver sido cancelado por motivo de estorno/chargeback ou mesmo se outra antecipação tiver sido realizada com recebíveis utilizados nesta simulação), esta vai para o estado de inválida (invalid).

requested simulated approved succeeded canceled rejected invalid expired

status_detail

string

Detalhamento do status da antecipação. Em caso de antecipação rejeitada, aparecerá o informe do Financeiro que explica o motivo da rejeição. Em caso de antecipação inválida, provê detalhes para identificar o motivo da invalidação.

prepayment_gross_amount

integer

Valor total, em centavos de Reais, dos recebíveis selecionados na simulação (ou antecipados, caso a antecipação já tenha sido realizada), antes de aplicadas as taxas de antecipação.

prepayment_net_amount

integer

Valor total, em centavos de Reais, dos recebíveis selecionados na simulação (ou antecipados, caso a antecipação já tenha sido realizada), após aplicadas as taxas de antecipação. É o valor que o Seller receberá de fato pela antecipação.

receivables_count

integer

Total de recebíveis selecionados na simulação (ou antecipados, caso a antecipação já tenha sido realizada).

zoop_fee

float

Taxa percentual de 30 dias da Zoop aplicada à antecipação.

partner_fee

float

Taxa percentual de 30 dias do Marketplace Zoop aplicada à antecipação.

auto_commit

boolean

Informa se o transito automático do status simulated para ready esta ativo ou inativo. O valor default é true

created_at

date

Data e hora da criação da solicitação de antecipação.

updated_at

date

Data e hora da última atualização do status da antecipação.

400

Requisição inválida

404

Marketplace ou Seller não encontrado

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://payments.zoop.ws/v1/marketplaces/marketplaceId/prepayments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "fail_on_receivable_invalid": "false"
8
}
9
'

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

application/json

200Sucesso na criação da antecipação