CiputraLife logo
API docs by Ciputra Life

E-Payment Ciputra Life - API Documentation (2.1.5)

Download OpenAPI specification:Download

E-Payment Ciputra Life - API Documentation

Authentication

bearerAuth

Security Scheme Type: /auth/token

token

Everything about token

Get Token for Authorization

header Parameters
api-key
required
string

API Key Code

api-secret
required
string

API Secret Code

Responses

Response samples

Content type
application/json
{
  • "code": "00",
  • "status": true,
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJsdW1lbi1qd3QiLCJzdWIiOiJvdUF5SURnR3N6QWtJV2hYZHp4Umswc0JxQUZycDNBWGpqUThqN1g4MjNSaVg3TVowWDNSTXZsczNZQ3ZwR2o3IiwiaWF0IjoxNjE0NjcwOTM5LCJleHAiOjE2MTQ2NzQ1Mzl9.zo0cvIcnsScv7-vP3Iy4IR-GSv4qk3-mXqETy4yh2ko",
  • "expires_in": 1635915352,
  • "token_type": "Bearer",
  • "message": "Success"
}

api-transaction

transaction epay

Transaction payment

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Authorization Bearer token

Request Body schema:

Transaction

action
string

Type of a action

paytype
required
string
Enum: "all" "va" "cc" "ib" "ewallet" "otc"

Payment type [all: All Payment, va: Virtual Account, cc: Credit Card, ib: Internet Banking, ewallet: Ewallat]

paycode
required
string
Enum: "all" "bca" "bni" "permata" "bri" "mandiri" "credit_card" "cimb_niaga" "jenius" "gopay" "ovo" "dana" "alfamart" "indomaret"

Payment code [all: All Payment Code, bca: Bank BCA, bni: BANK BNI, permata: BANK Permata, bri: BANK BRI, mandiri: BANK MANDIRI, credit_card: Credit Card, cimb_niaga: BANK CIMB NIAGA, jenius: BANK BTPN, gopay: Ewallet Gopay, ovo: Ewallet OVO, dana: Ewallet DANA, alfamart: OTC Alfamart, indomaret: OTC Indomaret]

external_id
required
string

Unique customer code

name
required
string

Customer's name

email
string

Customer's email address

phone
string

Customer's phone address

refno
string

Policy number

object

Transaction description

amount
required
string

Total amount of transaction

exptype
string
Enum: "S" "M" "H" "D" "MN" "SD"

Expired type [Blank | S : Seconds | M : Minute | H : Hour | D : Days | MN : Month | SD : Specific Date]

expval
string

Expired value [Blank | 1,2,3,4,5,6,7,8,9,0 | yyyy-MM-dd]

redirect_url
string

Redirect url use for redirect to cashier page

callback_url
string

Callback url

back_url
string

Back url

send_email
string

send payment information via email [blank : default setup | 0 : don't send email | 1 : send email]

send_sms
string

send payment information via sms [blank : default setup | 0 : don't send sms | 1 : send sms]

Responses

Request samples

Content type
Example
{
  • "action": "charge",
  • "paytype": "ewallet",
  • "paycode": "gopay",
  • "external_id": "ECL00001",
  • "name": "Jhonny",
  • "email": "[email protected]",
  • "phone": "080000022233",
  • "refno": "0000000001",
  • "description": {
    },
  • "amount": "2000000",
  • "exptype": "D",
  • "expval": "3",
  • "redirect_url": "https://ciputralife.com",
  • "callback_url": "https://ciputralife.com",
  • "back_url": "https://ciputralife.com",
  • "send_email": "0",
  • "send_sms": "0"
}

Response samples

Content type
application/json
{
  • "code": "00",
  • "status": true,
  • "data": {
    },
  • "message": "Success"
}

api-inquiry-charge

inquiry transaction

Inquiry Transaction payment

Authorizations:
bearerAuth
path Parameters
external_id
required
string
header Parameters
Authorization
required
string

Authorization Bearer token

Responses

Response samples

Content type
application/json
{
  • "code": "00",
  • "status": true,
  • "data": {
    },
  • "message": "Success"
}

api-inquiry-registration

inquiry registration

Inquiry Registration

Authorizations:
bearerAuth
path Parameters
external_id
required
string
header Parameters
Authorization
required
string

Authorization Bearer token

Responses

Response samples

Content type
application/json
{
  • "code": "00",
  • "status": true,
  • "data": {
    },
  • "message": "Success"
}