Pull the next messages from the configured message source (the correspondent bank simulator on the local stack)

POST/ledger/correspondent/pulls

Reads the configured correspondent message source (the correspondent bank simulator on the local stack) and receives each message in order, advancing the source cursor. A deployed bank configures no source: its correspondents' messages arrive over SWIFT through the gateway.

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Returns

200 OK

cursorstringRequired

follow_up_errorsarray of stringsOptional

processedintegerRequired

receiptsarray of objectsRequired

11 child attributes

idintegerRequired

message_definitionstringOptional

message_sha256stringRequired

network_refstringOptional

outcomestringRequired

reasonstringOptional

received_atstring · date-timeRequired

received_bystringRequired

sender_bicstringOptional

sourcestringRequired

statement_idsarray of stringsRequired

sourcestringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503