Requests
Pay Request
Use Pay to create an iDEAL in3 transaction. Performing this call initiates a credit check of the customer and - if approved - returns a redirect URL where the customer needs to be redirected to in order to perform the first payment (one of three). The remaining two installments can be paid later; iDEAL in3 will send the payment instructions per email to the consumer.
Parameters
Service specific parameters
| Parameter | Type | GroupType | GroupId | Value | Required | Description |
|---|---|---|---|---|---|---|
| Identifier | string | Article | 1 | ABC123 | Optional | Way to identify article |
| Type | string | Article | 1 | Physical | Optional | Type of the article |
| Description | string | Article | 1 | Blue Toy Car | Mandatory | Description of the order |
| Category | string | Article | 1 | Toy Car | Optional | Category of the article |
| Quantity | integer | Article | 1 | 1 | Mandatory | Quantity of the article |
| GrossUnitPrice | decimal | Article | 1 | 5000 | Mandatory | GrossUnitPrice of the article |
| QuantityDescription | string | Article | 1 | Pieces | Optional | QuantityDescription of the article |
| VatPercentage | numeric | Article | 1 | 21 | Optional | VatPercentage of the article |
| VatAmount | decimal | Article | 1 | 0.01 | Optional | Vat Amount of the Article |
| DeliveryDate | date | Article | 1 | YYYY-MM-DD | Optional | DeliveryDate of the article |
| CustomerNumber | string | BillingCustomer | 1 | 123456 | Mandatory | CustomerNumber of the billing customer |
| FirstName | string | BillingCustomer | 1 | John | Optional | FirstName of the billing customer |
| LastName | string | BillingCustomer | 1 | Doe | Mandatory | LastName of the billing customer |
| Initials | string | BillingCustomer | 1 | JD | Optional | Initials of the billing customer |
| BirthDate | date | BillingCustomer | 1 | YYYY-MM-DD | Optional | BirthDate of the billing customer |
| Phone | string | BillingCustomer | 1 | 0612345678 | Mandatory | Phone of the billing customer |
| string | BillingCustomer | 1 | [email protected] | Mandatory | E-mail address of the Billing customer | |
| Fax | string | BillingCustomer | 1 | 03012345678 | Optional | Fax number of the billing customer |
| Category | string | BillingCustomer | 1 | B2C | Mandatory | Category of the billing customer |
| CareOf | string | BillingCustomer | 1 | John Doe | Optional | CareOf of the billing customer |
| Street | string | BillingCustomer | 1 | Zonnebaan | Mandatory | Street of the billing customer |
| StreetNumber | string | BillingCustomer | 1 | 9 | Mandatory | StreetNumber of the billing customer |
| StreetNumberSuffix | string | BillingCustomer | 1 | ABC123 | Optional | StreetNumberSuffix of the billing customer |
| PostalCode | string | BillingCustomer | 2 | 3542EA | Mandatory | PostalCode of the billing customer |
| City | string | BillingCustomer | 1 | Utrecht | Mandatory | City of the billing customer |
| Region | string | BillingCustomer | 1 | Utrecht | Optional | Region of the billing customer |
| CountryCode | string | BillingCustomer | 1 | NL | Mandatory | CountryCode of the billing customer |
| Careof | string | ShippingCustomer | 1 | Jane Doe | Optional | Careof of the shipping customer |
| Street | string | ShippingCustomer | 1 | Zonnebaan | Mandatory | Street of the shipping customer |
| StreetNumber | string | ShippingCustomer | 1 | 9 | Mandatory | StreetNumber of the shipping customer |
| StreetNumberSuffix | string | ShippingCustomer | 1 | ABC123 | Optional | StreetNumberSuffix of the shipping customer |
| City | string | ShippingCustomer | 1 | Utrecht | Mandatory | City of the shipping customer |
| PostalCode | string | ShippingCustomer | 1 | 3542EA | Mandatory | PostalCode of the shipping customer |
| Region | string | ShippingCustomer | 1 | Utrecht | Optional | Region of the shipping customer |
| CountryCode | string | ShippingCustomer | 1 | NL | Mandatory | CountryCode of the shipping customer |
| Invoicedate | date | YYYY-MM-DD | Optional | Invoicedate of the Customer | ||
| InvoiceUrl | string | https://www.buckaroo.nl | Optional | URL of the Customer | ||
| CompanyName | string | BillingCustomer | 1 | None | Optional | Company Name of the billing customer |
| CocNumber | string | BillingCustomer | 1 | None | Optional | CocNumber of the billing customer |
Example request
{
"Currency": "EUR",
"AmountDebit": 5000.0,
"AmountCredit": null,
"Invoice": "iDEAL In3 Pay 1693216267",
"Order": null,
"Description": "iDEAL In3_Pay",
"ClientIP": null,
"ReturnURL": null,
"ReturnURLCancel": null,
"ReturnURLError": null,
"ReturnURLReject": null,
"OriginalTransactionKey": null,
"ServicesSelectableByClient": null,
"ServicesExcludedForClient": null,
"PushURL": null,
"PushURLFailure": null,
"ClientUserAgent": null,
"OriginalTransactionReference": null,
"Services": {
"ServiceList": [
{
"Name": "In3",
"Action": "Pay",
"Version": 0,
"Parameters": [
{
"Name": "Identifier",
"GroupType": "Article",
"GroupID": "1",
"Value": "ABC123"
},
{
"Name": "Type",
"GroupType": "Article",
"GroupID": "1",
"Value": "Physical"
},
{
"Name": "Description",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "Category",
"GroupType": "Article",
"GroupID": "1",
"Value": "Toy Car"
},
{
"Name": "Quantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "1"
},
{
"Name": "GrossUnitPrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "5000"
},
{
"Name": "QuantityDescription",
"GroupType": "Article",
"GroupID": "1",
"Value": "Pieces"
},
{
"Name": "VatPercentage",
"GroupType": "Article",
"GroupID": "1",
"Value": "21"
},
{
"Name": "VatAmount",
"GroupType": "Article",
"GroupID": "1",
"Value": "0.01"
},
{
"Name": "DeliveryDate",
"GroupType": "Article",
"GroupID": "1",
"Value": "2023-11-11"
},
{
"Name": "CustomerNumber",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "123456"
},
{
"Name": "FirstName",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "John"
},
{
"Name": "LastName",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "Doe"
},
{
"Name": "Initials",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "JD"
},
{
"Name": "BirthDate",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "1990-01-01"
},
{
"Name": "Phone",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "0630352688"
},
{
"Name": "Email",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "[email protected]"
},
{
"Name": "Fax",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "0301234567"
},
{
"Name": "Category",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "B2C"
},
{
"Name": "CareOf",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "John Doe"
},
{
"Name": "Street",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "Zonnebaan"
},
{
"Name": "StreetNumber",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "9"
},
{
"Name": "StreetNumberSuffix",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "A"
},
{
"Name": "PostalCode",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "3542EA"
},
{
"Name": "City",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "Utrecht"
},
{
"Name": "Region",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "Utrecht"
},
{
"Name": "CountryCode",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "NL"
},
{
"Name": "CareOf",
"GroupType": "ShippingCustomer",
"GroupID": "1",
"Value": "Jane Doe"
},
{
"Name": "Street",
"GroupType": "ShippingCustomer",
"GroupID": "1",
"Value": "Zonebaan"
},
{
"Name": "StreetNumber",
"GroupType": "ShippingCustomer",
"GroupID": "1",
"Value": "9"
},
{
"Name": "StreetNumberSuffix",
"GroupType": "ShippingCustomer",
"GroupID": "1",
"Value": "A"
},
{
"Name": "City",
"GroupType": "ShippingCustomer",
"GroupID": "1",
"Value": "Utrecht"
},
{
"Name": "PostalCode",
"GroupType": "ShippingCustomer",
"GroupID": "1",
"Value": "3542EA"
},
{
"Name": "Region",
"GroupType": "ShippingCustomer",
"GroupID": "1",
"Value": "Utrecht"
},
{
"Name": "CountryCode",
"GroupType": "ShippingCustomer",
"GroupID": "1",
"Value": "NL"
},
{
"Name": "InvoiceDate",
"GroupType": "",
"GroupID": "",
"Value": "2023-12-01"
},
{
"Name": "InvoiceUrl",
"GroupType": "",
"GroupID": "",
"Value": "https://www.buckaroo.nl"
},
{
"Name": "CompanyName",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "none"
},
{
"Name": "CocNumber",
"GroupType": "BillingCustomer",
"GroupID": "1",
"Value": "none"
}
]
}
]
},
"CustomParameters": null,
"AdditionalParameters": null
}
Pay response
The response contains a URL where the customer can be redirected to in order to perform the first initial payment.
Example response
{
"Key": "9A2C1AEC43F64EAA820970**********",
"Status": {
"Code": {
"Code": 791,
"Description": "Pending processing"
},
"SubCode": {
"Code": "S002",
"Description": "An additional action is required: Redirect"
},
"DateTime": "2023-08-28T11:51:08"
},
"RequiredAction": {
"RedirectURL": "https://checkout.buckaroo.nl/html/redirect.ashx?r=A85BFD4B91BC48189C588***********",
"RequestedInformation": null,
"PayRemainderDetails": null,
"Name": "Redirect",
"TypeDeprecated": 0
},
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "iDEAL In3 Pay 1693216267",
"ServiceCode": "In3",
"Currency": "EUR",
"AmountDebit": 5000.0,
"TransactionType": "C103",
"MutationType": 1,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "03AB82E49A834D2CB06B98**********"
}
Pay push
When the payment has been done and the customer has successfully been redirected back to the merchants' website, the following push will be performed by Buckaroo.
Example push
{
"Transaction": {
"Key": "9A2C1AEC43F64EAA820970**********",
"Invoice": "iDEAL In3 Pay 1693216267",
"ServiceCode": "In3",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2023-08-28T11:51:21"
},
"Order": null,
"Currency": "EUR",
"AmountDebit": 5000.0,
"TransactionType": "C103",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": null,
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "03AB82E49A834D2CB06B98**********",
"Description": "iDEAL In3_Pay"
}
}
Refund
This action can be used to perform a refund (or cancellation) of a placed order.
Refund request
For this request, it is required to provide an AmountDebit and the TransactionKey of the original order.
Example request
{
"Currency": "EUR",
"AmountDebit": null,
"AmountCredit": 5000.0,
"Invoice": "iDEAL In3 Refund 1693216289",
"Order": null,
"Description": "iDEAL In3_Refund",
"ClientIP": null,
"ReturnURL": null,
"ReturnURLCancel": null,
"ReturnURLError": null,
"ReturnURLReject": null,
"OriginalTransactionKey": "9A2C1AEC43F64EAA820970**********",
"ServicesSelectableByClient": null,
"ServicesExcludedForClient": null,
"PushURL": null,
"PushURLFailure": null,
"ClientUserAgent": null,
"OriginalTransactionReference": null,
"Services": {
"ServiceList": [
{
"Name": "In3",
"Action": "Refund",
"Version": 0,
"Parameters": []
}
]
},
"CustomParameters": null,
"AdditionalParameters": null
}
Refund response
Example response
{
"Key": "0AA2B55B366A48D690D762**********",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2023-08-28T11:51:30"
},
"RequiredAction": null,
"Services": [
{
"Name": "In3",
"Action": null,
"Parameters": [
{
"Name": "Processed",
"Value": "Classic"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "i
DEAL In3 Refund 1693216289",
"ServiceCode": "In3",
"Currency": "EUR",
"AmountCredit": 5000.0,
"TransactionType": "C203",
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "9A2C1AEC43F64EAA820970**********"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "40CB985149BE46BF9A67D5**********"
}
Refund push
Example push
{
"Transaction": {
"Key": "0AA2B55B366A48D690D762**********",
"Invoice": "iDEAL In3 Refund 1693216289",
"ServiceCode": "In3",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2023-08-28T11:51:30"
},
"Order": null,
"Currency": "EUR",
"AmountCredit": 5000.0,
"TransactionType": "C203",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "9A2C1AEC43F64EAA820970**********"
}
],
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "40CB985149BE46BF9A67D5**********",
"Description": "iDEAL In3_Refund"
}
}
Updated 23 days ago