Response information

You can refer below for information about the responses you get when using our API methods.

On this page:

When troubleshooting any technical problems you might have, please refer also to our page on Debugging errors which contains additional guidance.

Response query string parameters

Applicable to Smart Checkout only.

After completion of a payment order payment by the customer on our Smart Checkout, the customer is redirected back to your website, and the below query string parameters are appended to the redirect URL.

ParameterDescription
EventIdCode corresponding to the outcome of the payment. See Event ID codes below for full details.
ECIECI code. See Electronic Commerce Indicator below for full details.
ErrorCodeTypically corresponds to the HTTP response code returned by the API.
In cases where it does not correspond to the HTTP response code, it should be ignored.
ErrorTextReason phrase of error code.

Event ID codes

During a payment attempt, any of the following EventId codes can be appended to the Success / Failure URL as query string parameters.

EventId Reason Explanation Type
0 Undefined Undefined System
2061 3DS flow incomplete Browser closed before authentication finished. User
2062 3DS validation failed Wrong password or two-factor auth code entered. User
2108 Payments Policy Acquiring Restriction Exceeds withdrawal count limit. Issuer
6511 ISO packager pack failed validation Data cannot be converted to the specified ISO format. Issuer
10001 Refer to card issuer The issuing bank prevented the transaction. Issuer
10003 Invalid merchant number Security violation (source is not correct issuer). Issuer
10004 Pick up card The card has been designated as lost or stolen. Issuer
10005 Do not honor The issuing bank declined the transaction without an explanation. Issuer
10006 General error The card issuer has declined the transaction as there is a problem with the card number. Issuer
10012 Invalid transaction The bank has declined the transaction because of an invalid format or field. This indicates the card details were incorrect. Issuer
10013 Invalid amount The card issuer has declined the transaction because of an invalid format or field. System
10014 Invalid card number The card issuer has declined the transaction as the credit card number is incorrectly entered or does not exist. User
10015 Invalid issuer The card issuer doesn't exist. System
10030 Format error The card issuer does not recognise the transaction details being entered. This is due to a format error. System
10041 Lost card The card issuer has declined the transaction as the card has been reported lost. Issuer
10043 Stolen card The card has been designated as lost or stolen. User
10051 Insufficient funds The card has insufficient funds to cover the cost of the transaction. Issuer
10054 Expired card The payment gateway declined the transaction because the expiration date is expired or does not match. User
10055 Incorrect PIN Incorrect PIN. User
10057 Function not permitted to cardholder The card issuer has declined the transaction as the credit card cannot be used for this type of transaction. Issuer
10058 Function not permitted to terminal The card issuer has declined the transaction as the credit card cannot be used for this type of transaction. Issuer
10061 Withdrawal limit exceeded Exceeds withdrawal amount limit. Issuer
10062 Restricted card The customer's bank has declined their card. Issuer
10063 Issuer response security violation Flag raised due to security validation problem. Issuer
10065 Soft decline The issuer requests Strong Customer Authentication. The merchant should retry the transaction after successfully authenticating customer with 3DS first. Issuer
10070 Call issuer Contact card issuer. Issuer
10075 PIN entry tries exceeded Allowable number of PIN tries exceeded. User
10076 Invalid / non-existent "to account" specified Invalid / non-existent OR Invalid / non-existent specified. System
10096 System malfunction A temporary error occurred during the transaction. System
10200 Generic error A temporary error occurred during the transaction. System
10301 Soft decline The issuer requests Strong Customer Authentication. The merchant should retry the transaction after successfully authenticating customer with 3DS first. Issuer

Electronic Commerce Indicator

The Electronic Commerce Indicator (ECI) is a code appended to the Success / Failure URL as a query string parameter in addition to Event ID (above). The following values are possible:

ECI code Meaning
0 Unspecified
1 Authenticated
2 No 3DS
3 Attempt or not enrolled

Transaction feedback parameters

Applicable to all API methods.

When receiving information about a transaction / payment via the call of an API method, certain transaction feedback parameters are returned in the response. In particular, the StatusId parameter is used to return information relating to payment success / failure, while the TransactionTypeId parameter is used to return information about the type of the transaction.

StatusId parameter

The result of a transaction is identified by the StatusId parameter in the response body. It applies to the following API calls:

It can have any one of the values outlined in the table below.

StatusIdDescription
EThe transaction was not completed because of an error (PAYMENT UNSUCCESSFUL)
AThe transaction is in progress (PAYMENT PENDING)
MThe cardholder has disputed the transaction with the issuing Bank
MADispute Awaiting Response
MIDispute in Progress
MLA disputed transaction has been refunded (Dispute Lost)
MWDispute Won
MSSuspected Dispute
XThe transaction was cancelled by the merchant
RThe transaction has been fully or partially refunded
FThe transaction has been completed successfully (PAYMENT SUCCESSFUL)

TransactionTypeId parameter

The transaction type is identified by the TransactionTypeId parameter returned in the response body. It is relevant in the context of the Retrieve transactions API call and webhooks for payments only.

TransactionTypeId Description
0 Card capture
1 Card pre-auth
4 Card refund*
5 Card charge
6 Card charge (installments)
7 Card void
8 Card Original Credit (refund, betting MCC only)*
9 Wallet charge
11 Wallet refund
13 Card refund claimed
15 Dias
16 Cash
17 Cash refund
18 Card refund (installments)*
19 Card payout
20 Alipay charge
21 Alipay refund
22 Card manual cash disbursement
23 iDEAL charge
24 iDEAL refund
25 P24 charge
26 P24 refund
27 BLIK charge
28 BLIK refund
29 PayU charge
30 PayU refund
31 Card withdrawal
32 MULTIBANCO charge
33 MULTIBANCO refund
34 giropay charge
35 giropay refund
36 Sofort charge
37 Sofort refund
38 EPS charge
39 EPS refund
40 WeChat Pay charge
41 WeChat Pay refund
42 BitPay charge
43 BitPay refund

*The transactions that reverse previous payments have always a negative amount.

HTTP response codes

Applicable to all API methods.

Viva Wallet uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 200 range indicate success, while 400 codes indicate a client-side error, and 500 codes indicate an error with Viva Wallet’s servers. You may occasionally refer to the HTTP response code to determine whether the API call has been completed successfully.

Response codeMeaningMessage
200OKThe request has succeeded. The meaning of the success depends on the HTTP method:
  • GET
    The resource has been fetched and is transmitted in the message body.
  • PUT or POST
    The resource describing the result of the action is transmitted in the message body.
400Bad requestThe server could not understand the request due to invalid syntax.
401UnauthorizedAlthough the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
403ForbiddenThe client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the client's identity is known to the server.
404Not foundThe server cannot find requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist.
405Method not allowedThe request method is known by the server but has been disabled and cannot be used.
406Not acceptableYou requested a format that isn't JSON.
409ConflictThis response is sent when a request conflicts with the current state of the server.
410GoneThis response is sent when the requested content has been permanently deleted from server, with no forwarding address.
429Too many requestsThe user has sent too many requests in a given amount of time ('rate limiting').
500, 502, 504Server errorSomething went wrong at our end. Try again later.
503Service unavailableWe're temporarily offline for maintenance. Try again later.