Getting Started


The PixelPay Sandbox allows you to run test transactions and tokenization requests through the API or SDK.

PixelPay Sandbox is a great tool to test your integration without the need to carry out real transactions or tokenize real cards.


There are two versions of PixelPay Sandbox: The SDK Sandbox, and the API Sandbox. Both versions allow developers to test transactions and tokenize cards.

With the tokenization feature, developers can test storing a card, retrieving its data, editing its information, or completely deleting a card.

With the transaction feature, developers can test different transaction types, such as SALE, AUTH y CAPTURE.


Requests are directives that take the required data from the models and convert it into a proper request that our system can interpret. An example of this would be converting an order with multiple items included to the proper JSON format.

The Requests section includes the necessary methods to create different transaction types:

  • SaleTransaction: Creates the request to carry out a direct sale.
  • AuthTransaction: Creates the request to authorize a sale. Once the sale is authorized, the merchant can request the capture of the authorized funds through the SDK.
  • CaptureTransaction: Creates the request to capture the funds from an authorized sale.
  • VoidTransaction: Creates the request to cancel a sale.
  • StatusTransaction: Creates the request to obtain the status of a transaction.
  • CardTokenization: Creates the request to tokenize a credit/debit card.

To use PixelPay Services, it is necessary to send the information through requests.


Services are in charge of all the communication between your integration and the PixelPay system. Services make it easy to build requests, which are then sent to the PixelPay servers for further processing.

The Services section includes:

  • Transaction: Allows the creation, authorization, capture, cancellation or status retrieval of all sales within the business.
  • Tokenization: Allows the tokenization, update, deletion or retrieval of credit and debit cards within the affiliated company.

Services generate the Requests to the PixelPay API, which is why they are of great importance.

Responses and Entities

Responses and entities provide additional information that can be of great aid to developers using the SDK, such as additional documentation in the form of IntelliSense (function parameter information, variables, and SDK modules).


The Responses section includes all the different types of Responses that can be obtained when making a query to the PixelPay services.

Response types can help a developer determine whether a transaction performed is succesful or not. If it is not successful, you can capture what type of error was generated. All response types are equivalent to one or more HTTP response codes.

Response Type HTTP Code Description
SuccessResponse 200 Respuesta exitosa
Successful response
Possibly contains additional information in data.
ErrorResponse 400 General error by the client
NoAccessResponse 401, 403 Permissions and/or access error, the client does not have access to this resource. You may not have submitted the necessary credentials or your credentials have already expired.
PaymentDeclinedResponse 402 Payment was declined by the service.
NotFoundResponse 404, 405, 406 Resource not found.
TimeoutResponse 408 Server response time out.
PreconditionalResponse 412, 418 rror where the terms submitted by the client do not match the terms of service.
InputErrorResponse 422 Error in the entity sent by the client, where a validation failed in one or more sent fields.
NetworkFailureResponse 500 Communication failure with the service
FailureResponse >500 or network failure Service Failure.

Response Structure

The type of responses received when interacting with the PixelPay service has a defined format, depending on the type of response received from the service. Response types are defined here.

success boolean Defines if the request was executed successfully or not.
message string Description of the response returned by the service.
data object<string, any> Data returned by the service requests. Its content varies depending on the service requested.
errors object<string, string[]> In case there are errors (for example, invalid values in a form), all the fields that caused the error are sent along with a descriptive error message for each field.

Success Reponse Example

  "success": true,
  "message": "Información obtenida con exito",
  "data": {
    "status": "active",
    "mask": "411111******1111",
    "network": "visa",
    "type": "CREDIT",
    "bin": "411111",
    "last": "1111",
    "hash": "33fa2660f8e7c3556b72a3da1f375d535c3f00250b4af18777f950a40c7fcc1489d7c7879a73366f39ef23dfd210b6d74d98d1ec2db63b1797565a38e76bd239",
    "address": "Calle 1",
    "country": "HN",
    "state": "HN-CR",
    "city": "San Pedro Sula",
    "phone": "999-999999999",
    "token": "T-25ae86aa-d4f4-438f-8806-019575782fa0"

Failed Response Example

  "success": false,
  "message": "El campo number es obligatorio.",
  "errors": {
    "number": ["El campo number es obligatorio."],
    "cvv2": ["El campo cvv2 es obligatorio."],
    "expire_month": ["El campo expire month es obligatorio."],
    "expire_year": ["El campo expire year es obligatorio."],
    "cardholder": ["El campo cardholder es obligatorio."],
    "address": ["El campo dirección es obligatorio."],
    "country": ["El campo country es obligatorio."],
    "state": ["El campo departamento es obligatorio."],
    "city": ["El campo ciudad es obligatorio."],
    "phone": ["El campo teléfono es obligatorio."]


The PixelPay Sandbox can be used via API or SDK:


To use the PixelPay Sandbox with the SDK or via API, it is necessary to make an initial setup with the affiliated merchant's data, as shown below.

The necessary information to set the Sandbox up includes:

  • Type of environment
  • Endpoint
  • Keys


Through the SDK, you can set up different types of environments, mainly production and sandbox. The sandbox environment is useful for testing the integration with PixelPay. Once the tests are done and succesful, the environment can be changed to production.

Environment Types:

  • LIVE (producción)

Endpoint and Keys

To use the SDK, it is necessary to extract the domain from the route (endpoint) and certain keys associated with the PixelPay platform merchant. This documentation shows how to extract this data.