List Payments

Fetch a list of all payments

Get payments being processed or already completed

GET https://api.finove.com.br/api/v1/merchant/payments

List payments that are being processed or are already completed, depending on the status parameter.

Query Parameters

Name	Type	Description
status	string	Filter for the status of the payments, can be "processing" or "completed". If not present, all payments will be returned, including the ones still awaiting invoice (more on that bellow).

Headers

Name	Type	Description
Authorization	string	Access token received from Authentication API. Needs to be on format "Bearer <YOUR_ACCESS_TOKEN>"

200 Success

{
   data: [
      {
         id: "c34a4345-57e9-43a1-b308-92fe21767023",
         status: "completed",
         currency: "BRL",
         orderId: "4c6b62f3-1f08-4710-a7f1-c8c88b5f8f09",
         orderDescription: "Some description about the order",
         meta: { as send in meta on payment request},
         senderId: "9cbd9fee-3142-4746-b921-37898867f9b3",
         sender: {
            id: "e65b85fc-faf9-48a7-9336-fc18883a626c",
            legalName: "name of the customer",
            cnpj: "16954540000144",
         },
         amount: 267054,
         merchantSubsidyAmount: 10059,
         merchantSubsidyRate: 0.025,
         merchantTotalAmount: 10059,
         paymentType: "bank_transfer",
         invoiceStatus: "submitted",
         monthsUntilFirstPayment: 1,
         firstInstallmendDate: "2019-05-23T12:43:41.758Z",
         paymentMeta: {
            lenderPaidAt: "2019-05-24T12:43:41.758Z"
         },
         merchantRecourseRate: 0.02,
         createdAt: "2019-05-23T12:43:41.758Z",
         updatedAt: "2019-05-23T13:43:41.758Z"
      }
   ],
   count: 1
}

Example requests

Payments that have been finalized by the client but require some action to be 'captured'

/merchant/payments?status=authorized

Payments that have been paid to the merchant's bank account:

/merchant/payments?status=settled