Getting Started
Capabilities
Payout Report
Charge
Banking
Mandate
Retrieve a Mandate
Retrieves a direct debit mandate with mandate id.
POST
/
api
/
service
/
mandate
/
retrieve
Copy
curl --request POST \
--url https://api.sand.getivy.de/api/service/mandate/retrieve \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
Copy
{
"status": "pending",
"userNotificationEmail": "<string>",
"revokedAt": "<any>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceId": "<string>",
"reference": "<string>",
"signature": {
"ip": "<string>",
"signedAt": "<any>",
"token": "<string>"
},
"creditor": {
"id": "<string>",
"name": "<string>",
"address": {
"street": "<string>",
"city": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
},
"debtor": {
"account": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
}
}
}
Authorizations
API key for authentication
Body
application/json
Response
200 - application/json
The details of the mandate
The response is of type object
.
Copy
curl --request POST \
--url https://api.sand.getivy.de/api/service/mandate/retrieve \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
Copy
{
"status": "pending",
"userNotificationEmail": "<string>",
"revokedAt": "<any>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceId": "<string>",
"reference": "<string>",
"signature": {
"ip": "<string>",
"signedAt": "<any>",
"token": "<string>"
},
"creditor": {
"id": "<string>",
"name": "<string>",
"address": {
"street": "<string>",
"city": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
},
"debtor": {
"account": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.