System Reference Number
The Payment Details by System Reference Number API allows Client to fetch payment details using system reference number of the transaction, as part of the Open Banking PIS flow and based on customer's consent.
Example Response
{
"systemReferenceNumber": "308a4d01-8549-4cbb-b83f-05cd768d606f",
"debtorAccount": {
"iban": "DE06000000000023456789",
"bban": "BARC12345612345678",
"pan": "5309050000012345",
"maskedPan": "******12345",
"msisdn": "+49 170 1234567",
"currency": "EUR"
},
"creditorAccount": {
"iban": "DE06000000000023489765",
"bban": "BARC12345612349087",
"pan": "5609050000012345",
"maskedPan": "******12345",
"msisdn": "+49 170 1234897",
"currency": "EUR"
},
"instructedAmount": {
"amount": 1000.5,
"currency": "EUR"
},
"routingCodeValue": "AAAADEBBXXX",
"statementNarrative": "Family maintenance",
"creditorName": "John Smith",
"comments": "Request initiated",
"status": "INITIATED"
}
Response Body
Field | Description | Type |
---|---|---|
systemReferenceNumber | The unique, system generated reference number for the transaction. | UUID |
debtorAccount | This object contains the account details for the debtor in this transaction. | Object |
debtorAccount.iban | The International Bank Account Number (IBAN) for the debtor’s account, for example, FR7612345987650123456789014. | String |
debtorAccount.bban | The Basic Bank Account Number (BBAN) Identifier. This data elements is used for payment accounts which have no IBAN, for example, BARC12345612345678. | String |
debtorAccount.pan | The Primary Account Number (PAN) of the debtor’s card, can be tokenized by the ASPSP due to PCI DSS requirements. | String |
debtorAccount.maskedPan | The masked Primary Account Number (PAN) of the debtor’s card. Masked data is represented by *. | String |
debtorAccount.msisdn | An alias to access a payment account via a registered mobile phone number. | String |
debtorAccount.currency | The debtor’s 3-letter ISO-4217 currency code. | String |
creditorAccount | This object contains the account details for the creditor in this transaction. | Object |
creditorAccount.iban | The International Bank Account Number (IBAN) for the creditor’s account, for example, FR7612345987650123456789014. | String |
creditorAccount.bban | The Basic Bank Account Number (BBAN) Identifier for the creditor’s account. This data elements is used for payment accounts which have no IBAN, for example, BARC12345612345678. | String |
creditorAccount.pan | The Primary Account Number (PAN) of the creditor’s card, can be tokenized by the ASPSP due to PCI DSS requirements. | String |
creditorAccount.maskedPan | The masked Primary Account Number (PAN) of the creditor’s card. Masked data is represented by *. | String |
creditorAccount.msisdn | An alias to access a payment account via a registered mobile phone number. | String |
creditorAccount.currency | The creditor’s 3-letter ISO-4217 currency code. | String |
instructedAmount | This object contains the amount and currency of the transaction. | Object |
instructedAmount.amount | The amount of the transaction. | Double |
instructedAmount.currency | The 3-letter ISO-4217 currency code of the transaction. | String |
routingCodeValue | The BIC routing code for the transaction. | String |
statementNarrative | The narrative for the transaction. | String |
creditorName | The name of the receiver for this flow. | String |
comments | The system-generated comments for the transaction. | String |
status | The status of the transaction. The possible values are: • INITIATED • PAID • PENDING • REJECTED • RETURN • SENT_TO_BANK | String |