Skip to main content
GET
Export payment links
The file has every link that matches the same filters and order as the payment-link list, one per row, with eleven columns whose headers are in Portuguese: Identificador (the ID), Nome, Descrição, Status (Ativo, Desativado or Expirado), Produtos (each product as {"produto": <ID>, "quantidadae": <quantity>}, comma-separated), Data de expiração, Método de pagamento, Métodos de pagamento secundários, Primeiro pagamento, Numero de parcelas and Criado em. Dates are written as DD/MM/YYYY HH:mm in Brasília time. A link with no expiration date or no secondary payment methods reads Não disponível there, one with no description an empty Descrição, and one with no number of installments 0. When no link matches, the file has the header and one placeholder row: empty Identificador, Nome and Descrição, Numero de parcelas 0, and Não disponível in every other column. ?type=csv answers a UTF-8 CSV file; ?type=xlsx an Excel workbook, base64-encoded. An export is limited to 50,000 links and 4 MiB (a little less for a CSV with many quotes or line breaks): narrow the filters to export more. Only an admin of the organization, or of the realm, can export them.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of your organization: the one that sells through the links.

Format: UUID

Query Parameters

type
enum<string>
required

File format: csv or xlsx.

Available options:
csv,
xlsx
name
string

Only links whose name contains this text, ignoring case.

Required string length: 1 - 56
status
enum<string>[]

Only links in these statuses. Omit it for every status.


Example (comma-separated list): ?status=ACTIVE,DEACTIVATED

Available options:
ACTIVE,
DEACTIVATED,
EXPIRED
order
enum<string>
default:DESC

Sort direction of the rows.

Available options:
ASC,
DESC
orderBy
enum<string>
default:createdAt

Field the rows are sorted by.

Available options:
name,
createdAt
startAt

Only links created on or after this moment: an ISO 8601 date (read as midnight UTC) or a date-time with an offset.

endAt

Only links created on or before this moment: an ISO 8601 date (read as midnight UTC) or a date-time with an offset.

Response

application/csv — The payment links as a UTF-8 CSV file, when type is csv.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet — The Excel workbook, base64-encoded, when type is xlsx.

The payment links as a UTF-8 CSV file, when type is csv.