Payables

Create Payable

Changed on Oct 15, 2026

post/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

Headers

Idempotency-Keystring

Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

customer_idstring required

currency'BRL' | 'USD' | 'MXN' | 'COP' | 'ARS' | 'EUR' | 'GBP' required

ISO 4217 currency code of the payable.

notestring nullable

discountinteger nullable

Discount in cents of the payable currency.

taxesinteger nullable

Taxes in cents of the payable currency.

boleto_barcodestring nullable

Boleto or arrecadação code (linha digitável or barcode).

pix_qrcodestring nullable

PIX copia e cola (EMV) payload.

document_filestring uri nullable

The boleto or invoice document, as a file URL returned by POST /upload with bucket documents. Not accepted for PIX payables. Read it through POST /presign.

due_datestring nullable

scheduled_atstring nullable

When to pay this payable automatically. Not executed yet: stored for the upcoming scheduling feature.

Example request

{
  "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",
  "bank_account": {
    "type": "wire",
    "name": "Bank Account Name",
    "status": "verifying",
    "recipient_relationship": "vendor_or_supplier",
    "swift_payment_code": "bh_swift_afl",
    "pix_key": "14947677768",
    "beneficiary_name": "Individual full name or business name",
    "routing_number": "012345678",
    "account_number": "1001001234",
    "account_type": "checking",
    "account_class": "individual",
    "address_line_1": "Address line 1",
    "address_line_2": "Address line 2",
    "city": "City",
    "state_province_region": "State/Province/Region",
    "country": "US",
    "postal_code": "Postal code",
    "checkbook_account_id": "dc809ff8f4d3417d83e5697e76f0b88a",
    "checkbook_user_key": "d84fd0dc-3882-4de9-97f8-656730214619",
    "onemoney_external_account_id": "ex_000000000000",
    "pix_safe_bank_code": "00416968",
    "pix_safe_branch_code": "0001",
    "pix_safe_cpf_cnpj": "12345678901",
    "ted_bank_code": "033",
    "ted_branch_code": "0001",
    "ted_cpf_cnpj": "12345678901",
    "spei_protocol": "clabe",
    "spei_institution_code": "40002",
    "spei_clabe": "5482347403740546",
    "transfers_type": "CVU",
    "transfers_account": "BM123123123123",
    "ach_cop_beneficiary_first_name": "Fernando",
    "ach_cop_beneficiary_last_name": "Guzman Alarcón",
    "ach_cop_document_id": "1661105408",
    "ach_cop_document_type": "CC",
    "ach_cop_email": "fernando.guzman@gmail.com",
    "ach_cop_bank_code": "051",
    "ach_cop_bank_account": "12345678",
    "swift_code_bic": "123456789",
    "swift_account_holder_name": "John Doe",
    "swift_account_number_iban": "123456789",
    "swift_beneficiary_address_line_1": "123 MAIN STREET SUITE 100",
    "swift_beneficiary_address_line_2": "BUILDING A FLOOR 5",
    "swift_beneficiary_country": "MX",
    "swift_beneficiary_city": "MEXICO CITY",
    "swift_beneficiary_state_province_region": "MX",
    "swift_beneficiary_postal_code": "11530",
    "swift_bank_name": "Banco Regional SA",
    "swift_bank_address_line_1": "123 Main Street, Suite 100, Downtown District, City Center CP 12345",
    "swift_bank_address_line_2": "456 Oak Avenue, Building 7, Financial District, Business Center CP 54321",
    "swift_bank_country": "MX",
    "swift_bank_city": "City",
    "swift_bank_state_province_region": "District",
    "swift_bank_postal_code": "11530",
    "swift_ifsc_branch_code": "BARB0AHIMCI",
    "swift_intermediary_bank_account_number_iban": "123456789",
    "swift_intermediary_bank_name": "Banco Regional SA",
    "swift_intermediary_bank_country": "US",
    "sepa_iban": "DE89370400440532013000",
    "sepa_beneficiary_bic": "TRWIBEB1XXX",
    "sepa_beneficiary_legal_name": "Hans Müller",
    "sepa_beneficiary_address_line_1": "Friedrichstraße 12",
    "sepa_beneficiary_address_line_2": "Apt 4B",
    "sepa_beneficiary_city": "Berlin",
    "sepa_beneficiary_state_province_region": "Berlin",
    "sepa_beneficiary_postal_code": "10117",
    "sepa_beneficiary_country": "DE",
    "faster_payments_sort_code": "040004",
    "faster_payments_account_number": "12345678",
    "faster_payments_beneficiary_legal_name": "Oliver Smith",
    "faster_payments_beneficiary_address_line_1": "221B Baker Street",
    "faster_payments_beneficiary_address_line_2": "Flat 2",
    "faster_payments_beneficiary_city": "London",
    "faster_payments_beneficiary_state_province_region": "Greater London",
    "faster_payments_beneficiary_postal_code": "NW1 6XE",
    "faster_payments_beneficiary_country": "GB",
    "business_industry": "541511",
    "phone_number": "+13055555555",
    "tax_id": "536804398"
  }
}

Response

Payable created as a draft. Pay it by creating a payout quote with payable_id.

idstring required

instance_idstring required

customer_idstring required

currency'BRL' | 'USD' | 'MXN' | 'COP' | 'ARS' | 'EUR' | 'GBP' required

ISO 4217 currency code of the payable.

notestring nullable

discountinteger nullable

Discount in cents of the payable currency.

taxesinteger nullable

Taxes in cents of the payable currency.

boleto_barcodestring nullable

Boleto or arrecadação code (linha digitável or barcode).

pix_qrcodestring nullable

PIX copia e cola (EMV) payload.

document_filestring uri nullable

The boleto or invoice document, as a file URL returned by POST /upload with bucket documents. Not accepted for PIX payables. Read it through POST /presign.

due_datestring nullable

scheduled_atstring nullable

When to pay this payable automatically. Not executed yet: stored for the upcoming scheduling feature.

status'draft' | 'processing' | 'completed' | 'canceled' required

draft until a payout executes this payable, processing while one is in flight, completed when paid, canceled when a draft is deleted. A failed or refunded attempt returns it to draft; follow the payout for the attempt detail.

created_atstring date-time nullable

updated_atstring date-time nullable

amountinteger nullable required

Derived total in cents: line item sum plus taxes minus discount. For boleto/PIX the rail amount is re-resolved from the code at quote time and can differ (fines, interest).

payout_idstring nullable

The payout executing this payable, once one exists. Null while the payable is a draft.

last_attempt_status'failed' | 'refunded' nullable

Why the payable returned to draft: the attempt in payout_id failed before funding or was refunded after it. Set only on that payable.update event; follow the payout for the detail.

first_namestring nullable

last_namestring nullable

legal_namestring nullable

Example response

{
  "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"
}

Changes

Oct 15, 20265e4f8b62871c Revision changes
- warning
  added the new GBP enum value to the response property for the response status
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new GBP enum value to the request property
- info
  added the new faster_payments enum value to the request property /
Oct 14, 20261250e63e2b30 Revision changes
- info
  added the new 111120 enum value to the request property /
- info
  added the new 111219 enum value to the request property /
- info
  added the new 111336 enum value to the request property /
- info
  added the new 111421 enum value to the request property /
- info
  added the new 112111 enum value to the request property /
- info
  added the new 112210 enum value to the request property /
- info
  added the new 112310 enum value to the request property /
- info
  added the new 112410 enum value to the request property /
- info
  added the new 112519 enum value to the request property /
- info
  added the new 112990 enum value to the request property /
- info
  added the new 113110 enum value to the request property /
- info
  added the new 113210 enum value to the request property /
- info
  added the new 114119 enum value to the request property /
- info
  added the new 114210 enum value to the request property /
- info
  added the new 115113 enum value to the request property /
- info
  added the new 115210 enum value to the request property /
- info
  added the new 115310 enum value to the request property /
- info
  added the new 211130 enum value to the request property /
- info
  added the new 212290 enum value to the request property /
- info
  added the new 212390 enum value to the request property /
- info
  added the new 213113 enum value to the request property /
- info
  added the new 221122 enum value to the request property /
- info
  added the new 221210 enum value to the request property /
- info
  added the new 221320 enum value to the request property /
- info
  added the new 236118 enum value to the request property /
- info
  added the new 236210 enum value to the request property /
- info
  added the new 237130 enum value to the request property /
- info
  added the new 237210 enum value to the request property /
- info
  added the new 237990 enum value to the request property /
- info
  added the new 238191 enum value to the request property /
- info
  added the new 238391 enum value to the request property /
- info
  added the new 238991 enum value to the request property /
- info
  added the new 311119 enum value to the request property /
- info
  added the new 311212 enum value to the request property /
- info
  added the new 311314 enum value to the request property /
- info
  added the new 311422 enum value to the request property /
- info
  added the new 311511 enum value to the request property /
- info
  added the new 311612 enum value to the request property /
- info
  added the new 311710 enum value to the request property /
- info
  added the new 311811 enum value to the request property /
- info
  added the new 311999 enum value to the request property /
- info
  added the new 312111 enum value to the request property /
- info
  added the new 312230 enum value to the request property /
- info
  added the new 313240 enum value to the request property /
- info
  added the new 313310 enum value to the request property /
- info
  added the new 314120 enum value to the request property /
- info
  added the new 314999 enum value to the request property /
- info
  added the new 315120 enum value to the request property /
- info
  added the new 315250 enum value to the request property /
- info
  added the new 316110 enum value to the request property /
- info
  added the new 316210 enum value to the request property /
- info
  added the new 316990 enum value to the request property /
- info
  added the new 321113 enum value to the request property /
- info
  added the new 321211 enum value to the request property /
- info
  added the new 321918 enum value to the request property /
- info
  added the new 322120 enum value to the request property /
- info
  added the new 322299 enum value to the request property /
- info
  added the new 323120 enum value to the request property /
- info
  added the new 324110 enum value to the request property /
- info
  added the new 325180 enum value to the request property /
- info
  added the new 325220 enum value to the request property /
- info
  added the new 325320 enum value to the request property /
- info
  added the new 325510 enum value to the request property /
- info
  added the new 325611 enum value to the request property /
- info
  added the new 325998 enum value to the request property /
- info
  added the new 326111 enum value to the request property /
- info
  added the new 326220 enum value to the request property /
- info
  added the new 327120 enum value to the request property /
- info
  added the new 327212 enum value to the request property /
- info
  added the new 327310 enum value to the request property /
- info
  added the new 327410 enum value to the request property /
- info
  added the new 327999 enum value to the request property /
- info
  added the new 331110 enum value to the request property /
- info
  added the new 331210 enum value to the request property /
- info
  added the new 331313 enum value to the request property /
- info
  added the new 331410 enum value to the request property /
- info
  added the new 331511 enum value to the request property /
- info
  added the new 332111 enum value to the request property /
- info
  added the new 332215 enum value to the request property /
- info
  added the new 332311 enum value to the request property /
- info
  added the new 332410 enum value to the request property /
- info
  added the new 332510 enum value to the request property /
- info
  added the new 332613 enum value to the request property /
- info
  added the new 332710 enum value to the request property /
- info
  added the new 332812 enum value to the request property /
- info
  added the new 332999 enum value to the request property /
- info
  added the new 333111 enum value to the request property /
- info
  added the new 333248 enum value to the request property /
- info
  added the new 333310 enum value to the request property /
- info
  added the new 333413 enum value to the request property /
- info
  added the new 333517 enum value to the request property /
- info
  added the new 333611 enum value to the request property /
- info
  added the new 333618 enum value to the request property /
- info
  added the new 334310 enum value to the request property /
- info
  added the new 334413 enum value to the request property /
- info
  added the new 334511 enum value to the request property /
- info
  added the new 334610 enum value to the request property /
- info
  added the new 335131 enum value to the request property /
- info
  added the new 335220 enum value to the request property /
- info
  added the new 335311 enum value to the request property /
- info
  added the new 335999 enum value to the request property /
- info
  added the new 336211 enum value to the request property /
- info
  added the new 336412 enum value to the request property /
- info
  added the new 336510 enum value to the request property /
- info
  added the new 336611 enum value to the request property /
- info
  added the new 336999 enum value to the request property /
- info
  added the new 337122 enum value to the request property /
- info
  added the new 337214 enum value to the request property /
- info
  added the new 337920 enum value to the request property /
- info
  added the new 339999 enum value to the request property /
- info
  added the new 423120 enum value to the request property /
- info
  added the new 423220 enum value to the request property /
- info
  added the new 423310 enum value to the request property /
- info
  added the new 423490 enum value to the request property /
- info
  added the new 423520 enum value to the request property /
- info
  added the new 423620 enum value to the request property /
- info
  added the new 423710 enum value to the request property /
- info
  added the new 423990 enum value to the request property /
- info
  added the new 424110 enum value to the request property /
- info
  added the new 424310 enum value to the request property /
- info
  added the new 424490 enum value to the request property /
- info
  added the new 424590 enum value to the request property /
- info
  added the new 424720 enum value to the request property /
- info
  added the new 424820 enum value to the request property /
- info
  added the new 425120 enum value to the request property /
- info
  added the new 441110 enum value to the request property /
- info
  added the new 441227 enum value to the request property /
- info
  added the new 441330 enum value to the request property /
- info
  added the new 444180 enum value to the request property /
- info
  added the new 444240 enum value to the request property /
- info
  added the new 445132 enum value to the request property /
- info
  added the new 445298 enum value to the request property /
- info
  added the new 449110 enum value to the request property /
- info
  added the new 449129 enum value to the request property /
- info
  added the new 454390 enum value to the request property /
- info
  added the new 458320 enum value to the request property /
- info
  added the new 459310 enum value to the request property /
- info
  added the new 459410 enum value to the request property /
- info
  added the new 459510 enum value to the request property /
- info
  added the new 459999 enum value to the request property /
- info
  added the new 481211 enum value to the request property /
- info
  added the new 482111 enum value to the request property /
- info
  added the new 483112 enum value to the request property /
- info
  added the new 483212 enum value to the request property /
- info
  added the new 484110 enum value to the request property /
- info
  added the new 484220 enum value to the request property /
- info
  added the new 485119 enum value to the request property /
- info
  added the new 485310 enum value to the request property /
- info
  added the new 485410 enum value to the request property /
- info
  added the new 485510 enum value to the request property /
- info
  added the new 485999 enum value to the request property /
- info
  added the new 486110 enum value to the request property /
- info
  added the new 486210 enum value to the request property /
- info
  added the new 486990 enum value to the request property /
- info
  added the new 487110 enum value to the request property /
- info
  added the new 487210 enum value to the request property /
- info
  added the new 487990 enum value to the request property /
- info
  added the new 488190 enum value to the request property /
- info
  added the new 488210 enum value to the request property /
- info
  added the new 488390 enum value to the request property /
- info
  added the new 488490 enum value to the request property /
- info
  added the new 488999 enum value to the request property /
- info
  added the new 492110 enum value to the request property /
- info
  added the new 492210 enum value to the request property /
- info
  added the new 493190 enum value to the request property /
- info
  added the new 512199 enum value to the request property /
- info
  added the new 512290 enum value to the request property /
- info
  added the new 515210 enum value to the request property /
- info
  added the new 517810 enum value to the request property /
- info
  added the new 521110 enum value to the request property /
- info
  added the new 522130 enum value to the request property /
- info
  added the new 522298 enum value to the request property /
- info
  added the new 522390 enum value to the request property /
- info
  added the new 523210 enum value to the request property /
- info
  added the new 524128 enum value to the request property /
- info
  added the new 524298 enum value to the request property /
- info
  added the new 525190 enum value to the request property /
- info
  added the new 525910 enum value to the request property /
- info
  added the new 532289 enum value to the request property /
- info
  added the new 532310 enum value to the request property /
- info
  added the new 532490 enum value to the request property /
- info
  added the new 533110 enum value to the request property /
- info
  added the new 541199 enum value to the request property /
- info
  added the new 541310 enum value to the request property /
- info
  added the new 541490 enum value to the request property /
- info
  added the new 541690 enum value to the request property /
- info
  added the new 541720 enum value to the request property /
- info
  added the new 551114 enum value to the request property /
- info
  added the new 561110 enum value to the request property /
- info
  added the new 561210 enum value to the request property /
- info
  added the new 561599 enum value to the request property /
- info
  added the new 561611 enum value to the request property /
- info
  added the new 561790 enum value to the request property /
- info
  added the new 561990 enum value to the request property /
- info
  added the new 562211 enum value to the request property /
- info
  added the new 562998 enum value to the request property /
- info
  added the new 611210 enum value to the request property /
- info
  added the new 611420 enum value to the request property /
- info
  added the new 611519 enum value to the request property /
- info
  added the new 611699 enum value to the request property /
- info
  added the new 621498 enum value to the request property /
- info
  added the new 621610 enum value to the request property /
- info
  added the new 621999 enum value to the request property /
- info
  added the new 622210 enum value to the request property /
- info
  added the new 622310 enum value to the request property /
- info
  added the new 623210 enum value to the request property /
- info
  added the new 623311 enum value to the request property /
- info
  added the new 623990 enum value to the request property /
- info
  added the new 624190 enum value to the request property /
- info
  added the new 624230 enum value to the request property /
- info
  added the new 624310 enum value to the request property /
- info
  added the new 711190 enum value to the request property /
- info
  added the new 711219 enum value to the request property /
- info
  added the new 711310 enum value to the request property /
- info
  added the new 712120 enum value to the request property /
- info
  added the new 713290 enum value to the request property /
- info
  added the new 713990 enum value to the request property /
- info
  added the new 721199 enum value to the request property /
- info
  added the new 721211 enum value to the request property /
- info
  added the new 721310 enum value to the request property /
- info
  added the new 722310 enum value to the request property /
- info
  added the new 722410 enum value to the request property /
- info
  added the new 811198 enum value to the request property /
- info
  added the new 811310 enum value to the request property /
- info
  added the new 811411 enum value to the request property /
- info
  added the new 812210 enum value to the request property /
- info
  added the new 812320 enum value to the request property /
- info
  added the new 812990 enum value to the request property /
- info
  added the new 813319 enum value to the request property /
- info
  added the new 813410 enum value to the request property /
- info
  added the new 813930 enum value to the request property /
- info
  added the new 814110 enum value to the request property /
- info
  added the new 921140 enum value to the request property /
- info
  added the new 922190 enum value to the request property /
- info
  added the new 923130 enum value to the request property /
- info
  added the new 924110 enum value to the request property /
- info
  added the new 925120 enum value to the request property /
- info
  added the new 926110 enum value to the request property /
- info
  added the new 927110 enum value to the request property /
- info
  added the new 928110 enum value to the request property /

Operation history (5 revisions)