Cost+Docs

Naisc Íocaíochta

Cruthaigh naisc íocaíochta in-athúsáidte

Is URLanna in-athúsáidte iad naisc íocaíochta a ligeann do chustaiméirí íoc as ordú. Murab ionann agus gnáthorduithe a éagann tar éis iarracht theipthe amháin, tacaíonn naisc íocaíochta le hiarrachta atrialacha iolracha, rud a fhágann go bhfuil siad oiriúnach do shonraisc, íocaíochtaí ríomhphost-bhunaithe, agus cásanna nach féidir leis an gcustaiméir íoc láithreach.

Príomhghnéithe

  • In-athúsáidte: Is féidir le custaiméirí an íocaíocht a atriail suas le 25 uair má theipeann ar iarrachta roimhe seo.
  • Fadmharthana: Is é an réamhshocrú éaga ná 30 lá (inchumraithe tríd an expiration_period).
  • Inroinnte: Seol an nasc trí ríomhphost, SMS, comhrá, nó leabaigh ar do shuíomh gréasáin.

Nasc Íocaíochta a Chruthú

Seol iarratas POST chuig /v1/paymentlinks/:

POST /v1/paymentlinks/
curl -X POST https://api.costplus.online/v1/paymentlinks/ \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "merchant_order_id": "invoice-1234",
    "amount": 995,
    "currency": "EUR",
    "description": "Invoice #1234"
  }'

Áirítear an payment_url san fhreagra chun é a roinnt leis an gcustaiméir agus id uathúil le haghaidh rianaithe:

Response (201 Created)
{
  "id": "e6eecc6a-47c5-4948-bcc0-d8b73f5c55a1",
  "merchant_order_id": "invoice-1234",
  "amount": 995,
  "currency": "EUR",
  "description": "Invoice #1234",
  "expiration_period": "P30D",
  "payment_url": "https://api.costplus.online/paymentlinks/e6eecc6a.../",
  "status": "new",
  "reason": "Payment Link was created, not yet visited",
  "orders": {},
  "created": "2026-01-15T12:00:00.000000Z"
}

Sábháil an id — úsáidfidh tú é chun stádas an naisc íocaíochta a sheiceáil níos déanaí.

Réimsí Riachtanacha

RéimseCur Síos
merchant_order_idD'aitheantas tagartha féin don nasc íocaíochta
amountMéid i mionaonad ISO 4217 an airgeadra (m.sh., 9.95 EUR = 995)
currencyCód airgeadra ISO 4217 (m.sh., EUR, GBP)

Réimsí Roghnacha

RéimseCur Síos
descriptionCur síos a thaispeántar don chustaiméir
expiration_periodFad ISO 8601. Is é an réamhshocrú ná P30D (30 lá)
return_urlURL chun an custaiméir a atreorú tar éis íocaíochta rathúla
failure_urlURL chun an custaiméir a atreorú ar cheallú, éag, nó earráid
webhook_urlURL chun fógraí athraithe stádais a fháil
customerRéad sonraí custaiméara (ainm, ríomhphost, srl.)

Má chuireann tú return_url agus failure_url araon ar fáil, atreorófar custaiméirí chuig failure_url nuair atá stádas an ordaithe cancelled, expired, nó error. Seachas sin, téann gach atreorú chuig return_url.

Nasc Íocaíochta a Aisghabháil

Seol iarratas GET chuig /v1/paymentlinks/{id}/ ag úsáid id an naisc íocaíochta ón bhfreagra cruthaithe:

GET /v1/paymentlinks/{id}/
curl -u YOUR_API_KEY: \
  https://api.costplus.online/v1/paymentlinks/e6eecc6a-47c5-4948-bcc0-d8b73f5c55a1/

Áirítear an stádas reatha san fhreagra agus tagairtí do gach ordú a cruthaíodh ón nasc, grúpáilte de réir a stádais:

Response (completed example)
{
  "id": "e6eecc6a-47c5-4948-bcc0-d8b73f5c55a1",
  "merchant_order_id": "invoice-1234",
  "amount": 995,
  "currency": "EUR",
  "description": "Invoice #1234",
  "expiration_period": "P30D",
  "payment_url": "https://api.costplus.online/paymentlinks/e6eecc6a.../",
  "status": "completed",
  "reason": "Completed",
  "completed": "2026-01-15T12:05:30.123456+00:00",
  "completed_order_id": "3bb663cc-2a20-400d-8bf6-18d9695d0c66",
  "orders": {
    "error": ["0d79014c-0aaa-4fd6-87c5-c8cfa5f5ac69"],
    "completed": ["3bb663cc-2a20-400d-8bf6-18d9695d0c66"]
  }
}

Sa sampla seo, rinne an custaiméir iarracht theipthe amháin (ordú 0d79014c... le stádas error) sula ndearna siad go rathúil é (ordú 3bb663cc... le stádas completed). Is féidir leat sonraí iomlána aon ordaithe a fháil tríd an GET /v1/orders/{order_id}/.

Stádais Naisc Íocaíochta

StádasCur Síos
newCruthaíodh an nasc ach níor rinneadh aon iarracht íocaíochta fós.
processingTá iarracht íocaíochta ar siúl faoi láthair.
all_unsuccessfulTheip ar gach iarracht íocaíochta go dtí seo. Is féidir leis an gcustaiméir atriail fós (suas le 25 iarracht).
completedD'éirigh leis an íocaíocht. Níl an nasc gníomhach a thuilleadh.
expiredD'éag an nasc sular éirigh le híocaíocht.

Ní stádas deiridh é an stádas all_unsuccessful. Is féidir leis an gcustaiméir iarracht a dhéanamh íoc arís go dtí go n-éiríonn leis an íocaíocht, go sroichtear uaslíon na n-iarrachtaí (25), nó go n-éagann an nasc.

Nuair a shroicheann nasc íocaíochta an stádas completed nó expired, ní féidir é a úsáid arís. Cruthaigh nasc íocaíochta nua má theastaíonn ón gcustaiméir íoc arís.

Sreabhadh Oibre Samplach

  1. Cruthaigh nasc íocaíochta trí POST /v1/paymentlinks/.
  2. Roinn an payment_url a fuarthas ar ais le do chustaiméir (m.sh., trí ríomhphost, SMS, nó sonrasc).
  3. Osclaíonn an custaiméir an nasc agus críochnaíonn siad an íocaíocht.
  4. Seolann Cost+ webhook chuig do webhook_url nuair a athraíonn an stádas.
  5. Fíoraigh stádas an naisc íocaíochta trí GET /v1/paymentlinks/{id}/.
  6. Comhlíon an t-ordú nuair atá an stádas completed.

Críochphointí Gaolmhara

On this page