Void
API Payment
- API ini digunakan DP untuk membatalkan transaksi
Request
1curl --location -g --request POST 'https://api.prakerja.go.id/api/v1/integration/payment/void' \
2--header 'Content-Type: application/json' \
3--header 'client_code: CLIENT_CODE' \
4--header 'signature: SIGNATURE' \
5--header 'timestamp: TIMESTAMP_UNIX_IN_SECONDS' \
6--data-raw '{
7 "invoice_code":"INVOICE_CODE",
8 "transaction_code":"TRANSACTION_CODE"
9}'
Endpoint Path
/api/v1/integration/payment/void
Method
POSTHeader
Key | Value |
---|---|
Content-Type | application/json |
client_code | Unique Client ID yang disediakan Prakerja ke DP / LP. Prakerja akan menyediakan credential yaitu kombinasi client_code dan sign_key ke DP / LP. |
signature | Signature dibuat dari raw_signature yang di-hashing menggunakan algoritma HMAC-SHA1 dengan sign_key yang disediakan Prakerja ke DP / LP |
timestamp | Format nilai waktu dalam satuan detik yang digunakan saat melakukan hit API Contoh 1698289216 = 26-10-2023 10:00:16 WIB = 2023-10-26T10:00:16+07:00 Timestamp digunakan di --header 'timestamp:' yang nilainya harus sama persis dengan timestamp yang digunakan untuk membuat signature. |
Body (Payload)
Field | Type | Description |
---|---|---|
invoice_code | string, required | Kode invoice yang dibuat oleh sistem DP |
transaction_code | string, required | Kode / ID transaksi yang dibuat oleh sistem Prakerja |
Response
Success Response
Response 200 OK
1{
2 "success": true,
3 "message": "Transaksi berhasil dibatalkan."
4}
Response Detail
Field | Type | Description |
---|---|---|
success | boolean | Status hit API,
|
message | string | Deskripsi status hit API |
Error Response
- Termasuk juga list error general response
- Response 400 Bad Request parameter transaction_code tidak valid
1{ 2 "code": "ERRVOD40001", 3 "message": "Kode transaksi tidak ditemukan.", 4 "success": false 5}
- Response 400 Bad Request transaksi sudah dibatalkan
1{ 2 "code": "ERRPLT40028", 3 "message": "Transaksi sudah dibatalkan sebelumnya, silahkan hubungi tim ops prakerja.", 4 "success": false 5}
- Response 400 Bad Request sudah lewat dari batas maksimal pembatalan
1{ 2 "code": "ERRVOD40003", 3 "message": "Gagal dibatalkan. Sudah melewati batas waktu maksimal pembatalan.", 4 "success": false 5}
- Response 400 Bad Request peserta sudah terlanjur melakukan redeem
1{ 2 "code": "ERRVOD40004", 3 "message": "Gagal dibatalkan. Peserta sudah melakukan redeem untuk pelatihan ini.", 4 "success": false 5}
- Response 400 Bad Request tanggal permintaan lebih dari 4 hari dari tanggal rekonsiliasi yang dibuat
1{ 2 "code": "ERRVOD40005", 3 "message": "Gagal dibatalkan. Tanggal permintaan lebih besar dari 4 hari.", 4 "success": false 5}
- Response 400 Bad Request transaksi tidak ditemukan
1{ 2 "code": "ERRPLT40401", 3 "message": "Transaksi tidak ditemukan.", 4 "success": false 5}
- Response 400 Bad Request pelatihan sudah selesai
1{ 2 "code": "ERRVOD40008", 3 "message": "Gagal dibatalkan. Laporan penyelesaian pelatihan untuk transaksi ini sudah validasi sebelumnya.", 4 "success": false 5}
- Response 400 Bad Request transaksi sudah dibayar Prakerja ke DP
1{ 2 "code": "ERRVOD40009", 3 "message": "Gagal dibatalkan. Sudah dibayarkan ke digital platform untuk transaksi ini.", 4 "success": false 5}
- Response 400 Bad Request transaksi sudah lebih dari 2 hari sejak pembelian
1{ 2 "code": "ERRVOD40010", 3 "message": "Transaksi sudah lebih dari 2 hari, silahkan hubungi tim ops prakerja.", 4 "success": false 5}
Try this API
Example Code
1// Generated by Prakerja Generator
2// for complete documentation please visit https://developer.prakerja.go.id
3
4const crypto = require('crypto-js');
5const axios = require('axios');
6
7const client_code = ''; // provided by Prakerja
8const timestamp = Math.round((new Date()).getTime() / 1000); // generate current timestamp
9const method = 'POST'; // API Method
10const endpoint = '/api/v1/integration/payment/void'; // API Redeem Status Endpoint
11
12const data = {};
13
14const input = client_code + timestamp + method + endpoint + JSON.stringify(data); // create signature input
15const sign_key = ''; // provided by Prakerja
16
17const signature = crypto.HmacSHA1(input, sign_key).toString(crypto.enc.Hex); // generate signature
18
19axios({
20method: 'post',
21url: 'https://testapi123.prakerja.go.id' + endpoint,
22headers: {
23 'Content-Type': 'application/json',
24 'client_code': client_code,
25 'signature': signature,
26 'timestamp': timestamp,
27},
28data
29})
30.then((response) => {
31console.log(response.data)
32})
33.catch((error) => {
34console.log(error.response.data)
35});
1<?php
2// Generated by Prakerja Generator
3// for complete documentation please visit https://developer.prakerja.go.id
4
5$client_code = ''; // provided by Prakerja
6$timestamp = time(); // generate current timestamp
7$method = 'POST'; // API Method
8$endpoint = '/api/v1/integration/payment/void'; // API Redeem Status Endpoint
9
10$data = [];
11
12$input = $client_code . $timestamp . $method . $endpoint . json_encode($data); // create signature input
13$sign_key = ''; // provided by Prakerja
14
15$signature = hash_hmac('sha1', $input, $sign_key); // generate signature
16
17$headers = [
18'Content-Type: application/json',
19'client_code: ' . $client_code,
20'signature: ' . $signature,
21'timestamp: ' . $timestamp,
22];
23
24$ch = curl_init();
25curl_setopt($ch, CURLOPT_URL, 'https://testapi123.prakerja.go.id' . $endpoint );
26curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
27curl_setopt($ch, CURLOPT_POST, 1);
28curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
29curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
30$result = curl_exec($ch);
31curl_close ($ch);
32
33print_r("result: ");
34print_r($result);
1# Generated by Prakerja Generator
2# for complete documentation please visit https://developer.prakerja.go.id
3
4from hashlib import sha1
5import hmac
6import time
7import json
8import requests
9
10client_code = '' # provided by Prakerja
11timestamp = str(int(time.time())) # generate current timestamp
12method = 'POST' # API Method
13endpoint = '/api/v1/integration/payment/void' # API Redeem Status Endpoint
14
15data = {}
16
17# create signature input
18input = client_code + timestamp + method + endpoint + json.dumps(data, separators=(',', ':'))
19
20sign_key = '' # provided by Prakerja
21
22# generate signature
23signature = hmac.new(sign_key.encode("utf-8"), input.encode("utf-8"), sha1).hexdigest()
24
25headers = {
26'Content-Type': 'application/json',
27'client_code': client_code,
28'signature': signature,
29'timestamp': timestamp
30}
31
32result = requests.post(
33'https://testapi123.prakerja.go.id' + endpoint,
34headers=headers,
35data=json.dumps(data)
36)
37
38print('result: ')
39print(result.text)
1# Generated by Prakerja Generator
2# for complete documentation please visit https://developer.prakerja.go.id
3
4require 'base64'
5require 'cgi'
6require 'openssl'
7require 'net/http'
8require 'uri'
9require 'json'
10
11client_code = '' # provided by Prakerja
12timestamp = String(Time.now.to_i) # generate current timestamp
13method = 'POST' # API Method
14endpoint = '/api/v1/integration/payment/void' # API Redeem Status Endpoint
15
16data = {}
17
18# create signature input
19input = client_code + timestamp + method + endpoint + JSON.generate(data, quirks_mode: true)
20
21key = '' # provided by Prakerja
22
23signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), key.encode("ASCII"), input.encode("ASCII"))
24
25uri = URI.parse('https://testapi123.prakerja.go.id' + endpoint)
26request = Net::HTTP::Post.new(uri)
27request.content_type = "application/json"
28request.body = JSON.generate(data, quirks_mode: true)
29request['Client_code'] = client_code
30request['Signature'] = signature
31request['Timestamp'] = timestamp
32
33req_options = {
34use_ssl: uri.scheme == "https",
35}
36
37result = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
38http.request(request)
39end
40
41# result.code
42# result.body
43puts 'result: ' + result.body