Skip to main content
Una solicitud de atribución solo surte efecto cuando un propietario del negocio la acepta. Usa la API de Partner Referral Requests para crear enlaces de referido y enviar solicitudes de atribución. También puedes listar los enlaces y solicitudes que has enviado o recibido, y aceptar, rechazar o cancelar una solicitud pendiente.

Endpoints

Atributos

string
requerido
ID de la solicitud de referido de partner, con el prefijo prfr_.
object | null
requerido
Negocio que recibe la solicitud, cuando hay uno asignado.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
string
requerido
Nombre visible de la cuenta.
string | null
requerido
La membresía de equipo del partner para la que se creó este referido, con el prefijo ausr_. null cuando el referido es personal.
string | null
requerido
Código de referido único, cuando está asignado.
string
requerido
Cuándo se creó la solicitud, como marca de tiempo ISO 8601.
integer | null
requerido
Número máximo de canjes permitidos, cuando está limitado.
string | null
requerido
El registro de miembro del partner para el que se creó este referido, con el prefijo mber_, cuando su rol en ese negocio está en su registro de miembro. null en caso contrario.
object
requerido
Perfil público del partner solicitante.

Propiedades

string
requerido
ID del usuario, con el prefijo user_.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no estableció ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre presente. Es un marcador de posición generado cuando el usuario no estableció ninguna imagen.
string
requerido
Nombre de usuario público.
object | null
requerido
Negocio en cuyo nombre el partner envió esta solicitud, cuando el referido pertenece a su equipo. null para un referido personal.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
string
requerido
Nombre visible de la cuenta.
string
requerido
Cómo se inició la solicitud de referido.Opciones disponibles: manual, ownership_transfer, link
object[]
requerido
Recompensas ofrecidas por esta solicitud.

Propiedades

string
requerido
ID de la recompensa de partner, con el prefijo prwd_.
string | null
requerido
Actividad que califica para esta recompensa, cuando se especifica.Opciones disponibles: sales, ad_spend
object
requerido
Importe en USD de actividad calificada necesario para obtener la recompensa.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
string | null
requerido
Rol del destinatario de la recompensa, o null para un usuario fijo que no es el partner solicitante.Opciones disponibles: business, partner
string | null
requerido
ID del usuario o negocio destinatario concreto, o null hasta que un negocio canjee la oferta.
object
requerido
Importe en USD otorgado tras la calificación.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún float lo redondee en tránsito.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales lleva el importe. Esta es la precisión con la que se ejecuta el cargo en sí.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para formatear el número en tu propia configuración regional.
string | null
requerido
El estado de aprobación, o null para solicitudes sin proceso de aprobación.Opciones disponibles: pending, accepted, denied, cancelled
string
requerido
Cuándo cambió la solicitud por última vez, como marca de tiempo ISO 8601.
object | null
requerido
El usuario al que se envió una solicitud de atribución. Obsoleto: las solicitudes a un usuario han finalizado. Siempre null. OBSOLETO: ya no se rellena. Siempre null.

Propiedades

string
requerido
ID del usuario, con el prefijo user_.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no estableció ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre presente. Es un marcador de posición generado cuando el usuario no estableció ninguna imagen.
string
requerido
Nombre de usuario público.
PartnerReferralRequest