Documents

Get account statement

Changed on

Generate an account statement for a date range. Maximum range is 90 days. The statement is built from the real-money ledger, which sandbox transactions never touch, so a sandbox key always receives an empty statement with zero balances. Split credits received from other YuvexPay companies, and the proportional debits taken back on a refund or MED, appear here. Besides GET /v1/balance, this is the only public record a recipient has of a split: the payment itself belongs to the originating company and is not readable by the recipient. The price of a recovery kit appears as a debit labelled Kit de recuperação. The fee of a free order, a payment a coupon covered in full, appears as a debit labelled Taxa de pedido gratuito.

get/v1/documents/statements

Request

Query parameters

startDatestring required

Start date in YYYY-MM-DD format. Interpreted in the America/Sao_Paulo timezone, inclusive from 00:00.

endDatestring required

End date in YYYY-MM-DD format. Interpreted in the America/Sao_Paulo timezone, inclusive through 23:59:59.

format'html' | 'text'

Output format.

Response

Statement generated.

contentstring

The statement content in the requested format.

Changes