Payments
Account-to-account payment initiation, status, and challenge deposit verification
What it returns
A hosted redirect to initiate an A2A bank payment, a status lookup for that transaction, and a challenge-deposit (penny drop) identity check against an IBAN.
Request
POST /payments/initiate
| Field | Required | Description |
|---|---|---|
referenceId | yes | Unique transaction identifier you generate |
transactionDescription | yes | |
returnUrl | yes | Redirect target after payment |
IBAN | yes | Recipient's IBAN |
currency | yes | |
amount | yes | Decimal string |
storedBIC / language / country | no |
POST /payments/status, note this is POST, not GET. { "referenceId": "..." }.
POST /payments/challenge-deposit
| Field | Required | Description |
|---|---|---|
amount | yes | Small verification amount, e.g. "0.10" |
currency | yes | 3-letter code |
description | yes | Alphanumeric and hyphens only |
firstName / lastName | yes | For identity verification |
piiToggle | yes | 0 or 1, whether PII is returned |
nameMatchLogic | yes | exact or fuzzy |
Response
initiate returns requestId and redirectUrl (the hosted payment page). status returns
status (one of PROCESSING, SUCCESS, INITIATED, PENDING, PENDING_EXTERNAL_AUTHORIZATION,
FAILURE_*, SETTLEMENT_*, COMPLETED, FAILED) and statusReasonInformation.
challenge-deposit returns transactionId, status (OK/FAIL), globalResult.overall
(review/pass/fail), globalResult.totalScore, nameMatchScore, and, when
piiToggle is 1, iban, returnedFirstName, returnedLastName.
Decision
The caller decides from status for a payment's progress, and from globalResult.overall plus
nameMatchScore for a challenge deposit's identity match.
Test cases
Pending.
Reference
Umbrella API reference. Third-party sandbox bank credentials for testing: Try it (sign-in required).