Get payment link details - Developer Suite

This API allows you to retrieve the details of a payment link that has already been created.

Request

Header Params

Content-Type

string

required

Example:

application/json

Body Params application/json

request_time

string

required

Request date and time in UTC format as YYYYMMDDHHmmss.

merchant_id

string

required

A unique merchant key provided by ABA Bank.

merchant_auth

string

required

A JSON string representing a JSON object, encrypted using OpenSSL with an RSA public key.

PHP Sample Code

hash

string

required

Base64-encoded HMAC SHA-512 hash of the concatenated values: request_time, merchant_id, and merchant_auth with public_key.

PHP Sample Code

Example

{
    "request_time": "20200728093403",
    "merchant_id": "ec000002",
    "merchant_auth": "39aaa43e6929a752.....08cdb29ab498d9604600101d8dc00a",
    "hash": "EVDFA2118UD0...fbMa2b5q9CCt+sWw=="
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

object

required

string

required

A unique payment link ID generated by the payment gateway.

title

string

optional

The title of your payment link.

image

object

optional

Image associated with the payment link

amount

number

required

Payment link amount.

currency

string

required

Payment link currency. Supported values: KHR, USD.

>= 3 characters<= 3 characters

status

string

required

Status of the payment link:

OPEN: The status remains open when payment_limit is greater than total_trxn, meaning payments can still be made.

PAID: The status changes to paid once payment_limit equals total_trxn. At this point, the user can no longer make payments using the PAID payment link.

description

string

required

A description of your payment link.

payment_limit

number

required

The maximum number of transactions allowed for this payment link.

total_amount_org

string

required

Total payment amount before refund.

total_refund

string

required

Total of refund amount of all lated transaction of the payment link.

total_amount

number

required

Total amount after refund.

total_trxn

number

required

The total number of completed payment transactions. A newly created payment link will have a value of 0

created_at

string

required

Date and time when the payment link was created in the payment gateway.

updated_at

string

required

The last updated date and time of the payment link.

expired_date

number

required

The expiration timestamp for this payment link.

pushback_url

string

optional

The URL that the payment gateway will call to send payment status updates.

payment_link

string

optional

A unique payment link url generated by the payment gateway.

status

object

required

code

string

required

PTL02 : Wrong hash

PTL132 : Invalid payment link

message

string

required

Please see the property reponse code for the details.

tran_id

string

required

A unique log ID generated by the payment gateway.

Examples

SuccessException

{
    "data": {
        "id": "iN4sbkzbwOCx5VzdXTYsCw==",
        "title": "Test curl 001",
        "image": {
            "image": "",
            "filename": "",
            "size": 0
        },
        "amount": 0.02,
        "currency": "USD",
        "status": "OPEN",
        "description": "Payment link created from curl",
        "payment_limit": 5,
        "total_amount": 0,
        "total_trxn": 0,
        "created_at": "2022-08-17 11:31:43",
        "updated_at": "2022-08-17 11:31:43",
        "expired_date": 1660710702,
        "pushback_url": "https://domain.com",
        "payment_link": "https://dpayment-euat.payway.com.kh/UA10736"
    },
    "status": {
        "code": "00",
        "message": "Success!"
    },
    "tran_id": "20220817063142"
}