Once a payment is successfully initiated, you will receive a response containing the payment ID and its current status. The initial status will usually be PendingProcessing, indicating that the payment has been received by BC Connect and is awaiting processing.

Payment statuses

To check the status of a payment, you have the option to either call our payment status endpoints or subscribe to Webhooks.

Look up payment status

You can check the status of payments individually regardless of whether they were submitted using the Single or Bulk endpoints. Additionally, you can obtain the overall status of a bulk payment file submission.

Individual payment status

To retrieve the status of a single payment, use the endpoint api/v1/payments/singles/{payment-id}/status, where {payment-id} refers to the ID of the payment received during initiation. Here is a link to the relevant API Reference Get status of a payment.

Example request:

GET/api/v1/payments/singles/9ffa7024-5536-4b0f-9578-d03171f75182/status

The response will provide the status of the payment without any additional parameters:

{  
  "status": "Processed"  
}

Bulk payment status

To get the overall status of a bulk payment, use the endpoint api/v1/payments/bulks/{payment-bulk-id}/status with the ID of the payment received as response to the payment initiation. Here is a link to the relevant API Reference Get status of single bulk payment.

Example request:

GET/api/v1/payments/bulks/be0c7c7d-8dba-471c-822a-8e5ba340e97e/status

The response contains the status of the payment bulk and no other parameters:

{  
  "status": "Processed"  
}

The returned status represents the aggregated status of all payments within the bulk. If at least 51% of the payments have been processed, the overall status will be "Processed."

For a more detailed overview of the bulk status, you can use the api/v1/payments/bulks/{payment-bulk-id} endpoint. This will provide general information about the bulk and an overview of the payment statuses within it.

{  
  "paymentBulkId": "f3822099-8316-4487-bceb-32c5e89352de",  
  "concurrencyToken": "1638789624",  
  "status": "Approved",  
  "instructedDate": "2021-12-06T00:00:00+00:00",  
  "paymentStatistics": {  
    "processed": 232,  
    "pendingProcessing": 0,  
    "rejected": 0,  
    "missingFunding": 0,  
    "cancelled": 0,  
    "pendingApproval": 0,  
    "pendingSca": 0,  
    "scaDeclined": 0,  
    "scaExpired": 0,  
    "declinedByApprover": 0,  
    "total": 232,  
    "aggregatedAmount": 274933  
  }  
}

📘

Check status of the individual payments submitted in bulk

You can use the GET/api/v1/payments/singles and filter on PaymentBulkId

Rejection reasons

Rejections can occur either upfront or after the payment has been processed in our core system. A payment may be rejected if it has been in the MissingFunding state for two days or if any of the fields contain invalid values.

To determine the rejection reason, use either the GET/api/v1/payments/singles or GET/api/v1/payments/singles/{payment-id} endpoint to retrieve the payment details and read the rejection reason.

Here is a snippet of data returned by these endpoints, where the rejection reason can be found in the "errors" field:

{  
  "paymentId": "690a72db-aa73-4d48-974b-7b26abdcd164",  
  "transactionReference": "TRANS221122323",  
  "concurrencyToken": "1638789624",  
  "classification": "Outgoing",  
  "status": "Rejected",  
  "errors": "InvalidAccountFormat",  
  "

If you easily want to look up rejected payments and the reasons for a bulk file, use the GET/api/v1/payments/singles and filter on PaymentBulkId and Status.

Below is a list of the possible rejection reasons, and an explanation for each. The list contains both upfront validation errors and processing errors.

Cancelling Payments

Single or bulk payments can be cancelled before processing via the single or bulk cancellation endpoint respectively. The following conditions apply:

• A payment can only be cancelled if it is in one of the following states:
  • Pending processing (ie. pendingProcessing)
  • Failed (e.g. missingFunding, scaDeclined, scaExpired, declinedByApprover)
  • Earlier state (e.g. pendingApproval, pendingSca)
• When cancelling a bulk payment, the system will attempt to cancel each individual payment based on the conditions above.
  • If some payments have already been processed, the cancellation will be partial, affecting only those still eligible