Pular para o conteúdo principal

Lista métodos de pagamento de um estabelecimento.

GET /api/{userId}/establishment/{establishmentId}/paymentmethods

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento

Requisição

  • Método: GET
  • Path: /api/\{userId\}/establishment/\{establishmentId\}/paymentmethods
  • Headers: Authorization, Accept: application/json
  • Autorização: informe o userId do token na URL e envie o token no header Authorization: Bearer <YOUR_API_TOKEN> (gerados no painel de API do Site Admin).

Parâmetros de consulta (query string)

NomeTipoDescrição
searchstringBusca parcial por paymentMethodName.
primitivePaymentMethodnumberFiltra pela forma de pagamento primitiva.
statusnumber1 = ativo (padrão), 0 = inativo.
orderBystringCampo de ordenação. Padrão: created_at.
sortstringasc (padrão) ou desc.
pagenumberNúmero da página. Padrão: 1.

Resposta

  • Status: 200 OK
  • Content-Type: application/json

Observações

  • receivingFee: taxa percentual de recebimento. Ex.: 2.5 = 2,5%.

Exemplo de resposta

{
"response": "success",
"data": {
"content": [
{
"establishmentPaymentMethodId": 17,
"establishmentId": 1234,
"primitivePaymentMethodId": 1,
"paymentMethodName": "Dinheiro",
"accountId": 55,
"receivingFee": 0,
"status": 1
},
{
"establishmentPaymentMethodId": 18,
"establishmentId": 1234,
"primitivePaymentMethodId": 2,
"paymentMethodName": "Cartão de Crédito",
"accountId": 55,
"receivingFee": 2.5,
"status": 1
},
{
"establishmentPaymentMethodId": 19,
"establishmentId": 1234,
"primitivePaymentMethodId": 3,
"paymentMethodName": "PIX",
"accountId": 55,
"receivingFee": 0,
"status": 1
}
],
"total": 3,
"perPage": 20,
"currentPage": 1,
"lastPage": 1
}
}