Create a wallet

POST

https://api-v2.test.eldowallet.fr/wallets

Creates a new wallet with its contact details, logos and terms and conditions. Restricted to administrator accounts; integrations use GET /wallets and PATCH /wallets on their own wallet.

Good to know

• Body is multipart/form-data: nested objects (colors, security, locations…) are sent as a JSON string, booleans as "true"/"false". Images: PNG or JPEG, 1 KB to 5 MB.
• termsAndConditions.customUrl is required when type is URL.

Request

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Body multipart/form-data required

• webHookUrl string
  Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token
• icon string <binary>
• logo string <binary>
• androidLogo string <binary>
• name string required
• identifier string
• identifierQr string
• address string
• website string
• servicePhone string
• businessPhone string
• socialMedia object
  • linkedin string
  • tiktok string
  • twitter string
  • facebook string
  • instagram string
  • youtube string
  • snapchat string
  • pinterest string
  • reddit string
  • whatsapp string
  • telegram string
• additionalContacts object[]
  • title string required
  • value string required
  • kind string requiredenum: URL, PHONE, EMAIL
• termsAndConditions object
  • type string
    Type of terms and conditions
    enum: PDF, URL, NONEexample: PDF
  • customUrl string <uri>
    Custom URL for terms and conditions (maps to generalRoleUrl)
    example: https://example.com/terms
  • pdfFile string <binary>
• rootDomain string
• timezone string
• allowedPasses string[]enum: ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL
• expiredCleanupEnabled boolean

Responses

201

Schema application/json

• name string required
• logo string required
• icon string required
• androidLogo string
• displayIdentifiant boolean required
• passBuilderPassTemplateId string
• passBuilderBusinessId string
• passBuilderToken string
• identifier string required
• identifierQr string required
• address string
• website string required
• servicePhone string required
• businessPhone string required
• socialMedia object required
  • linkedin string
  • facebook string
  • instagram string
  • tiktok string
  • twitter string
  • youtube string
  • snapchat string
  • pinterest string
  • reddit string
  • whatsapp string
  • telegram string
• additionalContacts object[] required
  • title string required
  • value string required
  • kind string requiredenum: URL, PHONE, EMAIL
• termsAndConditions object required
  • type string requiredenum: PDF, URL, NONE
  • customUrl string
  • pdfUrl string
• webHookUrl string required
• rootDomain string required
• timezone string
• allowedPasses string[] requiredenum: ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL
• expiredCleanupEnabled boolean required
• _id string required
• createdAt string <date-time> required
• updatedAt string <date-time> required

400

VALIDATION_ERROR · INVALID_JSON · INVALID_MULTIPART

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

401

UNAUTHORIZED

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

409

PASSBUILDER_IDENTITY_INCOMPLETE

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

415

UNSUPPORTED_MEDIA_TYPE

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

503

PASS_BUILDER_ERROR

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email