Merchants > API Reference > Endpoints > Payment Method Voucher

Payment Method Voucher

Field Status Definitions

Required Required fields must be sent. If the data is not sent Ravelin will return an error.

Important Important fields are crucial for performance where that data is relevant for your business.

Optional Optional fields are additional data points that can be shared with Ravelin.
These fields are unlikely to impact performance but may be visible in the Ravelin dashboard.

POST api.ravelin.com/v2/paymentmethod/voucher

Show all

timestamp integer required

The time at which this data payload was valid. When sending events in realtime, this will usually be 'now'. This is used to merge data that arrives out-of-order.

A Unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

voucherRedemption object required

Represents the redemption of the voucher.

Show definition

paymentMethodId string required

A unique identifier for the voucher usage. A transactionId for vouchers.

voucherCode string required

The string customers actually see in their app.

value integer required

The value that the voucher can be exchanged for, in the currency's basic units.

redemptionTime integer required

The time that the customer is utilising the voucher.

A Unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

success boolean required

Whether the voucher has successfully been used by the customer.

currency string optional

The currency of the value of this voucher, as an ISO 4217 currency code.

Pattern: ^[a-zA-Z]{3}$

expiry integer optional

The time the after which the voucher can no longer be redeemed.

A Unix timestamp as an integer count of milliseconds, or nanoseconds since 1970-01-01T00:00 UTC.

voucherType string optional

The type of the voucher. If REFERRAL, also set the referredId so Ravelin will create a network of who has invited who.

One of: REFERRAL, REACTIVATION, or GENERAL.

referrerId string optional

The customerId of the customer who created this voucher.

referralValue integer optional

The amount the referring customer of the voucher gets when the voucher is used, in the currency's basic units.

failureReason string optional

Optional reason why the attempt was not successful.

One of: EXPIRED, NOT_NEW_CUSTOMER, ALREADY_USED, ABUSER, SYSTEM_FAILURE, or MAX_ALLOWED_TIMES.

failureSource string optional

The source of why the voucher failed.

One of: RAVELIN, or CLIENT.

custom object optional

Custom data that is relevant to your domain. This can be any json object. Please include any details that you think are relevant to fraud that our schema does not capture.

eventType string optional

An eventType should identify what event in your system triggered this API call.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*$

customerId string optional

The unique identifier of the customer. If your system allows anonymous checkout then we recommend making this the customer's email address.

customer object optional

Show definition

customerId string required

The unique identifier of the customer. If your system allows anonymous checkout then we recommend making this the customer's email address.

registrationTime integer important

The time that the customer registered. If this value is unknown, you can set it to the time the request is sent. Ravelin will retain the earliest value you have sent for this customer ID.

A Unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

email string important

The email address of the customer.

emailVerifiedTime integer important

The time at which the customer verified their email, usually by following a link back to your website from an email you sent to their address.

A Unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

name string important

The full name of the customer. If you have the name split into parts, consider familyName and givenName instead.

familyName string important

The surname/last name of the customer. If you do not have the name split into parts, consider name instead.

givenName string important

The first/given names of the customer. If you do not have the name split into parts, consider name instead.

telephone string important

The telephone number of the customer. Best in E.164 format with an international dialing code.

telephoneVerifiedTime integer important

The time at which the customer verified their telephone number, usually by confirming a code from an SMS you sent to the number.

A Unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

telephoneCountry string optional

The country the telephone number directs to. Note that the country is not an adequate replacement for the international dialing code in the Dominican Republic or Puerto Rico where multiple dialing codes are used.

A ISO 3166-1 Alpha 3 or Alpha 2 country code.

tags object optional

The tags to set or unset. Use the tag ID followed by true or false, depending on whether you want to set or unset the tag.

location object optional

Show definition

country string important

A ISO 3166-1 Alpha 3 or Alpha 2 country code.

postalCode string important

The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.

latitude number important

The latitude of the location.

longitude number important

The longitude of the location.

addresseeName string optional

The name of the person that will accept delivery of goods to this address.

street1 string optional

The street address of the location.

street2 string optional

The street address of the location.

neighbourhood string optional

The neighbourhood of the location.

zone string optional

The zone of the location.

city string optional

The city/village/town

region string optional

The state/county of the location.

poBoxNumber string optional

The PO box number related to the location.

custom object optional

Custom data that is relevant to your domain. This can be any json object. Please include any details that you think are relevant to fraud that our schema does not capture.

geohash string optional

deprecated

The geohash of the location.

custom object optional

Custom data that is relevant to your domain. This can be any json object. Please include any details that you think are relevant to fraud that our schema does not capture.

accountType string important

The type of account which the customer currently has.

See also order.accountType.

One of:

GUEST - The customer has not yet registered for an account, but may have placed an order.
REGISTERED - The customer has registered for an account.

username string optional

deprecated

The username the customer would log in with.

gender string optional

deprecated

The gender of the customer.

balance object optional

deprecated

The wallet contents of the customer, in the form of an object whose keys are currencies and values the amount held in that currency, in the currency's basic units.

banned boolean optional

deprecated

Whether the customer is banned in your systems.

country string optional

deprecated

The home country for this customer. Doesn't change when the customer is briefly abroad.

market string optional

deprecated

The logical region in which this customer exists.

Pattern: ^[0-9a-z-]*$

marketCity string optional

deprecated

The logical city in which this customer exists.

Pattern: ^[0-9a-z-]*$

passwordBcrypted string optional

deprecated

The bcypted form of the password for this customer. By its nature, the bcrypt operation is slow. Consider using passwordHashed if this is too slow for you.

passwordHashed string optional

deprecated

The SHA256 form of the password for this customer. This must be base64 encoded.

password string optional

deprecated

The plaintext password for the customer. We never store the raw password but for security we recommend using one of the hashing options instead of the plaintext option.

passwordChanged boolean optional

deprecated

Set to true on events where the password has been changed, false or omit otherwise.

POST https://api.ravelin.com/v2/paymentmethod/voucher HTTP/1.1
Authorization: token ...
Content-Type: application/json

{
  "timestamp": 1512828988826,
  "customerId": "abc-123-ZYZ",
  "voucherRedemption": {
    "paymentMethodId": "VOUCH-89-abc-123-ZYZ",
    "voucherCode": "VOUCH-89",
    "redemptionTime": 1512828988826,
    "success": true,
    "value": 10000,
    "currency": "GBP",
    "voucherType": "GENERAL"
  }
}

Feedback

Was this page helpful?