Uncategorized

Payment Link

Posted helponepay

Endpoint URL: {{GatewayAPIURL}}/PayLink

REQUEST FIELD DESCRIPTION:

         KEY FIELD STATUS         TYPE      VALUE DESCRIPTION
paylink_request 
first_name  Optional String Upto 50 Characters First Name of the Customer
last_name  Optional String Upto 50 Characters Last Name of the Customer
customer_id  Optional String “AUTO” for auto generated id’s  
starts from 100000

OR

User Generated e.g. CID001

 The customer ID is either system generated or user specific
invoice  Optional String Variable Length Invoice Number of the transaction
email  Conditonal String abc@xyz.com Customer email address for paylink
phone_number  Conditonal Numeric 10 digits Customer phone number for paylink
amount  Mandatory Numeric Format 0 or 0.00 Transaction Amount

RESPONSE FIELD DESCRIPTION:

KEY TYPE  VALUE DESCRIPTION
paylink_response
result_code String 1 Status of paylink
result_sub_code String 000 Response Sub Code
result_text String SUCCESS Description of the outcome of paylink request
transaction_datetime String Format- yyyyMMddTHHmmssZ Date and Time of the paylink response
paylink String https://app.onepay.com/PLE23036c9b-a0b9-4230-8015-d3387d8a6d53 Payment link
paylink_id String 100106 Unique identifier for paylink

SAMPLE REQUEST (Email):

{
    "paylink_request": [
        {
            "first_name": "John",
            "last_name": "Smith",
            "customer_id": {{$timestamp}},
            "invoice_number": {{$timestamp}},
            "email":"ab@gmail.com",
            "amount": "100.00"
        }
    ]
}

SAMPLE RESPONSE (Email):

{  \"PayLink_response\": {    \"result_code\": 1,    \"result_sub_code\": \"000\",    \"result_text\": \"SUCCESS\",    \"transaction_datetime\": \"20220317T103355Z\", \"paylink\": \"https://app.onepay.com/PLE23036c9b-a0b9-4230-8015-d3387d8a6d53\", \"paylink_id\": \"20220317\" }}

SAMPLE REQUEST (Phone):

{
    "paylink_request": [
        {
            "first_name": "John",
            "last_name": "Smith",
            "customer_id": "Cust1234",
            "invoice_number": "inv-002",
            "phone_number":"1234567890",
            "amount": "10.00"
        }
    ] 
}

SAMPLE RESPONSE (Phone):

{  \"PayLink_response\": {    \"result_code\": 1,    \"result_sub_code\": \"000\",    \"result_text\": \"SUCCESS\",    \"transaction_datetime\": \"20220317T103529Z\", \"paylink\": \"https://app.onepay.com/PLS23036c9b-a0b9-4230-8015-d3387d8a6d53\", \"paylink_id\": \"20220327\" }}

SAMPLE REQUEST (EMAIL & PHONE)

{
    "paylink_request": [
        {
            "first_name": "Anu",
            "last_name": "Jose",
            "customer_id": {{$timestamp}},
            "invoice": {{$timestamp}},
            "email":"abc@gmail.com",
            "phone":"1234567890",
            "amount": "30.00"
        }
    ]
}

SAMPLE RESPONSE (Email & Phone):

{  \"PayLink_response\": {    \"result_code\": 1,    \"result_sub_code\": \"000\",    \"result_text\": \"SUCCESS\",    \"transaction_datetime\": \"20220317T103601Z\", \"paylink\": \"https://app.onepay.com/PLES23036c9b-a0b9-4230-8015-d3387d8a6d53\", \"paylink_id\": \"20220217\"  }}

Leave a Reply