Payment Request

Overview

Payment Request creates a payment link that may be emailed to your customers for taking a payment on a Chargent Order.

Prerequisites

There are multiple prerequisite resources that must be created before creating a Payment Request.

Object	Definition
Contact	Salesforce standard Contact object.
Chargent Order	Chargent Orders are central objects to payments lifecycle management.

Create Payment Request

Resource URL

HTTP Request	URL
POST	/services/data/v{{version}}/sobjects/ChargentOrders__Payment_Request__c/

Request

JSON Example

{
    "ChargentOrders__Billing_Contact__c": "{{contactId}}",
    "ChargentOrders__ChargentOrder__c" : "{{orderId}}",
    "ChargentOrders__Send_Payment_Request_Email__c" : true
}

Response

JSON Example

{
    "id": "{{paymentRequestId}}",
    "success": true,
    "errors": []
}

JSForce Example

Node.js Example

function createChargentOrder(conn, contactId, orderId) {
    
    const relativeUrl = "/services/data/v{{version}}/sobjects/ChargentOrders__Payment_Request__c/"

    var chargentOrder = {
        ChargentOrders__Billing_Contact__c: contactId,
        ChargentOrders__ChargentOrder__c: orderId,
        ChargentOrders__ChargentOrders__Send_Payment_Request_Email__c: true,
    }
    console.log(JSON.stringify(chargentOrder))

    return new Promise((resolve, reject) => {
        conn.request({
            method: 'POST',
            url: relativeUrl,
            body: JSON.stringify(chargentOrder),
            headers: { 'Content-Type': 'application/json' }
        }, function(error, result) {
            if (error) {
                reject(error)
            } else {
                resolve(result)
            }
        })
    })
}

module.exports = createChargentOrder

Learn More

Learn more about Payment Request Setup.