Wallets

Configurar Apple Pay

Changed on

Mediante este método se configura Apple Pay para el comercio indicado en client_uuid, que debe pertenecer al cliente que realiza la petición. Si el comercio no tenía Apple Pay configurado, la wallet se crea; en caso contrario se actualiza con los datos enviados.

En la modalidad WEB los dominios indicados en domains se registran automáticamente en Apple Pay. En la modalidad APP deben enviarse merchant_id y certificate para registrar el certificado del comercio.

Puede consultarse el detalle de cada modalidad de integración en la documentación de Apple Pay.

post/onboarding/applepay

Request

  • Base URL
    https://api.paylands.com/v1/sandbox
  • URL
    https://api.paylands.com/v1/sandbox/onboarding/applepay
  • Auth
    none required

Parameters

#/paths/~1/get/parameters/0 (unresolved $ref)

Request body

signatureSignature required(unresolved $ref)
client_uuidUuid required(unresolved $ref)
flow_type'WEB' | 'APP' required

Modalidad de integración a configurar. WEB para el botón en el checkout o en la web del comercio, APP para integraciones nativas en aplicaciones móviles.

country_codestring required

Código ISO 3166 del país del comercio, en formato alfa-2, alfa-3 o numérico. Determina la región con la que se configura Apple Pay.

domainsstring[] nullable

Obligatorio en la modalidad WEB. Dominios desde los que se mostrará el botón de Apple Pay. Se registran y validan en Apple Pay.

merchant_idstring nullable

Identificador de comercio de Apple Pay. Necesario, junto a certificate, para configurar la modalidad APP en producción. Si no se indica, se utiliza el UUID del comercio.

certificatestring nullable

Certificado de Apple Pay codificado en base64. Se utiliza en la modalidad APP en producción.

merchant_namestring nullable

Nombre del comercio que mostrará Apple Pay. Si no se indica, se utiliza el nombre del comercio.

button_color'BLACK' | 'WHITE' | 'WHITEOUTLINE'

Color del botón de Apple Pay que se mostrará al usuario.

button_type'ADD-MONEY' | 'BOOK' | 'BUY' | 'CHECK-OUT' | 'CONTINUE' | 'CONTRIBUTE' | 'DONATE' | 'ORDER' | 'PAY' | 'PLAIN' | 'RELOAD' | 'RENT' | 'SET-UP' | 'SUBSCRIBE' | 'SUPPORT' | 'TIP' | 'TOP-UP'

Tipo de botón de Apple Pay que se mostrará al usuario.

shipping_address_requiredboolean nullable

Indica si Apple Pay debe solicitar la dirección de envío al usuario.

billing_address_requiredboolean nullable

Indica si Apple Pay debe solicitar la dirección de facturación al usuario.

only_debitboolean nullable

Restringe los pagos con Apple Pay a tarjetas de débito.

is_enabledboolean nullable

Indica si Apple Pay queda habilitado para el comercio.

Example request

{
  "signature": "121149a0ba5361191d740fa898784a8b",
  "client_uuid": "8dc780e8-c311-4791-a47f-c1a272ffbb87",
  "flow_type": "WEB",
  "country_code": "ESP",
  "domains": [
    "jhondoe-shop.com",
    "shop.jhondoe.com"
  ],
  "merchant_name": "Jhon Doe Shop",
  "button_color": "BLACK",
  "button_type": "PAY",
  "shipping_address_required": false,
  "billing_address_required": false,
  "only_debit": false,
  "is_enabled": true
}

Response

OK

messagestring required

Nombre del código HTTP de respuesta.

codenumber required

Código de respuesta.

current_timestring required

Fecha y hora de la petición.

Changes