Online Refund

POST

/credit-card/v1/cancellation/credit-card/refund

Header Parameter	Type	Description
Client-Id	`string`	The Client ID you retrieved from Jokul Back Office `MANDATORY`
Request-Id	`string`	Random string that must unique per request for idempotency `MANDATORY` `ALPHA NUMERIC` `40 chars`
Request-Timestamp	`string`	Request time in ISO8601 format with UTC + 0 `MANDATORY`
Signature	`string`	Security parameter to ensure the request's authenticity. Learn more how to generate Signature here `MANDATORY`

Request

Header Params

Client-Id

string

required

Example:

Request-Id

string

required

Example:

Request-Timestamp

string

required

Example:

Signature

string

required

Example:

Body Params application/json

order

object

required

invoice_number

string

required

line_items

array [object {3}]

required

amount

integer

required

callback_url

string

required

auto_redirect

boolean

required

session_id

string

required

customer

object

required

string

required

name

string

required

string

required

phone

string

required

address

string

required

country

string

required

override_configuration

object

required

themes

object

required

Example

{ 
    "order": {
       	"invoice_number":"INV-{{$timestamp}}",
       	"line_items": [
			{
      		"name": "DOKU T-Shirt Merah",
      		"price": 30000,
      		"quantity": 2
    		},
			{
      		"name": "DOKU T-Shirt Biru",
      		"price": 30000,
      		"quantity": 1
    		}
  		],
       	"amount": 90000,
       	"callback_url": "https://doku.com",
       	"auto_redirect": false,
       	"session_id": "0000231223"
    },
    "customer": {
    	"id":"W7rbKhPYh76VSHYwHRaGDIbBhgTebgAoWtX",
    	"name":"Anton Budiman",
    	"email":"anton@doku.com",
    	"phone":"+6281287458232",
		"address":"Jakarta, Menara Mulia Lt 8",
		"country":"ID"
	},
    "override_configuration": {
        "themes": {
            "language": "ID",
            "background_color": "",
            "font_color": "",
            "button_background_color": "",
            "button_font_color": ""
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/credit-card/v1/cancellation/credit-card/refund' \
--header 'Client-Id: {{client_id}}' \
--header 'Request-Id: {{request_id}}' \
--header 'Request-Timestamp: {{request_timestamp}}' \
--header 'Signature: {{signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "order": {
       	"invoice_number":"INV-{{$timestamp}}",
       	"line_items": [
			{
      		"name": "DOKU T-Shirt Merah",
      		"price": 30000,
      		"quantity": 2
    		},
			{
      		"name": "DOKU T-Shirt Biru",
      		"price": 30000,
      		"quantity": 1
    		}
  		],
       	"amount": 90000,
       	"callback_url": "https://doku.com",
       	"auto_redirect": false,
       	"session_id": "0000231223"
    },
    "customer": {
    	"id":"W7rbKhPYh76VSHYwHRaGDIbBhgTebgAoWtX",
    	"name":"Anton Budiman",
    	"email":"anton@doku.com",
    	"phone":"+6281287458232",
		"address":"Jakarta, Menara Mulia Lt 8",
		"country":"ID"
	},
    "override_configuration": {
        "themes": {
            "language": "ID",
            "background_color": "",
            "font_color": "",
            "button_background_color": "",
            "button_font_color": ""
        }
    }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2025-07-17 09:16:25

Unbinding

Payment