--- title: "List all Blockchain Payments" method: GET path: "/v0/blockchain_payments" tags: ["Blockchain Payment"] --- # List all Blockchain Payments `GET /v0/blockchain_payments` List all Blockchain Payments. ## Query parameters - `status` 'created' | 'under_review' | 'awaiting_funds' | 'submitted' | 'posted' | 'rejected' | 'canceled' — The current status of the blockchain payment. - `limit` integer - `starting_after` string - `ending_before` string ## Response `200` List of Blockchain Payment objects - object - `objects` BlockchainPayment[], required - `id` string — The ID of the Blockchain Payment object. - `debtor` BlockchainPaymentDebtorResponse — The source of funds for the transfer, with enriched entity data. - `account_identifier` BlockchainPaymentAccountIdentifier — Identifies the debtor's account. - `type` 'account_number_id' | 'wallet_address', required — The type of account identifier used for the debtor. - `value` string, required — The account identifier value. - `chain` 'ethereum' | 'solana' | 'base' — The blockchain network. - `refund_wallet_address` string — Wallet address for refunds. - `funding_instructions` BlockchainPaymentDebtorFundingInstructions — Instructions for funding the transfer. Present only when the debtor's account_identifier type is wallet_address. - `from_wallet_address` string, required — The wallet address to send funds from. - `chain` string, required — The blockchain network for the funding transaction. - `amount` string, required — The amount to fund. - `currency_code` string, required — The currency code for the funding amount. - `to_wallet_address` string, required — The wallet address to send funds to. - `entity_id` string — The entity ID associated with the debtor. - `creditor` union — The destination of the transfer, including payment rail details and recipient information. The required detail object depends on `payment_rail`. Each rail requires its matching object and rejects detail objects that belong to a different rail: | `payment_rail` | Required detail object | | --- | --- | | `ach` | `ach` | | `wire` | `wire` | | `sepa` | `iban` | | `spei` | `clabe` | | `pix` | exactly one of `pix_key` or `pix_br_code` | | `faster_payments` | `fps` | | `bre_b` | `bre_b` | | `swift` | `swift` | | `co_bank_transfer` | `co_bank_transfer` | | `solana`, `base`, `ethereum` | `wallet` | Provide `individual` when `type` is `individual`, and `business` when `type` is `business`. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor name provided here must closely match the legal name registered on the receiving account — for individuals, an approximate match on first + last name; for businesses, on the legal name or DBA. If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'ach', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch, required — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'wire', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire, required — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'sepa' | 'iban', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban, required — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'spei' | 'clabe', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe, required — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - union - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'ach' | 'wire' | 'sepa' | 'spei' | 'pix' | 'faster_payments' | 'bre_b' | 'swift' | 'co_bank_transfer' | 'solana' | 'base' | 'ethereum' | 'ach_wire' | 'iban' | 'clabe' | 'pix_key' | 'pix_br_code' | 'fps', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey, required — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'ach' | 'wire' | 'sepa' | 'spei' | 'pix' | 'faster_payments' | 'bre_b' | 'swift' | 'co_bank_transfer' | 'solana' | 'base' | 'ethereum' | 'ach_wire' | 'iban' | 'clabe' | 'pix_key' | 'pix_br_code' | 'fps', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode, required — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'faster_payments' | 'fps', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps, required — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'bre_b', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB, required — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'swift', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift, required — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'co_bank_transfer', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer, required — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'solana' | 'base' | 'ethereum', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet, required — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - object — Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference `BlockchainPaymentCreditor`, which selects the correct variant from `payment_rail`. - `payment_rail` 'ach_wire', required — The payment rail used for the creditor payout. - `ach_wire` BlockchainPaymentCreditorAchWire, required — Deprecated: use `ach` or `wire` instead. ACH/Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `ach` BlockchainPaymentCreditorAch — ACH payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `wire` BlockchainPaymentCreditorWire — Wire payment details. - `account_number` string, required — The bank account number. 1–17 alphanumeric characters. - `routing_number` string, required — The routing number. For US-address creditors it is checked against the FedACH directory when that directory is available; a well-formed but unknown routing number is rejected. - `bre_b` BlockchainPaymentCreditorBreB — BRE-B payment details. - `bre_b_key` string, required — The BRE-B key. - `fps` BlockchainPaymentCreditorFps — Faster Payments Service (FPS) payment details. - `account_number` string, required — The bank account number. - `sort_code` string, required — The sort code. - `iban` BlockchainPaymentCreditorIban — IBAN payment details. - `account_number` string, required — The IBAN account number. Validated for the country's IBAN length and the ISO 7064 MOD-97 check digits; a malformed or bad-checksum IBAN is rejected. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string — The BIC/SWIFT code (optional). When provided, must be a valid ISO 9362 BIC (8 or 11 characters). - `swift` BlockchainPaymentCreditorSwift — SWIFT payment details. - `account_number` string, required — The account number. - `country` string, required — ISO 3166-1 alpha-2 country code. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `business_identifier_code` string, required — The BIC/SWIFT code. Must be a valid ISO 9362 BIC (8 or 11 characters). - `role` 'client' | 'parent_company' | 'subsidiary' | 'supplier', required — The role of the creditor in a SWIFT transfer. - `purpose_of_funds` 'intra_group_transfer' | 'invoice_for_goods_and_services', required — The purpose of funds for a SWIFT transfer. - `short_business_desc` string, required — A short description of the business. - `clabe` BlockchainPaymentCreditorClabe — CLABE payment details. - `account_number` string, required — The CLABE account number (18 digits). Validated for length and the Banco de México control-digit checksum; a bad-checksum CLABE is rejected. - `pix_key` BlockchainPaymentCreditorPixKey — PIX key payment details. - `pix_key` string, required — PIX key. For CPF (11 digits) and CNPJ (14 digits), send digits only — strip periods and hyphens (e.g. "12345678909", not "123.456.789-09"). Phone keys use E.164 (+55, a 2-digit area code, then an 8- or 9-digit number), email keys are plain addresses, EVP/random keys are lowercase UUID v4. CPF and CNPJ keys are validated for their check digits; a bad-checksum document is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `pix_br_code` BlockchainPaymentCreditorPixBrCode — PIX BR Code payment details. - `br_code` string, required — PIX BR Code (EMV QR Code payload). Must be a dynamic code — static codes (Point of Initiation Method = 11) are rejected. The payload's CRC-16 checksum is validated; a bad-checksum code is rejected. - `document_number` string, nullable — Optional payer/payee tax document (CPF or CNPJ), digits only. Forwarded to the PIX network; not validated by this API. - `co_bank_transfer` BlockchainPaymentCreditorCoBankTransfer — Colombian COP bank-transfer payment details. For this rail the creditor address country and the creditor agent `country_code` must both be `CO`. - `account_number` string, required — The bank account number. - `bank_code` '1001' | '1002' | '1006' | '1007' | '1009' | '1012' | '1013' | '1019' | '1023' | '1032' | '1040' | '1047' | '1051' | '1052' | '1053' | '1059' | '1060' | '1061' | '1062' | '1063' | '1065' | '1066' | '1067' | '1069' | '1070' | '1071' | '1097' | '1121' | '1283' | '1286' | '1289' | '1292' | '1303' | '1370' | '1507' | '1551' | '1558' | '1637' | '1801' | '1802' | '1803' | '1804' | '1805' | '1808' | '1809' | '1811' | '1812' | '1814' | '1815' | '1816', required — The receiving bank code (Colombian financial-institution code). - `account_type` 'savings' | 'checking' | 'electronic_deposit', required — The type of bank account. - `document_type` 'cc' | 'ce' | 'nit' | 'rut' | 'pa' | 'ppt' | 'ti' | 'rc' | 'te' | 'die' | 'nd', required — The recipient's identification document type. - `document_number` string, required — The recipient's identification document number. - `phone_number` string, required — The recipient's phone number in E.164 format. - `wallet` BlockchainPaymentCreditorWallet — Blockchain wallet payment details. - `wallet_address` string, required — The destination wallet address. - `type` 'individual' | 'business', required — Whether the creditor is an individual or a business. - `individual` BlockchainPaymentCreditorIndividual — Individual creditor details. - `first_name` string, required — First name of the individual. On payment rails where the receiving account is validated (currently `pix` and `spei`), the creditor's first and last name together must closely match the legal name registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `last_name` string, required — Last name of the individual. See `first_name` for the name-matching requirement that applies on account-validated rails (`pix`, `spei`). - `business` BlockchainPaymentCreditorBusiness — Business creditor details. - `business_name` string, required — Name of the business. On payment rails where the receiving account is validated (currently `pix` and `spei`), the business name must closely match the legal name or DBA registered on the receiving account (an approximate match). If the names do not match, the payment is rejected with `rejection_reason: "name in request and name on account do not match"`. On other rails the creditor name is not matched against the account. - `address` BlockchainPaymentAddress, required — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - `creditor_agent` BlockchainPaymentCreditorAgent — Details of the receiving financial institution. Required when `creditor.payment_rail` is not a blockchain network (`solana`, `base`, `ethereum`). When `creditor.payment_rail` is `swift`, `address` is also required. - `bank_name` string, required — Name of the receiving bank. - `country_code` string, required — ISO 3166-1 alpha-2 country code of the receiving bank. Must be a real, assigned country code (unassigned or grouping codes such as `EU`/`ZZ` are rejected — stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `address` BlockchainPaymentAddress — A physical address. - `line_one` string, required — First line of the address. - `line_two` string — Second line of the address (optional). - `city` string, required — City name. - `country` string, required — ISO 3166-1 alpha-2 country code. On the creditor address, the IBAN and SWIFT country, and the creditor agent `country_code`, the value must be a real, assigned country code — unassigned or grouping codes such as `EU`/`ZZ` are rejected (stricter than the `^[A-Z]{2}$` pattern). Sanctioned countries are not accepted. - `state` string — State or province. Required for US ach, wire, and swift addresses; optional otherwise. - `postal_code` string — Postal or zip code. Required for ach, wire, and swift payments to countries that use postal codes; optional for other rails. - `amounts` BlockchainPaymentResponseAmounts — The transfer amounts, currency codes, and settlement details. - `instructed_amount` integer — The transfer amount represented in cents. - `instructed_currency_code` 'USD' | 'USDC' | 'USDB' — The currency code for the instructed amount. The accepted value depends on the debtor's account-identifier type: an `account_number_id` (fiat) debtor must use `USD`; a `wallet_address` debtor must use `USDC` or `USDB`. `USDB` is additionally not available when the creditor or creditor agent is located in an EEA country. - `settlement_currency_code` 'BRL' | 'COP' | 'EUR' | 'GBP' | 'MXN' | 'USD' | 'USDC' | 'USDB' — The currency code for the settlement amount. The value must match the currency the `creditor.payment_rail` settles in, otherwise the payment is rejected at creation: | Rail | Settlement currency | | --- | --- | | `ach`, `wire`, `swift` | `USD` | | `sepa` | `EUR` | | `spei` | `MXN` | | `pix` | `BRL` | | `faster_payments` | `GBP` | | `bre_b`, `co_bank_transfer` | `COP` | - `settlement_amount` integer — The settlement amount represented in cents. - `settlement_exchange_rate` string — The settlement exchange rate. - `payment_purpose` BlockchainPaymentPurpose — The purpose of the transfer. - `type` 'salary_payment' | 'invoice_payment' | 'gift' | 'payment_for_goods' | 'payment_for_services' | 'insurance_premium_payment' | 'interest_payment' | 'loan' | 'loan_repayment' | 'account_management' | 'cash_management_transfer' | 'other' | 'tax_payment' | 'government_payment' | 'benefits_payment' | 'pension_payment' | 'rent_payment' | 'utilities_payment' | 'education_payment' | 'healthcare_payment' | 'charitable_payment' | 'refund' | 'fee_payment' | 'intercompany_transfer' | 'investment_payment' | 'fx_or_treasury' | 'derivatives_payment' | 'card_network_settlement', required — The purpose of the transfer. - `other_details` string — Additional details when purpose type is 'other'. - `reference` string — The reference message for the transfer. For `iban` payments created without a reference, this is a value generated automatically at creation, of the form `Payment via Lead ` (the payment's public ID with underscores replaced by hyphens, e.g. `Payment via Lead blockchain-payment-2x7abc...`). See `reference` on the create request for the per-rail formatting rules. - `status` 'created' | 'under_review' | 'awaiting_funds' | 'submitted' | 'posted' | 'rejected' | 'canceled' — The current status of the blockchain payment. - `rejection_reason` string — Human-readable reason the payment was rejected. Present only when `status` is `rejected`. This is a free-text field. Alongside the documented values below it may carry a return reason passed through from the receiving institution, so do not treat the set of values as closed or match on it programmatically for control flow. Rejections fall into two classes: - **Retryable** — the payment was rejected for a condition that can clear on its own. You may submit the same payment again (a new create request with a new `Idempotency-Key`); it can succeed on a later attempt. - **Terminal** — submitting the same payment again will be rejected for the same reason. You must change the request, or the beneficiary's account must change, before a payment to that beneficiary can succeed. | `rejection_reason` | Meaning | Retryable | | --- | --- | --- | | `name could not be validated` | The beneficiary name on the destination account had not finished verification when the payment was processed. | **Yes** — submit the same payment again; it will succeed once verification completes. | | `name in request and name on account do not match` | The beneficiary name you supplied does not match the name on the destination account. | No — submit a new payment with the correct beneficiary name. | | `account closed` | The beneficiary's destination account is closed. | No — use a different destination account. | | `payment could not be processed` | The payment could not be completed. | No | - `cancelation_reason` string — Reason the transfer was canceled. Present only if status is canceled. - `created_at` string, date-time — ISO 8601 format timestamp representing when the blockchain payment was created. - `updated_at` string, date-time — ISO 8601 format timestamp representing when the blockchain payment was last updated. - `has_more` boolean, required — Indicates whether more results are available. ## Other responses - `400` — Invalid query parameter value. - `401` — Missing or invalid authentication token. - `429` — Too many requests. Please retry after some time. - `500` — Unexpected server error. --- [API](https://skmtc.net/lead/apis/lead-bank.md) · [All operations](https://skmtc.net/lead/apis/lead-bank/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lead/lead-bank/revisions/25c2a92d55e2/schema)