Pagamento

Recuperar um pagamento

Retorna um pagamento específico.

Escopo requerido

Valor	Descrição
open:order-payment:read	Permite acessar um pagamento

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatório
order_id	uuid4	Identificação do pedido que esse pagamento pertence	Sim
id	uuid4	Identificação da ficha de dados	Sim

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/v0/orders/{order_id}/payments/{id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
    "id": "02a6c7f5-4d0f-4f4f-b8ea-2adb3bc780a9",
    "status": "approved",
    "status_at": "2023-07-01 10:30:00",
    "created_at": "2022-10-28T17:29:47Z",
    "sent_at": "2022-10-28T17:29:47Z",
    "order": {
        "code": "1234567890123456",
        "id": "778c618d-1bac-457a-ad78-d6695ed5d626",
        "reference": "https://api.magalu.com/v0/orders/778c618d-1bac-457a-ad78-d6695ed5d626"
    },
    "extras": {}
}

Códigos de retorno

Nota

Para maiores informações sobre códigos de retorno, Código de retorno.

Código	Descrição
200	OK
401	Unauthorized
403	Forbidden
404	Not Found
422	Unprocessable Entity
500	Internal Server Error
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout

Recuperar uma lista de pagamentos

Retorna todos os pagamentos disponíveis.

Nota

Este endpoint implementa paginação, ordenação e filtros. Para saber mais, consulte Fazer solicitações paginadas e parâmetros de consulta.

Escopo requerido

Valor	Descrição
open:order-payment:read	Permite listar as fichas de dados

Parâmetros de consulta

Campo	Tipo	Descrição	Obrigatório
order.code	string	Retorna todos os pagamentos referentes ao pedido do código informado	Não
order.id	uuid4	Retorna todos os pagamentos referentes ao id do pedido informado	Não
status	string	Retorna todos os pagamentos com o status informado	Não

Parâmetros de ordenação

Campo	Descrição	Obrigatório
created_at	Ordernar por data de criação dos pagamentos.	Não
status_at	Ordernar por data de alteração do status de pagamento.	Não

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/v0/orders/payments' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "meta": {},
  "results": [{
    "id": "02a6c7f5-4d0f-4f4f-b8ea-2adb3bc780a9",
    "status": "approved",
    "created_at": "2022-10-28T17:29:47Z",
    "order": {
      "code": "1234567890123456",
      "id": "778c618d-1bac-457a-ad78-d6695ed5d626"
    }
  }]
}

Códigos de retorno

Nota

Para maiores informações sobre códigos de retorno, Código de retorno.

Código	Descrição
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
422	Unprocessable Entity
500	Internal Server Error
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout