(Available soon) Customer Payment Status Report
The Customer Payment Status Report provides information on the processing status of previously submitted payment or direct debit instructions. It informs whether the individual transaction has been accepted, rejected, or is pending processing.
This report enables tracking of the outcome of submitted payment instructions and identify any errors or rejections that may require corrective action.
By default, the report will be a summary of the transaction status. To include transactional data, make sure to set includeTransactionDetails to TRUE.
Currently, only Direct Debit Instructions are supported and present in the report
The report can be retrieved by Cursor-based pagination (synchronous)
Supported Formats
The report is available in the following formats:
- (future planned) CSV - Flat, tabular format suitable for spreadsheets and simple integrations.
- JSON - Structured format optimized for system-to-system integrations.
- (future planned) PAIN.002 (ISO 20022) - Standardized XML format for financial messaging and enterprise-grade integrations.
Report Content
The Customer Payment Status Report includes:
- Transaction identification
- Transaction status
- Transaction details, including:
- Amount
- Currency
- Transaction date and value date
- Debtor- & Creditor information
- Mandate information
Property descriptions
| Logical Property | JSON Property | Description |
|---|---|---|
| End-to-End ID | endToEndId | Unique identifier assigned by instructor in the original payment instruction to track the transaction end-to-end. This will be present in Remittance Information Line 1 for the subsequent credit entry. |
| Instruction UETR | instructionUetr | Unique payment identifier (GUID) assigned to the instruction for internal transaction tracking. Assigned by Banking Circle. |
| Account Servicer Reference | accountServicerReference | Reference assigned by Banking Circle for the payment contract. |
| Clearing System Reference | clearingSystemReference | Reference used by the clearing system. |
| Acceptance Date Time | acceptanceDateTime | Timestamp indicating when the payment instruction was accepted by Banking Circle. |
| Transaction Status | transactionStatus | Current processing status of the payment transaction. |
| Status Reason Code | statusReasonInformation[].reason | Code describing the reason for a rejection. |
| Status Additional Information | statusReasonInformation[].additionalInformation | Additional explanatory text related to the status reason for rejections |
| Requested Collection Date | transactionReference.requestedCollectionDate | Date on which the direct debit collection was requested to be executed. |
| Interbank Settlement Date | transactionReference.interbankSettlementDate | Value date when settlement occurs. |
| Instructed Amount Currency | transactionReference.instructedAmount.currency | Currency of the instructed transaction amount. |
| Instructed Amount | transactionReference.instructedAmount.amount | Amount requested to be collected from the debtor account. |
| Payment Rail / Local Instrument | transactionReference.paymentTypeInformation.localInstrument | Payment scheme or rail used to process the transaction (e.g., SEPA Direct Debit). See Payment rails. |
| Sequence Type | transactionReference.paymentTypeInformation.sequenceType | Indicates the sequence type of the direct debit (e.g., first, recurring, final). |
| Mandate ID | transactionReference.mandateRelatedInformation.mandateId | Identifier of the direct debit mandate authorizing the collection. |
| Mandate Signature Date | transactionReference.mandateRelatedInformation.dateOfSignature | Date when the direct debit mandate was originally signed. |
| Service Level | transactionReference.mandateRelatedInformation.serviceLevel | Payment service level used. |
| Ultimate Creditor Name | transactionReference.ultimateCreditor.name | Name of the ultimate party receiving the funds. |
| Ultimate Creditor Organisation ID | transactionReference.ultimateCreditor.organisationId | Identifier of the ultimate creditor organization. |
| Creditor Name | transactionReference.creditor.name | Name of the party collecting the funds. |
| Creditor Person ID | transactionReference.creditor.personId | Personal identifier associated with the creditor. |
| Creditor Postal Address | transactionReference.creditor.postalAddress.* | Structured postal address details of the creditor. |
| Creditor IBAN | transactionReference.creditorAccount.iban | IBAN of the creditor account receiving the funds. |
| Creditor Account UUID | transactionReference.creditorAccount.accountUuid | Internal unique identifier of the creditor account within the platform. |
| Creditor Agent BIC | transactionReference.creditorAgent.bicFi | BIC of the creditor's financial institution. |
| Creditor Agent Country | transactionReference.creditorAgent.country | Country of the creditor's financial institution. |
| Debtor Name | transactionReference.debtor.name | Name of the account holder from whom the funds are collected. |
| Debtor Postal Address | transactionReference.debtor.postalAddress.* | Structured postal address details of the debtor. |
| Debtor IBAN | transactionReference.debtorAccount.iban | IBAN of the debtor account to be debited. |
| Debtor Agent BIC | transactionReference.debtorAgent.bicFi | BIC of the debtor's financial institution. |
| Debtor Agent Country | transactionReference.debtorAgent.country | Country of the debtor's financial institution. |
| Remittance Line 1-4 | transactionReference.remittanceInformation.line1-line4 | Remittance information lines |
Updated about 3 hours ago