Counterparty account requisites
Generates and retrieves detailed counterparty account requisites report. This endpoint provides comprehensive banking and account information for counterparties (vendors, suppliers, partners) in various formats for payment processing and documentation purposes.
Endpoint: GET /v2/report/counterparty/account/{accountId}
Link:
Request
Path Parameters
Parameter
Type
Description
Required
Example
accountId
string
Counterparty Account ID to generate requisites for.
Yes
"UE0OyTy7pNcS"
Query Parameters
Parameter
Type
Description
Required
Allowed Values
Default
option.format
string
Output format for the report.
No
Unknown, PDF, XLSX
Unknown
Headers
Key
Value
Required
Authorization
Bearer <JWT>
Yes
Accept
application/json or format-specific
Yes
Response (200 OK)
Returns the counterparty account requisites report in the requested format, either as base64-encoded data or raw file content.
Response Fields
Field
Type
Description
Example
data
string
Report content as base64-encoded bytes or raw data.
"JVBERi0xLjQK..."
name
string
Report file name.
"counterparty_requisites_UE0OyTy7pNcS_20240522.pdf"
Typical Report Content
Banking Details
Bank name
Bank address
SWIFT/BIC code
ABA/Routing number (for US accounts)
IBAN (for international accounts)
Sort code/Branch code
Bank identifier code
Or other type of requisites, depending on the currency and payment rails.
Error Responses
Counterparty Account Not Found:
json
Unauthorized:
json
Invalid Format:
json
Access Denied:
json
Notes
Format Options:
PDF: Professional document format suitable for printing and official documentationXLSX: Spreadsheet format for data analysis and integration with accounting systemsUnknown: Default JSON format with base64-encoded data
Data Security:
Counterparty financial information is protected
Access restricted to authorized users only
Usage Scenarios:
Supplier/vendor payment setup
Partner account documentation
Payment processing instructions
Compliance and audit requirements
International wire transfer setup
Common Use Cases:
Setting up supplier payments
Documenting partner banking information
Payment processing automation
Integration with accounting/ERP systems
Format Recommendations:
PDF: For official documents and printing (most common)
XLSX: For data processing and bulk payment setups
Report Features:
Timestamped generation
Examples
Real request
Real response
200OK
File example
Last updated

