Split de Pagamento

Adicionar Regra de Comissionamento

https://api.premepay.com/v1/stores/{storeId}/split_rules

Lista de Descrição dos Campos

Parâmetro
Tipo
Descrição
Obrigatório
recipientId
integer
Id da Store comissionada
Sim
percentage
decimal
Valor em Porcentagem a ser comissionado
Não
fixed
decimal
Valor Fixo a ser comissionado
Não
comissioning_type
Tipo do comissionamento
Sim
percentage
fixed
both
disputeLiable
boolean
Define se a Store terceira arca com prejuízo em caso de chargeback ou não
Sim
refundLiable
boolean
Define se a Store terceira arca com prejuízo em caso de estorno ou não
Sim

Exemplos de Requisição

{
"recipientId": 5325,
"type":"percentage",
"disputeLiable": true,
"refundLiable": true,
"percentage": 1
}
{
"recipientId": 5325,
"type": "fixed",
"disputeLiable": true,
"refundLiable": true,
"fixed": 2
}
{
"recipientId": 5325,
"type": "both",
"disputeLiable": true,
"refundLiable": true,
"percentage": 2.00,
"fixed": 1.00
}

Respostas

200: Ok

Estes são exemplos de resposta para os casos em que sua requisição seja bem sucedida.
{
"id": 28378,
"recipient": {
"id": 346401,
"name": "Store Comissionada"
},
"type": "Percentage",
"disputeLiable": true,
"refundLiable": true,
"percentage": 2.00,
"fixed": 0.0
}
{
"id": 28379,
"recipient": {
"id": 346401,
"name": "Store Comissionada"
},
"type": "Fixed",
"disputeLiable": true,
"refundLiable": true,
"percentage": 0.0,
"fixed": 2.00
}
{
"id": 28380,
"recipient": {
"id": 346401,
"name": "Store Comissionada"
},
"type": "Both",
"disputeLiable": true,
"refundLiable": true,
"percentage": 2.00,
"fixed": 1.00
}

400: Bad Request

Esta é a resposta para os casos em que o servidor não processa a requisição devido a um erro encontrado. Alguns exemplos que podem resultar neste erro são uma URL digitada incorretamente, sintaxe malformada ou requisição de roteamento inválida.
{
"errors": [
{
"message": "Error description"
}
],
"status": 400,
"detail": "Error details"
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"error": {
"message": "Unauthorized"
}
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"error": {
"message": "Forbidden"
}
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"error": {
"message": "Internal server error"
}
}

Listar Regras de Comissionamento

https://api.premepay.com/v1/stores/{storeId}/split_rules

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
[
{
"id": 25529,
"recipient": {
"id": 346401,
"name": "Store Comissionada"
},
"type": "Fixed",
"disputeLiable": true,
"refundLiable": true,
"percentage": 0.00,
"fixed": 2.00
},
{
"id": 25530,
"recipient": {
"id": 346401,
"name": "Store Comissionada"
},
"type": "Percentage",
"disputeLiable": true,
"refundLiable": true,
"percentage": 2.00,
"fixed": 0.00
},
{
"id": 25531,
"recipient": {
"id": 346401,
"name": "Store Comissionada"
},
"type": "Both",
"disputeLiable": true,
"refundLiable": true,
"percentage": 2.00,
"fixed": 1.00
}
]

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"status": 401
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"status": 403
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"status": 500,
"detail": "Error details"
}

Excluir Regra de Comissionamento

https://api.premepay.com/v1/stores/{storeId}/split_rules/{id}

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"message": "Split Rule deleted"
}

400: Bad Request

Esta é a resposta para os casos em que o servidor não processa a requisição devido a um erro encontrado. Alguns exemplos que podem resultar neste erro são uma URL digitada incorretamente, sintaxe malformada ou requisição de roteamento inválida.
{
"errors": [
{
"message": "Error description"
}
],
"status": 400,
"detail": "Error details"
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"status": 401
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"status": 403
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"status": 500,
"detail": "Error details"
}
Copy link
Outline
Adicionar Regra de Comissionamento
Listar Regras de Comissionamento
Excluir Regra de Comissionamento