Ruby

Officiellt Ruby SDK för Cost+ betalningsgateway. Förenklar HPP-omdirigeringsflödet (Hosted Payment Page), HMAC payload-signering och webhook-verifiering.

Funktioner

HMAC-SHA256 signaturgenerering och verifiering med konstant tid
Automatisk snake_case-mappning från API:et till Ruby-vänliga OpenStruct-objekt
Webhook-tolkning + API-baserad orderverifiering
Testad med Ruby 3.1, 3.2 och 3.3
Sinatra-baserad demohandlarapplikation inkluderad

Krav

Ruby 3.1 eller senare
Ett Cost+-handelskonto — dashboard.costplus.io

Installation

Lägg till i din Gemfile:

gem "nopayn"

Kör sedan:

bundle install

Eller installera direkt:

gem install nopayn

Snabbstart

1. Initiera klienten

require "nopayn"

nopayn = NoPayn::Client.new(
  api_key:     "your-api-key",
  merchant_id: "your-project"
)

2. Skapa en betalning och omdirigera till HPP

result = nopayn.generate_payment_url(
  amount:            1295,           # €12.95 in cents
  currency:          "EUR",
  merchant_order_id: "ORDER-001",
  description:       "Premium Widget",
  return_url:        "https://shop.example.com/success",
  failure_url:       "https://shop.example.com/failure",
  webhook_url:       "https://shop.example.com/webhook",
  locale:            "en-GB",
  expiration_period: "PT30M"
)

# Redirect the customer
# result.order_url   → HPP (customer picks payment method)
# result.payment_url → direct link to the first transaction's payment method
# result.signature   → HMAC-SHA256 for verification
# result.order_id    → NoPayn order UUID

3. Hantera webhooken

post "/webhook" do
  request.body.rewind
  raw_body = request.body.read

  verified = nopayn.verify_webhook(raw_body)

  puts verified.order.status  # "completed", "cancelled", etc.
  puts verified.is_final      # true when the order won't change

  if verified.order.status == "completed"
    # Fulfil the order
  end

  status 200
end

API-referens

`NoPayn::Client.new(api_key:, merchant_id:, base_url:)`

Parameter	Typ	Obligatorisk	Standard
`api_key`	`String`	Ja	—
`merchant_id`	`String`	Ja	—
`base_url`	`String`	Nej	`https://api.nopayn.co.uk`

`client.create_order(params) -> OpenStruct`

Skapar en order via POST /v1/orders/.

Parameter	Typ	Obligatorisk	Beskrivning
`:amount`	`Integer`	Ja	Belopp i minsta valutaenhet (cent)
`:currency`	`String`	Ja	ISO 4217-kod (`EUR`, `GBP`, `USD`, `NOK`, `SEK`)
`:merchant_order_id`	`String`	Nej	Din interna orderreferens
`:description`	`String`	Nej	Orderbeskrivning
`:return_url`	`String`	Nej	Omdirigering efter lyckad betalning
`:failure_url`	`String`	Nej	Omdirigering vid avbrytning/utgång/fel
`:webhook_url`	`String`	Nej	Asynkrona statusändringsnotifieringar
`:locale`	`String`	Nej	HPP-språk (`en-GB`, `de-DE`, `nl-NL`, etc.)
`:payment_methods`	`Array<String>`	Nej	Filtrera HPP-metoder
`:expiration_period`	`String`	Nej	ISO 8601-duration (`PT30M`)

Tillgängliga betalningsmetoder: credit-card, apple-pay, google-pay, vipps-mobilepay

`client.get_order(order_id) -> OpenStruct`

Hämtar orderdetaljer via GET /v1/orders/{id}/.

`client.create_refund(order_id, amount, description: nil) -> OpenStruct`

Utfärdar en fullständig eller partiell återbetalning via POST /v1/orders/{id}/refunds/.

`client.generate_payment_url(params) -> OpenStruct`

Bekvämlighetsmetod som skapar en order och returnerar:

result.order_id     # NoPayn order UUID
result.order_url    # HPP URL
result.payment_url  # Direct payment URL (first transaction)
result.signature    # HMAC-SHA256 of amount:currency:order_id
result.order        # Full order OpenStruct

`client.generate_signature(amount, currency, order_id) -> String`

Genererar en HMAC-SHA256 hex-signatur.

`client.verify_signature(amount, currency, order_id, signature) -> Boolean`

Verifiering med konstant tid av en HMAC-SHA256-signatur.

`client.verify_webhook(raw_body) -> OpenStruct`

Tolkar webhook-kroppen och anropar sedan GET /v1/orders/{id}/ för att verifiera faktisk status.

Fristående HMAC-verktyg

require "nopayn"

sig = NoPayn::Signature.generate("your-api-key", 1295, "EUR", "order-uuid")
ok  = NoPayn::Signature.verify("your-api-key", 1295, "EUR", "order-uuid", sig)

Felhantering

begin
  nopayn.create_order(amount: 100, currency: "EUR")
rescue NoPayn::ApiError => e
  puts e.status_code  # 401, 400, etc.
  puts e.error_body   # Raw API error response
rescue NoPayn::Error => e
  puts e.message      # Network or parsing error
end

Undantag	Förälder	Beskrivning
`NoPayn::Error`	`StandardError`	Basfel för alla SDK-fel
`NoPayn::ApiError`	`NoPayn::Error`	HTTP-fel från API:et
`NoPayn::WebhookError`	`NoPayn::Error`	Ogiltig webhook-payload

Orderstatusar

Status	Slutgiltig?	Beskrivning
`new`	Nej	Order skapad
`processing`	Nej	Betalning pågår
`completed`	Ja	Betalning lyckades — leverera varorna
`cancelled`	Ja	Betalning avbruten av kunden
`expired`	Ja	Betalningslänken löpte ut
`error`	Ja	Tekniskt fel

Bästa praxis för webhooks

Verifiera alltid via API:et — webhook-payloaden innehåller bara order-ID:t, aldrig statusen. SDK:ts verify_webhook gör detta automatiskt.
Returnera HTTP 200 för att bekräfta mottagandet. Annan kod utlöser upp till 10 omförsök (2 minuter emellan).
Implementera en reservpoller — för ordrar äldre än 10 minuter som inte har nått slutgiltig status, polla get_order som säkerhetsnät.
Var idempotent — du kan ta emot samma webhook flera gånger.

Testkort

Använd dessa kort i Cost+ testläge (sandbox-webbplats):

Kort	Nummer	Noteringar
Visa (lyckad)	`4111 1111 1111 1111`	Valfritt CVV
Mastercard (lyckad)	`5544 3300 0003 7`	Valfritt CVV
Visa (nekad)	`4111 1111 1111 1105`	Do Not Honor
Visa (otillräckligt saldo)	`4111 1111 1111 1151`	Insufficient Funds

Använd valfritt framtida utgångsdatum och valfri 3-siffrig CVC.

Demoapplikation

En Sinatra-baserad demoapplikation ingår i GitHub-repositoryt för att testa det fullständiga betalningsflödet.

Support

Behöver du hjälp? Kontakta vårt supportteam på support@costplus.io.

On this page