Listar pedidos do recebedor

GET

/v1/recipient/{recipient_hash}/orders

Lista, de forma paginada, os pedidos do merchant autenticado em que o recebedor participou do split, do mais recente para o mais antigo. Cada página traz até 100 pedidos.

Para cada pedido são retornados o valor total (total), o valor líquido (liquid_total) e quanto foi destinado ao recebedor (recipient_amount). Se o recebedor tiver mais de um split no mesmo pedido, o pedido aparece uma única vez e recipient_amount traz a soma dos splits.

Valores em centavos

Todos os valores da resposta (total, liquid_total e recipient_amount) são inteiros em centavos.

Autorizações

bearerAuth

Token Bearer do merchant obtido via POST /oauth2/token usando as credenciais do merchant (não do app). Veja Autenticação.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

recipient_hash*

Hash do recebedor (retornado em POST /v1/recipient).

Tipo

string

Obrigatório

Exemplo"d9bd0dae-3274-5e5a-939f-f50d867eb652"

Parâmetros de Consulta

page

Página a ser retornada.

Tipo

integer

Exemplo1

Mínimo

1

Padrão

1

Respostas

Pedidos retornados.

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"order_id": 501,

  

  

  

"total": 30000,

  

  

  

"liquid_total": 28550,

  

  

  

"recipient_amount": 10000

  

  

},

  

  

{

  

  

  

"order_id": 500,

  

  

  

"total": 15000,

  

  

  

"liquid_total": 14230,

  

  

  

"recipient_amount": 4035

  

  

}

  

],

  

"meta": {

  

  

"page": 1,

  

  

"pages": 1,

  

  

"total": 2,

  

  

"limit": 100

  

}

}

GET

/v1/recipient/{recipient_hash}/orders

Exemplos

Sandboxhttps://api.sandboxappmax.com.br

Parâmetros da URL

recipient_hash

Authorization (Bearer)

Cole uma vez e use em todos os playgrounds — o token fica salvo somente nesta aba do navegador e é apagado quando ela for fechada.