Requests

Samenvatting van het artikel

Vond je deze samenvatting nuttig?

Bedankt voor uw feedback

Pay request

Gebruik het ‘Pay’ request om een iDEAL In3 transactie aan te maken. Na het indienen van het request wordt er een creditcheck gedaan op de consument en indien goedgekeurd, komt er een return URL waar de consument naar toe wordt geleid om de eerste iDeal transactie te kunnen doen. (één van de drie). De twee resterende betalingen kunnen later worden betaald. iDEAL In3 zal per mail een betaallink versturen aan de consument.

Base JSON request

Use the base request as instructed on this page

Parameters

Service specific parameters

Parameter	Type	GroupType	GroupId	Value	Required	Description
Identifier	string	Article	1	ABC123	Optional	Way to identity 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	VatA-mount address of the Article article
DeliveryDate	date	Article	1	45241	Optional	DeliveryDate of the article
CustomerNumber	string	BillingCustomer	1	123456	Mandatory	CustomerNumber of the billingcustomer
FirstName	string	BillingCustomer	1	John	Optional	FirstName of the billingcustomer
LastName	string	BillingCustomer	1	Doe	Mandatory	LastName of the billingcustomer
Initials	string	BillingCustomer	1	JD	Optional	Initials of the billingcustomer
BirthDate	date	BillingCustomer	1	32874	Optional	BirthDate of the billingcustomer
Phone	string	BillingCustomer	1	0612345678	Mandatory	Phone of the billingcustomer
Email	string	BillingCustomer	1	john@doe.com	Mandatory	E-mail address of the Billing customer
Fax	string	BillingCustomer	1	03012345678	Optional	Faxnumber of the billingcustomer
Category	string	BillingCustomer	1	B2C	Mandatory	Category of the billingcustomer
CareOf	string	BillingCustomer	1	John Doe	Optional	CareOf of the billingcustomer
Street	string	BillingCustomer	1	Zonnebaan	Mandatory	Street of the billingcustomer
StreetNumber	string	BillingCustomer	1	9	Mandatory	StreetNumber of the billingcustomer
StreetNumberSuffix	string	BillingCustomer	1	ABC123	Optional	StreetNumberSuffix of the billingcustomer
PostalCode	string	BillingCustomer	2	3542EA	Mandatory	PostalCode of the billingcustomer
City	string	BillingCustomer	1	Utrecht	Mandatory	City of the billingcustomer
Region	string	BillingCustomer	1	Utrecht	Optional	Region of the billingcustomer
CountryCode	string	BillingCustomer	1	NL	Mandatory	CountryCode of the billingcustomer
Careof	string	ShippingCustomer	1	Jane Doe	Optional	Careof of the shippingcustomer
Street	string	ShippingCustomer	1	Zonnebaan	Mandatory	Street of the shippingcustomer
StreetNumber	string	ShippingCustomer	1	9	Mandatory	StreetNumber of the shippingcustomer
StreetNumberSuffix	string	ShippingCustomer	1	ABC123	Optional	StreetNumberSuffix of the shippingcustomer
City	string	ShippingCustomer	1	Utrecht	Mandatory	City of the shippingcustomer
PostalCode	string	ShippingCustomer	1	3542EA	Mandatory	PostalCode of the shippingcustomer
Region	string	ShippingCustomer	1	Utrecht	Optional	Region of the shippingcustomer
CountryCode	string	ShippingCustomer	1	NL	Mandatory	CountryCode of the shippingcustomer
Invoicedate	date		""	45261	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 billingcustomer
CocNumber	string	BillingCustomer	1	None	Optional	CocNumber of the billingcustomer

Voorbeeld 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": "iDEAL 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": "john@doe.com"
          },
          {
            "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.

Voorbeeld 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": "iDEAL 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

Wanneer de betaling is gelukt en de consument succesvol is geleid naar de Merchants website, zal Buckaroo het volgende push bericht sturen.

Voorbeeld push

{
  "Transaction": {
    "Key": "9A2C1AEC43F64EAA820970**********",
    "Invoice": "iDEAL In3 Pay 1693216267",
    "ServiceCode": "iDEAL 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

Dit request kan worden gebruikt om een refund (of annulering) van een geplaatste order uit te voeren.

Refund request

Om dit request uit te voeren is het te crediteren bedrag en de transactie key nodig van de originele bestelling.

Voorbeeld 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": "iDEAL In3",
        "Action": "Refund",
        "Version": 0,
        "Parameters": []
      }
    ]
  },
  "CustomParameters": null,
  "AdditionalParameters": null
}

Refund response

Voorbeeld 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": "iDEAL In3",
      "Action": null,
      "Parameters": [
        {
          "Name": "Processed",
          "Value": "Classic"
        }
      ]
    }
  ],
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": null,
  "Invoice": "iDEAL In3 Refund 1693216289",
  "ServiceCode": "iDEAL 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

Voorbeeld push

{
  "Transaction": {
    "Key": "0AA2B55B366A48D690D762**********",
    "Invoice": "iDEAL In3 Refund 1693216289",
    "ServiceCode": "iDEAL 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"
  }
}

Was dit artikel nuttig?

What's Next

Inhoudsopgave

Refund