Obciążenie profilu OneClick lub recurring

Obciążenie profilu OneClick lub recurring Run in API Explorer

POST /{merchantId}/transaction/profile

Token autoryzacyjny

Path parameters

merchantId string Required

Identyfikator klienta

application/json

Body Required

serviceId string(uuid) Required

Identyfikator sklepu jako UUID v4

Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
paymentProfileId string(uuid) Required

Identyfikator profilu jako UUID v4

Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
amount integer Required

Kwota transakcji w najmniejszej jednostce waluty np. grosze.
currency string Required

Waluta transakcji w standardzie ISO 4217

Maximum length is 3. Values are PLN, EUR, USD, GBP, CHF, SEK, HUF, CZK, BGN, or RON.
orderId string Required

Numer zamówienia

Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\\\\/ \u00C0-\u02C0]+$.
title string

Tytuł transakcji

Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
notificationUrl string(uri)

Dynamiczny adres notyfikacji, możliwość ustawienia konkretnego adresu dla pojedynczej transakcji. Adresy zawierające localhost oraz porty zostaną odrzucone.

Maximum length is 300.
data object
Hide data attribute Show data attribute object
- multipayout array[object] Required
  
  Informacje na temat numerów rachunków, na jakie mają zostać wypłacone środki z transakcji.
  Wymagana aktywna funkcja multiwypłat.
  
  W przypadku korzystania z płatności Split Payment, maksymalna dopuszczalna kwota, jaką można przekazać w ramach multiwypłat jest równa kwocie netto zamówienia.
  Hide multipayout attributes Show multipayout attributes object
  
  ban string Required
  
  Numer konta bankowego
  
  Minimum length is 26, maximum length is 26. Format should match the following pattern: ^[0-9]{26}$.
  
  amount integer Required
  
  Kwota transakcji w najmniejszej jednostce waluty np. grosze.
  
  label string Required
  
  Nazwa odbiorcy
  
  Maximum length is 70. Format should match the following pattern: ^[A-Za-z0-9\-\,\. \u00C0-\u02C0"']+$.
  
  title string
  
  Tytuł przelewu.
  Jego obecność powoduje wyodrębnienie danej transakcji na koncie odbiorcy. Podanie parametru dla jednego elementu warunkuje konieczność dostarczenia go dla pozostałych.
  
  Maximum length is 105. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
invoice object

Dane do faktury wymagane przy aktywnej usłudze ING Księgowość oraz przy płatności Split payment.

Obiekt nie może być użyty, jeśli w sklepie włączona jest opłata serwisowa.
Hide invoice attributes Show invoice attributes object
- buyer object Required
  
  Dane kupującego
  Hide buyer attributes Show buyer attributes object
  
  type string Required
  
  Typ kupującego. Przyjmuje wartość PERSON odbioraca indywidualny lub COMPANY firma
  
  Values are PERSON or COMPANY.
  
  email string(email) Required
  
  Adres e-mail w formacie zgodnym ze standardem RFC 5322 oraz RFC 6531
  
  Maximum length is 200.
  
  fullName string Required
  
  Imię i nazwisko nabywcy/nazwa firmy
  
  Maximum length is 200. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.
  
  street string Required
  
  Ulica
  
  Maximum length is 200. Format should match the following pattern: ^[0-9a-zA-Z\s\-#.'"&,_/\u00C0-\u02C0]*$`.
  
  city string Required
  
  Miasto
  
  Maximum length is 100. Format should match the following pattern: ^[0-9a-zA-Z\s\-#.'"&,_/\u00C0-\u02C0]*$`.
  
  postalCode string Required
  
  Kod pocztowy
  
  Maximum length is 30.
  
  countryCodeAlpha2 string Required
  
  Kod kraju Alpha2
  
  Maximum length is 2.
  
  idCountryCodeAlpha2 string
  
  Identyfikator kodu kraju Alpha2. Wymagane dla wartości VAT_ID parametru idType.
  
  Maximum length is 2.
  
  idType string
  
  Typ numeru identyfikacyjnego. Wymagane dla wartości COMPANY parametru type. Przyjmuje wartość ID dla PESEL lub VAT_ID dla NIP.
  
  Values are ID or VAT_ID.
  
  idNumber string
  
  NIP lub numer PESEL. Wymagane w przypadku wartości COMPANY dla parametru type.
  
  Maximum length is 30.
- positions array[object] Required
  
  Lista produktów
  Hide positions attributes Show positions attributes object
  
  name string Required
  
  Nazwa produktu
  
  code string Required
  
  Kod produktu
  
  quantity number Required
  
  Ilość. Minimalna wartość to 0.
  
  unit string Required
  
  Jednostka
  
  grossAmount integer Required
  
  Wartość jednostkowa brutto
  
  taxStake string Required
  
  Stawka podatku
  
  Values are TAX_23, TAX_22, TAX_8, TAX_7, TAX_5, TAX_3, TAX_0, TAX_EXEMPT, TAX_NOT_LIABLE, TAX_REVERSE_CHARGE, or TAX_EXCLUDING.
  
  discountAmount integer
  
  Wartość upustu
  
  taxAmount integer
  
  Wartość podatku w groszach. Wymagany tylko dla płatności Split Payment.
- issueInvoice boolean
  
  Automatyczna wysyłka faktury
- basisForVatExemption object
  
  Podstawa zwolnienia z podatku
  Hide basisForVatExemption attributes Show basisForVatExemption attributes object
  
  type string Required
  
  Values are DENTAL_TECHNICAN_SERVICES, DOCTOR_DENTIST_SERVICES, PHYSIOTHERAPY_SERVICES, NURSING_SERVICES, PSYCHOLOGICAL_SERVICES, MEDICAL_TRANSPORT_SERVICES, CARE_SERVICES, TUTORING, TEACHING_FOREIGN_LANGUAGES, ARTISTS, RENTING_PROPERTY, INSURANCE_SERVICES, CREDITS_AND_LOANS_SERVICES, GUARANTIEES, SPECIAL_CONDITIONS_FOR_EXEMPTION, UE_TRANSACTIONS, SUBJECTIVE_EXEMPTIONS, OTHER, or OTHER_OBJECTIVE_EXEMPTIONS.
  
  text string
  
  Opis. Parametr niezbędny w przypadku podania w parametrze type wartości OTHER.
- invoiceId string
  
  Numer faktury. Wymagany tylko dla płatności Split Payment.

Responses

200 application/json

Zapytanie wykonane poprawnie
Hide response attribute Show response attribute object
- transaction object
  
  Hide transaction attributes Show transaction attributes object
  
  id string(uuid)
  
  Identyfikator transakcji jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  type string
  
  Typ transakcji
  
  Values are sale or refund.
  
  status string
  
  Status
  
  Values are new, pending, settled, authorized, rejected, cancelled, or error.
  
  source string
  
  Żródło transakcji
  
  Values are web or api.
  
  created integer | null
  
  Data utworzenia jako timestamp
  
  modified integer | null
  
  Data modyfikacji jako timestamp
  
  notificationUrl string(uri)
  
  Dynamiczny adres notyfikacji, możliwość ustawienia konkretnego adresu dla pojedynczej transakcji. Adresy zawierające localhost oraz porty zostaną odrzucone.
  
  Maximum length is 300.
  
  serviceId string(uuid)
  
  Identyfikator sklepu jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  amount integer
  
  Kwota transakcji w najmniejszej jednostce waluty np. grosze.
  
  currency string
  
  Waluta transakcji w standardzie ISO 4217
  
  Maximum length is 3. Values are PLN, EUR, USD, GBP, CHF, SEK, HUF, CZK, BGN, or RON.
  
  title string
  
  Tytuł transakcji
  
  Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.
  
  orderId string
  
  Numer zamówienia
  
  Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\\\\/ \u00C0-\u02C0]+$.
  
  paymentMethod string
  
  Oznaczenie metody płatności
  
  Values are blik, pbl, ing, card, wallet, imoje_paylater, wt, or imoje_installments.
  
  paymentMethodCode string
  
  Oznaczenie kanału płatności
  
  Values are blik, imoje_twisto, paypo, blik_paylater, pragma_go, gpay, applepay, visa_mobile, paypal, ecom3ds, oneclick, recurring, ing, mtransfer, bzwbk, pekao24, inteligo, ipko, getin, noble, creditagricole, alior, millennium, citi, bos, bnpparibas, pocztowy, plusbank, bs, bspb, nest, pbs, cs, mp, kb, rf, pg, pf, cb, uc, posta, sporo, tatra, viamo, vub, wt, wt_split, inbank, or inbank_0.
  
  payment object
  
  Hide payment attributes Show payment attributes object
  
  id string(uuid)
  
  Identyfikator linku płatności jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  status string
  
  Status
  
  Values are new, pending, settled, authorized, rejected, cancelled, or error.
  
  paymentProfile object
  
  Dane profilu kartowego
  
  Hide paymentProfile attributes Show paymentProfile attributes object
  
  id string(uuid)
  
  Identyfikator profilu jako UUID v4
  
  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.
  
  merchantMid string
  
  Identyfikator klienta
  
  merchantCustomerId string
  
  Identyfikator płatnika
  
  firstName string
  
  Imię płatnika
  
  lastName string
  
  Nazwisko płatnika
  
  maskedNumber string
  
  Częściowo zamaskowany numer karty płatnika
  
  month string
  
  Ważność karty płatniczej - miesiąc
  
  year string
  
  Ważność karty płatniczej - rok
  
  organization string
  
  Organizacja karty płatniczej
  
  isActive integer
  
  Status aktywności profilu kartowego. 1 - aktywny, 0 - nieaktywny
  
  Values are 0 or 1.
  
  profile string
  
  Typ profilu kartowego
  
  Values are ONE_CLICK or RECURRING.
400 application/json

Profil jest nieaktywny
Hide response attribute Show response attribute object
- apiErrorResponse object
  
  Szczegóły błędu
  
  Hide apiErrorResponse attributes Show apiErrorResponse attributes object
  
  code string
  
  Kod błędu
  
  message string
  
  Komunikat błędu
  
  instance object
  
  Body przesłanego zapytania HTTP do imoje.
  
  errors array[object]
  
  Lista błędów
  
  Hide errors attributes Show errors attributes object
  
  property string
  
  Miejsce wystąpienia błędu
  
  message string
  
  Powód wystąpienia błędu

POST /{merchantId}/transaction/profile

curl \
 --request POST 'https://sandbox.api.imoje.pl/v1/merchant/{merchantId}/transaction/profile' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"title":"yourTitle","amount":1000,"orderId":"yourOrderId","currency":"PLN","serviceId":"ab16c18c-e83b-424f-80c9-f839ed23181f","paymentProfileId":"39ac1087-e632-41ff-acb8-8d661068a9d5"}'

Request example

{
  "title": "yourTitle",
  "amount": 1000,
  "orderId": "yourOrderId",
  "currency": "PLN",
  "serviceId": "ab16c18c-e83b-424f-80c9-f839ed23181f",
  "paymentProfileId": "39ac1087-e632-41ff-acb8-8d661068a9d5"
}

Response examples (200)

{
  "transaction": {
    "id": "440c5518-daf2-46e3-b7b6-22a0734648b2",
    "type": "sale",
    "title": "Card profile debiting",
    "amount": 1000,
    "source": "api",
    "status": "pending",
    "created": 1735686000,
    "orderId": "Card profile debiting",
    "payment": {
      "id": "440c5518-daf2-46e3-b7b6-22a0734648b2",
      "status": "pending"
    },
    "currency": "PLN",
    "modified": 1735686000,
    "serviceId": "e2bb5020-a185-4f44-ba99-8f2aeb0e3be7",
    "paymentMethod": "card",
    "paymentProfile": {
      "id": "46f095b4-be6f-4ea0-8052-475ac8fbf218",
      "year": "2029",
      "month": "12",
      "profile": "ONE_CLICK",
      "isActive": 1,
      "lastName": "Doe",
      "firstName": "John",
      "merchantMid": "rgfnb43ub57pry2nuc13",
      "maskedNumber": "****1111",
      "organization": "MASTERCARD",
      "merchantCustomerId": "yourMerchantCustomerId"
    },
    "notificationUrl": "https://asdgs.requestcatcher.com/",
    "paymentMethodCode": "oneclick"
  }
}

Response examples (400)

{
  "apiErrorResponse": {
    "code": "TRX-ERROR-120301",
    "errors": [],
    "message": "Payment profile inactive.",
    "instance": {
      "title": "yourTitle",
      "amount": 1000,
      "orderId": "yourOrderId",
      "currency": "PLN",
      "serviceId": "ab16c18c-e83b-424f-80c9-f839ed23181f",
      "paymentProfileId": "39ac1087-e632-41ff-acb8-8d661068a9d5"
    }
  }
}