Payment Transaction (Async)
The payment webhook sends the following object to your site regarding the status updates of the payment, encoded in JSON.
In other words:
- First it sends an object that informs the user that the payment is in progress,
- Then it sends a second object that informs the user that the status of the payment is either successful or unsuccessful.
To learn more about VCC Live Pay, please visit our guide here.
Table of Contents
Request Object
| Name | Type | Comment |
|---|---|---|
| client_data | object | Custom data object, including contacts. |
| in_call | boolean | True if the payment happened during the phone call. Payment can happen after the call if the payment process takes longer than the conversation. |
| numberid | integer | Record identifier. |
| payment | object | Payment object. |
| projectid | int | Project identifier. |
| teamids | array of integers | Array of teamids. |
| timestamp | string | Time of disposition setting, in ISO 8601 format. |
| userid | integer | Agent identifier. |
| username | string | Agent username. |
| uuid | string | Call identifier. |
Payment Object
| Name | Type | Comment |
|---|---|---|
| amount | number | Amount of payment. |
| card_expiration | sting | Expiration date (MMYY). |
| card_number_length | number | Card number’s length. |
| card_number_trailing | string | Card number’s last 4 characters. |
| currency | string | Currency of payment in lowercase ISO 4217 format. |
| payment_gw | string | The payment gateway’s identifier. |
| payment_type | string | Type of the payment. Currently credit card is the only supported value. |
| status | string | Status of the payment: – successful – unsuccessful – in_progress |
| status_message | string | Status message if there is any. |
| token | string | Unique payment identifier generated by VCC. This token is used for recurring payment. |
| transactionid | string | A unique number, that represents the payment. |
| vposid | string | Virtual POS identifier. |
Sample Request Body
{
"payment": {
"payment_type": "creditcard",
"card_number_trailing": "1234",
"card_number_length": 16,
"card_expiration": "1218",
"payment_gw": "testgw",
"transactionid": "431fba930c344aa0b6d64458824036d1",
"amount": 100000,
"currency": "huf",
"status": "successful",
"status_message": "cde.success",
"vposid": null,
"token": null,
},
"in_call": true,
"uuid": "a7587a1a-2581-4dfe-b9eb-6a8ddb7caf0e",
"projectid": 4,
"numberid": 25,
"username": "elemer.erdosi",
"userid": 26,
"teamids": [
1
],
"client_data": {
"email": "[email protected]",
"scenario": [
{
"valueid": 3,
"fieldid": 7,
"label": "Success",
"export_value": "",
"description": "1"
}
],
"name": "Elemer Erdosi",
"amount": "100000",
"pci_currency": [
{
"valueid": 8,
"fieldid": 3,
"label": "huf",
"export_value": null,
"description": ""
}
],
"phone1": "36301234567",
"termekek": [
{
"valueid": 12,
"fieldid": 10,
"label": "Ticket",
"export_value": "100000",
"description": ""
}
],
"contacts": {
"1": {
"name": null,
"phone": "36304739238",
"email": null,
"title": null
}
}
},
"timestamp": "2015-11-12T10:31:48+01:00"
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.