Saltar al contenido principal

Solicitud de Cargo

POST 
/charge/v2 - Solicitud de Cargo
Enviar pago

Parámetros del encabezado

  • Accept string required

    Tipo de datos

    Ejemplo: application/json
  • Content-Type string required

    Tipo de contenido

    Ejemplo: application/json
  • prepayToken string required

    referencia de preparación de pago recibida de AP

    Ejemplo: e686282e-fad0-45d7-84b6-eff5bf0c126d

Cuerpo

Codificar toda la información en UTF-8 y, formatearla en JSON y enviarla por POST al endpoint AP habilitado para su recepción.
    merchantId Numérico entero 4~7 dígitosrequired

    Identificador de tu comercio en la plataforma de AP.

    • Es un código numérico facilitado por Soporte en el correo de bienvenida.
    • Tiene de 4 a 7 dígitos y es común para ambos entornos (pruebas/producción).
    merchantKey Alphanumeric UUID Formatrequired

    Contraseña de Javascript.

    • Se utiliza para verificar que la petición es legítima (enviada desde el comercio).
    • Debe coincidir con la almacenada en AP.
    operationType stringrequired

    Possible values: [ACCOUNT_REGISTRATION, DEBIT, REFUND, REBATE, CREDIT, CANCEL_WITHDRAWAL]

    Tipo de operación.

    merchantTransactionId Alfanumérico Máx. 45 caracteresrequired

    Identificador de la transacción en tu plataforma de comercio electrónico. Sirve para que tu plataforma enlace las notificaciones recibidas conel pedido del cliente.

    • No puede repetirse entre transacciones.
    • Máx. 45 caracteres - Página de códigos Latin-1 (ISO-8859-1)
    customerId Alfanumérico Máx. 80 caracteresrequired

    ID. del cliente en tu plataforma de comercio electrónico.

    • Alfanumérico – Max. 80 caracteres.
    amount Numérico decimal 0~1000000.00required

    Importe de la transacción.

    • Si el importe contiene decimales, se usa el punto (.) como separador decimal.
    • No se puede incluir separador de millares.
    • En transacciones que no generen movimiento monetario, como por ejemplo el registro de la tarjeta de un cliente, se debe enviar cero (0) como importe.
    • Por ejemplo, 1.234,56€ se enviaría 1234.56
    currency Currencyrequired

    Possible values: [EUR, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMW, ZWL]

    Moneda de la transacción.

    • Código ISO-4217.3 de la divisa de la transacción (EUR, USD, GBP, etc.).
    country Countryrequired

    Possible values: [AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, TP, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KV, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, ME, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

    País desde el que se envía la transacción. Código ISO-3166.2 del país desde la cual se envía la transacción (ES, US, UK, etc.).

    paymentSolution stringrequired

    Nombre de la solución de pago por la cual debe procesarse la transacción (creditcards, bizum, paypal, etc.).

    apiVersion stringrequired

    Possible values: [5]

    Versión del API de la pasarela de Addon Payments por la que debe procesarse la transacción.

    productId Numérico entero 6~11 dígitosrequired

    Altamente recomendado Identificador del producto creado en tu comercio en AP por el cual se debe procesar la transacción.

    • Se facilita en el correo de bienvenida.
    • Tiene de 6 a 11 dígitos numéricos.
    • El producto es el que limita qué soluciones de pago de las activadas para el comercio se ofrecen al cliente.
    • AP permite que los comercios dispongan de varios productos configurados a sus necesidades.
    • Si no se envía, AP usará el primer producto del comercio que esté marcado en BBDD como “por defecto”.
      • Si el comercio no tiene ningún producto marcado “por defecto” y no se envía el parámetro, la petición generará error.
    • Puede ser diferente dependiente del entorno (pruebas y producción).
    • Por ejemplo:
      • Un comercio dispone de las soluciones de pago tarjeta, Bizum y Quix activadas.
      • TEl comercio dispone de dos productos, uno para clientes nacionales con todas las soluciones de pago activadas, y otro para clientes internacionales con únicamente pago con tarjeta.
      • El comercio indica el identificador de uno u otro producto en la petición dependiendo de la nacionalidad de su cliente.
      • Con ello evita ofrecer soluciones de pago como Bizum o Quix, que únicamente pueden operar con clientes nacionales, a clientes internacionales.
    statusURL Alfabético ISO 639-1required

    Altamente recomendado URL de tu plataforma de comercio electrónico donde AP enviará la notificación con el estado de la transacción.

    • Si se envía en la petición, tendrá prioridad sobre la configurada en el panel de administración de Addon Payments.
    • Alfanumérico – Máx. 2048 caracteres.
    successURL Alfabético ISO 639-1required

    Altamente recomendado URL de retorno a la web del comercio a la que redirigir al cliente si la transacción es autorizada.

    • Alfanumérico – Máx. 2048 caracteres.
    • Si se envía en la petición, tendrá prioridad sobre la configurada en el panel de administración de Addon Payments.
    • Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.
    errorURL Alfabético ISO 639-1required

    Altamente recomendado URL de retorno a la web del comercio a la que redirigir al cliente si la transacción es denegada.

    • Alfanumérico – Máx. 2048 caracteres.
    • Si se envía en la petición, tendrá prioridad sobre la configurada en el panel de administración de Addon Payments.
    • Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.
    cancelURL Alfabético ISO 639-1required

    Altamente recomendado URL de retorno a la web del comercio a la que redirigir al cliente si cancela la transacción.

    • Alfanumérico – Máx. 2048 caracteres.
    • Si se envía en la petición, tendrá prioridad sobre la configurada en el panel de administración de Addon Payments.
    • Si no se envía en la petición, se redirigirá al cliente a la URL configurada en el módulo de administración.
    awaitingURL Alfabético ISO 639-1required

    URL de retorno a la web del comercio a la que redirigir al cliente si la transacción está pendiente de procesar por la solución de pago.

    • Alfanumérico – Máx. 2048 caracteres.
    merchantParams Clave1:Valor1;Clave2:Valor2;ClaveN:ValorN Máx. 500 caracteres

    parámetros que envía tu plataforma de comercio electrónico para modificar la gestión de la transacción en AP

    • Alfanumérico – Máx. 500 caracteres.
    • Los parámetros se envían en el siguiente formato:
      • Clave1:Valor1;Clave2:Valor2;ClaveN:ValorN
    • Los parámetros que se envíen serán recibidos de vuelta en el campo “optionalTransactionParams” de la respuesta.
    description Alfanumérico Máx. 1000 caracteres

    Descripción de la transacción.

    • Máx. 1000 caracteres, página de códigos Latin-1 (ISO-8859-1)
    • Puede resultar útil para localizarla o identificarla posteriormente en el panel de gestión de AP.
    printReceipt boolean

    Possible values: [true, false]

    Muestra al cliente final un recibo en el proceso de redirección tipo opcional.

    forceTokenRequest boolean

    Possible values: [false, true]

    Indica si guardar o no el token de la tarjeta del cliente. Si no quieres guardar la tarjeta, usa «false»

    referenceId Alfanumérico 12 caracteres

    Referencia variable para comercios que necesiten de archivos de conciliación FB500.

Respuestas
Solicitud de pago aceptada
Schema
    response object
    message string

    informa el identificador de transacción en AP y si el flujo de trabajo ha finalizado correctamente o si se ha producido algún error.

    • NOT TO BE CONFUSED WITH THE STATUS OF THE TRANSACTION, WHICH IS REPORTED IN THE “STATUS” OF THE LAST OPERATION.
    operations object[]
    elemento que contiene o agrupa cada una de las operaciones que se ha realizado sobre la transacción. El n.º de elementos “operation” que contiene es igual al indicado en el “operation-size” del “response”.
  • Array [
    • amount string

    Importe de la transacción.

    currency Currency

    Possible values: [EUR, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMW, ZWL]

    Moneda de la transacción.

    • Código ISO-4217.3 de la divisa de la transacción (EUR, USD, GBP, etc.).
    merchantTransactionId Alfanumérico Máx. 45 caracteres

    Identificador de la transacción en tu plataforma de comercio electrónico.

    operationType string

    Possible values: [ACCOUNT_REGISTRATION, DEBIT, REFUND, REBATE, CREDIT, CANCEL_WITHDRAWAL]

    Tipo de operación.

    payFrexTransactionId string

    Identificador de la transacción en AP.

    • Es conveniente guardarlo para poder realizar transacciones secundarias (liquidación, devolución, etc.) y para localizar la transacción en caso de consulta.
    sorted-order string

    Orden de la operación en el flujo.

    status string

    Possible values: [INITIATED, PENDING, TO_CAPTURE, SUCCESS, SUCCESS_WARNING, ERROR, VOIDED, REBATED, REJECTED, REDIRECTED, AWAITING_PAYSOL, SUCCESS3DS, ERROR3DS, FAIL, N/A (Not Applicable)]

    estado de la transacción tras ser gestionada por la solución de pago o servicio.

    • Si es la última operación, refleja el estado final de la transacción.
    authCode string

    código de autorización del emisor para pagos con tarjeta.

    • Alfanumeríco – 6 caracteres.
    details string

    Respuesta sin tratar de la solución de pago.

    mpi object
    respuesta de 3DSv2 que contiene información sobre la autenticación en pagos con tarjeta.
    eci string

    Resultado del intento de autenticación.

    paymentCode string

    Código de respuesta original de la solución de pago.

    • El formato y los valores dependen de cada solución de pago.
    paymentDetails object
    Destalles de la tarjeta o cuenta del cliente
    account string

    Cartera o n.º de cuenta del cliente

    cardHolderName string

    Titular de la tarjeta

    cardNumber string

    N.º de tarjeta enmascarado

    • Numérico – Max. 19 dígitos.
    • Ejemplo: 4907270002222227 → 490727******2227
    • Necesario su almacenado en tu plataforma de comercio electrónico si se van a realizar transacciones posteriores sobre la tarjeta, como pagos recurrentes.
    cardNumberToken string

    Referencia de la tarjeta del cliente generada por AP

    • Alfanumérico – 16~20 caracteres.
    cardType string

    Possible values: [VISA, MASTERCARD, AMEX]

    Marca de la tarjeta.

    expDate string

    Fecha de caducidad de la tarjeta.

    • Numérico – 4 dígitos.
    • Formato: MMAA - MM los dos dígitos del mes y AA los dos últimos dígitos del año.
    • Por ejemplo: Junio 2023 → 0623
    extraDetails object[]
    Elemento con información extra del servicio o solución de pago que ha gestionado la transacción. * Los posibles valores y formatos dependerán del servicio o solución de pago que lo genere.
  • Array [
    • key string

    Nombre de la clave extra.

    value string

    Valor de la clave extra.

  • ]
    • issuerBank string

    Nombre del banco emisor de la tarjeta.

    issuerCountry string

    País del banco emisor de la tarjeta.

    paymentMessage string

    Mensaje original de la respuesta de la solución de pago o servicio que ha gestionado la transacción.

    paymentSolution string

    Nombre de la solución de pago que ha gestionado la transacción.

    • Cuando se recibe este parámetro no se recibirá el parámetro “service”.
    paySolTransactionId string

    Identificador de la transacción en la solución de pago.

    • El formato depende de cada solución de pago.
    rad string

    Datos adicionales de la respuesta.

    • Sólo disponible en algunos emisores de tarjeta.
    radMessage string

    Mensaje recibido junto a los datos adicionales de la respuesta.

    • Sólo disponible en algunos emisores de tarjeta.
    redirectionResponse string

    URL a la cual tu plataforma de comercio electrónico tiene que redirigir al cliente para completar el pago.

    respCode object
    código de respuesta de AP. Mapea los diferentes códigos de respuesta de los diferentes servicios y soluciones de pago a una serie de códigos unificados.
    message string

    Mensajes de respuesta de AP..

    uuid string

    UUID interno de AP generado para la transacción.

    service string

    Nombre del servicio que ha gestionado la transacción.

    • Cuando se recibe este parámetro no se recibirá el parámetro “paymentSolution”
    subscriptionPlan string

    Identificador para pagos recurrentes. * Necesario su almacenado en tu plataforma de comercio electrónico si se van a realizar transacciones posteriores como pagos recurrentes.

  • ]
    • status string
    workFlowResponse object
    Elemento que informa el nombre y versión del flujo de trabajo que ha gestionado la petición.
    id string

    Identificador interno del flujo de trabajo en AP.

    name string

    Nombre del flujo de trabajo.

    version string

    Versión del flujo de trabajo.

Cargando...