What will I see once when I've set up the data APIs?

Created by Isaac Harper, Modified on Tue, 23 May 2023 at 10:17 AM by Isaac Harper

The data APIs are a great extra check to help you manage your operations and flag any payments where an issue might have occurred. If you haven't already, you can read more about why you should use our Data APIs and see how to set them up

Once set up, what can I expect to see?

The data APIs are a double check of your transactions, so they will provide an additional status.

In the vast majority of instances, these statuses will just reconfirm the transaction, but on very rare occasions they might flag where the response we received from the bank doesn't match what really happened with the payment.

Where the data API status doesn't match the status the bank gave us or there was an error, we'll show a warning against the payment. Just hover over this to see what's happened e.g.

Warning Message	What this means
"We have been unable to reconcile this payment. Please check your bank statement to confirm this payment was received"	The bank told us that the payment had been completed successfully, but in our checks we haven't been able to identify the payment. You should check your bank statement to confirm this, and request payment from your customer again.
"We received a payment status of Pending from the bank, but have since identified this payment. Please double check your bank statement"	The status we received from the bank indicated that the payment hadn't been completed, but we have found a payment that matches this request. You should check your bank statement to confirm this.
"We received a payment status of In Progress from the bank, but have since identified this payment. Please double check your bank statement"
"Payment was rejected by the bank but has since arrived. Please double check your bank statement"
"We were unable to check the status of this payment. We’ll keep trying to check the payment’s status"	We will show this if there was a temporary issue checking the payment, we will run a check again after a hour
"Connection to your bank account has been lost. Please add your account again using mobile or internet banking"	If we encounter repeated errors, then it's likely connection was lost to your bank account. You just need to reconnect your account.

If you click into a payment to view the payment details, you will also see two new fields:

Data API Check Status - what the result of the check was
Last Data API Check At - at what time the check was last run

The Data API Check Status is just the result of the check, and should be considered in combination with the status returned initially (The "Status" in the above screenshot). The Data API Check Status can be one of the following:

Data API Check Status	Description
MISSED_PAYMENT	No payment was identified that matched this payment request. If the payment status was Paid or Completed, then we recommend checking your bank statement
PAYMENT_MADE	Payment identified. If the original status returned was rejected or in progress, but data APIs return a status of payment made, then you can assume the payment has arrived, but we recommend double checking
PARTIAL_PAYMENT	if the received payment doesn't match the amount expected (it could be less or more) e.g. user made manual bank transfer but didn't make full payment
UNABLE_TO_CHECK	Temporary error checking, will try again in an hour
PERMANENT_CONNECTION_LOSS	Failed to run a check 5 times in a row (checks are hourly), connection to bank account is assumed lost and user needs to connect/add their bank account again
WAITING_FOR_FIRST_CHECK	Payment has been actioned by the end user (could be completed, rejected, in progress etc), but no data API check has been run. This will update on the next check to the relevant status