POST
/
payments
/
challenge-deposit
Initiate Challenge Deposit
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/payments/challenge-deposit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "0.10",
  "currency": "EUR",
  "description": "merchantId19887-65",
  "firstName": "John",
  "lastName": "Doe",
  "piiToggle": 1,
  "nameMatchLogic": "fuzzy"
}'
{
  "transactionId": "e5c81c78-272b-4307-9197-3ace19109fd3",
  "description": "merchantId19887-65",
  "status": "OK",
  "globalResult": {
    "overall": "review",
    "totalScore": 100
  },
  "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

​
Swagger

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
amount
string
required

Small amount sent for verification.

Example:

"0.10"

​
currency
string
required

Currency code.

Required string length: 3
Example:

"EUR"

​
description
string
required

Mandatory, non-blank. Alphanumeric only; hyphens (-) allowed as separators. No spaces or other special characters.

Example:

"merchantId19887-65"

​
firstName
string
required

First name for identity verification.

Example:

"John"

​
lastName
string
required

Last name for identity verification.

Example:

"Doe"

​
piiToggle
enum<integer>
required

Determines if PII details should be returned.

Available options:
0,
1
Example:

1

​
nameMatchLogic
enum<string>
required

Name matching logic type.

Available options:
exact,
fuzzy
Example:

"fuzzy"

Response

Successfully initiated challenge deposit.

​
description
string
required

The description sent in the request.

Example:

"merchantId19887-65"

​
status
enum<string>
required

Status of the challenge deposit.

Available options:
OK,
FAIL
Example:

"OK"

​
globalResult
object
required

Contains verification score and assessment result.

​
nameMatchScore
integer
required

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

Required range: 0 <= x <= 100
Example:

85

​
transactionId
string

Unique identifier for the challenge deposit transaction.

Example:

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

​
iban
string

Verified IBAN.

Example:

"DE44500105175407324931"

​
returnedFirstName
string

First name returned from verification if available and piiToggle = 1.

Example:

"John"

​
returnedLastName
string

Last name returned from verification if available and piiToggle = 1.

Example:

"Doe"