Payments API ReferenceInternal

Bank Income Callback (Internal)

Receives bank income notifications from external systems. Requires api-key authentication via api-key header. The payload is queued for processing and validation.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-admin-api-keystringRequired

Request

This endpoint expects an object.
movementIdstringRequired
Movement ID from psp provider
txIdstringRequired
Transaction ID
amountdoubleRequired
Amount of the bank income
externalSystemNotifierIdstringRequired
External system notifier ID
bankEntityCodestringRequired
Bank entity code
datestringRequired

Date of the bank income in YYYY-MM-DD format

countryCodestringRequired

Country code (three-letter ISO)

currencyCodestringRequired
Currency code
externalSystemUniqueCodestringRequired
External system unique code
paymentMethodstringRequired
Payment method
documentTypestringRequired

Document type (e.g., RUT, CUIT, CNPJ)

documentNumberstringRequired
Document number
bankAccountNumberstringRequired
Bank account number
orchestratorServicestringRequired
Orchestrator service
bankAccountNumberEntitystringRequired
Bank account number entity code

Response

Bank income notification accepted
referenceIdstring or null

Errors