POST
/
payments
/
challenge-deposit
curl --request POST \
  --url https://api-umbrella.io/api/services/payments/challenge-deposit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "0.10",
  "currency": "EUR",
  "referenceId": "unique-ref-id-123",
  "firstName": "John",
  "lastName": "Doe",
  "piiToggle": 1,
  "nameMatchLogic": "fuzzy"
}'
{
  "transactionId": "e5c81c78-272b-4307-9197-3ace19109fd3",
  "referenceId": "unique-ref-id-123",
  "status": "OK",
  "globalResult": {
    "overall": "review",
    "totalScore": 85
  },
  "nameMatchScore": 85,
  "iban": "DE44500105175407324931",
  "returnedFirstName": "John",
  "returnedLastName": "Doe"
}

For a usage description of the Payment Initiation Service, please refer to the Payment Services page.

​
Endpoint

POST /payments/challenge-deposit

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
amount
string

Small amount sent for verification.

Example:

"0.10"

​
currency
string

ISO 4217 currency code.

Example:

"EUR"

​
referenceId
string

Unique identifier for the transaction.

Example:

"unique-ref-id-123"

​
firstName
string

First name for identity verification.

Example:

"John"

​
lastName
string

Last name for identity verification.

Example:

"Doe"

​
piiToggle
integer

Determines if PII details should be returned (0 or 1).

Example:

1

​
nameMatchLogic
string

Name matching logic type.

Example:

"fuzzy"

Response

200
application/json
Successfully initiated challenge deposit.
​
transactionId
string

Unique identifier for the transaction.

Example:

"e5c81c78-272b-4307-9197-3ace19109fd3"

​
referenceId
string

The reference ID sent in the request.

Example:

"unique-ref-id-123"

​
status
string

Status of the challenge deposit (e.g., OK, FAIL).

Example:

"OK"

​
globalResult
object
​
nameMatchScore
integer

Score (0-100) indicating how well names matched.

Example:

85

​
iban
string

Verified IBAN if piiToggle = 1, otherwise omitted.

Example:

"DE44500105175407324931"

​
returnedFirstName
string

First name returned from verification if available.

Example:

"John"

​
returnedLastName
string

Last name returned from verification if available.

Example:

"Doe"