Saltar al contenido principal
Un socio puede llamar al plugin Payments con su propia credencial. Restringes esa credencial a una organización de Midaz. Lo necesitas cuando un despliegue de Payments atiende varias organizaciones, o cuando uno de tus propios clientes emite boletos y paga cuentas por sí mismo. Todo socio de Payments necesita un alcance.

Paso a paso

1

Elige la organización en la que actúa el socio

Payments tiene una restricción:La restricción acepta una organización. Más de un valor se rechaza con 400 e IDE-0002.El ledger y las cuentas no son una restricción de Payments. Consulta El alcance del socio en Midaz no vale para Payments.
2

Da al socio sus permisos y su alcance

Crea el socio, o modifícalo, en la Consola o con la API de Identity. El slug del producto es plugin-br-payments.
  • Agrega la entrada de alcance con la organización. Sin ella, Access Manager rechaza el socio con 400 e IDE-1060.
  • Revisa los recursos y las acciones. Lo máximo que puedes dar es lo que tiene el rol editor de Payments en tu tenant. Por encima de eso, Access Manager rechaza con IDE-1043.
Puedes dar a un socio estas acciones: read, create y cancel sobre el recurso boletos; read y create sobre el recurso payments; y read sobre el recurso dashboard.El recurso admin actúa sobre todo el tenant. Access Manager rechaza toda acción de admin con 400 e IDE-1056, y la Consola marca la línea como Fuera del alcance.
3

Crea su aplicación de Payments

Crea la aplicación del socio con el producto plugin-br-payments. Consulta Crea las aplicaciones del socio en la guía de la API, o en la Consola. Envía el client ID y el client secret al socio por un canal seguro.
4

Indica la organización en cada solicitud

Toda solicitud indica la organización en el encabezado X-Organization-Id, que Payments ya exige en estas rutas. El valor debe ser la organización del alcance del socio. Una solicitud sin él se rechaza.Un boleto, lote, serie o pago de otra organización responde 404, la misma respuesta que un ID que no existe: indica la organización a la que pertenece el elemento.
5

Confirma que funciona

Usa la credencial del socio. Lista los boletos de la organización del alcance del socio. La respuesta es 200:
Envía la misma solicitud sin el encabezado, o con otra organización. La respuesta es 403 con PBP-0004.

El alcance del socio en Midaz no vale para Payments

Payments hace los asientos en Midaz con su propia credencial de máquina, no con el token del socio. Un alcance de Midaz que das al socio no vale para esos asientos. El socio puede usar todos los ledgers y cuentas de su organización que Payments acepta.

Rutas que ningún socio alcanza

A un socio se le rechaza con 403 y PBP-0004 en estas rutas:
  • Toda ruta bajo /v1/admin.
  • POST /v1/payments/{id}/cancel.
Las rutas administrativas configuran la integración de todo tu tenant. Usa una aplicación de tu propia institución para ellas y para la cancelación de un pago.

Si algo falla

PBP-0004 no dice si fueron los permisos o el alcance los que rechazaron la solicitud. Es intencional: un socio no puede usar un rechazo para saber qué organizaciones existen fuera de su alcance. Para los rechazos al crear o cambiar un socio, consulta Códigos de error en la guía de la API. En un despliegue BYOC, Access Manager sabe que Payments acepta socios solo después de que Payments publica su declaración de permisos. Consulta Declaración de permisos.