Requests
Requests
Article summary
Did you find this summary helpful?
Thank you for your feedback
Create
The Create request is a data request and is used to create a new wallet. It is possible to provide customer details but this is not required. Customer details can be added or updated at a later moment by the Update request. The WalletId must be unique, regardless of test or live. It is not possible to delete a wallet, but only to (de)activate it.
Create request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletId | string | Yes | Unique identifier of the Buckaroo Wallet for the merchant. Should be provided when performing updates on the wallet. |
| ConsumerFirstName | string | First name of the customer | |
| ConsumerLastName | string | Last name of the customer | |
| ConsumerEmail | string | Email address of the customer | |
| ConsumerIban | string | IBAN number of the customer. | |
| Currency | string | Yes | Currency of the Wallet |
Example request
{
"Currency": "EUR",
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "Create",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "ConsumerFirstName",
"Value": "First Name"
},
{
"Name": "ConsumerLastName",
"Value": "Last Name"
},
{
"Name": "ConsumerEmail",
"Value": "test@gmail.com"
},
{
"Name": "ConsumerIban",
"Value": "NL13TEST0123456789"
}
]
}
]
}
}
Create response
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletGuid | string | Unique identifier of the Wallet used by Buckaroo. | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant. Should be provided when performing updates on the wallet. |
Basic parameters
Example response
{
"Key": "1757B313E57E4973997DD8C5235A3D48",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T11:09:24"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletGuid",
"Value": "313BC97B38084203A4592A0515044"
},
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"ConsumerMessage": null
}
Update
The Update request is a data request that can be used to update information of a wallet, with the exception of the WalletId itself. Additionally, the Wallet status can be updated.
Update request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletId | string | Yes | Unique identifier of the Buckaroo Wallet for the merchant. Cannot be updated. Should be provided to specify the wallet that needs to be updated. |
| ConsumerFirstName | string | First name of the customer | |
| ConsumerLastName | string | Last name of the customer | |
| ConsumerEmail | string | Email address of the customer | |
| ConsumerIban | string | IBAN number of the customer. | |
| Status | string | Status of the wallet. Possible values: Active, Disabled |
Example request
{
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "Update",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "ConsumerFirstName",
"Value": "First Name"
},
{
"Name": "ConsumerLastName",
"Value": "Last Name"
},
{
"Name": "ConsumerEmail",
"Value": "test@gmail.com"
},
{
"Name": "ConsumerIban",
"Value": "NL13TEST0123456789"
},
{
"Name": "Status",
"Value": "Disabled"
}
]
}
]
}
}
Update response
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletGuid | string | Unique identifier of the Wallet used by Buckaroo. | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant. Should be provided when performing updates on the wallet. |
Basic parameters
Example response
{
"Key": "1757B313E57E4973997DD8C5235A3D48",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T11:09:24"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletGuid",
"Value": "313BC97B38084203A4592A0515044"
},
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"ConsumerMessage": null
}
GetInfo
The GetInfo request is a data request that can be used to retrieve information of a Wallet.
GetInfo request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletId | string | Yes | Unique identifier of the Buckaroo Wallet for the merchant. Cannot be updated.. Should be provided to specify the wallet that needs to be updated. |
Example request
{
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "GetInfo",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
}
]
}
]
}
}
GetInfo response
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletGuid | string | Unique identifier of the Wallet used by Buckaroo. | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant | |
| ConsumerFirstName | string | First name of the customer | |
| ConsumerLastName | string | Last name of the customer | |
| ConsumerEmail | string | Email address of the customer | |
| ConsumerIban | string | IBAN number of the customer. | |
| Status | string | Status of the wallet | |
| Currency | string | Currency of the wallet balance | |
| CurrentBalance | decimal | Currence balance of the Wallet | |
| CurrentUsableBalance | decimal | Balance that is usable for mutations like payments and withdrawals. |
Basic parameters
Example response
{
"Key": "1757B313E57E4973997DD8C5235A3D48",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T11:09:24"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletGuid",
"Value": "313BC97B38084203A4592A051504"
},
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "ConsumerFirstName",
"Value": "First Name"
},
{
"Name": "ConsumerLastName",
"Value": "Last Name"
{
"Name": "ConsumerEmail",
"Value": "test@gmail.com"
},
{
"Name": "ConsumerIban",
"Value": "NL13TEST0123456789"
},
{
"Name": "Status",
"Value": "Disabled"
},
{
"Name": "Currency",
"Value": "EUR"
},
{
"Name": "CurrentBalance",
"Value": "10.00"
},
{
"Name": "CurrentUsableBalance",
"Value": "10.00"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"ConsumerMessage": null
}
Release
The Release request is a data request that can be used to make a reserved amount usable in the Buckaroo Wallet, so it can be used to perform mutations like payments and withdrawals.
Release request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Currency | string | Yes | Currency of the release amount. This is a basic parameter, not a service parameter. |
| AmountCredit | Decimal | Yes | The release amount. This is a basic parameter, not a service parameter. |
| WalletMutationGuid | string | Only if WalletId is not provied | Unique identifier of a reservation. The provided AmountCredit will be released for this reservation (even if the WalletId is provided as well). If not provided, then the WalletId is required. |
| WalletId | string | Only if WalletMutationGuid is not provided | Unique identifier of the Buckaroo Wallet for the merchant. The provided AmountCredit will be released starting from the oldest reservation to the newest reservation. If not provided, then the WalletMutationGuid is required. |
Example request
{
"Currency": "EUR",
"AmountCredit": 1,
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "Release",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "WalletMutationGuid",
"Value": "1757B313E57E4973997DD8C5235A"
}
]
}
]
}
}
Release response
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletMutationGuid | string | Unique identifier of the reservation. | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example response
{
"Key": "1757B313E57E4973997DD8C5235A3D48",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T11:09:24"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "WalletMutationGuid",
"Value": "313BC97B38084203A4592A0515044"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"ConsumerMessage": null
}
Deposit
The Deposit request is a transaction request that can be used to increase a wallet balance. Transaction data like AmountCredit and currency is required to specify the transaction.
Deposit request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Currency | string | Yes | Currency of the deposit amount. This is a basic parameter, not a service parameter. |
| AmountCredit | Decimal | Yes | The deposit amount. This is a basic parameter, not a service parameter. |
| Invoice | string | Yes | Invoice number of the Deposit transaction. This is a basic parameter, not a service parameter. |
| OriginalTransactionKey | string | Transaction key of a transaction that is used as reference for the deposit transaction. If provided, the specified AmountCredit will still be regarded as the deposit amount. This is a basic parameter, not a service parameter. | |
| WalletId | string | Yes | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example request
{
"Currency": "EUR",
"AmountCredit": 1,
"Invoice": "BuckarooWalletInvoiceId",
"OriginalTransactionKey": "46FB241693914AA4AE7A8B6DB33DE",
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "Deposit",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
}
]
}
]
}
}
Deposit response
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletMutationGuid | string | Unique identifier of the Deposit | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example response
{
"Key": "49B018248ECE4346AC20B9020DAD",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T10:23:13"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "WalletMutationGuid",
"Value": "313BC97B38084203A4592A051504"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "BuckarooWalletInvoiceId",
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 1,
"TransactionType": "V803", // To be determined yet
"MutationType": 2,
"RelatedTransactions": [
{
"RelationType": "BuckarooWalletDeposit",
"RelatedTransactionKey": "46FB241693914AA4AE7A8B6DB33DE"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "3E6437D538BB469FBA723A30BC33"
}
Reserve
The Reserve request is a transaction request that can be used to increase the balance of a wallet, with the only difference that the reserved amount is not yet usable. The request is, apart from its action name, identical to the Deposit request.
Reserve request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Currency | string | Yes | Currency of the Reserve amount. This is a basic parameter, not a service parameter. |
| AmountCredit | Decimal | Yes | The Reserve amount. This is a basic parameter, not a service parameter. |
| Invoice | string | Yes | Invoice number of the Reserve transaction. This is a basic parameter, not a service parameter. |
| OriginalTransactionKey | string | Transaction key of a transaction that is used as reference for the Reserve transaction. If provided, the specified AmountCredit will still be regarded as the Reserve amount. This is a basic parameter, not a service parameter. | |
| WalletId | string | Yes | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example request
{
"Currency": "EUR",
"AmountCredit": 1,
"Invoice": "BuckarooWalletInvoiceId",
"OriginalTransactionKey": "46FB241693914AA4AE7A8B6DB33DE",
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "Reserve",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
}
]
}
]
}
}
Reserve response
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletMutationGuid | string | Unique identifier of the reservation. | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example response
{
"Key": "49B018248ECE4346AC20B9020DADEXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T10:23:13"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "WalletMutationGuid",
"Value": "313BC97B38084203A4592A05150448F6"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "BuckarooWalletInvoiceId",
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 1,
"TransactionType": "V803", // To be determined yet
"MutationType": 2,
"RelatedTransactions": [
{
"RelationType": "BuckarooWalletReservation",
"RelatedTransactionKey": "46FB241693914AA4AE7A8B6DB33"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "3E6437D538BB469FBA723A30BC33AXXX"
}
Withdrawal
The Withdrawal request is a transaction request that can be used to decrease a Wallet's usable balance.
Withdrawal request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Currency | string | Yes | Currency of the Withdrawal amount. This is a basic parameter, not a service parameter |
| AmountDebit | Decimal | Yes | The Withdrawal amount. This is a basic parameter, not a service parameter. |
| Invoice | string | Yes | Invoice number of the Withdrawal transaction. This is a basic parameter, not a service parameter. |
| OriginalTransactionKey | string | Transaction key of a transaction that is used as reference for the Withdrawal transaction. If provided, the specified AmountDebit will still be regarded as the Withdrawal amount. This is a basic parameter, not a service parameter. | |
| WalletId | string | Yes | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example request
{
"Currency": "EUR",
"AmountDebit": 1,
"Invoice": "BuckarooWalletInvoiceId",
"OriginalTransactionKey": "46FB241693914AA4AE7A8B6DB33D",
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "Withdrawal",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
}
]
}
]
}
}
Withdrawal response
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletMutationGuid | string | Unique identifier of the Withdrawal | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example response
{
"Key": "49B018248ECE4346AC20B9020",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T10:23:13"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "WalletMutationGuid",
"Value": "313BC97B38084203A4592A05150"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "BuckarooWalletInvoiceId",
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 1,
"TransactionType": "V803", // To be determined yet
"MutationType": 2,
"RelatedTransactions": [
{
"RelationType": "BuckarooWalletWithdrawal",
"RelatedTransactionKey": "46FB241693914AA4AE7A8B6DB33"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "3E6437D538BB469FBA723A30BC33"
}
CancelReservation
The CancelReservation request is a transaction request that cancels a reserved amount. As a result, it will decrease the balance of the wallet.
CancelReservation request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Currency | string | Yes | Currency of the CancelReservation transaction. This is a basic parameter, not a service parameter. |
| AmountDebit | Decimal | Yes | The CancelReservation amount. This is a basic parameter, not a service parameter. |
| Invoice | string | Yes | Invoice number of the CancelReservation transaction. This is a basic parameter, not a service parameter. |
| OriginalTransactionKey | string | Transaction key of a transaction that is used as reference for the CancelReservation transaction. If provided, the specified AmountDebit will still be regarded as the CancelReservation amount. This is a basic parameter, not a service parameter. | |
| WalletMutationGuid | string | Yes | Unique identifier of the Reservation. |
Basic parameters
Example request
{
"Currency": "EUR",
"AmountDebit": 1,
"Invoice": "BuckarooWalletInvoiceId",
"OriginalTransactionKey": "49B018248ECE4346AC20B90",
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "CancelReservation",
"Parameters": [
{
"Name": "WalletMutationGuid",
"Value": "49B018248ECE4346AC20B902"
}
]
}
]
}
}
CancelReservation response
Parameters
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletMutationGuid | string | Unique identifier of the CancelReservation mutation. | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example response
{
"Key": "EE4E2E5270104413B73CF70B1A4XXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2024-01-16T15:38:18"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletId",
"Value": "TestWallet001"
},
{
"Name": "WalletMutationGuid",
"Value": "89D137F4897D4D87BCEC7EFB0F80XXXX"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "BuckarooWalletInvoiceId",
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": false,
"Currency": "EUR",
"AmountDebit": 0.5,
"TransactionType": "C113",
"MutationType": 1,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "First Name2 Last Name2",
"PayerHash": null,
"PaymentKey": "F4A38E1EDBD047669C60B9F867DDXXXX"
}
Pay
The Pay request is a transaction request that can be used to spend an amount in the usable balance of the wallet.
Pay request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Currency | string | Yes | Currency of the Pay transaction. This is a basic parameter, not a service parameter. |
| AmountDebit | Decimal | Yes | The Pay amount. This is a basic parameter, not a service parameter. |
| Invoice | string | Yes | Invoice number of the Pay transaction. This is a basic parameter, not a service parameter. |
| WalletId | string | Yes | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example request
{
"Invoice": "BuckarooWalletInvoiceId",
"Currency": "EUR",
"AmountDebit": 1,
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "Pay",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
}
]
}
]
}
}
Pay response
Parameters
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletMutationGuid | string | Unique identifier of the Pay mutation in the Wallet. | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example response
{
"Key": "46FB241693914AA4AE7A8B6DB33DEXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T10:23:13"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "WalletMutationGuid",
"Value": "313BC97B38084203A4592A051504"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "BuckarooWalletInvoiceId",
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 1,
"TransactionType": "V802", // To be determined yet
"MutationType": 2,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "First Name Last Name",
"PayerHash": null,
"PaymentKey": "DF7CC74BFBD54DF3B5CCCFF1171B3XXX"
}
Refund
The Refund request is a transaction request and can be used to perform a refund on a previously successful Wallet Pay transaction. This will increase the usable balance of the Wallet.
Refund request
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Currency | string | Yes | Currency of the Refund transaction. This is a basic parameter, not a service parameter. |
| AmountCredit | Decimal | Yes | The Refund amount. This is a basic parameter, not a service parameter.. |
| Invoice | string | Yes | Invoice number of the Refund transaction. This is a basic parameter, not a service parameter. |
| OriginalTransactionKey | string | Yes | Transaction key of successful Wallet Pay transaction. This is a basic parameter, not a service parameter. |
Basic parameters
Example request
{
"Invoice": "BuckarooWalletInvoiceId",
"Currency": "EUR",
"AmountDebit": 1,
"Services": {
"ServiceList": [
{
"Name": "BuckarooWalletCollecting",
"Action": "Pay",
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
}
]
}
]
}
}
Refund response
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| WalletMutationGuid | string | Unique identifier of the Refund mutation. | |
| WalletId | string | Unique identifier of the Buckaroo Wallet for the merchant |
Basic parameters
Example response
{
"Key": "46FB241693914AA4AE7A8B6DB33DEXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2021-12-23T10:23:13"
},
"RequiredAction": null,
"Services": [
{
"Name": "BuckarooWalletCollecting",
"Action": null,
"Parameters": [
{
"Name": "WalletId",
"Value": "SomeMerchantUniqueValue"
},
{
"Name": "WalletMutationGuid",
"Value": "313BC97B38084203A4592A051504"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "BuckarooWalletInvoiceId",
"ServiceCode": "BuckarooWalletCollecting",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 1,
"TransactionType": "V802", // To be determined yet
"MutationType": 2,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "First Name Last Name",
"PayerHash": null,
"PaymentKey": "DF7CC74BFBD54DF3B5CCCFF1171B3XXX"
}
Was this article helpful?