Obter transações

Xsolla Developers

Obter transaçõesServer-sideAdmin

get/merchants/{merchant_id}/reports/transactions/registry.{format}

Retorna a lista de informações detalhadas sobre todas as transações bem- sucedidas e canceladas em um período específico. Em resposta, você obtém informações sobre pagamentos, incluindo dados sobre as taxas, tarifas, bem como pedido e usuário. Você pode obter a lista nos formatos JSON e CSV. Você pode usar essa chamada API para realizar a reconciliação financeira.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer ID de comerciante.
format required	string Formato da data. Enum: "json" "csv" "xls"

query Parameters

datetime_from

required

string <datetime>

O início do período no formato AAAA-MM-DD. Não é obrigatório se ao menos um dos seguintes parâmetros for passado:

limit
transfer_id
report_id

Example: datetime_from=2023-02-08

datetime_to

required

string <datetime>

O fim do período no formato AAAA-MM-DD. Não é obrigatório se ao menos um dos seguintes parâmetros for passado:

limit
transfer_id
report_id

A diferença entre datetime_from e datetime_to não pode ser maior do que 92 dias.

Example: datetime_to=2023-03-08

in_transfer_currency

required

integer

Converte todos os dados financeiros à moeda do pagamento (a moeda de pagamento é usada por padrão). Não é obrigatório se ao menos um dos seguintes parâmetros for passado:

transfer_id
report_id

show_total

boolean

Se a quantia total das transações deve ser incluída ou não no relatório. Disponível para exportar apenas no formato CSV. true por padrão.

merchant_of_records

string or null

Comerciante do Registro. Pode ser xsolla, merchant, ou não especificado. Se for merchant, retorna as transações feitas através dos portais do parceiro. Se for xsolla, retorna as transações que não foram feitas pelos portais do parceiro. Se não for especificado, retorna todas as transações.

Enum:	Description
merchant	Retorna as transações feitas pelos portais do parceiro.
xsolla	Retorna as transações que não foram feitas pelos portais do parceiro.

project_id

integer

ID do projeto.

show_dry_run

boolean

Se transações de teste devem ser incluídas ou não.

transfer_id

integer

ID de pagamento.

report_id

integer

ID de relatório financeiro.

offset

integer

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

limit

integer

Limite da quantidade de transações exibidas na página. Se esse parâmetro for passado, você não precisará passar os parâmetros datetime_from e datetime_to.

status

string

Status da transação.

Enum: "done" "canceled" "error"

Responses

200

A lista de transações foi retornada com sucesso.

Request samples

curl -i -X GET \
  -u <merchant_id>:<api_key> \
  'https://api.xsolla.com/merchant/v3/merchants/{merchant_id}/reports/transactions/registry.{format}?datetime_from=string&datetime_to=string&in_transfer_currency=0&show_total=true&merchant_of_records=xsolla&project_id=0&show_dry_run=true&transfer_id=0&report_id=0&offset=0&limit=0&status=done'

Response samples

application/json

[{"payment_details": {"chargebackPenalty": {"amount": 0
},
"commission_agent": {"amount": 0,
"percent": 0
},
"commission_agent_fixed": 0,
"commission_ps": {"amount": 0,
"fixed_amount": 0,
"percent": 0
},
"commission_ps_from_vat": {"amount": 0
},
"commission_user": {"amount": 0.01,
"percent": 33.33
},
"commission_xsolla": {"amount": 0,
"fixed_amount": 0,
"percent": 5
},
"cpa_network_commission": {"amount": 0,
"percent": 0
},
"direct_wht": {"amount": 0,
"percent": 0
},
"payment": {"amount": 0.03,
"amount_from_ps": 0,
"currency": "USD"
},
"payout": {"amount": 0.02,
"amount_from_ps": 0,
"currency": "RUB",
"fx_rate": 64.1386407767,
"percent": 100
},
"refundPenalty": {"amount": 0
},
"repatriation_costs": {"amount": 0,
"percent": 0
},
"sales_tax": {"amount": 0,
"percent": 0
},
"vat": {"amount": 0,
"percent": 0,
"user_amount": 0,
"user_percent": 0
}
},
"purchase": {"friend": {"email": null,
"user_id": null
},
"items_amount": 1,
"pin_codes": {"amount": null,
"content": null,
"currency": null
},
"purchase_amount": 0.02,
"simple_checkout": {"amount": null,
"currency": null
},
"subscription": {"name": null,
"plan_id": null,
"product_id": null,
"product_name": null,
"subscription_id": null
},
"virtual_currency": {"amount": 0.02,
"currency": "USD"
},
"virtual_currency_amount": 1,
"virtual_items": {"amount": null,
"content": null,
"currency": null
}
},
"transaction": {"custom_parameters": null,
"direct_account": 0,
"dry_run": 0,
"external_id": null,
"id": 418756634,
"payment_method": {"class": "Digital Payment Methods",
"id": 2760,
"name": "Your Balance"
},
"project": {"id": 21092,
"name": "Smith"
},
"refund_reason": null,
"refund_reason_comment": null,
"status": "done",
"transfer_date": "2019-02-11T13:32:00+03:00"
},
"user": {"country": "US",
"custom": null,
"email": "email@example.com",
"id": "smith123",
"ip": "209.11.22.33",
"marketplace": "Pay Station",
"name": "Tom",
"phone": null
},
"user_balance": {"payment_currency": {"deduction_amount": 0,
"payout_amount_from_balance": 0.02,
"purchase_amount_from_balance": 0.02
}
}
}
]