POST
/
payment-links
curl --request POST \
  --url https://api.mattildapayments.com/payment-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 1299,
  "currency": "MXN",
  "country": "MX",
  "buyer": {},
  "expires_at": "2022-01-01T12:00:00+00:00",
  "connection_options": {
    "cybersource-card": {
      "meta_key_merchant_id": "<string>"
    },
    "cybersource-anti-fraud": {
      "meta_key_merchant_id": "<string>",
      "merchant_defined_data": {
        "1": "John Doe",
        "2": "trusted",
        "99": "recurring"
      }
    },
    "forter-anti-fraud": {
      "delivery_type": "PHYSICAL",
      "delivery_method": "<string>",
      "is_guest_buyer": false,
      "cart_items": [
        {
          "basic_item_data": {
            "type": "TANGIBLE"
          },
          "delivery_details": {
            "delivery_type": "PHYSICAL",
            "delivery_method": "USPS - Ground Mail"
          },
          "beneficiaries": [
            {
              "personal_details": {
                "first_name": "John",
                "last_name": "Smith",
                "email": "john@example.com"
              },
              "address": {
                "country": "MX",
                "address1": "235 Montgomery st.",
                "address2": "Ste. 1110",
                "zip": "94104",
                "region": "CA",
                "company": "Generic Corp. ltd.",
                "city": "San Francisco"
              },
              "phone": [
                {
                  "phone": "15557654321"
                }
              ],
              "comments": {
                "user_comments_to_merchant": "Please wrap with care!!",
                "message_to_beneficiary": "Enjoy the gift John!",
                "merchant_comments": "Shipping delayed"
              }
            }
          ]
        }
      ],
      "total_discount": {
        "coupon_code_used": "FATHERSDAY2015",
        "discount_type": "COUPON",
        "coupon_discount_amount": {
          "amount_local_currency": "105.55",
          "currency": "CAD"
        },
        "coupon_discount_percent": "20%"
      }
    },
    "adyen-card": {
      "additionalData": {
        "riskdata.operatorCode": "operatorCode,",
        "riskdata.operatorCountry": "operatorCountry"
      }
    },
    "paypal-paypal": {
      "additional_data": [
        {
          "key": "test",
          "value": "abc"
        }
      ]
    },
    "paypal-paypalpaylater": {
      "additional_data": [
        {
          "key": "test",
          "value": "abc"
        }
      ]
    },
    "stripe-card": {
      "error_on_requires_action": false
    }
  },
  "external_identifier": "payment-link-123",
  "locale": "en",
  "merchant_name": "Gr4vy",
  "merchant_url": "https://example.com",
  "merchant_banner_url": "https://example.com/banner.png",
  "merchant_color": "#FF0000",
  "merchant_message": "Thank you for shopping with us!",
  "merchant_terms_and_conditions_url": "https://example.com/terms",
  "merchant_favicon_url": "https://example.com/favicon.png",
  "intent": "authorize",
  "return_url": "https://example.com/return",
  "cart_items": [
    {
      "name": "GoPro HERO9 Camcorder",
      "quantity": 1,
      "unit_amount": 37999,
      "discount_amount": 0,
      "tax_amount": 0,
      "external_identifier": "item-789123",
      "sku": "sku-789123",
      "product_url": "https://example.com/items/gopro",
      "image_url": "https://example.com/images/items/gopro.png",
      "categories": [
        "<string>"
      ],
      "product_type": "physical"
    }
  ],
  "metadata": {
    "key": "value"
  },
  "payment_source": "recurring"
}'
{
  "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
  "type": "payment_link",
  "amount": 1299,
  "currency": "MXN",
  "created_at": "2022-01-01T12:00:00+00:00",
  "updated_at": "2022-01-01T12:00:00+00:00",
  "expires_at": "2022-01-01T12:00:00+00:00",
  "status": "active",
  "external_identifier": "payment-link-123",
  "locale": "en",
  "merchant_name": "mattilda Pay",
  "merchant_url": "https://example.com",
  "merchant_banner_url": "https://example.com/banner.png",
  "merchant_color": "#FF0000",
  "merchant_message": "Thank you for shopping with us!",
  "merchant_terms_and_conditions_url": "https://example.com/terms",
  "merchant_favicon_url": "https://example.com/favicon.png",
  "country": "MX",
  "intent": "authorize",
  "return_url": "https://example.com/return",
  "cart_items": [
    {
      "name": "GoPro HERO9 Camcorder",
      "quantity": 1,
      "unit_amount": 37999,
      "discount_amount": 0,
      "tax_amount": 0,
      "external_identifier": "item-789123",
      "sku": "sku-789123",
      "product_url": "https://example.com/items/gopro",
      "image_url": "https://example.com/images/items/gopro.png",
      "categories": [
        "<string>"
      ],
      "product_type": "physical"
    }
  ],
  "metadata": {
    "key": "value"
  },
  "payment_source": "recurring",
  "buyer": {
    "type": "buyer",
    "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
    "billing_details": {
      "type": "billing-details",
      "first_name": "John",
      "last_name": "Lunn",
      "email_address": "john@example.com",
      "phone_number": "+1234567890",
      "address": {
        "city": "London",
        "country": "GB",
        "postal_code": "789123",
        "state": "Greater London",
        "state_code": "GB-LND",
        "house_number_or_name": "10",
        "line1": "10 Oxford Street",
        "line2": "New Oxford Court",
        "organization": "mattilda Pay"
      },
      "tax_id": {
        "value": "12345678931",
        "kind": "gb.vat"
      }
    },
    "display_name": "John L.",
    "external_identifier": "user-789123"
  },
  "shipping_details": {
    "type": "shipping-details",
    "id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
    "buyer_id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
    "first_name": "John",
    "last_name": "Lunn",
    "email_address": "john@example.com",
    "phone_number": "+1234567890",
    "address": {
      "city": "London",
      "country": "GB",
      "postal_code": "789123",
      "state": "Greater London",
      "state_code": "GB-LND",
      "house_number_or_name": "10",
      "line1": "10 Oxford Street",
      "line2": "New Oxford Court",
      "organization": "mattilda Pay"
    }
  }
}

This endpoint requires the payment-links.write scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating a new payment link.

Response

201
application/json

Returns the created payment link.

The response is of type object.