Sign in

v1

latestOpenAPI 3.1.02026-07-2413059.7 KB

Payment

This endpoint enables you to process transactions securely and efficiently through our API.

post/payment

Request body

api_secretstring required

This is the credential that Vendo will use to authenticate your request

is_testinteger

Set to 1 if you want to process a test transaction. Check Appendix A for test card details.

merchant_idinteger required

Your Vendo Merchant ID. This will be provided by your account manager

site_idinteger required

The Vendo Site ID for which you're processing the transaction.

amountnumber float required

The amount that you want to charge the user. Example: 39.95

currencystring required

The 3-letter currency code of the amount to be charged. Currencies

success_urlstring

The URL to which the user must be redirected after a successful verification. If it isn't specified then our platform will fallback to the Success URL configured in Vendo's back office.

mitboolean

Merchant Initiated Transaction - set this flag to true when performing automatic recurring charges (i.e. rebills). The "mit" flag is false by default, indicating that the customer themselves initiated the transaction.

preauth_onlyboolean

Pre-Authorization Only. Set this flag to true when you do not want to capture the transaction amount immediately, but only validate the payment details and block (reserve) the amount. The capture of a preauth-only transaction can be performed with the Capture API. Only available for "card" type of payment

non_recurringboolean

Flags a payment as non-recurring. Set this to true if no MITs (merchant initiated transactions / rebills) will follow automatically. This may increase the chance of the transaction being accepted by some banks.

Response

200

OR
OR

Example response

{
  "status": 1,
  "external_references": {
    "transaction_reference": "123",
    "program_id": "1",
    "campaign_id": "2",
    "affiliate_id": "3"
  },
  "transaction": {
    "id": 240123482,
    "amount": "10.10",
    "currency": "USD",
    "datetime": "2020-03-31T12:51:37+02:00"
  },
  "card_details": {
    "auth_code": "348738"
  },
  "payment_details_token": "1234567890",
  "request_id": "XoMgrUtN4CXZnJrJ2sRT5wAAAMc"
}
All 13 operations