Contents x
    Merchant Remittance Runs Response
    • 30 Nov 2023
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Merchant Remittance Runs Response

    • Updated on 30 Nov 2023
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    A HTTP 200 response body will return the following. Additionally, a response header ‘X-Total-Count’ included indicating total no of records matching given request. This would be useful to calculate no of pages that can be used for navigation. 

    Entity  

    Sub-entity  

    Sub-sub-entity  

    Sub-sub-sub-entity  

    Description  

    merchantId  

      

      

      

    Merchant Id  

    outcome  

    totals  

    onHoldCount  

      

    Integer – count of credit transactions only  

    onHoldAmount  

      

    Decimal  

    pendingCount  

      

    Integer– count of credit transactions only  

    pendingAmount  

      

    Decimal  

    insufficientCreditCount  

      

    Integer– count of credit transactions only  

    insufficientCreditAmount  

      

    Decimal  

    generatedCount  

      

    Integer– count of credit transactions only  

    generatedAmount  

      

    Decimal  

    transferredCount  

      

    Integer– count of credit transactions only  

    transferredAmount  

      

    Decimal  

    completedCount  

      

    Integer– count of credit transactions only  

    completedAmount  

      

    Decimal  

    runs  

    {array of remittance runs}  

    summary  

    status 

    Values  

    ON_HOLD (KYC/AML not approved/pre-approval)  

    PENDING (expected remittance date not reached)  

    INSUFFICIENT_CREDIT (remittance held due to insufficient credits)  

    GENERATED (remittance run has been generated)  

    TRANSFERRED (remittance file has been uploaded)  

    COMPLETED (remittance has been submitted or completed)  

    transactionCount  

    Integer  

      

    This is the total count for  

    Payments  

    Chargeback Reversal  

    Credit Chargeback  

    transactionAmount  

    Decimal  

      

    This is the total amount for  

    Payments  

    Chargeback Reversal  

    Credit Chargeback  

    feeAmount  

    Decimal  

      

    This is the fee amount for   

    Payments  

    remittanceAmount  

    Decimal – transactionAmount minus feeAmount  

    bankAccountId 

    Guid – Bank account ID for that transaction 

    accountNumber  

    String(4) – this will return only the last 4 digits of the bank account  

    bankAccountHolderName 

    String (250) – Name of the bank account holder 

    sortCode  

    String(6)  

    remittanceReference  

    String(18)  

    expectedRemittanceAt 

    Date – when remittance is expected (the date we estimate the transfer to be done)  

      

    Only returned when status is PENDING  

    This will be NULL for status ON_HOLD  

      

    This will be the current date for any date that is in the past  

    transferType  

    Type of transfer to be performed.  

    “BACS” or “FP”  

      

    Only returned when status is not PENDING or ON_HOLD or INSUFFICIENT_CREDIT  

    runId  

    Integer  

      

    Only returned when status is not PENDING or ON_HOLD or INSUFFICIENT_CREDIT  

    generatedAt  

    Date – When the run was initiated.  

      

    Only returned when status is GENERATED  

    transferredAt  

    Date – When the file was generated.  

      

    Only returned when status is TRANSFERRED  

    completedAt  

    Date – When notification of process completion was confirmed.  

      

    Only returned when status is COMPLETED  

    debits  

      

    {array of upcoming debits}  

    summary  

    status  

    Values  

    ON_HOLD (KYC/AML not approved/pre-approval)  

    PENDING (awaiting NETT settlement from an upcoming credit)  

    ALLOCATED (included into an upcoming credit run)  

    COMPLETED (NETT settlement of the debit has been completed)   

    disputeAmount  

    Decimal  

      

    Amount of all debit transactions. This includes  

    Refunds  

    Chargebacks  

    Credit Chargeback Reversal  

    Returned as -ve value  

    feeAmount  

    Decimal  

      

    Amount of all dispute fees.   

    Chargeback fee  

    PayPal Direct  

      

    Returned as -ve value  

    accountNumber  

    String(4) – this will return only the last 4 digits of the bank account  

    bankAccountHolderName 

    String (250) – Name of the bank account holder 

    sortCode  

    String(6)  

    bankAccountId  

    GUID  

    expectedRemittanceAt  

    Date – when recovery of funds is expected (the date we estimate the transfer to be done)  

      

    Only returned when status is PENDING and ALLOCATED  

    This will be NULL for status ON_HOLD  

      

    This will be the current date for any date that is in the past  

    generatedAt  

    Date – When the run was initiated. 

      

    Only returned when status is GENERATED  

    transferredAt  

    Date – When the file was generated. 

      

    Only returned when status is TRANSFERRED  

    completedAt  

    Date – When notification of process completion was confirmed.  

      

    Only returned when status is COMPLETED  

    Notes

    Sort Order

    • The remittance run list will be returned in order of status defined above then by xxxAt date descending order 

    • The remittance debits list will be returned in order of status defined above and then by the expectedRemittanceAt date descending order  

    Grouping

    • The list will be grouped by status, runDate, accountId, accountNumber, sortCode, remittanceReference, invoiceable and accountHolderName.  

    • The debits list will be grouped by e status, runDate, accountId, accountNumber, sortCode, remittanceReference and accountHolderName. 

    • Optional parameters to be provided in the query string. If not provided, then will return all records. 

    • If the page and or size is present, then performs the filter logic to return the requested records. This filter will only be applied to Paid (COMPLETE) remittances. Only completed debits for the filtered credits must be returned.  

    • If the bankAccountId(s) is present, then perform filter logic to return the requested records. Do not verifiy that the bankAccountId is applicable for the merchant before filtering. This filter will be applied to all remittance statuses (Upcoming and Paid) 

    Was this article helpful?
    What's Next