Endpoints responsáveis pela gestão dos meios de pagamento do fornecedor.
Utilizados pelos fornecedores que operam com crédito próprio.
Início > Meios de Pagamentos
Versão: 2.0
Meios de Pagamentos
GET Meios de Pagamentos
Endpoint responsável pela consulta dos cadastros de pessoas físicas.
Endpoint GET
URL:
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/v2/meios_de_pagamentos' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
[
{
"id": 1009,
"nome": "Boleto 7/14 dias",
"codigo_condicao_pagamento": "0714D",
"condicao": "7/14",
"pedido_minimo": 200,
"deleted": false
}
]
Elementos da Resposta
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
POST Meios de Pagamentos
Última Atualização: 20/03/2024
O post Meios de Pagamentos permite que seja criado novos meios de pagamentos no fornecedor.
Endpoint POST
Sintaxe da Requisição
Elementos da Requisição
tipo_meio_pagamento
Tipo do meio de pagamento.
Valores aceitos: Boleto, Pedido bonificado, PIX, Pagamento à vista e Pagamento adiantado.
Tipo: String.
nome
Nome do meio de pagamento.
Tipo: String.
codigo_condicao_pagamento
Código da condição de pagamento no fornecedor.
Tipo: String.
condicao
Dias da condição de pagamento.
Exemplos: 7 para referenciar 7 dias, 7/14 para referenciar pagamento parcelado em 7 e 14 dias.
Tipo: String.
pedido_minimo
Valor do pedido mínimo para esse meio de pagamento.
Tipo: Float.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
success
Código de meio de pagamento dos meios de pagamentos que foram criados com sucesso.
Tipo: Array.
failures
Meios de pagamento que falharam na criação.
Tipo: Array.
tipo_meio_pagamento
Tipo do meio de pagamento que falhou.
Tipo: String.
erro
Motivo da criação ter falhado.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
Para que a requisição do método PATCH seja bem-sucedida, é necessário que seja passado os seguintes valores dentro de um json:
PATCH Meios de Pagamentos
Última Atualização: 20/03/2024
O PATCH permite que seja atualizado o pedido mínimo do meio de pagamento
Endpoint PATCH
Sintaxe da Requisição
Elementos da Requisição
codigo_condicao_pagamento
Código da condição de pagamento no fornecedor.
Tipo: String.
pedido_minimo
Valor do pedido mínimo para esse meio de pagamento.
Tipo: Float.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
Para que a requisição do método Delete seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
DELETE Meios de Pagamentos
Última Atualização: 20/03/2024
O DELETE permite que seja removido o meio de pagamento informado.
Endpoint DELETE
Sintaxe da Requisição
Elementos da Requisição
codigo_condicao_pagamento
Código da condição de pagamento no fornecedor.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá: