Ahora que ya hemos configurado nuestro primer cliente con un mandato, estamos listos para empezar a aceptar pagos. Hay dos formas de configurar los pagos (la opción más adecuada para ti dependerá del uso que hagas de GoCardless):
- Pagos puntuales: activa el pago de un mandato en cualquier momento a través de la API. Esto es ideal si deseas aplicar cargos de cantidades ad hoc a los clientes.
- Suscripciones: configura un pago recurrente automático. Esto es ideal si deseas aceptar el mismo pago de manera regular (por ejemplo, cinco libras por semana, o veinte libras el primer día de cada mes).
Incluso puedes utilizarlos juntos: una vez que tienes un mandato, tienes total libertad para efectuar cargos a los clientes cuando quieras.
Vamos a probar los dos: te recomendamos que le dediques unos minutos a cada uno para comprender bien todo el potencial de la API.
Pagos puntuales
Para crear un pago para un cliente, se necesitan los siguientes campos:
amount: cantidad en peniques (GBP), céntimos (AUD/EUR), öre (SEK) u øre (DKK).
currency: el código de divisa ISO 4217. En la actualidad, las únicas admitidas son GBP, EUR, SEK y AUD.
links[mandate]: identificador del mandato del cliente para el cual se realizaría el cobro de este pago.
Deberás utilizar la divisa adecuada para el mandato que configures. Esto depende del esquema de domiciliación bancaria que utilices; el esquema del mandato configurado a través del flujo de redirección dependerá de tu ubicación (aunque se puede ajustar manualmente mediante la especificación de un esquema):
| Ubicación | divisa |
|---|---|
| Reino Unido | GBP |
| Suecia | SEK |
| Australia | AUD |
| En cualquier otro lugar | EUR |
Además de estos campos, se pueden enviar los siguientes parámetros opcionales:
app_fee: la cantidad que se debe deducir del pago en concepto de tarifa de la aplicación OAuth, en peniques/céntimos/öre/øre (solo aplicable a asociados)
charge_date: una fecha futura en la cual debe cobrarse el pago. Si no se especifica, el pago se cobrará tan pronto como sea posible. Debe ser en la fecha next_possible_charge_date del mandato o en una fecha posterior, y GoCardless la pasará adelante si no es un día laborable.
description: una descripción del pago en lenguaje natural Se incluirá en el correo electrónico de notificación que GoCardless le envía al cliente si tu organización no envía sus propias notificaciones (ver requisitos de cumplimiento).
metadata: almacenamiento de datos personalizados de tipo clave-valor. Se permiten hasta tres claves, con nombres de clave de hasta 50 caracteres y valores de hasta 500 caracteres.
reference: una referencia de pago opcional que aparecerá en el extracto bancario del cliente. Para los pagos de Bacs, puede ser de hasta 10 caracteres; para los pagos de SEPA, el límite es de 140 caracteres; para los pagos de Betalingsservice, el límite es de 30 caracteres; y para los pagos de Autogiro, el límite es de 11 caracteres. Restricted: solo se puede especificar una referencia de pago para los pagos de Bacs (es decir, al cobrar desde el Reino Unido) si cuentas con los planes Plus o Pro de GoCardless.
Para obtener ejemplos de código de muestra, consulta la guía que se encuentra aquí.
Claves de idempotencia
Idempotency-Key. Si proporcionamos una cadena específica única para este pago (por ejemplo, su identificador en nuestra propia base de datos), la API garantizará que este pago solo se crea una vez.Esto significa que si a una solicitud de la API se le agota el tiempo o algo va mal en tu extremo, al cliente no se le facturará nunca dos veces por error; para obtener más información, consulta esta entrada de nuestro blog. Puedes usar claves de idempotencia cuando crees algo con la API.
Suscripciones
Las suscripciones permiten crear pagos según un programa.
Para crear una suscripción para un cliente, se necesitan los siguientes campos:
amount: cantidad en peniques (GBP), céntimos (AUD/EUR), öre (SEK) u øre (DKK).
currency: el código de divisa ISO 4217. En la actualidad las únicas admitidas son GBP, EUR, SEK, AUD y DKK .
interval_unit: la unidad de tiempo entre las fechas de cargo del cliente. Las opciones son weekly, monthly o yearly.
links[mandate]: identificador del mandato del cliente para el cual la suscripción creará pagos.
Además de estos campos, se pueden enviar los siguientes parámetros opcionales:
name: nombre opcional de la suscripción, que también establecerá la descripción de cada pago.
interval: la cantidad de interval_units entre cada fecha de cargo. Debe suponer, como mínimo, un cargo al año. Si no se especifica, se asigna un valor predeterminado de 1.
count: la cantidad total de pagos que se van a aceptar por la suscripción. Si no se especifica ninguna cifra, la suscripción seguirá indefinidamente.
day_of_month: el día del mes (entre el 1 y el 28) en el que deseas que se efectúe el cargo al cliente. También puedes utilizar -1 para indicar el último día del mes.
month: el nombre del mes en el que se efectúa el cargo al cliente.
start_date: la fecha en la que se debe cargar el primer pago. Esta fecha debe estar dentro del plazo de un año desde la creación de la suscripción, y en la fecha next_possible_charge_date del mandato o en una fecha posterior. Si no se incluye este parámetro, el primer pago se cargará lo antes posible.
payment_reference: este parámetro está restringido únicamente a cuentas Pro. Una referencia de pago opcional que se establecerá para todos los pagos y que aparecerá en el extracto bancario del cliente.
Para obtener ejemplos de código de muestra, consulta la guía que se encuentra aquí.
Para obtener más información sobre las normas de periodicidad y consejos de implementación, consulta nuestro artículo que profundiza más en el tema aquí.