Perform sale
Introduction
API URLs
Integration |
Production |
---|---|
https://sandbox.payneteasy.eu/paynet/dapi/v1/sale/{endpointId}/{invoiceId} |
https://gate.payneteasy.eu/paynet/dapi/v1/sale/{endpointId}/{invoiceId} |
Request Parameters
Parameter Name |
Description |
Value |
---|---|---|
consumer |
Necessity : RequiredType : Object |
|
consumer.device |
Necessity : RequiredType : Object |
|
consumer.device.serialNumber |
Consumer’s device serial number. |
Necessity : RequiredType : StringLength : 1-50 |
consumer.email |
Сonsumer’s email address, if sent in original card mapping transaction and card reference is being used instead of cardholder data. |
Necessity : RequiredType : StringLength : 3-128 |
session |
Necessity : RequiredType : Object |
|
session.accessToken |
Access token key received in Optional consumer authentication. |
Necessity : RequiredType : StringLength : 32-128 |
session.nonce |
Value received in initiate sale response. |
Necessity : RequiredType : StringLength : 32-128 |
session.signature |
Value received in initiate sale response. |
Necessity : RequiredType : StringLength : 32-128 |
sourceOfFunds |
Necessity : RequiredType : Object |
|
sourceOfFunds.card |
Only one of these subtypes (card, reference) should be used. |
Necessity : RequiredType : Object |
sourceOfFunds.card.expiry |
Necessity : RequiredType : Object |
|
sourceOfFunds.card.expiry.month |
Source Card expiration month. |
Necessity : RequiredType : IntegerLength : 2 |
sourceOfFunds.card.expiry.year |
Source Card expiration year. |
Necessity : RequiredType : IntegerLength : 4 |
sourceOfFunds.card.holder |
Necessity : RequiredType : Object |
|
sourceOfFunds.card.holder.firstName |
Cardholder’s first name. |
Necessity : RequiredType : StringLength : 1-50 |
sourceOfFunds.card.holder.lastName |
Cardholder’s last name. |
Necessity : RequiredType : StringLength : 1-50 |
sourceOfFunds.card.holder.printedName |
Cardholder’s printed name (first and last name together). May be used instead of firstName + lastName. |
Necessity : RequiredType : StringLength : 1-50 |
sourceOfFunds.card.number |
Source card number (PAN). |
Necessity : RequiredType : StringLength : 9-19 |
sourceOfFunds.card.securityCode |
Source card security code (CVV). |
Necessity : RequiredType : StringLength : 3-4 |
sourceOfFunds.reference |
only one of these subtypes (card, reference) should be used. |
Necessity : RequiredType : Object |
sourceOfFunds.reference.clientCardId |
Source card reference identifier (on client side). |
Necessity : RequiredType : StringLength : 1-128 |
sourceOfFunds.reference.securityCode |
Source card security code (CVV). |
Necessity : RequiredType : StringLength : 3-4 |
transaction |
Necessity : RequiredType : Object |
|
transaction.amountCentis |
Transaction amount, 1.00 EUR = 100 centis. |
Necessity : RequiredType : Integer |
transaction.currency |
Upper case letters (ISO 4217 alpha code). |
Necessity : RequiredType : StringLength : 3 |
location |
Necessity : OptionalType : Object |
|
location.lat |
The latitude specified in the range of -90.0 through +90.0, both inclusive. |
Necessity : OptionalType : Double |
location.lng |
The longitude specified in the range -180.0 through +180.0, both inclusive. |
Necessity : OptionalType : Double |
billing |
Necessity : OptionalType : Object |
|
billing.address |
Necessity : OptionalType : Object |
|
billing.address.city |
City name. |
Necessity : OptionalType : StringLength : 1-100 |
billing.address.country |
ISO alpha3 country code. |
Necessity : OptionalType : StringLength : 3 |
billing.address.postcodeZip |
ZIP post code. |
Necessity : OptionalType : StringLength : 1-10 |
billing.address.state |
State is used if present. For example, Los Angeles is in CA state. |
Necessity : OptionalType : StringLength : 2-3 |
billing.address.street |
Street is used for district names and street names. |
Necessity : OptionalType : StringLength : 1-50 |
billing.address.street2 |
Street 2 is used for long addresses. Usually it contains apartment and building №. |
Necessity : OptionalType : StringLength : 1-50 |
billing.phone |
Сonsumer’s contact phone number. |
Necessity : OptionalType : StringLength : 1-20 |
consumer.birthDay |
Сonsumer’s birth day in “ddMMyyyy” format. |
Necessity : OptionalType : StringLength : 8 |
consumer.device.imei |
Сonsumer’s device international mobile equipment identity. |
Necessity : OptionalType : StringLength : 14-16 |
consumer.ipAddresses |
Сonsumer’s IP addresses. |
Necessity : OptionalType : List |
consumer.ipAddresses[] |
Сonsumer’s IP address. |
Necessity : OptionalType : StringLength : 7-15 |
order |
Necessity : OptionalType : Object |
|
order.description |
Brief transaction description. May be mandatory for certain Acquirer Banks. |
Necessity : OptionalType : StringLength : 128 |
order.siteUrl |
URL of website associated with the transaction. |
Necessity : OptionalType : StringLength : 128 |
order.purpose |
May be used for better transaction control or additional checks. |
Necessity : OptionalType : StringLength : 128 |
Success Response Parameters
Parameter Name |
Description |
Value |
---|---|---|
invoiceId |
Sale transaction identifier. |
Type : String |
session |
Type : Object |
|
session.token |
The session token of sale transaction. |
Type : String |
Fail Response Parameters
Parameter Name |
Description |
Value |
---|---|---|
error |
Type : Object |
|
error.cause |
Cause of the error. Possible values: |
Type : Enum |
error.code |
The unique error code. |
Type : String |
error.message |
Description of the error. |
Type : String |
invoiceId |
Sale transaction identifier. |
Type : String |
Request Example
{
"billing": {
"address": {
"city": "string",
"country": "string",
"postcodeZip": "string",
"state": "string",
"street": "string",
"street2": "string"
},
"phone": "string"
},
"consumer": {
"birthDay": "string",
"device": {
"imei": "string",
"serialNumber": "string"
},
"email": "string",
"ipAddresses": ["string"]
},
"location": {
"lat": "double",
"lng": "double"
},
"order": {
"description": "string",
"siteUrl": "string",
"purpose": "string"
},
"session": {
"accessToken": "string",
"nonce": "string",
"signature": "string"
},
"sourceOfFunds": {
"card": {
"expiry": {
"month": "integer",
"year": "integer"
},
"holder":{
"firstName": "string",
"lastName": "string"
},
"number": "string",
"securityCode": "string"
},
"reference": {
"clientCardId": "string",
"securityCode": "string"
}
},
"transaction": {
"amountCentis": "integer",
"currency": "string"
}
}
Success Response Example
{
"invoiceId": "string",
"session": {
"token": "string"
}
}
Fail Response Example
{
"error": {
"cause": "enum",
"code": "string",
"message": "string"
},
"invoiceId": "string"
}
Request Builder