Update v2

Update v2

curl --request PUT \
  --url https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-PARTNER-ID: <api-key>' \
  --data '
{
  "description": "Updated description",
  "max_usage": 5,
  "expired_at": "2026-08-10T00:00:00+07:00",
  "status": "closed",
  "whitelisted_payment_method": [
    "<string>"
  ],
  "success_redirect_url": "https://merchant.example.com/payment/success",
  "expired_redirect_url": "https://merchant.example.com/payment/expired",
  "optional_metadata": {},
  "required_customer_number": false,
  "required_customer_email": true
}
'

import requests

url = "https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}"

payload = {
    "description": "Updated description",
    "max_usage": 5,
    "expired_at": "2026-08-10T00:00:00+07:00",
    "status": "closed",
    "whitelisted_payment_method": ["<string>"],
    "success_redirect_url": "https://merchant.example.com/payment/success",
    "expired_redirect_url": "https://merchant.example.com/payment/expired",
    "optional_metadata": {},
    "required_customer_number": False,
    "required_customer_email": True
}
headers = {
    "Authorization": "Bearer <token>",
    "X-PARTNER-ID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <token>',
    'X-PARTNER-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    description: 'Updated description',
    max_usage: 5,
    expired_at: '2026-08-10T00:00:00+07:00',
    status: 'closed',
    whitelisted_payment_method: ['<string>'],
    success_redirect_url: 'https://merchant.example.com/payment/success',
    expired_redirect_url: 'https://merchant.example.com/payment/expired',
    optional_metadata: {},
    required_customer_number: false,
    required_customer_email: true
  })
};

fetch('https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Updated description',
    'max_usage' => 5,
    'expired_at' => '2026-08-10T00:00:00+07:00',
    'status' => 'closed',
    'whitelisted_payment_method' => [
        '<string>'
    ],
    'success_redirect_url' => 'https://merchant.example.com/payment/success',
    'expired_redirect_url' => 'https://merchant.example.com/payment/expired',
    'optional_metadata' => [
        
    ],
    'required_customer_number' => false,
    'required_customer_email' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-PARTNER-ID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}"

	payload := strings.NewReader("{\n  \"description\": \"Updated description\",\n  \"max_usage\": 5,\n  \"expired_at\": \"2026-08-10T00:00:00+07:00\",\n  \"status\": \"closed\",\n  \"whitelisted_payment_method\": [\n    \"<string>\"\n  ],\n  \"success_redirect_url\": \"https://merchant.example.com/payment/success\",\n  \"expired_redirect_url\": \"https://merchant.example.com/payment/expired\",\n  \"optional_metadata\": {},\n  \"required_customer_number\": false,\n  \"required_customer_email\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-PARTNER-ID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}")
  .header("Authorization", "Bearer <token>")
  .header("X-PARTNER-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Updated description\",\n  \"max_usage\": 5,\n  \"expired_at\": \"2026-08-10T00:00:00+07:00\",\n  \"status\": \"closed\",\n  \"whitelisted_payment_method\": [\n    \"<string>\"\n  ],\n  \"success_redirect_url\": \"https://merchant.example.com/payment/success\",\n  \"expired_redirect_url\": \"https://merchant.example.com/payment/expired\",\n  \"optional_metadata\": {},\n  \"required_customer_number\": false,\n  \"required_customer_email\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-PARTNER-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Updated description\",\n  \"max_usage\": 5,\n  \"expired_at\": \"2026-08-10T00:00:00+07:00\",\n  \"status\": \"closed\",\n  \"whitelisted_payment_method\": [\n    \"<string>\"\n  ],\n  \"success_redirect_url\": \"https://merchant.example.com/payment/success\",\n  \"expired_redirect_url\": \"https://merchant.example.com/payment/expired\",\n  \"optional_metadata\": {},\n  \"required_customer_number\": false,\n  \"required_customer_email\": true\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "success": true,
  "data": {
    "id": 103,
    "reff_no": "INV20240513001",
    "description": "Invoice #INV20240513001",
    "source": "api v2",
    "payment_url": "https://example.com/payment-link",
    "status": "open",
    "is_expired": false,
    "payment_link_type": "total",
    "is_multiple_payment": false,
    "is_unlimited_usage": false,
    "max_usage": 1,
    "current_usage": 0,
    "expired_at": "2024-05-13T00:00:00Z",
    "required_customer_detail": true,
    "required_customer_fields": {
      "name": true,
      "phone": false,
      "email": false
    },
    "total_amount": 150000,
    "items": [
      {
        "name": "Product A",
        "quantity": 1,
        "unit_price": 150000,
        "subtotal": 150000
      }
    ],
    "whitelisted_payment_method": [
      "<string>"
    ],
    "redirect_url_enabled": false,
    "success_redirect_url": "https://merchant.example.com/payment/success",
    "expired_redirect_url": "https://merchant.example.com/payment/expired",
    "optional_metadata": {},
    "target_customer_details_enabled": true,
    "customer_name": "Jane Doe",
    "customer_email": "jane@example.com",
    "customer_phone": "081234567890",
    "customer_notification_preference": {
      "payment_link_created": [
        "whatsapp",
        "email"
      ],
      "payment_link_reminder": [
        "whatsapp"
      ]
    },
    "reminder_unit": "day",
    "reminder_period": 1,
    "created_at": "2024-05-13T00:00:00Z",
    "updated_at": "2024-05-13T00:00:00Z",
    "account": {
      "id": 1,
      "name": "Account 1"
    }
  }
}

{
  "status": 401,
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized merchant, please sign in"
  }
}

{
  "status": 403,
  "success": false,
  "error": {
    "code": 403,
    "message": "Access denied."
  }
}

{
  "status": 404,
  "success": false,
  "error": {
    "code": 404,
    "message": "Account not found."
  }
}

{
  "status": 405,
  "success": false,
  "error": {
    "code": 4059901,
    "message": "The PATCH method is not supported for this route. Supported methods: GET, HEAD, POST."
  }
}

{
  "status": 422,
  "success": false,
  "error": {
    "code": 422,
    "message": "Validation error.",
    "errors": {
      "field": [
        "error message"
      ]
    }
  },
  "data": {
    "errors": {
      "field": [
        "error message"
      ]
    }
  }
}

PUT

api

v2.0

payment-link

update

{link_id}

Update v2

curl --request PUT \
  --url https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-PARTNER-ID: <api-key>' \
  --data '
{
  "description": "Updated description",
  "max_usage": 5,
  "expired_at": "2026-08-10T00:00:00+07:00",
  "status": "closed",
  "whitelisted_payment_method": [
    "<string>"
  ],
  "success_redirect_url": "https://merchant.example.com/payment/success",
  "expired_redirect_url": "https://merchant.example.com/payment/expired",
  "optional_metadata": {},
  "required_customer_number": false,
  "required_customer_email": true
}
'

import requests

url = "https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}"

payload = {
    "description": "Updated description",
    "max_usage": 5,
    "expired_at": "2026-08-10T00:00:00+07:00",
    "status": "closed",
    "whitelisted_payment_method": ["<string>"],
    "success_redirect_url": "https://merchant.example.com/payment/success",
    "expired_redirect_url": "https://merchant.example.com/payment/expired",
    "optional_metadata": {},
    "required_customer_number": False,
    "required_customer_email": True
}
headers = {
    "Authorization": "Bearer <token>",
    "X-PARTNER-ID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <token>',
    'X-PARTNER-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    description: 'Updated description',
    max_usage: 5,
    expired_at: '2026-08-10T00:00:00+07:00',
    status: 'closed',
    whitelisted_payment_method: ['<string>'],
    success_redirect_url: 'https://merchant.example.com/payment/success',
    expired_redirect_url: 'https://merchant.example.com/payment/expired',
    optional_metadata: {},
    required_customer_number: false,
    required_customer_email: true
  })
};

fetch('https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Updated description',
    'max_usage' => 5,
    'expired_at' => '2026-08-10T00:00:00+07:00',
    'status' => 'closed',
    'whitelisted_payment_method' => [
        '<string>'
    ],
    'success_redirect_url' => 'https://merchant.example.com/payment/success',
    'expired_redirect_url' => 'https://merchant.example.com/payment/expired',
    'optional_metadata' => [
        
    ],
    'required_customer_number' => false,
    'required_customer_email' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-PARTNER-ID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}"

	payload := strings.NewReader("{\n  \"description\": \"Updated description\",\n  \"max_usage\": 5,\n  \"expired_at\": \"2026-08-10T00:00:00+07:00\",\n  \"status\": \"closed\",\n  \"whitelisted_payment_method\": [\n    \"<string>\"\n  ],\n  \"success_redirect_url\": \"https://merchant.example.com/payment/success\",\n  \"expired_redirect_url\": \"https://merchant.example.com/payment/expired\",\n  \"optional_metadata\": {},\n  \"required_customer_number\": false,\n  \"required_customer_email\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-PARTNER-ID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}")
  .header("Authorization", "Bearer <token>")
  .header("X-PARTNER-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Updated description\",\n  \"max_usage\": 5,\n  \"expired_at\": \"2026-08-10T00:00:00+07:00\",\n  \"status\": \"closed\",\n  \"whitelisted_payment_method\": [\n    \"<string>\"\n  ],\n  \"success_redirect_url\": \"https://merchant.example.com/payment/success\",\n  \"expired_redirect_url\": \"https://merchant.example.com/payment/expired\",\n  \"optional_metadata\": {},\n  \"required_customer_number\": false,\n  \"required_customer_email\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-payment-b2b.singapay.id/api/v2.0/payment-link/update/{link_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-PARTNER-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Updated description\",\n  \"max_usage\": 5,\n  \"expired_at\": \"2026-08-10T00:00:00+07:00\",\n  \"status\": \"closed\",\n  \"whitelisted_payment_method\": [\n    \"<string>\"\n  ],\n  \"success_redirect_url\": \"https://merchant.example.com/payment/success\",\n  \"expired_redirect_url\": \"https://merchant.example.com/payment/expired\",\n  \"optional_metadata\": {},\n  \"required_customer_number\": false,\n  \"required_customer_email\": true\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "success": true,
  "data": {
    "id": 103,
    "reff_no": "INV20240513001",
    "description": "Invoice #INV20240513001",
    "source": "api v2",
    "payment_url": "https://example.com/payment-link",
    "status": "open",
    "is_expired": false,
    "payment_link_type": "total",
    "is_multiple_payment": false,
    "is_unlimited_usage": false,
    "max_usage": 1,
    "current_usage": 0,
    "expired_at": "2024-05-13T00:00:00Z",
    "required_customer_detail": true,
    "required_customer_fields": {
      "name": true,
      "phone": false,
      "email": false
    },
    "total_amount": 150000,
    "items": [
      {
        "name": "Product A",
        "quantity": 1,
        "unit_price": 150000,
        "subtotal": 150000
      }
    ],
    "whitelisted_payment_method": [
      "<string>"
    ],
    "redirect_url_enabled": false,
    "success_redirect_url": "https://merchant.example.com/payment/success",
    "expired_redirect_url": "https://merchant.example.com/payment/expired",
    "optional_metadata": {},
    "target_customer_details_enabled": true,
    "customer_name": "Jane Doe",
    "customer_email": "jane@example.com",
    "customer_phone": "081234567890",
    "customer_notification_preference": {
      "payment_link_created": [
        "whatsapp",
        "email"
      ],
      "payment_link_reminder": [
        "whatsapp"
      ]
    },
    "reminder_unit": "day",
    "reminder_period": 1,
    "created_at": "2024-05-13T00:00:00Z",
    "updated_at": "2024-05-13T00:00:00Z",
    "account": {
      "id": 1,
      "name": "Account 1"
    }
  }
}

{
  "status": 401,
  "success": false,
  "error": {
    "code": 401,
    "message": "Unauthorized merchant, please sign in"
  }
}

{
  "status": 403,
  "success": false,
  "error": {
    "code": 403,
    "message": "Access denied."
  }
}

{
  "status": 404,
  "success": false,
  "error": {
    "code": 404,
    "message": "Account not found."
  }
}

{
  "status": 405,
  "success": false,
  "error": {
    "code": 4059901,
    "message": "The PATCH method is not supported for this route. Supported methods: GET, HEAD, POST."
  }
}

{
  "status": 422,
  "success": false,
  "error": {
    "code": 422,
    "message": "Validation error.",
    "errors": {
      "field": [
        "error message"
      ]
    }
  },
  "data": {
    "errors": {
      "field": [
        "error message"
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

JWT issued by POST /api/v1.1/access-token/b2b. Send Authorization: Bearer <token>.

X-PARTNER-ID

string

header

required

Merchant API key (Credential.api_key). Required on every request.

Path Parameters

link_id

integer

required

Payment link identifier (payment_links.id).

Body

application/json

True partial update — unlike v1's update (which recomputes several fields to their "not sent" defaults, silently clearing them when omitted), every field here is optional and any field left out of the request body is left completely untouched. reff_no, title, payment_link_type, total_amount, items, and customer_name/customer_email/customer_phone are immutable after creation and not accepted here.

description

string | null

Updates the payment link description. Send an empty string/null to clear it.

Maximum string length: 255

Example:

"Updated description"

max_usage

integer | null

Updates the usage cap. 0 means unlimited. Cannot be set below the current usage count (422). Also re-derives is_multiple_payment/is_unlimited_usage/required_customer_detail. Rejected with 422 if this payment link has customer_name/customer_email/customer_phone and/or a notification/reminder configuration set — those only work for single-use links, so changing max_usage could silently move the link to multi-use and break them. Omit to leave unchanged.

Required range: 0 <= x <= 999

Example:

5

expired_at

string<date-time> | null

Updates the expiration timestamp (must be in the future). Rejected with 422 if this payment link already has a reminder notification configured (i.e. reminder_at is set from reminder_unit/reminder_period sent at creation) — reminder_at is only computed once and would otherwise desync from the new expiry. Omit to leave unchanged.

Example:

"2026-08-10T00:00:00+07:00"

status

enum<string> | null

Updates the payment link lifecycle status. Omit to leave unchanged.

Available options:

open,

closed,

expired

Example:

"closed"

whitelisted_payment_method

string[] | null

Updates the allowed payment method codes. Send null/an empty array to re-auto-select eligible methods based on the link's existing total_amount. Omit the field entirely to leave the current whitelist untouched.

success_redirect_url

string<uri> | null

Updates the success redirect URL. Omit to leave unchanged.

Maximum string length: 2048

Example:

"https://merchant.example.com/payment/success"

expired_redirect_url

string<uri> | null

Updates the expired redirect URL. Omit to leave unchanged.

Maximum string length: 2048

Example:

"https://merchant.example.com/payment/expired"

optional_metadata

object | null

Updates the merchant-defined metadata. Omit to leave unchanged.

required_customer_number

boolean | null

Only applied when the link is (or is being made) multi-use. Omit to leave unchanged.

Example:

false

required_customer_email

boolean | null

Only applied when the link is (or is being made) multi-use. Omit to leave unchanged.

Example:

true

Response

Updated

status

integer

required

HTTP status code.

Example:

200

success

boolean

required

Indicates whether the request was successful.

Example:

true

data

object

Payment link resource payload.

Show child attributes

Getting Started

Security

Accept Money

Send Money

Transaction Records

Money Accounts

Webhook

Authorizations

Path Parameters

Body

Response