Requests
Pay
The pay action is the default action for the gift card service. The action is used to perform a gift card payment.
Base JSON request
Note
Use the base request as instructed on this page.
Parameters
Basic Parameters:
- Find basic parameters here.
Pay Request
Parameters
- Service Specific Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| FashionChequeCardNumber | String | Required if the gift card is from FashionCheque | The number as displayed on the FashionCheque card |
| FashionChequePIN | String | Required if the gift card is from FashionCheque | The Personal Identification Number of the card |
| IntersolveCardnumber | String | Required if the gift card is from Intersolve | The number as displayed on the InterSolve card |
| IntersolvePIN | String | Required if the gift card is from Intersolve | The Personal Identification Number of the card |
| TCSCardnumber | String | Required if the gift card is from TCS | The number as displayed on the TCS card |
| TCSValidationCode | String | Required if the gift card is from TCS | The Personal Identification Number of the card |
| Cardnumber | String | Required when using a custom gift card service | The number as displayed on the gift card |
| PIN | String | Required when using a custom gift card service | The Personal Identification Number of the card |
| LastName | String | Optional | Last name of the customer |
| String | Optional | Email address of the customer |
Example Request
{
"Currency": "EUR",
"AmountDebit": 10,
"Invoice": "testinvoice 123",
"Services": {
"ServiceList": [
{
"Name": "boekenbon",
"Action": "Pay",
"Parameters": [
{
"Name": "IntersolveCardnumber",
"Value": "0000000000000000001"
},
{
"Name": "IntersolvePin",
"Value": "1000"
}
]
}
]
}
}
Pay Response
If the gift card has sufficient balance to cover the full transaction amount, the payment will be completed with one gift card transaction and return a success status. If the balance does not cover the full amount, the response will provide a redirect URL for completing the payment on the checkout page, allowing for multiple partial payments.
Parameters
Example Response
{
"Key": "C11C13902A0848FCA1DA17C10332XXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2019-03-23T00:18:27"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice 123",
"ServiceCode": "boekenbon",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "V238",
"MutationType": 2,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "D450A4D7E25A49D3A5E9E643D6F2XXXX"
}
Pay Push
Example Push
{
"Transaction": {
"Key": "901745AE6B4643C6837497C513D2xxxx",
"Invoice": "testinvoice 123",
"ServiceCode": "boekenbon",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S003",
"Description": "A partial payment of EUR 1 was successfully performed on a requested amount of EUR 10.00."
},
"DateTime": "2019-03-22T23:28:13"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 1,
"TransactionType": "V238",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 2,
"RelatedTransactions": [
{
"RelationType": "partialpayment",
"RelatedTransactionKey": "40591C0E384A40AC8FF5C5D1C6A0xxxx"
}
],
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "B14054AF06FA4997B98450C696D7xxxx"
}
}
Refund
To refund a successful gift card transaction, use the Refund action.
Refund Request
| Parameter | Type | Required | Description |
|---|---|---|---|
| originaltransaction | String | Yes | Transaction key of the original transaction to refund |
Example Request
{
"Currency": "EUR",
"AmountCredit": 1,
"Invoice": "testinvoice 123",
"OriginalTransactionKey": "901745AE6B4643C6837497C513D2xxxx",
"Services": {
"ServiceList": [
{
"Name": "boekenbon",
"Action": "Refund"
}
]
}
}
Refund Response
Example Response
{
"Key": "62AB2EF2C17F42A1A79DC42CD552xxxx",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2019-03-22T23:34:18"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice 123",
"ServiceCode": "boekenbon",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 1,
"TransactionType": "V239",
"MutationType": 2,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "901745AE6B4643C6837497C513D2xxxx"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "B93B33C25C1840A9AF19DC609CF7xxxx"
}
Refund Push
Example Push
{
"Transaction": {
"Key": "62AB2EF2C17F42A1A79DC42CD552xxxx",
"Invoice": "testinvoice 123",
"ServiceCode": "boekenbon",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": null,
"DateTime": "2019-03-22T23:34:18"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountCredit": 1,
"TransactionType": "V239",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 2,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "901745AE6B4643C6837497C513D2xxxx"
}
],
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": null
}
}
Updated 2 months ago