Mandate
Retrieve a Mandate
Getting Started
Charge
Capabilities
Subaccount
Banking
Mandate
Retrieve a Mandate
Retrieves a direct debit mandate with mandate id.
POST
/
api
/
service
/
mandate
/
retrieve
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": "<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
Body
application/json
Response
200 - application/json
The details of the mandate
The response is of type object
.
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": "<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>"
}