Skip to main content
The gift card simulator is a sandbox-only connector that can be used to simulate responses for balance checks, gift card redemptions and refunds, and issuing and activating gift cards. The values for the error_code, balance and expiration_date can be simulated by passing in different pin and gift card numbers. This can be used when testing your integration.

​
Credentials

To configure the connection, you need to set the following credentials.

​
Error codes

The pin field is used to simulate error codes:
  • Starts with 0: Reserved for successful responses. Example: 01000.
  • Starts with 1: Validation error returned by the provider, error_code populated as explained below. Example 10001.
  • Starts with 2: Server error, error_code populated as explained below. Example: 20010.
  • Starts with 3: Client error, error_code populated as explained below. Example: 30003.
The rest of digits of the pin number are used to determine the error_code: Any other value is mapped to unknown_error too.

​
Refunds

Similar logic is applied to trigger error cases for refunds, but the last digit of the refund amount is used, rather than the PIN.
  • Ends with 0: Reserved for successful responses. Example: 1000.
  • Ends with 1: Validation error returned by the provider. Example 1001.
  • Ends with 2: Server error. Example: 1002.
  • Ends with 3: Client error. Example: 1003.

​
Balance

For endpoints returning the gift card balance, its value is the pin number as an integer. The recommendation is that it starts with 0, so it’s always considered a successful response. For example, a PIN of 01234 results in a gift card balance of 12.34.

​
Activation

Activating a gift card uses the pin to simulate errors, and the error_code is taken from the remaining digits as described in the error codes section. The prefixes differ slightly from a balance check.
  • Omit the pin: successful activation.
  • Starts with 1: Client error. Example: 10001.
  • Starts with 2: Server error. Example: 20010.
  • Starts with 3: Client error. Example: 30003.
  • Starts with 4: Validation error returned by the provider. Example: 40006.
On a successful activation, the resulting balance is the amount you send. Omit the amount and the balance is derived from the pin exactly as described in the Balance section.

​
Issuance

Issuing a virtual gift card has no pin or number to simulate errors with, so the amount is used instead. The last digit selects the type of error and the remaining digits determine the error_code.
  • Ends with 0: Reserved for successful responses. Example: 5000.
  • Ends with 1: Client error. Example: 10001.
  • Ends with 2: Server error. Example: 10002.
  • Ends with 3: Client error. Example: 10003.
  • Ends with 4: Validation error returned by the provider. Example: 10004.

​
Expiration date

For endpoints returning the expiration date, the gift card number is considered.
  • A gift card number that starts with 0 results in an expiration date in the past. For example: 0000444455556666 results in an expiration date set in the past. Currently, this is set to a month in the past, but this behavior may change.
  • A gift card number that starts with 1 results in an expiration date in the future. For example: 1000444455556666 results in an expiration date set in the future. Currently, this is set to a month in the future, but this behavior may change.
  • Otherwise, any other gift card has no expiration date. For example: 9000444455556666 results in a gift card without an expiration date.