Payment methods

Plugin or API

To enable a specific payment method you will first need an active subscription. Reach out to you acocunt manager or request a payment method via our Merchant Support department. You can send a request to wecare@buckaroo.nl.

Plugin

After activation by our Merchant support team you can activate the payment method in your plugin. More information regarding plugins and their configuration you can find this here: Plugins

API

Ofcourse it's also possible to start sending requests via our JSON API. You will find example requests in the menu on the left under Your Payment method > Integration > Requests For all JSON requests you will need to send in the base payment request as explained below.

Base Payment Request

Required parameters in every transaction.

Parameter	Required	Type	Example	Description
Currency	Yes	String	EUR	This denotes the currency in which the transaction is done. Possible values are: EUR, USD, GBP and others.
AmountDebit	Yes	Decimal	1.0	The debit amount for the request. This is in decimal format, with a point as the decimal separator. For example, if the currency is specified as EUR, sending “1” will mean that 1 euro will be paid. “1.00” is also 1 euro. “0.01” means 1 cent. Please note, a transaction must have either a debit amount or a credit amount and it cannot have both.
AmountCredit			1.0	The credit amount for the request. This is in decimal format, with a point as the decimal separator. For example, if the currency is specified as EUR, sending “1” will mean that 1 euro will be paid. “1.00” is also 1 euro. “0.01” means 1 cent. Please note, a transaction must have either a debit amount or a credit amount and it cannot have both.
Invoice		String	Test Invoice 1234	The invoice number used for the request. This can be a combination of numbers and letters. Please note, the invoice will be trimmed on our side, so white spaces at the beginning and end will be removed.
Order		String	Order 1234	The order number for which the request is done. This can be a combination of numbers and letters. Please note, this field is not yet supported. Anything sent in with this field is ignored at this moment.
Description	No	String	The description for the transaction.
ClientIP	No	Yes	192.168.2.1	In this field the IP address of the customer (or employee) for which the action is being performed can be passed. Please note, If this field is not sent to our gateway, your server IP address will be used as the clientIP. This may result in unwanted behaviour for anti-fraud checks. Also, certain payment methods perform checks on the IP address, if an IP address is overused, the request could be blocked. This field is sent in the following format, where type 0 = IPv4 and type 1 = IPv6: "ClientIP": { "Type": 0, "Address": "0.0.0.0" },
ReturnURL	No	String	https://www.buckaroo.nl/returncancel	This is the URL to which a customer is redirected after completing a payment. For some payments, the customer needs to be sent to a webpage where the customer needs to complete the payment. After completing the process on this page, the customer is then redirected back to the page specified in this field. If this field is omitted, the URL as configured in the Payment Plaza is taken.
ReturnURLCancel	No	String	https://www.buckaroo.nl/returncancel	It is possible to specify an alternative return URL for transactions that have been cancelled by the customer. This can be specified in this field.
ReturnURLError	No	String	https://www.buckaroo.nl/returnerror	It is possible to specify an alternative return URL for transactions that generate an error during processing. This can be specified in this field.
ReturnURLReject	No	String	https://www.buckaroo.nl/returnreject	It is possible to specify an alternative return URL for transactions that have been rejected. This can be specified in this field.
OriginalTransactionKey	No	String	4E8BD922192746C3918BF4077CXXXXXX	Some requests need to refer to a previously created transaction, since they perform an additional action upon them. In this field the transaction key identifying the transaction can be specified
ServicesSelectableByClient	No	String	paypal,ideal,mastercard	These options will be shown in the Buckaroo checkout. Other active payment methods will be hidden.
ServicesExcludedForClient	No	String	billink,visa,nexi	These options will be hidden in the Buckaroo checkout. Other active payment methods will be shown.
ContinueOnIncomplete	No	Boolean	1	This will redirect the consumer to the Buckaroo Checkout.
PushURL	No	String	https://www.buckaroo.nl/push	When provided, this push URL overrides all the push URLs as configured in the payment plaza under websites for the associated website key
PushURLFailure	No	String	https://www.buckaroo.nl/pushfail	When provided, this push URL overrides the push URL for failed transactions as configured in the payment plaza under websites for the associated website key.
ClientUserAgent	No	String	Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36	This tag can be used to tell the Payment Engine what the user agent of the client’s webbrowser is. This can be used for statistical purposes but also to perform anti-fraud checks on transactions.
OriginalTransactionReference				Some request need to refer to a previously created transaction, since they perform an additional action upon them. In this field an alternative reference to the original transaction can be provided
Services
ServiceList
CustomParameters
AdditionalParameters

Parameter

Required

Type

Example

Description

Currency

Yes

String

EUR

This denotes the currency in which the transaction is done. Possible values are: EUR, USD, GBP and others.

AmountDebit

Yes

Decimal

1.0

The debit amount for the request. This is in decimal format, with a point as the decimal separator. For example, if the currency is specified as EUR, sending “1” will mean that 1 euro will be paid. “1.00” is also 1 euro. “0.01” means 1 cent. Please note, a transaction must have either a debit amount or a credit amount and it cannot have both.

AmountCredit

1.0

The credit amount for the request. This is in decimal format, with a point as the decimal separator. For example, if the currency is specified as EUR, sending “1” will mean that 1 euro will be paid. “1.00” is also 1 euro. “0.01” means 1 cent. Please note, a transaction must have either a debit amount or a credit amount and it cannot have both.

Invoice

String

Test Invoice 1234

The invoice number used for the request. This can be a combination of numbers and letters. Please note, the invoice will be trimmed on our side, so white spaces at the beginning and end will be removed.

Order

String

Order 1234

The order number for which the request is done. This can be a combination of numbers and letters. Please note, this field is not yet supported. Anything sent in with this field is ignored at this moment.

Description

String

The description for the transaction.

ClientIP

Yes

192.168.2.1

In this field the IP address of the customer (or employee) for which the action is being performed can be passed. Please note, If this field is not sent to our gateway, your server IP address will be used as the clientIP. This may result in unwanted behaviour for anti-fraud checks. Also, certain payment methods perform checks on the IP address, if an IP address is overused, the request could be blocked. This field is sent in the following format, where type 0 = IPv4 and type 1 = IPv6: "ClientIP": { "Type": 0, "Address": "0.0.0.0" },

ReturnURL

String

https://www.buckaroo.nl/returncancel

This is the URL to which a customer is redirected after completing a payment. For some payments, the customer needs to be sent to a webpage where the customer needs to complete the payment. After completing the process on this page, the customer is then redirected back to the page specified in this field. If this field is omitted, the URL as configured in the Payment Plaza is taken.

ReturnURLCancel

String

https://www.buckaroo.nl/returncancel

It is possible to specify an alternative return URL for transactions that have been cancelled by the customer. This can be specified in this field.

ReturnURLError

String

https://www.buckaroo.nl/returnerror

It is possible to specify an alternative return URL for transactions that generate an error during processing. This can be specified in this field.

ReturnURLReject

String

https://www.buckaroo.nl/returnreject

It is possible to specify an alternative return URL for transactions that have been rejected. This can be specified in this field.

OriginalTransactionKey

String

4E8BD922192746C3918BF4077CXXXXXX

Some requests need to refer to a previously created transaction, since they perform an additional action upon them. In this field the transaction key identifying the transaction can be specified

ServicesSelectableByClient

String

paypal,ideal,mastercard

These options will be shown in the Buckaroo checkout. Other active payment methods will be hidden.

ServicesExcludedForClient

String

billink,visa,nexi

These options will be hidden in the Buckaroo checkout. Other active payment methods will be shown.

ContinueOnIncomplete

Boolean

This will redirect the consumer to the Buckaroo Checkout.

PushURL

String

https://www.buckaroo.nl/push

When provided, this push URL overrides all the push URLs as configured in the payment plaza under websites for the associated website key

PushURLFailure

String

https://www.buckaroo.nl/pushfail

When provided, this push URL overrides the push URL for failed transactions as configured in the payment plaza under websites for the associated website key.

ClientUserAgent

String

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36

This tag can be used to tell the Payment Engine what the user agent of the client’s webbrowser is. This can be used for statistical purposes but also to perform anti-fraud checks on transactions.

OriginalTransactionReference

Some request need to refer to a previously created transaction, since they perform an additional action upon them. In this field an alternative reference to the original transaction can be provided

Services

ServiceList

CustomParameters

AdditionalParameters

Note:

In addition to the basic variables, each service (like a payment method) can have additional service specific variables that may be required to add in the request. They are explained in each of the payment method and additional services sections.

Example request

"Currency": "EUR", "AmountDebit": 1.0, "AmountCredit": 1.0, "Invoice": "Test Invoice 1234", "Order": "sample string 3", "Description": "Example for docs", "ClientIP": { "Type": 0, "Address": "192.168.2.1" }, "ReturnURL": "https://www.buckaroo.nl/return", "ReturnURLCancel": "https://www.buckaroo.nl/returncancel", "ReturnURLError": "https://www.buckaroo.nl/returnerror", "ReturnURLReject": "https://www.buckaroo.nl/returnreject", "OriginalTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX", "StartRecurrent": true, "ContinueOnIncomplete": 1, "ServicesSelectableByClient": "ideal,mastercard,visa,giftcard", "ServicesExcludedForClient": "payconiq,nexi", "PushURL": "https://www.buckaroo.nl/push", "PushURLFailure": "https://www.buckaroo.nl/pushfail", "ClientUserAgent": "sample string 17", "OriginalTransactionReference": null, "Services": { "ServiceList": [] }, "CustomParameters": null, "AdditionalParameters": null }

Payment methods

Which currencies does Buckaroo support collecting?

Plugin or API

Plugin

API

Base Payment Request

Example request

What's Next