Outgoing Payments

You can make payments from an payment profile into a bank account of your choice, the primary function of this is to refund a payment.

First you will need to call our API and request a payment. This should be done from your back-end to prevent users from accessing your payment profile credentials.

To do this you need to send a POST request to the following url

https://api.vendreo.com/v1/request-outgoing-payment (Full example: docs)

curl --location --request POST 'https://api.vendreo.com/v1/request-outgoing-payment' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {AUTH_TOKEN}' \
  --data-raw '{
    "application_key": "{APPLICATION_KEY}",
    "amount": "120",
    "currency": "GBP",
    "description" : "Product Description",
    "redirect_url": "https://example.com/redirect",
    "original_payment_uuid": null,
    "options": "optional string ",
    "account_name": "Joe Blogs",
    "sort_code": "123456",
    "account_number": "12345678"
  }'

If any of the account_name, sort_code or account_number is not filled in, the user will be prompted to enter their details, if all three are present, the user will be locked into using the details you provide.

User will be redirected to redirect_url where the payment process will start.

Sandbox Credentials:

Bank	How to login
AIB GB Sandbox	Click on the login link. Authorisation will complete immediately and you will be redirected.
Natwest Sandbox	Customer Number: 123456789012 When prompted to enter your PIN and Password, Natwest Sandbox will display the values to enter above each text box. Please enter these values in each box before selecting 'Continue'
Royal Bank Of Scotland	Customer Number: 123456789012 When prompted to enter your PIN and Password, Natwest Sandbox will display the values to enter above each text box. Please enter these values in each box before selecting 'Continue'
Modelo Sandbox	Username: mits Passwords: mits

For Sandbox environment, Vendreo recommends using Modelo Sandbox bank for testing your API integration.

As soon as the payment process is complete (success/fail), the user will be redirected to the redirect_url provided on request-outgoing-payment API request.

Returned Postbacks

Vendreo will attempt to inform your system about the status of a payment by making a series of API requests to your Payment Profile callback URL