OpenPayd Developer Hub

Welcome to the OpenPayd developer hub. You'll find comprehensive guides and documentation to help you start working with OpenPayd as quickly as possible, as well as support if you get stuck. Let's jump right in!

API Reference    Guides

Pay-in Review Webhook

If the feature is enabled on your account, you can receive a Pay-in Review webhook notification when a deposit arrives for your account but before it is actually credited into the account.

This allows you to perform your own review (e.g. fraud checks, confirming that the deposit was from your client etc.) on the deposit and approve or reject it using the Review Deposit Transaction API. The transaction will only be credited on the account if you update the reviewStatus to APPROVED.

Webhook Payload

The webhook payload contains full details of the pay-in received for your account which you can use to decide whether you want to approve or reject the deposit.

"{
 \n  \"id\": \"12c9040e-adbd-43b2-ad72-95f7026c89aa\",
 \n  \"type\": \"PAYIN\",
 \n  \"status\": \"PROCESSING\",
 \n  \"paymentType\": \"FASTER_PAYMENTS\",
 \n  \"senderBic\": \"BUKBGB22\",
 \n  \"senderIban\": \"GB29NWBK60161331926819\",
 \n  \"senderName\": \"John Doe\",
 \n  \"senderAddress\": \"10 Downing Street, London\",
 \n  \"senderInformation\": \"Test\",
 \n  \"senderAccountNumber\": 32599570,
 \n  \"senderRoutingCodes\":[
      {
       \n  \"routingCodeKey\":\"SORT_CODE\",
       \n  \"routingCodeValue\":\"040510\"
      \n}
   ]
 \n  \"amount\": {
                                \n \"currency\": \"EUR\",
                                \n  \"value\": \"150.00\"\n
                                 },
 \n  \"fee\" : {
                                \n \"currency\" : \"GBP\",
                \n \"value\" : -12.34\n                             
                }, 
 \n  \"transactionDateTime\": \"2019-05-03T11:30:12.941\",
 \n  \"transactionReference\": \"funding my account\",
 \n  \"internalAccountId\": \"EUR10172739387826\",
 \n  \"beneficiaryAccountHolderName\": \"Jason Doe\",
 \n  \"accountHolderId\" : \"cb2f83f1-131e-4494-9e51-eb1b9641b0b1\"\n
}"

Mitigation Against Authorised Push Payment Fraud

For GBP payins via Faster Payments, the beneficiaryAccountHolderName field will contain the beneficiary name as provided by the sender. This can be used to check against your account holder name to determine if the payin is a potential push payment fraud. For all other currencies and payment types, the field will be null.

Updated 3 months ago

Pay-in Review Webhook


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.