Managing Payment Methods
Manage payment tokens using the REST and SubMan APIs.
For more information about the Pay Now SubMan APIs, see the discussion about Pay Now APIs. For more information about payment refunds, see the discussion about Pay Now refunds.
Pay Now REST APIs
Payment Method REST APIs describes the payment method REST APIs where
object is either subscriber or group.
| API | Description |
|---|---|
| GET /object/{SearchTerm}/payment_history | Request to retrieve subscriber/group payment data in the database. This value MUST be passed in as part of the URL. |
| PUT /object/{SearchTerm}/payment_history/{ResourceId}/refund | Request for a refund payment to a subscription/group main balance using the Object ID
for the subscription/group. This value MUST be passed in as part
of the URL. The Resource ID for the payment status data to
refund is required. Important: If the Pay Now refund amount causes the main balance to exceed its
credit limit, the request still succeeds and the main
balance is charged the full refund amount. |
| GET /object/{SearchTerm}/payment_method | Request the payment method of a subscription/group. |
| PUT /object/{SearchTerm}/payment_method/{ResourceId} | Request to modify a payment method for a subscription/group. |
| POST /object/{SearchTerm}/payment_method/{GatewayId} | Request to add a payment method to a subscription/group. |
| DELETE /object/{SearchTerm}/payment_method/{ResourceId} | Request to remove a payment method from a subscription/group. |
| POST /object/{SearchTerm}/payment_token/{ResourceId}/create_one_time/ | Request that a payment one-time token is created based on a subscription/group payment method. The call can specify the payment method and can include Payment Gateway Provider specific fields. If a payment method is not specified, the default is used. The Payment Gateway Provider returns a nonce and any extensions in MtxResponsePaymentOneTimeToken. For information about using a one-time token for 3-D Secure verification, see the discussion about generating a nonce for 3-D Secure authentication. |
| GET /object/{SearchTerm}/threshold_recharge_defn | Request the threshold recharge definitions associated with a subscription/group. |
| POST /system/payment_client/{GatewayId}/token/{UserId:.*} | Request to create a client payment token. |
| PUT /object/{SearchTerm:.+}/validate_payment_method | Request to validate the postal code in the subscription/group payment method. |
Pay Now SubMan APIs
Clients can use the REST and SubMan APIs to directly manage payment tokens in MATRIXX Charging Application. Payment Method SubMan APIs describes the payment method SubMan APIs.
| API | Description |
|---|---|
| MtxRequestSysCreateClientToken | The client requests a payment token from the RS Gateway with which it can request a payment nonce from the Payment Gateway Provider. |
| MtxRequestGroupAddPaymentMethod | Add a payment method to a group. This creates a payment method in the payment gateway and registers the new payment method in the wallet. A unique resource ID is assigned to each payment method. |
| MtxRequestGroupCreatePaymentOneTimeToken | Request that a payment one-time token is created based on a subscription payment method. The call can specify the payment method and can include Payment Gateway Provider specific fields. If a payment method is not specified, the default is used. The Payment Gateway Provider returns a nonce and any extensions in MtxResponsePaymentOneTimeToken. For information about using a one-time token for 3-D Secure verification, see the discussion about generating a nonce for 3-D Secure authentication. |
| MtxRequestGroupModifyPaymentMethod | Modify any attribute of an existing payment method in the group wallet, including the payment token. If supported by the Payment Gateway Provider. the request to modify a payment token and whether it is the default payment method is passed to the payment gateway so that the payment method is also updated on the Payment Gateway Provider. |
| MtxRequestGroupQueryPaymentMethod | Get the group payment method information. |
| MtxRequestGroupRemovePaymentMethod | Remove a payment method from a group. This marks a payment method as deleted in the wallet and, if supported, the removal is sent to the payment gateway. |
| MtxRequestGroupValidatePaymentMethod | Request to validate the postal code in the subscription/group payment method. |
| MtxRequestSubscriberAddPaymentMethod | Add a payment method to a subscriber. This creates a payment method in the payment gateway and registers the new payment method in the wallet. A unique resource ID is assigned to each payment method. |
| MtxRequestSubscriberModifyPaymentMethod | Modify any attribute of an existing payment method in the subscriber wallet, including the payment token. If supported by the Payment Gateway Provider. the request to modify a payment token and whether it is the default payment method, is passed to the payment gateway so that the payment method is also updated on the Payment Gateway Provider. |
| MtxRequestSubscriberCreatePaymentOneTimeToken | Request that a payment one-time token is created based on a subscriber payment method. The call can specify the payment method and can include Payment Gateway Provider specific fields. If a payment method is not specified, the default is used. The Payment Gateway Provider returns a nonce and any extensions in MtxResponsePaymentOneTimeToken. For information about using a one-time token for 3-D Secure verification, see the discussion about generating a nonce for 3-D Secure authentication. |
| MtxRequestSubscriberQueryPaymentMethod | Get the subscriber payment method information. |
| MtxRequestSubscriberRemovePaymentMethod | Remove a payment method from a subscriber. This marks a payment method as deleted in the wallet and, if supported by the Payment Gateway Provider, the removal request is sent to the payment gateway. |
| MtxRequestSubscriberValidatePaymentMethod | Request to validate the postal code in the subscription/group payment method. |
To request a payment refund for a subscriber or group, use the SubMan APIs described
in Payment Refund SubMan APIs.
| API | Description |
|---|---|
| MtxRequestSubscriberRefundPayment | Request a payment refund for a subscriber. |
| MtxRequestGroupRefundPayment | Request a payment refund for a group. |
To get the subscriber or group payment history, which can be used to get payment
information before requesting a refund, use the SubMan APIs described in Payment History SubMan APIs.
| API | Description |
|---|---|
| MtxRequestSubscriberQueryPaymentHistory | Request the payment history for a subscriber. |
| MtxRequestGroupQueryPaymentHistory | Request the payment history for a group. |
Subscriber or group wallets are not updated if the SubMan API returns an error.