IOPAY→Developers→Makselingid
Payment Links API · kehtiv V2

Makselingid

Loo, kohanda ja jälgi majutatud maksenõudeid API kaudu. V2 koondab kehtiva integratsiooni; V1 viide jääb olemasolevatele integratsioonidele kättesaadavaks.

Base URLhttps://api.iopay.com.br/api
AutentimineBearer token
VersioonidKehtiv V2 · V1 ühilduvus
Dokumentatsioon V2 ↗ V1 viide ↗ Vaata toodet →
V2 · ülevaade

Üks API lingi kogu elutsükli jaoks.

V2 võimaldab makselinke luua, pärida, uuendada, kustutada ja loetleda ning pärida nende linkide kaudu tekkinud tehinguid.

Checkout

Tooted, Order Bump ja identiteet.

Seadista tooted, valikulised pakkumised, põhivärv ja vajadusel bänner.

Kommertstingimus

Osamaksed, intress ja kasutus.

Määra osamaksed, intressi edasikandmine, kättesaadavuse aken ja maksete maksimaalne arv.

Toiming

Päritavad lingid ja tehingud.

Loetle maksenõuded ja filtreeri loodud tehinguid staatuse, meetodi, perioodi ja lingi järgi.

Quickstart V2

Loo makselink

Väärtused items[*].amount ja order_bump_items[*].amount esitatakse sentides. Põhisumma arvutatakse toodete summana; Order Bumpid ei kuulu algsummasse.

Arvesta allolevates näidetes BASE_URL = https://api.iopay.com.br/api.

POST {{BASE_URL}}/v2/payment_link
{
  "title": "Tellimus #1001",
  "description": "Compra de produtos diversos",
  "status": "enabled",
  "open_at": null,
  "end_at": null,
  "max_payments": 1,
  "max_installment": 3,
  "highlight_installment_condition": true,
  "enabled_payment_methods": {
    "credit": true,
    "pix": true,
    "boleto": true
  },
  "pass_interest_to_customer": true,
  "customer_interest_starts_at_installment": 1,
  "primary_color": "4099b4",
  "items": [
    {
      "name": "Produto principal",
      "amount": 60000
    }
  ],
  "order_bump_items": [
    {
      "name": "Garantia estendida",
      "amount": 15000
    }
  ]
}
Makseviisid. V2 dokumenteerib credit, pix ja boleto. Vähemalt üks meetod peab olema lubatud ning ka autenditud kontole avatud. debit pole makselinkide puhul saadaval.
Seadistus

V2 funktsioonid

FunktsioonPõhiväljadKasutus
Tooteditems[]Tooted, mis moodustavad lingi algsumma.
Order Bumporder_bump_items[]Checkoutis pakutavad valikulised tooted.
Meetodidenabled_payment_methodsKrediit, Pix ja boleto vastavalt konto lubamisele.
Osamaksedmax_installment · highlight_installment_condition1 kuni 12 osamakset, järgides konto seadistust.
Intresspass_interest_to_customer · customer_interest_starts_at_installmentIntressi ostjale edasikandmise kontroll.
Kättesaadavusopen_at · end_at · max_paymentsLingi ajaaken ja kasutuslimiit.
Identiteetprimary_color · bannersPõhivärv ja valikuline checkouti bänner.
Splitsplit_rules[]Protsendiline või fikseeritud jaotus lubatud kontodele.
V2 viide

Lõpp-punktid

MeetodMarsruutToiming
POST/v2/payment_linkLoo link JSON-is.
POST/v2/payment_linkLoo link bänneriga multiparti kaudu.
GET/v2/payment_link/{ID_LINK}Päri link.
PATCH/v2/payment_link/{ID_LINK}Uuenda osaliselt.
DELETE/v2/payment_link/{ID_LINK}Kustuta link.
GET/v2/payment_link/listLoetle lingid filtrite ja lehekülgedeks jagamisega.
GET/v2/payment_link/list/transactionsLoetle linkide kaudu tekkinud tehingud.
Päringud & filtrid

Tegevusloendid

Lingid

Filtreeri maksenõuete baasi.

page, limit, offset, sort, status ja loomise vahemik date_range kaudu.

Tehingud

Leia õige makse.

Lisaks lehekülgedeks jagamisele ja perioodile filtreeri id_link, status ja payment_type järgi.

Osaline uuendus. PATCH-is jäävad välja jäetud väljad muutumatuks. order_bump_items: [] saatmine eemaldab Order Bumpid; split_rules: [] eemaldab spliti reeglid; primary_color: null taastab vaiketeema.
Versioonimine

V2 uutele integratsioonidele. V1 ühilduvuse jaoks.

Developer Central toob V2 esile kehtiva viitena. Olemasolevad integratsioonid, mis veel sõltuvad varasemast lepingust, võivad jätkata V1 avaliku dokumentatsiooni kasutamist.

Ava V2 ↗ Ava V1 ↗