• Payments/
    Payment Gateways API/
    Configure PayPal Express Checkout

    Configure PayPal Express Checkout

    Use the /gateways/paypal_express_checkout endpoint to configure PayPal Express Checkout.

    To learn more about PayPal Express Checkout and check whether it will work for you, contact your sales or customer success team.

    The PayPal Express Checkout Gateway Object

    AttributeTypeDescription
    typestringSpecifies the type of the resource. You must use gateway.
    namestringSpecifies the name of the gateway.
    slugstringSpecifies a unique slug for the gateway.
    payer_idstringSpecifies the merchant account ID. The ID is displayed in the PayPal account details of the merchant.
    enabledbooleanSpecify whether the gateway is enabled or disabled. Set true to enable the gateway and false to disable the gateway.
    testbooleanSpecifies whether the test mode is enabled. Set true to enable test mode and false to disable the test mode.

    Sample Object

    {
        "data": {
            "type": "gateway",
            "name": "PayPal Express Checkout",
            "slug": "paypal_express_checkout",
            "payer_id": "ABCxxxxxxxx",
            "enabled": true,
            "test": true
        }
    }
    

    PUT Update PayPal Express Checkout settings

    https://api.moltin.com/v2/gateways/paypal_express_checkout
    

    Parameters

    Headers

    NameRequiredTypeDescription
    AuthorizationRequiredstringThe Bearer token required to get access to the API.

    Body

    NameRequiredTypeDescription
    payer_idRequiredstringSpecifies the merchant account ID. The ID is displayed in the PayPal account details of the merchant.
    enabledRequiredbooleanSpecifies whether the gateway is enabled or disabled. Set true to enable the gateway and false to disable the gateway.
    testRequiredbooleanSpecifies whether the test mode is enabled. Set true to enable test mode and false to disable the test mode.

    Request Example

    curl -X PUT https://api.moltin.com/v2/gateways/paypal_express_checkout \
         -H "Authorization: Bearer XXX" \
         -H "Content-Type: application/json" \
         -d $'{
           "data": {
            "payer_id": "ABCxxxxxxxx",
            "enabled": true,
            "test": true
           }
         }'
    

    Response Example

    200 OK

    {
        "data": {
            "payer_id": "ABCxxxxxxxx",
            "enabled": true,
            "test": true
        }
    }
    

    Was this helpful?

    Previous
    Configure CyberSource