Payables

List Payables

Changed on
get/v1/instances/{instance_id}/payables

Request

  • Base URL: https://blindpay.com (the document declares no server; this is the origin it was published from)
  • URL: https://blindpay.com/v1/instances/{instance_id}/payables
  • Auth: HTTP bearer

Path parameters

instance_idstring required
Example:in_000000000000

Query parameters

limit'10' | '50' | '100' | '200' | '500' | '1000'

Number of items to return

Example:50
offset'0' | '10' | '50' | '100' | '200' | '500' | '1000'

Number of items to skip

Example:0
starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list.

Example:pi_123
ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list.

Example:pi_123
status'draft' | 'processing' | 'completed' | 'canceled'
customer_idstring
Example:re_000000000000
customer_namestring
type'boleto' | 'pix_code' | 'invoice'
beneficiary_namestring

Response

List payables with pagination

OR

Example response

{
  "data": [
    {
      "id": "pb_000000000000",
      "instance_id": "in_000000000000",
      "customer_id": "re_000000000000",
      "from": {
        "legal_name": "Empresa de Servicos LTDA",
        "country": "BR",
        "tax_id": "12.345.678/0001-90"
      },
      "to": {
        "legal_name": "Empresa de Servicos LTDA",
        "country": "BR",
        "tax_id": "12.345.678/0001-90"
      },
      "currency": "BRL",
      "line_items": [
        {
          "name": "Consulting services",
          "quantity": 2,
          "price": 150000
        }
      ],
      "note": "August retainer",
      "boleto_barcode": "34191.79001 01043.510047 91020.150008 1 84660000002000",
      "document_file": "https://files.blindpay.com/1712345678901-boleto.pdf",
      "due_date": "2026-08-10",
      "scheduled_at": "2026-08-10T12:00:00.000Z",
      "status": "draft",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "amount": 300000,
      "payout_id": "po_000000000000",
      "bank_account": {
        "type": "ach",
        "beneficiary_name": "Northwind Cloud Services Inc",
        "routing_number": "026009593",
        "account_number": "000123456789",
        "account_type": "checking"
      },
      "last_attempt_status": "failed"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_page": "pi_123",
    "prev_page": "pi_123"
  }
}

Changes

  • 5e4f8b62871cRevision changes
    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status

  • 18850e607f8eRevision changes
    • info

      added the new optional query request parameter beneficiary_name

    • info

      added the new optional query request parameter customer_name

    • info

      added the new optional query request parameter type