Requests

Pay

The Pay action is the default action for the Bizum service. With this action a new transaction will be initiated.

Pay request

Example pay request:

{
    "Invoice":"Bizum_Test_{{#buck_timestamp}}",
    "Description":"Test",
    "Currency":"EUR",
    "AmountDebit":1.00,
    "ReturnURL": "https://www.buckaroo.nl",
    "ReturnURLCancel": "https://www.buckaroo.nl/annuleren",
    "ReturnURLError": "https://www.buckaroo.nl/mislukt",
    "ReturnURLReject": "https://www.buckaroo.nl/geweigerd",
    "Services":{
        "ServiceList":[
            {
                "Name":"Bizum",
                "Action":"Pay",
                "Parameters":[
                ]
            }
        ]
    }
}

Pay response

Example pay response:

{
    "Invoice":"Bizum_Test_{{#buck_timestamp}}",
    "Description":"Test",
    "Currency":"EUR",
    "AmountDebit":1.00,
    "ReturnURL": "https://www.buckaroo.nl",
    "ReturnURLCancel": "https://www.buckaroo.nl/annuleren",
    "ReturnURLError": "https://www.buckaroo.nl/mislukt",
    "ReturnURLReject": "https://www.buckaroo.nl/geweigerd",
    "Services":{
        "ServiceList":[
            {
                "Name":"Bizum",
                "Action":"Pay",
                "Parameters":[
                ]
            }
        ]
    }
}

Pay push

Example push:

{
	"Transaction": {
		"Key": "948547CF2D8E456ABF3E84A948D62DAA ",
		"Invoice": "Testinvoice 123",
		"ServiceCode": "Bizum",
		"Status": {
			"Code": {
				"Code": 190,
				"Description": "Success"
			},
			"SubCode": {
				"Code": "S990",
				"Description": "The request was successful."
			},
			"DateTime": "2025-09-02T10:27:34"
		},
		"IsTest": true,
		"Order": null,
		"Currency": "EUR",
		"AmountDebit": 1.00,
		"TransactionType": " C254",
		"Services": null,
		"CustomParameters": null,
		"AdditionalParameters": null,
		"MutationType": 1,
		"RelatedTransactions": null,
		"IsCancelable": false,
		"IssuingCountry": null,
		"StartRecurrent": false,
		"Recurring": false,
		"PayerHash": null,
		"PaymentKey": "F0E1A003B8194CA5A3BDAD39D253XXXX"
	}
}

Refund request

Example refund request:

{
    "Currency": "EUR",
    "AmountCredit": 1.0,
    "Invoice": "testinvoice 123",
    "OriginalTransactionKey": "948547CF2D8E456ABF3E84A948D62DAA",
    "Services": {
        "ServiceList": [
            {
                "Name": "Bizum",
                "Action": "Refund"
            }
        ]
    }
}

Refund response

Example refund response:

{
    "Key": " A5119DE5DE0144AF9EC99D886269123",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S990",
            "Description": "The request was successful."
        },
        "DateTime": "2020-01-08T16:05:56"
    },
    "RequiredAction": null,
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "testinvoice 123",
    "ServiceCode": "Bizum",
    "IsTest": true,
    "Currency": "EUR",
    "AmountCredit": 1.00,
    "TransactionType": "C255",
    "MutationType": 1,
    "RelatedTransactions": [
        {
            "RelationType": "refund",
            "RelatedTransactionKey": "948547CF2D8E456ABF3E84A948D62DAA "
        }
    ],
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "4090E8741FE44442A09096D64E29345"
}

Refund push

Example push:

{
    "Transaction": {
        "Key": "A5119DE5DE0144AF9EC99D886269123",
        "Invoice": "testinvoice 123",
        "ServiceCode": "Bizum",
        "Status": {
            "Code": {
                "Code": 190,
                "Description": "Success"
            },
            "SubCode": null,
            "DateTime": "2020-01-08T16:05:56"
        },
        "IsTest": true,
        "Order": null,
        "Currency": "EUR",
        "AmountCredit": 1.00,
        "TransactionType": "C255",
        "Services": null,
        "CustomParameters": null,
        "AdditionalParameters": null,
        "MutationType": 1,
        "RelatedTransactions": [
            {
                "RelationType": "refund",
                "RelatedTransactionKey": "948547CF2D8E456ABF3E84A948D62DAA"
            }
        ],
        "IsCancelable": false,
        "IssuingCountry": null,
        "StartRecurrent": false,
        "Recurring": false,
        "CustomerName": null,
        "PayerHash": null,
        "PaymentKey": null
    }
}