Consulta um método de pagamento por ID.
GET /api/{userId}/establishment/{establishmentId}/paymentmethods/{paymentMethodId}
Parâmetros de rota
| Nome | Tipo | Descrição |
|---|---|---|
userId | number | Identificador do usuário |
establishmentId | number | Identificador do estabelecimento |
paymentMethodId | number | Identificador do método de pagamento |
Requisição
- Método:
GET - Path:
/api/\{userId\}/establishment/\{establishmentId\}/paymentmethods/\{paymentMethodId\} - Headers:
Authorization,Accept: application/json - Autorização: informe o
userIddo token na URL e envie o token no headerAuthorization: Bearer <YOUR_API_TOKEN>(gerados no painel de API do Site Admin).
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": {
"establishmentPaymentMethodId": 18,
"establishmentId": 1234,
"primitivePaymentMethodId": 2,
"paymentMethodName": "Cartão de Crédito",
"accountId": 55,
"receivingDays": 30,
"receivingFee": 2.5,
"anticipationTime": 0,
"anticipationFee": 0,
"nfseGenerate": 0,
"form": [
{ "name": "operator", "value": "Cielo" },
{ "name": "acquirer", "value": "0001" }
],
"status": 1
}
}
Resposta de erro
{
"response": "error",
"data": {
"code": "13001",
"msg": "Método de pagamento não encontrado"
}
}