JapanAPI
  • 14 Mar 2025
  • 2 Minutes to read
  • Dark
    Light

JapanAPI

  • Dark
    Light

Article summary

Supported Transaction Types

  • Authorisation AUTH

  • Capture CAPT

  • Purchase PURC

  • Refund PARTIALREFUND

  • Void GENERALVOID

  • Payouts ORIGINALCREDIT

  • Recurring AUTH / PURC

Integrations Supported

Deposit - Authorisation / Purchase

  • Hosted Payment Page

  • Direct Connect ( server-to-server)

Capture, Void, Refunds, Payouts, Recurring

  • Hosted Payment Page

  • Direct Connect ( server-to-server)

Currencies & Countries Supported

Title

Description

Currencies Supported

Various supported currencies

Additional attributes to process Deposits

You must include the following JSON attributes in the payload. These attributes inform us to redirect to JapanAPI to finalize the payment process.

if you are using our Hosted Payment Page

Description

Hosted Payment Page

Transaction Type

"TransactionType": "PURC"

Force Transaction Routing

“Routing”:{

"ForceBank": "JAPANAPI”

Client Details

"Client" : {

"Email": "johndoe@gmail.com",

"ClientAccount": "testing",

"FirstName" : "Frictionless",

"LastName" : "Processed",

"Country": "MLT",

"MobileNo": "+35612345678",

"Street": "Valletta Road",

"City": "London",

"ZIPCode": "000001",

"State": "N/A",

"DateOfBirth" : "2000-07-20"

Test Indicator

"isTest”: true

Sample requests using our Hosted Payment Page can be viewed here.

 {
  "TransactionType": "PURC",
  "Amount": 10.00,
  "Currency": "EUR",
  "OrderReference": "34323",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect",
  "FailRedirectionURL": "https://yourURLhere.com/FailRedirect/",
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "Routing": {
    "ForceBank": "JAPANAPI"
  },
  "Client" : {
    "Email": "johndoe@gmail.com",
    "ClientAccount": "testing",
    "FirstName" : "Frictionless",
    "LastName" : "Processed",
    "Country": "MLT",
    "MobileNo": "+35612345678",
    "Street": "Valletta Road",
    "City": "London",
    "ZIPCode": "000001",
    "State": "N/A",
    "DateOfBirth" : "2000-07-20"
  },
  "IsTest": true
}

If you are using our direct connect solution (server-to-server)

Description

Direct Connect

Transaction Type

"TransactionType": "PURC"

Force Transaction Routing

“Routing”:{

"ForceBank": "JAPANAPI”

Client Details

"Client" : {

"Email": "apco@test.com",

"FirstName" : "Apco",

"LastName" : "Test",

"Country": "MLT",

"MobileNo": "+35612345678",

"Street": "Fake Street 123",

"City": "TestCity",

"ZIPCode": "000001",

"State": "N/A",

"IPAddress" : "214.21.134.79",

"DateOfBirth" : "2000-07-20"

Card Details

"PaymentCredentials": {

"PaymentSource": "Card",

"CardType": "MASTERCARD",

"CardNumber": "5351772561457936",

"CVV2": "123",

"ExpMonth": "02",

"ExpYear": "2027",

"CardHolderName": "Joe Smith"

},

Browser details

"BrowserDetails": {

"UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",

"JavaEnabled": true,

"ScreenColorDepth": "1",

"ScreenWidth": "1080",

"ScreenHeight": "840",

"TimeZone": "2",

"AcceptHeader": "application/json",

"BrowserLanguage": "en"

}

Test Indicator

"isTest”: true

Sample requests using Direct Connect can be viewed here.

 {
  "TransactionType": "PURC",
  "Amount": 10.23,
  "Currency": "EUR",
  "IsTest": true,
  "OrderReference": "123",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "FailRedirectionURL": "https://yourURLhere.com/FailRedirect/",
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "PaymentCredentials": {
    "PaymentSource": "Card",
    "CardType": "VISA",
    "CardNumber": "4000000000001018",
    "CardHolderName": "Frictionless Processed",
    "ExpMonth": "12",
    "ExpYear": "2030",
    "CvV2": "666"
  },
  "Client" : {
    "Email": "apco@test.com",
    "FirstName" : "Apco",
    "LastName" : "Test",
    "Country": "MLT",
    "MobileNo": "+35612345678",
    "Street": "Fake Street 123",
    "City": "TestCity",
    "ZIPCode": "000001",
    "State": "N/A",
    "IPAddress" : "214.21.134.79",
   "DateOfBirth" : "2000-07-20"
  },
   "BrowserDetails": {
    "UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
    "JavaEnabled": true,
    "ScreenColorDepth": "1",
    "ScreenWidth": "1080",
    "ScreenHeight": "840",
    "TimeZone": "2",
    "AcceptHeader": "application/json",
    "BrowserLanguage": "en"
  },
  "Routing": {
    "ForceBank": "JAPANAPI"
  }
}

Requesting a Refund

If you wish to a Refund the below are the mandatory fields.

Description

Direct Connect

Transaction Type

"TransactionType": "PARTIALREFUND"

Transaction Reference

"PspID": "342342”

Sample request for processing a PARTIALREFUND request.

{
"TransactionType": "PARTIALREFUND",
"Amount": 10.00,
"CallBackURL": "https://www.yourURLhere.com/Listener",
"IsTest": true,
"UniqueReference": "6514441d-8abe-4d7b-9e0c-3aa386333b34",
"PspID":"839791" 
}

Test Credentials

Test Card details below. You must use a future expiry date and use “Frictionless Processed” as the cardholder name. For more test information on different card use cases here.

Card Details

4642030491925753



Was this article helpful?