Look up a transfer with the bank

POSThttps://api.checkslip.com/api/slips/lookup

API key

Send the QR text read from the slip, or the slip image, and we ask the sending bank for the transfer it holds and return that data. We return what the bank has; the decision to accept the payment is yours, against your own order. The result is in outcome, e.g. FOUND, NOT_FOUND, DUPLICATE, PENDING. One credit is used only when outcome is FOUND. We never store the slip image, only the QR text. Images up to 10 MB and 50 megapixels, JPEG, PNG or WebP only (HEIC, GIF and PDF get 422 invalid-file, no credit). Always send an Idempotency-Key; a retry with the same value returns the same result and never charges twice. Needs an API key with slip:lookup.

Parameters

FieldInTypeRequired
Idempotency-Keyheaderstringno

Request body

application/json Also accepts: multipart/form-data

FieldTypeRequired
qrstringyes
client_referencestring | nullno

Responses

200 application/json

FieldTypeRequired
request_idstring (uuid)yes
outcomeFOUND | NOT_FOUND | DUPLICATE | PENDINGyes
checked_atstring (date-time)yes
slipSlip | SlipSummaryyes
duplicate_ofDuplicateOfno
duplicate_of.request_idstring (uuid)yes
duplicate_of.checked_atstring (date-time)yes
client_referencestring | nullno

202 application/json

FieldTypeRequired
request_idstring (uuid)yes
outcomeFOUND | NOT_FOUND | DUPLICATE | PENDINGyes
checked_atstring (date-time)yes
slipSlip | SlipSummaryyes
duplicate_ofDuplicateOfno
duplicate_of.request_idstring (uuid)yes
duplicate_of.checked_atstring (date-time)yes
client_referencestring | nullno

Possible errors

400401402403409413415422429500503

An error as Problem Details. All codes are listed at Error codes