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

Simulate pay-in completed webhook

Simulate Pay-in Transaction

A Payin transaction can be simulated into any account on Sandbox to test you integration. This will create a Payin transaction on the account, and trigger a Payin Completed Webhook.

The internalAccountId is the id of the account in which you want to simulate the payin.

curl --location --request POST 'https://sandbox.openpayd.com/api/simulator/payin' \
--header 'X-ACCOUNT-HOLDER-ID: 01bce837-7296-4eda-8c9d-387a9f9bebc8' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
   "internalAccountId":"EUR01110829353076",
   "amount":{
      "currency":"EUR",
      "value":10
   },
   "senderName":"Boris Johnson",
   "senderIban":"GB29NWBK60161331926819",
   "senderBic":"BUKBGB22",
   "senderAccountNumber":null,
   "senderSortCode":null,
   "senderAddress": "10 Downing Street, London",
   "reason":"Simulate Payin",
   "paymentType":"SEPA"
}'

Simulate Payin Completed Webhook

You can also simulate only a Payin Completed Webhook on Sandbox to test your integration. This will send a Payin Completed Webhook, but not create an actual Payin transaction on the system.

The following is an example request where THpzMUZ4bTF1STF1dllvUUFHTmQ0QT0 is the id of the account into which the pay-in should be simulated.

curl --location --request POST 'https://sandbox.openpayd.com/api/webhooks/payin/THpzMUZ4bTF1STF1dllvUUFHTmQ0QT09' \
--header 'X-ACCOUNT-HOLDER-ID: 01bce837-7296-4eda-8c9d-387a9f9bebc8' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "senderBic": "BUKBGB22",
  "senderIban": "GB29NWBK60161331926819",
  "senderName": "John Doe",
  "senderRoutingCodes": [
    {
        "routingCodeKey": "SORT_CODE",
      "routingCodeValue": "401615"     
    }
  ],
  "senderAddress": "10 Downing Street, London",
  "senderInformation": "Test",
  "transactionReference": "Gift",
  "paymentType":"SEPA"
}'

Updated 2 months ago

Simulate pay-in completed webhook


Suggested Edits are limited on API Reference Pages

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