Skip to main content

Payment Method Assignment

Overview​

Payment Method Tokenization is the first step in the payments lifecycle. To use a Payment Method it must be assigned to a Chargent Order. Chargent Orders are central to payments lifecycle management.

Prerequisites​

There are multiple prerequisite resources that must be created before managing Payment Method assignment to a Chargent Order.

           Object           Definition
Chargent OrderChargent Orders are central objects to payments lifecycle management.
Payment MethodPayment Methods are instruments that may be used to make or take payment.
Payment GatewayPayment Gateways track all the configuration settings that Chargent will use to proccess the payments and send requests to the gateway.

Resource URL​

HTTP RequestURL
PATCH/services/data/{{apiVersion}}/sobjects/ChargentOrders__ChargentOrder__c/

Assign Payment Method to Chargent Order​

Request​

JSON Example
{
    "ChargentOrders__Gateway__c": "{{gatewayId}}",
    "ChargentOrders__Payment_Method_Default__c": "{{paymentMethodId}}"
}

Response​

No Content

Unassign Payment Method to Chargent Order​

Request​

JSON Example
{
    "ChargentOrders__Gateway__c": "",
    "ChargentOrders__Payment_Method_Default__c": ""
}

Response​

No Content

Multi-Gateway Tokenization​

When a Payment Method has been tokenized across multiple gateways, changing the gateway on the Chargent Order will determine where to send the next transaction using the Token associated with the Payment Method.

Request​

JSON Example
{
    "ChargentOrders__Gateway__c": "{{gatewayId}}"
}

Response​

No Content