Skip to main content
POST
/
v1
/
createSepaDDPayment
Create payment
curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/v1/createSepaDDPayment \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 123,
  "creditor": {
    "iban": "<string>",
    "id": "<string>",
    "name": "<string>",
    "address": {
      "addressLine": "<string>",
      "buildingName": "<string>",
      "buildingNumber": "<string>",
      "country": "<string>",
      "countrySubDivision": "<string>",
      "department": "<string>",
      "districtName": "<string>",
      "floor": "<string>",
      "postBox": "<string>",
      "postCode": "<string>",
      "room": "<string>",
      "streetName": "<string>",
      "subDepartment": "<string>",
      "townLocationName": "<string>",
      "townName": "<string>"
    }
  },
  "currencyIsoCode": "<string>",
  "debtor": {
    "iban": "<string>",
    "name": "<string>",
    "address": {
      "addressLine": "<string>",
      "buildingName": "<string>",
      "buildingNumber": "<string>",
      "country": "<string>",
      "countrySubDivision": "<string>",
      "department": "<string>",
      "districtName": "<string>",
      "floor": "<string>",
      "postBox": "<string>",
      "postCode": "<string>",
      "room": "<string>",
      "streetName": "<string>",
      "subDepartment": "<string>",
      "townLocationName": "<string>",
      "townName": "<string>"
    },
    "bic": "<string>",
    "organisationIdentification": {
      "bic": "<string>",
      "lei": "<string>",
      "otherIdentification": {
        "id": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        },
        "issuer": "<string>"
      }
    },
    "privateIdentification": {
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "2023-12-25",
        "province": "<string>"
      },
      "otherIdentification": {
        "id": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        },
        "issuer": "<string>"
      }
    }
  },
  "mandateInformation": {
    "dateOfSignature": "2023-12-25",
    "id": "<string>",
    "amendmentInformation": {
      "creditorCode": "<string>",
      "debtorIban": "<string>",
      "originalMandateId": "<string>"
    },
    "eSignature": "<string>"
  },
  "sequenceType": "FRST",
  "settlementDate": "2023-12-25",
  "endToEndId": "<string>",
  "purpose": {
    "information": "<string>",
    "structured": {
      "issuer": "<string>",
      "reference": "<string>"
    },
    "unstructured": "<string>"
  },
  "ultimateCreditor": {
    "name": "<string>",
    "organisationIdentification": {
      "bic": "<string>",
      "lei": "<string>",
      "otherIdentification": {
        "id": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        },
        "issuer": "<string>"
      }
    },
    "privateIdentification": {
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "2023-12-25",
        "province": "<string>"
      },
      "otherIdentification": {
        "id": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        },
        "issuer": "<string>"
      }
    }
  },
  "ultimateDebtor": {
    "name": "<string>",
    "organisationIdentification": {
      "bic": "<string>",
      "lei": "<string>",
      "otherIdentification": {
        "id": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        },
        "issuer": "<string>"
      }
    },
    "privateIdentification": {
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "2023-12-25",
        "province": "<string>"
      },
      "otherIdentification": {
        "id": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        },
        "issuer": "<string>"
      }
    }
  }
}
'
{
  "result": {
    "amount": 123,
    "creditor": {
      "id": "<string>",
      "address": {
        "addressLine": "<string>",
        "buildingName": "<string>",
        "buildingNumber": "<string>",
        "country": "<string>",
        "countrySubDivision": "<string>",
        "department": "<string>",
        "districtName": "<string>",
        "floor": "<string>",
        "postBox": "<string>",
        "postCode": "<string>",
        "room": "<string>",
        "streetName": "<string>",
        "subDepartment": "<string>",
        "townLocationName": "<string>",
        "townName": "<string>"
      },
      "bankName": "<string>",
      "bic": "<string>",
      "iban": "<string>",
      "name": "<string>"
    },
    "currencyIsoCode": "<string>",
    "debtor": {
      "iban": "<string>",
      "address": {
        "addressLine": "<string>",
        "buildingName": "<string>",
        "buildingNumber": "<string>",
        "country": "<string>",
        "countrySubDivision": "<string>",
        "department": "<string>",
        "districtName": "<string>",
        "floor": "<string>",
        "postBox": "<string>",
        "postCode": "<string>",
        "room": "<string>",
        "streetName": "<string>",
        "subDepartment": "<string>",
        "townLocationName": "<string>",
        "townName": "<string>"
      },
      "bankName": "<string>",
      "bic": "<string>",
      "name": "<string>",
      "organisationIdentification": {
        "bic": "<string>",
        "lei": "<string>",
        "otherIdentification": {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      },
      "privateIdentification": {
        "birthInformation": {
          "city": "<string>",
          "country": "<string>",
          "date": "2023-12-25",
          "province": "<string>"
        },
        "otherIdentification": {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      }
    },
    "endToEndId": "<string>",
    "id": 123,
    "mandateInformation": {
      "amendmentInformation": {
        "creditorCode": "<string>",
        "debtorIban": "<string>",
        "originalMandateId": "<string>"
      },
      "dateOfSignature": "2023-12-25",
      "eSignature": "<string>",
      "id": "<string>"
    },
    "purpose": {
      "information": "<string>",
      "structured": {
        "issuer": "<string>",
        "reference": "<string>"
      },
      "unstructured": "<string>"
    },
    "sequenceType": "<string>",
    "settlementDate": "2023-12-25",
    "ultimateCreditor": {
      "name": "<string>",
      "organisationIdentification": {
        "bic": "<string>",
        "lei": "<string>",
        "otherIdentification": {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      },
      "privateIdentification": {
        "birthInformation": {
          "city": "<string>",
          "country": "<string>",
          "date": "2023-12-25",
          "province": "<string>"
        },
        "otherIdentification": {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      }
    },
    "ultimateDebtor": {
      "name": "<string>",
      "organisationIdentification": {
        "bic": "<string>",
        "lei": "<string>",
        "otherIdentification": {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      },
      "privateIdentification": {
        "birthInformation": {
          "city": "<string>",
          "country": "<string>",
          "date": "2023-12-25",
          "province": "<string>"
        },
        "otherIdentification": {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      }
    }
  }
}

​
Overview

This endpoint creates SEPA Direct Debit payments for collecting funds from customer accounts. The payment is validated and submitted to the clearing system for processing.

Headers

​
Idempotency-Key
string
required

Unique identifier in scope of payment creation endpoints required to prevent unintended duplicate direct debit payments

Body

application/json
​
amount
integer
required

Amount in minor currency units (cents)

​
creditor
object
required

Party on the credit side of the transaction to which the tax applies

​
currencyIsoCode
string
required

For SEPA Direct Debit payments, only allowed value is 'EUR'

​
debtor
object
required

Party that owes an amount of money to the (ultimate) creditor

​
mandateInformation
object
required

Provides further details of the direct debit mandate signed between the creditor and the debtor.

​
sequenceType
enum<string>
required

Identifies the direct debit sequence, such as first, recurrent, final or one-off.

Available options:
FRST,
RCUR,
FNAL,
OOFF
​
settlementDate
string<date>
required

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money
becomes available to the agent to which it is due.

​
endToEndId
string

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction.
This identification is passed on, unchanged, throughout the entire end-to-end chain

Required string length: 1 - 35
​
purpose
object

Underlying reason for the payment transaction. Usage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

​
ultimateCreditor
object

Ultimate party to which an amount of money is due.

​
ultimateDebtor
object

Ultimate party to which an amount of money is due.

Response

A new SEPA direct debit payment has been created

​
result
object
required

Result of sepa direct debit payment request creation