Skip to main content
Lusopay

Integrators

Endpoints & examples

API reference with real request and response examples, for every payment method.

Our API manual is extensive and integration is extremely customisable. The examples below are the simplest way to integrate. Every code used in the parameters is fully explained in the manual.

Generic

All payment methods

Valid for any payment method — this example uses the common PYM parameter: P0.

{
  "formParameters": {
    "L": "pt_PT",
    "CUR": "EUR",
    "OID": "07313",
    "PID": "cliente7",
    "AMT": "2.50",
    "PYM": "P0",
    "MSG": "Pagamento servico",
    "UF": "https://www.loja.pt"
  }
}
Response
{
  "title": "Pay by link por API V3",
  "content": "https://pay.lusopay.com/paybylink_test/v3/payment_form.php?data=VoojNVLo5z0GEpQdtsJ6LxWKRQGWEa7gqeGh1at10TV95T9eeSMfZlCvaSL51biM2Q%2F7COd597lk9TSuoC9EOqxUH4eVSb8Ar9wm74lQHeDmav6luR0TJf6kQBMPzJlIu4vbznz%2BGczpuUVK5BMxntpsMLDxSLS5q74K18%2FRYZtrfnM%2B8jk5etDNeCH%2FlCOl%2FgdOm9mRh%2BIVAYpgNS38Kri4Vyq0o7uY7AEZ5a6AinJbIKp0gCp7qhzrt8yK2QEc6TNePAbaWSQGpC4%2BN4ChvLomWO471F%2BJTzYy50KJXp8%3D",
  "reRun": false,
  "resultType": "richText"
}

MB WAY

Payment by MB WAY

Parameter PYM: P4.

{
  "formParameters": {
    "L": "pt_PT",
    "CUR": "EUR",
    "OID": "MBWAY07313",
    "PID": "cliente7",
    "AMT": "2.50",
    "PYM": "P4",
    "TID": "TERMINAL_MBWAY_EXEMPLO",
    "MSG": "Pagamento por MB WAY"
  }
}
Response
{
  "title": "Pay by link por API V3",
  "content": "https://pay.lusopay.com/paybylink_test/v3/payment_form.php?data=VoojNVLo5z0GEpQdtsJ6LxWKRQGWEa7gqeGh1at10TV95T9eeSMfZlCvaSL51biM2Q%2F7COd597lk9TSuoC9EOqxUH4eVSb8Ar9wm74lQHeDmav6luR0TJf6kQBMPzJlIu4vbznz%2BGczpuUVK5BMxntpsMLDxSLS5q74K18%2FRYZtrfnM%2B8jk5etDNeCH%2FlCOl%2FgdOm9mRh%2BIVAYpgNS38Kri4Vyq0o7uY7AEZ5a6AinJbIKp0gCp7qhzrt8yK2QEc6TNePAbaWSQGpC4%2BN4ChvLomWO471F%2BJTzYy50KJXp8%3D",
  "reRun": false,
  "resultType": "richText"
}

Multibanco

Payment by Multibanco reference

Parameter PYM: P2.

{
  "formParameters": {
    "L": "pt_PT",
    "CUR": "EUR",
    "OID": "MB07313",
    "PID": "cliente7",
    "AMT": "2.50",
    "PYM": "P2",
    "MSG": "Pagamento por referência Multibanco"
  }
}
Response
{
  "title": "Pay by link por API V3",
  "content": "https://pay.lusopay.com/paybylink_test/v3/payment_form.php?data=VoojNVLo5z0GEpQdtsJ6LxWKRQGWEa7gqeGh1at10TV95T9eeSMfZlCvaSL51biM2Q%2F7COd597lk9TSuoC9EOqxUH4eVSb8Ar9wm74lQHeDmav6luR0TJf6kQBMPzJlIu4vbznz%2BGczpuUVK5BMxntpsMLDxSLS5q74K18%2FRYZtrfnM%2B8jk5etDNeCH%2FlCOl%2FgdOm9mRh%2BIVAYpgNS38Kri4Vyq0o7uY7AEZ5a6AinJbIKp0gCp7qhzrt8yK2QEc6TNePAbaWSQGpC4%2BN4ChvLomWO471F%2BJTzYy50KJXp8%3D",
  "reRun": false,
  "resultType": "richText"
}

Payshop

Payment by Payshop

Parameter PYM: P5.

{
  "formParameters": {
    "L": "pt_PT",
    "CUR": "EUR",
    "OID": "PAYSHOP07313",
    "PID": "cliente7",
    "AMT": "2.50",
    "PYM": "P5",
    "MSG": "Pagamento por Payshop",
    "UF": "https://www.loja.pt"
  }
}
Response
{
  "title": "Pay by link por API V3",
  "content": "https://pay.lusopay.com/paybylink_test/v3/payment_form.php?data=VoojNVLo5z0GEpQdtsJ6LxWKRQGWEa7gqeGh1at10TV95T9eeSMfZlCvaSL51biM2Q%2F7COd597lk9TSuoC9EOqxUH4eVSb8Ar9wm74lQHeDmav6luR0TJf6kQBMPzJlIu4vbznz%2BGczpuUVK5BMxntpsMLDxSLS5q74K18%2FRYZtrfnM%2B8jk5etDNeCH%2FlCOl%2FgdOm9mRh%2BIVAYpgNS38Kri4Vyq0o7uY7AEZ5a6AinJbIKp0gCp7qhzrt8yK2QEc6TNePAbaWSQGpC4%2BN4ChvLomWO471F%2BJTzYy50KJXp8%3D",
  "reRun": false,
  "resultType": "richText"
}

Pix

Payment by Pix

Parameter PYM: P14.

{
  "formParameters": {
    "L": "pt_PT",
    "CUR": "EUR",
    "OID": "PIX07313",
    "PID": "cliente7",
    "AMT": "2.50",
    "PYM": "P14",
    "MSG": "Pagamento por Pix",
    "UF": "https://www.loja.pt"
  }
}
Response
{
  "title": "Pay by link por API V3",
  "content": "https://pay.lusopay.com/paybylink_test/v3/payment_form.php?data=VoojNVLo5z0GEpQdtsJ6LxWKRQGWEa7gqeGh1at10TV95T9eeSMfZlCvaSL51biM2Q%2F7COd597lk9TSuoC9EOqxUH4eVSb8Ar9wm74lQHeDmav6luR0TJf6kQBMPzJlIu4vbznz%2BGczpuUVK5BMxntpsMLDxSLS5q74K18%2FRYZtrfnM%2B8jk5etDNeCH%2FlCOl%2FgdOm9mRh%2BIVAYpgNS38Kri4Vyq0o7uY7AEZ5a6AinJbIKp0gCp7qhzrt8yK2QEc6TNePAbaWSQGpC4%2BN4ChvLomWO471F%2BJTzYy50KJXp8%3D",
  "reRun": false,
  "resultType": "richText"
}