Create Payment Link

Use this API to create payment link transaction for your user

‍

Endpoint:

‍[Production] POST https://partner.rem.id/api/payment-checkout/create-v2

‍[Staging] POST https://api-demo.rem.id/api/payment-checkout/create-v2

‍

Request

Parameter	Type	Required	Default	Description
partner_tx_id	String	FALSE	A unique transaction ID provided by partner.	A partner_tx_id that has been succesfully paid cannot be used anymore under the same username and only accepts alphanumerics. If empty then our system will generate automatically.
description	String	FALSE	Description of the payment link.	Only accepts alphabets (A-Z), numeric (0-9) and space as input.
notes	String	FALSE	Notes.	Only accepts alphabets (A-Z), numeric (0-9) and space as input.
sender_name	String	TRUE	Name of the payer for a transaction.	Only accepts alphabets (A-Z) and space as input and cannot be empty.
amount	Integer	TRUE	The amount of a transaction to be paid.	The amount of a transaction to be paid, min. amount is 10000
email	String	FALSE	The email addresses where the payment link will be sent to.	Up to 3 emails separated by ";"
phone_number	Numeric	FALSE	Phone number of the payer for a transaction.	Do not use special character (e.g. "+")
is_open	Boolean	TRUE	Enable open/closed amount transaction method.	If is_open = TRUE and the amount parameter is defined, then a payer can pay any amount (greater than IDR 10,000) up to the defined amount. And in the case that is_open=false, then the amount and partner_tx_id parameters must be defined.
include_admin_fee	Boolean	TRUE	Admin fee will be added to the specified amount or amount inputted by user if this parameter is set as TRUE.
list_disabled_payment_methods	String	FALSE	To configure payment methods to be disabled (e.g. BANK_TRANSFER, QRIS, EWALLET).	There must be at least 1 payment method enabled. If this field is not included in the request, or filled with an empty String, then all payment methods will be enabled.
list_enabled_banks	String	TRUE	To configure banks to be enabled for BANK_TRANSFER payment method.	List of eligible bank codes: -
expiration	datetime	FALSE	To set the expiration of the payment link (yyyy-MM-dd HH:mm:ss)	Expiration date will be defaulted to 24 hours if it is not defined.
va_display_name	String	FALSE	Optional parameter, name to display on Bank Transfer VA Name	Can be omitted. Accepts alphabets (A-Z), numeric (0-9) and space as input.

Response

Parameter	Type	Nullable	Description
status	Boolean	FALSE	true / false
url	String	TRUE	Payment link which used for payment. Only filled if payment checkout successfully created.
payment_link_id	String	TRUE	A unique transaction ID provided by partner. Only filled if payment checkout successfully created.
message	String	FALSE	Message response
email_status	String	TRUE	email status. Only filled if payment checkout successfully created.

{
  "partner_tx_id": "string",
  "description": "string",
  "notes": "string",
  "sender_name": "string",
  "amount": 10000,
  "email": "string",
  "phone_number": "string",
  "is_open": true,
  "include_admin_fee": true,
  "list_disabled_payment_methods": "BANK_TRANSFER,EWALLET",
  "list_enabled_banks": "002",
  "expiration": "2025-12-31 23:59:59",
  "va_display_name": "string"
}

Request Samples

200

{
  "status": true,
  "url": "string",
  "payment_link_id": "string",
  "message": "string",
  "email_status": "string"
}

500

{
  "status": {
    "code": "500",
    "message": "Internal server error"
  }
}

Response Samples

Payment Link Callback

Once user successfully do the payment, our system will make a callback via HTTP POST request to your system

‍

Callback for Delayed Settlement (Non-Real Time Settlement)

If your settlement is non-real time, for every transaction whose payment method is settled H+>0 from the time of transaction, you will receive two callbacks with details as follows:

‍

1st Callback -> To be sent after your customer successfully executes the transaction. For example, if your customer executes the transaction on 11 May 2021 at 14:00:00, that is also when we send the 1st Callback to you. In the 1st callback, the settlement status is set to WAITING (because it is not yet settled to your Account Statement balance)

‍

2nd Callback -> To be sent after the settlement status is changed from WAITING into SUCCESS. For example, if the settlement status is changed into SUCCESS on 12 May 2021 at 15:00:00, that is also when we send the 2nd Callback to you. In the 2nd callback, the settlement status is SUCCESS

‍

Callback Parameters

Parameter	Type	Nullable	Description
partner_tx_id	String	FALSE	A unique transaction ID provided by partner.
tx_ref_number	String	FALSE	Our system internal unique transaction ID.
amount	BigDecimal	FALSE	The amount of a transaction that is paid.
sender_name	String	FALSE	Name of a payer for a transaction.
sender_phone	String	TRUE	Phone number of a payer for a transaction. This parameter will only be sent if end user fill the data.
sender_note	String	TRUE	Additional notes from a payer for a transaction. This parameter will only be sent if end user fill the data.
status	String	FALSE	The status of a transaction (e.g. success/failed/processing).
sender_bank	String	FALSE	The bank code used by a payer to do payment.
payment_method	String	FALSE	The payment method used by user to complete a payment.
settlement_type	String	FALSE	Indicate if a transaction will be settled in realtime/non-realtime.
created	DateTime	FALSE	The timestamp which indicates the creation time of a payment link.
updated	DateTime	FALSE	The timestamp which indicates the latest updated time of a payment link due to status update.
payment_received_time	DateTime	TRUE	Indicates the time when payment routing is marked as COMPLETE (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’).
description	String	FALSE	The description of the payment link link.
payment_reference_number	String	TRUE	Identifier of a payment attempt when the end user successfully completes the payment. The reference number is also stated in the end user’s receipt/proof of transaction. Note that if a QRIS transaction is paid using OVO, the payment reference number is only the first 12 characters from the given transaction code. Available for: QRIS.
expiration	DateTime	FALSE	The expiration time of the payment link link.
due_date	DateTime	FALSE	The transaction due date of the payment link.
email	String	FALSE	The email addresses for the payment link link to be sent. You can add up to 3 emails separated by ";".
paid_amount	BigDecimal	FALSE	The total amount that a user has paid.
settlement_time	DateTime	TRUE	The timestamp (in UTC+7) indicating when the fund will be settled to partner’s account statement. This parameter will only be sent once status of the payment link is set to 'COMPLETE'.
settlement_status	String	TRUE	Status of the settlement (e.g. success/waiting). This parameter will only be sent once status of the payment link is set to 'COMPLETE'.

{
  "partner_tx_id": "string",
  "tx_ref_number": "string",
  "amount": 0,
  "sender_name": "string",
  "sender_phone": "string",
  "sender_note": "string",
  "status": "string",
  "sender_bank": "string",
  "payment_method": "string",
  "settlement_type": "string",
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "payment_received_time": "2019-08-24T14:15:22Z",
  "description": "string",
  "payment_reference_number": "string",
  "expiration": "2019-08-24T14:15:22Z",
  "due_date": "2019-08-24T14:15:22Z",
  "email": "string",
  "paid_amount": 0,
  "settlement_time": "2019-08-24T14:15:22Z",
  "settlement_status": "string"
}

Request Samples

Response Samples

Delete Payment Link

An endpoint to Delete Payment Link based on payment_link_id or partner_tx_id that is still active and a payment method has not been selected.

‍

Endpoint:

‍[Production] DELETE https://partner.rem.id/api/payment-checkout/{payment_link_id/partner_tx_id}

‍[Staging] DELETE https://api-demo.rem.id/api/payment-checkout/{payment_link_id/partner_tx_id}

‍

Path Parameters

Parameters	Type	Description
payment_link_id/partner_tx_id	String	payment_link_id or partner_tx_id in url param

Response

Parameter	Type	Nullable	Description
status	Boolean	FALSE	TRUE if delete is successful and FALSE otherwise.
message	String	FALSE	Return message.

Request Samples

200

{
  "status": true,
  "message": "string"
}

500

{
  "status": {
    "code": "500",
    "message": "Internal server error"
  }
}

Response Samples

Get Payment Link

An endpoint to get payment data.

‍

Endpoint:

‍[Production] GET https://partner.rem.id/api/payment-checkout/{payment_link_id/partner_tx_id}

‍[Staging] GET https://api-demo.rem.id/api/payment-checkout/{payment_link_id/partner_tx_id}

‍

Path Parameters

Parameters	Type	Description
payment_link_id/partner_tx_id	String	payment_link_id or partner_tx_id in url param

Response

Parameter	Type	Nullable	Description
partnerTxId	String	FALSE	Payment Partner Tx Id
paymentLinkId	String	FALSE	Payment Link Id
amount	Integer	FALSE	Payment Amount
username	String	FALSE	Partner Username
senderName	String	FALSE	Payment Sender Name
senderPhoneNumber	String	TRUE	Payment Sender Phone Number. This parameter will only be sent if end user fill the data
senderNotes	String	TRUE	Payment Notes / Subject. This parameter will only be sent if end user fill the data
status	String	FALSE	Payment Status
txRefNumber	String	FALSE	Payment Transaction Reference Number
description	String	FALSE	Payment Description
isOpen	Boolean	FALSE	Payment Editable Amount Capability
notes	String	FALSE	Payment Notes / Subject
email	String	FALSE	Payment Sender Email(s).You can add up to 3 emails separated by ";"
senderPhoneNumber	String	FALSE	Payment Sender Phone Number
includeAdminFee	Boolean	FALSE	Admin fee bills destination between partner or user
listDisabledPaymentMethods	String	FALSE	List Of Disable Payment Method.
listEnabledBanks	String	FALSE	Payment Method List Enable Bank for VA or Unique Code Payment Method
expirationTime	String	FALSE	Payment Expiration Date and Time
due_date	String	FALSE	Transaction Due Date

Request Samples

200

{
  "partnerTxId": "string",
  "paymentLinkId": "string",
  "amount": 0,
  "username": "string",
  "senderName": "string",
  "senderPhoneNumber": "string",
  "senderNotes": "string",
  "status": "string",
  "txRefNumber": "string",
  "description": "string",
  "isOpen": true,
  "notes": "string",
  "email": "string",
  "includeAdminFee": true,
  "listDisabledPaymentMethods": "string",
  "listEnabledBanks": "string",
  "expirationTime": "2019-08-24T14:15:22Z",
  "due_date": "2019-08-24T14:15:22Z"
}

500

{
  "status": {
    "code": "500",
    "message": "Internal server error"
  }
}

Response Samples

Check Status Payment Link

An endpoint to retrieve and/or re-send the latest callback status of a transaction.

‍

Endpoint:

‍[Production] GET https://partner.rem.id/api/payment-checkout/status?partner_tx_id={partner_tx_id}&send_callback={true/false}

‍[Staging] GET https://api-demo.rem.id/api/payment-checkout/status?partner_tx_id={partner_tx_id}&send_callback={true/false}

‍

Path Parameters

Parameters	Type	Description
partner_tx_id	String	A unique transaction ID which callback status to be checked
payment_reference_number	String	A unique reference ID only for QRIS transactions. Used to identify which callback status to be checked. The reference number is stated in the end user’s receipt/proof of transaction. Note that if a QRIS transaction is paid using OVO, the payment reference number is only the first 12 characters from the given transaction code
send_callback	Boolean	A flag to indiciate if the latest callback of a transaction need to be re-sent or not

Response

Parameter	Type	Nullable	Description
partner_tx_id	String	FALSE	A unique transaction ID provided by partner.
tx_ref_number	String	FALSE	Our system's internal unique transaction ID.
amount	BigDecimal	FALSE	The amount of a transaction that is paid.
sender_name	String	FALSE	Name of a payer for a transaction.
sender_phone	String	FALSE	Phone number of a payer for a transaction.
sender_note	String	FALSE	Additional notes from a payer for a transaction.
status	String	FALSE	The status of a payment link.
payment_received_time	String	TRUE	Indicates the time when payment routing is marked as COMPLETE (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’).
settlement_type	String	FALSE	Indicate if a transaction will be settled in realtime/non-realtime.
sender_bank	String	FALSE	The bank code used by a payer to do payment.
payment_method	String	FALSE	The payment method used in a transaction. Choices are: CC (Cards), QRIS, EWALLET (shopeepay_ewallet, dana_ewallet, linkaja_ewallet, ovo_ewallet), VA (Virtual Account), or BANK_TRANSFER (Unique Code).
created	String	FALSE	The timestamp which indicates the creation time of a payment link.
description	String	FALSE	Description of the payment link.
payment_reference_number	String	FALSE	Identifier of a payment attempt when the end user successfully completes the payment. The reference number is also stated in the end user’s receipt/proof of transaction. Note that if a QRIS transaction is paid using OVO, the payment reference number is only the first 12 characters from the given transaction code. Available for: QRIS.
paid_amount	BigDecimal	FALSE	the total amount that a user has paid.
expiration	String	FALSE	To set the expiration of the payment link (yyyy-MM-dd HH:mm:ss).
due_date	String	FALSE	To set the transaction due date of the payment (yyyy-MM-dd HH:mm:ss).
updated	String	FALSE	The timestamp which indicates the latest updated time of a payment link due to status update.
email	String	FALSE	The email addresses where the payment link will be sent to. You can add up to 3 emails separated by ";".
settlement_time	String	FALSE	The timestamp (in UTC+7) indicating when the fund will be settled to partner’s account statement (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’).
settlement_status	String	FALSE	The status of the settlement (this parameter will only be sent once status of the payment link is set to ‘COMPLETE’).

Request Samples

200

{
  "partner_tx_id": "string",
  "tx_ref_number": "string",
  "amount": 0,
  "sender_name": "string",
  "sender_phone": "string",
  "sender_note": "string",
  "status": "string",
  "payment_received_time": "2019-08-24T14:15:22Z",
  "settlement_type": "string",
  "sender_bank": "string",
  "payment_method": "string",
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "payment_reference_number": "string",
  "paid_amount": 0,
  "expiration": "2019-08-24T14:15:22Z",
  "due_date": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "email": "string",
  "settlement_time": "2019-08-24T14:15:22Z",
  "settlement_status": "string"
}

500

{
  "status": {
    "code": "500",
    "message": "Internal server error"
  }
}

Response Samples

Payment Link Status

Payment Status	Type	Description
created	String	Status that will be returned when the payment link is first created and user has not selected a payment method
waiting_payment	String	Status that indicates that the user has selected a payment method
expired	String	The payment link has expired
charge_in_progress	String	Payment currently in processed
failed	String	OTP for card payment method has been succesfully entered but payment is rejected or the selected payment channel has expired (but the link is still not yet expired)
complete	String	Transaction has been succesfully completed
closed	String	Payment link has been deleted

Request Samples

Response Samples

Payment Link Response Codes

Below is the list of HTTP Status Code for API Payment Link:

HTTP Status Code	Description
200	Response success without error
403	Forbidden (IP address is not whitelisted or request is deemed suspicious e.g SQL injection or XSS)
404	Not Found (wrong URL)
429	Request Rejected (Too Many Request to specific endpoint)
500	Internal Server Error (Our system encountered unknown error)
503	Service Unavailable (Our system is unable to process the request temporarily)
504	Gateway Timeout (Our system took too long processing the request and was unable to respond in time)

Request Samples

Response Samples