Requests
Requests
Article Summary
Share feedback
Thanks for sharing your feedback!
Pay
The Pay action is the default action for the service Payconiq. With this action a new transaction will be initiated via Payconiq.
In case of a correct request a pending response will follow with the transaction status “791 Pending Processing”. The response will contain some details about the transaction.
When using the Buckaroo Client SDK all you need to proceed is the SDK itself and the transactionKey. See below under “Example Client SDK implementation” for an example of how to use the Client SDK within you website / webshop.
Base JSON request
Use the base request as instructed on this page
Pay Request
Parameters
Service specific parameters
| Parameter | Type | Required | Recommended | Description |
|---|---|---|---|---|
| Description | String | No | Yes | A description for the transaction, visible to the consumer in the Payconiq app. Please note: This is a basic parameter (optional), not a service specific parameter. |
Basic parameters
Example request
{
"Currency": "EUR",
"AmountDebit": 10,
"Invoice": "testinvoice123",
"Description": "Payment for testinvoice123",
"Services": {
"ServiceList": [
{
"Name": "payconiq",
"Action": "Pay"
}
]
}
}
Pay Response
Parameters
Service specific parameters
| Parameter | Type | Required | Recommended | Description |
|---|---|---|---|---|
| QrUrl | String | No | Yes | A URL pointing to a PNG of the QR code that can be scanned with the Payconiq app. Only useful for a custom QR implementation. |
| PayconiqUrl | String | N/A | N/A | Redirect mobile users to this URL if the operating system is not iOS or Android. |
| PayconiqIosUrl | String | N/A | N/A | Redirect mobile iOS users to this URL. |
| PayconiqAndroidUrl | String | N/A | N/A | Redirect mobile Android users to this URL. |
| TransactionId | String | N/A | N/A | This is the Payconiq transaction ID. |
Basic parameters
Example response
{
"Key": "899402E3B0854F698F6FB627A00Cxxxx",
"Status": {
"Code": {
"Code": 791,
"Description": "Pending processing"
},
"SubCode": {
"Code": "S002",
"Description": "An additional action is required: Redirect to Buckaroo"
},
"DateTime": "2018-06-27T10:24:05"
},
"RequiredAction": {
"RedirectURL": "https://testcheckout.buckaroo.nl/html/redirect.ashx?r=FE3BD28B5875494BBDD31FFB86E2xxxx",
"RequestedInformation": null,
"PayRemainderDetails": null,
"Name": "Redirect",
"TypeDeprecated": 0
},
"Services": [
{
"Name": "Payconiq",
"Action": null,
"Parameters": [
{
"Name": "QrUrl",
"Value": "https://static.buckaroo.nl/qr/v1/aHR0cHM6Ly9wYXljb25pcS5jb20vcGF5LzEvNWIzMzQ5YTU1MjI1ZmIxNTBmMjdlxxxx"
},
{
"Name": "PayconiqUrl",
"Value": "https://payconiq.com/pay/1/5b3349a55225fb150f27ebfa?returnUrl=https%3a%2f%2ftestcheckout.buckaroo.nl%2fhtml%2fsslreturnpage.aspx%3fbrq_payment%3dC4E20544AF0843849D948D000xxxx2"
},
{
"Name": "PayconiqIosUrl",
"Value": "payconiq.ext://payconiq.com/pay/1/5b3349a55225fb150f27ebfa?returnUrl=https%3a%2f%2ftestcheckout.buckaroo.nl%2fhtml%2fsslreturnpage.aspx%3fbrq_payment%3dC4E20544AF0843849D948D00xxxx5A2"
},
{
"Name": "PayconiqAndroidUrl",
"Value": "intent://payconiq.com/pay/1/5b3349a55225fb150f27ebfa?returnUrl=https%3a%2f%2ftestcheckout.buckaroo.nl%2fhtml%2fsslreturnpage.aspx%3fbrq_payment%3dC4E20544AF0843849D948D0xxxx835A2#Intent;scheme=payconiq;package=com.payconiq.customers.external;end"
},
{
"Name": "TransactionId",
"Value": "5b3349a55225fb150f27xxxxx"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice123",
"ServiceCode": "Payconiq",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "C096",
"MutationType": 1,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "C4E20544AF0843849D948D00028xxxxx"
}
Pay push
Parameters
Basic parameters
Example response
{
"Transaction": {
"Key": "899402E3B0854F698F6FB627A00Cxxxx",
"Invoice": "testinvoice123",
"ServiceCode": "Payconiq",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2019-06-21T15:34:47"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 0.01,
"TransactionType": "C096",
"Services": [
{
"Name": "Payconiq",
"Action": null,
"Parameters": [
{
"Name": "QrUrl",
"Value": "https://static.buckaroo.nl/qr/v1/xxxxxxxxxxxx"
},
{
"Name": "PayconiqUrl",
"Value": "https://payconiq.com/pay/1/d4f028e910cc9980e3ec594c?returnUrl=https%3a%2f%2ftestcheckout.buckaroo.nl%2fhtml%2fsslreturnpage.aspx%3fbrq_payment%3dxxxxxxxxxxxx"
},
{
"Name": "PayconiqIosUrl",
"Value": "payconiq.ext://payconiq.com/pay/1/d4f028e910cc9980e3ec594c?returnUrl=https%3a%2f%2ftestcheckout.buckaroo.nl%2fhtml%2fsslreturnpage.aspx%3fbrq_payment%3xxxxxxxxxxxx"
},
{
"Name": "PayconiqAndroidUrl",
"Value": "intent://payconiq.com/pay/1/d4f028e910cc9980e3ec594c?returnUrl=https%3a%2f%2ftestcheckout.buckaroo.nl%2fhtml%2fsslreturnpage.aspx%3fbrq_payment%3xxxxxxxxxxxx#Intent;scheme=payconiq;package=com.payconiq.customers.external;end"
},
{
"Name": "TransactionId",
"Value": "5b3349a55225fb150f27xxxxx"
},
{
"Name": "consumerName",
"Value": "John Smith"
},
{
"Name": "consumerIBAN",
"Value": "NL83RABO0123456789"
}
],
"VersionAsProperty": 1
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": null,
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": true,
"Recurring": false,
"CustomerName": "John Smith",
"PayerHash": null,
"PaymentKey": "C4E20544AF0843849D948D00028xxxxx"
}
}
Client SDK implementation
After you initiated a server side Pay request you can initiate the payment on the client side. You will need to initiate the Client SDK with two parameters:
Container selector: Use the query selector format for selecting a DOM element.
Transaction key: Insert the transaction key from the server side Pay response. You can find the value in the “Key” field of the JSON response.
When initiated the Client SDK will render a minimal “widget” inside the container element of your choice. The script will render a QR code and listen for status updates. In case the consumer is using a mobile device the script will redirect the consumer directly to the Payconiq app to complete the payment.
After the payment is completed, cancelled or failed the consumer will be redirected (by the SDK) to the ReturnUrl.
Include the ClientSDK like this in the bottom of the BODY element of your page. Like this:
<script src="https://checkout.buckaroo.nl/api/buckaroosdk/script"></script>
Note: The only dependency of the Buckaroo Client SDK is jQuery 1.9+
Script example:
$(document).ready(function() { BuckarooSdk.Payconiq.initiate("#payconiqQr", "94EDDFBCFF774714AEDE0F9346XXXX"); });
Refund
Refund request
Parameters
Service specific parameters
| Parameter | Type | Required | Recommended | Description |
|---|---|---|---|---|
| OriginalTransactionKey | String | Yes | N/A | Transaction key of the original transaction that needs to be refunded. Please note: This is a basic parameter, not a service specific parameter. This value is a 32-character hex string. |
Basic parameters
Example request
{
"Currency": "EUR",
"AmountCredit": 1,
"Invoice": "testinvoice 123",
"OriginalTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX",
"Services": {
"ServiceList": [
{
"Name": "Payconiq",
"Action": "Refund"
}
]
}
}
Refund response
Parameters
Service specific parameters
| Parameter | Type | Required | Recommended | Description |
|---|---|---|---|---|
| customeraccountname | String | N/A | N/A | The beneficiary of the bank account from which the payment was made. |
| CustomerIBAN | String | N/A | N/A | The international bank account number (iban code) of the bank of the consumer. Please note: This field is optional. In some countries, banks are not allowed to provide this information to third parties. |
Basic parameters
Example response
{
"Key": "F996EE747ECD43CDA8851C5F83XXXXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "De verwerking is geslaagd."
},
"DateTime": "2017-03-31T09:03:45"
},
"RequiredAction": null,
"Services": [
{
"Name": "Payconiq",
"Action": null,
"Parameters": [
{
"Name": "customeraccountname",
"Value": "J. de Tèster"
},
{
"Name": "CustomerIBAN",
"Value": "NL44RABO0123456789"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice 123",
"ServiceCode": "Payconiq",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 1,
"TransactionType": "C097",
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "J. de Tèster",
"PayerHash": null,
"PaymentKey": "AE8B6E18A2684846AAAF06A63FXXXXXX"
}
Refund push
Parameters
Basic parameters
Example push
{
"Transaction": {
"Key": "F996EE747ECD43CDA8851C5F83XXXXXX",
"Invoice": "testinvoice 123",
"ServiceCode": "Payconiq",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": null,
"DateTime": "2019-07-02T14:49:09"
},
"IsTest": false,
"Order": null,
"Currency": "EUR",
"AmountCredit": 0.01,
"TransactionType": "C097",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX"
}
],
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "J. de Tèster",
"PayerHash": null,
"PaymentKey": null
}
}
Was this article helpful?