v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Pay

Initiate Payment Request

post/PayAPI/PayAPIService.svc/Pay

Request body

Amountnumber double required

Transaction Amount.

Range: 0.01 to 999999999.99 Default: No

CreateTokenboolean nullable

Create a Token for Future Use.

~ The token can be used only with the same iCredit user. Default: false

CreditboxTokenstring uuid required

Credit Box Identifier.

Format: UUID Default: No

IPNURLstring url nullable

IPN URL - After Success Payment.

Length: 15 to 500 Default: No

ParamJ0 | 2 | 5 nullable

Transaction Param J Type.

Options: (0 = Immediate transaction 2 = CC check + Create token 5 = Pending transaction) Default: 0

PreventDuplicatesboolean nullable

Prevent Doubled Transactions.

Default: true

RedirectURLstring URL nullable

Thank You Page URL - After Successful Payment.

Length: 15 to 500 Default: No

Example request

{
  "Amount": 1,
  "CreditboxToken": "7cd7ca78-e67c-4909-94b7-22fd19e42ad4",
  "IPNURL": "http://9188dde0.ngrok.io/test/ipn_listener.php",
  "RedirectURL": "https://www.icredit.co.il/"
}

Response

Payment With Pay Successful

error_codeinteger

The Response Error code (0 = Success).

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

urlstring url

The URL to Complete the ApplePay Payment.