POST
/
api
/
service
/
mandate
/
lookup
curl --request POST \
  --url https://api.sand.getivy.de/api/service/mandate/lookup \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '{
  "referenceId": "<string>"
}'
{
  "id": "<string>",
  "referenceId": "<string>",
  "reference": "<string>",
  "signature": {
    "ip": "<string>",
    "token": "<string>",
    "signedAt": "2023-11-07T05:31:56Z"
  },
  "creditor": {
    "id": "<string>",
    "name": "<string>",
    "address": {
      "street": "<string>",
      "city": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    }
  },
  "debtor": {
    "account": {
      "iban": "<string>",
      "bic": "<string>",
      "accountHolderName": "<string>"
    }
  },
  "status": "pending",
  "revokedAt": "2023-11-07T05:31:56Z",
  "userNotificationEmail": "<string>"
}

Authorizations

X-Ivy-Api-Key
string
header
required

Body

application/json
referenceId
string
required

A valid mandate reference id. This is set by the merchant during the checkout session when the mandate setup is initiated.

Response

200 - application/json
The details of the mandate
id
string
required
referenceId
string
required
reference
string
required
signature
object
required
creditor
object
required
debtor
object
required
status
enum<string>
required
Available options:
pending,
active,
inactive
userNotificationEmail
string
required
revokedAt
string

Required if status is inactive