Zapper Platform
Search…
Zapper Code
Payment Methods
Payments
Processing
Please note the parameters required when Zapper is processing the payment, versus when a third party processor is processing the payment.
post
https://api.zapper.com
/v1/payments
Process Payment
Customer
Field
Type
Description
id
string
Unique identifier for the customer.
countryISOCode
string
optional
Customers country. When information is not provided the customer will be created with a default country of ZA.
firstName
string
optional
Customer first name.
lastName
string
optional
Customer last name.
msisdn
string
optional
Customer phone number.
email
string
optional
Customer email address.
Payment Method
Field
Type
Description
external
object
conditional
Third party payment details.
Only one of card or external can be used. When using a card, Zapper will process the payment from the customer's card.
Either CVV or SecureData is required.
Card
Card number
Field
Type
Description
cardNumber
string
Number on the front of the card.
cvv
string
conditional
Security code at the back of the card.
holderName
string
Name on the card.
expiryMonth
number
Month the card expires (1-12).
expiryYear
number
Year the card expires (CCYY).
Tokenised card
Field
Type
Description
token
string
The token that represents the card.
cvv
string
conditional
Security code at the back of the card.
Secure Data
Field
Type
Description
eci
string
The relevant ECI indicator.
cavv
string
The Base64 encoded cardholder authentication verification value.
xid
string
The Base64 encoded transaction identifier.
Enrolled
Value
Description
Y
Yes
N
No
U
Unenrolled
PARes Status
Value
Description
Y
Yes
N
No
U
Unenrolled
A
Anenrolled
External
For non-Zapper processed payments, the external payment method type is be used.
Field
Type
Description
reference
string
Third party payment reference.
External Payment Status
Value
Description
success
Successful payment processed.
failed
Failed payment processed.
Example Requests
Card number payment
1
{
2
"reference": "00000000-0000-0000-0000-000000000000",
3
"code":"aHR0cDovLzIuemFwLnBlP3Q9NiZpPTgxNzo0NjM6N1szNHwxMC4wMDoxMFszOXxaQVIsMzh8Q2VudHJhbCBQZXJr",
4
"amount": 1000,
5
"tipAmount": 200,
6
"customer": {
7
"id": "DEF-456"
8
},
9
"paymentUTCDate": "0001-01-01T00:00:00.000Z",
10
"paymentMethod": {
11
"card": {
12
"cardNumber": "4000000000000002",
13
"cvv": "999",
14
"holderName": "Card Holder",
15
"expiryMonth": 9,
16
"expiryYear": 2030
17
}
18
},
19
"orderReference": "00000000-0000-0000-0000-000000000000"
20
}
Copied!
Card number payment using secure data
1
{
2
"reference": "00000000-0000-0000-0000-000000000000",
3
"code":"aHR0cDovLzIuemFwLnBlP3Q9NiZpPTgxNzo0NjM6N1szNHwxMC4wMDoxMFszOXxaQVIsMzh8Q2VudHJhbCBQZXJr",
4
"amount": 1000,
5
"tipAmount": 200,
6
"customer": {
7
"id": "DEF-456"
8
},
9
"paymentUTCDate": "0001-01-01T00:00:00.000Z",
10
"paymentMethod": {
11
"card": {
12
"cardNumber": "4000000000000002",
13
"holderName": "Card Holder",
14
"expiryMonth": 9,
15
"expiryYear": 2030,
16
"secureData": {
17
"enrolled": "Y",
18
"paresStatus": "Y",
19
"cavv": "Td7wOfSL7kueWouRKPhX883w8ReT",
20
"xid": "eY4hCbMdj9FQ0X5CV9iQHt2y82T4",
21
"eci": "05"
22
}
23
}
24
},
25
"orderReference": "00000000-0000-0000-0000-000000000000"
26
}
Copied!
Tokenised card payment
1
{
2
"reference": "00000000-0000-0000-0000-000000000000",
3
"code":"aHR0cDovLzIuemFwLnBlP3Q9NiZpPTgxNzo0NjM6N1szNHwxMC4wMDoxMFszOXxaQVIsMzh8Q2VudHJhbCBQZXJr",
4
"amount": 1000,
5
"tipAmount": 200,
6
"customer": {
7
"id": "DEF-456"
8
},
9
"paymentUTCDate": "0001-01-01T00:00:00.000Z",
10
"paymentMethod": {
11
"card": {
12
"token": "00000000-0000-0000-0000-000000000000",
13
"cvv": "999"
14
}
15
},
16
"orderReference": "00000000-0000-0000-0000-000000000000"
17
}
Copied!
External (non-Zapper) payment
1
{
2
"reference": "bcf12812-affa-42c9-90c8-db65188ff037",
3
"code":"aHR0cDovLzIuemFwLnBlP3Q9NiZpPTgxNzo0NjM6N1szNHwxMC4wMDoxMFszOXxaQVIsMzh8Q2VudHJhbCBQZXJr",
4
"amount": 1000,
5
"tipAmount": 100,
6
"paymentUTCDate": "0001-01-01T00:00:00.000Z",
7
"customer": {
8
"id": "DEF-456"
9
},
10
"paymentMethod": {
11
"external": {
12
"reference": "12345",
13
"status": "success"
14
}
15
}
16
"orderReference": "00000000-0000-0000-0000-000000000000"
17
}
Copied!
Payment Response
Field
DataType
Description
reference
string
Unique reference of the payment.
invoiceReference
string
Zapper's invoice reference.
invoiceExternalReference
string
Merchant's invoice reference.
merchantName
string
Merchant name.
currencyISOCode
string
The Currency ISO code of the invoice.
invoicedAmount
number
The invoiced amount in cents.
paymentReference
string
Zapper's payment reference (Zapper ID).
paymentUTCDate
string
The date of the payment.
paymentMethodType
string
Payment method type for processing the payment.
paymentMethodDescription
string
The masked value of the payment method.
verificationUrl
string
optional
The URL to invoke additional verification when the status is verificationRequired.
tipAmount
number
The tip amount paid by the customer in cents.
processedAmount
number
The amount processed for the request.
Including tip.
siteReference
string
The identifier of the point of sale till. This is required for the routing of Zapper payments and invoices.
Payment Status
Value
Description
processing
The transaction is processing.
success
The transaction completed successfully.
failed
The transaction failed during processing.
verificationRequired
The transaction verification. A URL will be returned in the response.
Customer
Field
Datatype
Required
Description
id
string
Yes
The unique reference for the customer.
firstName
string
Yes
The name of the customer.
lastName
string
Yes
The last name of the customer.
Error
Field
Type
Description
message
string
The message regarding the error.
Last modified 1yr ago