payment

Collection: payments

The historical record of payment applied to a given transaction which includes the payment gateway response, purchase order, third party id and/or masked payment card information.

Required Scopes

Full store_full_access
Read transactions_read
Write transactions_write

Actions

GET View a payment
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (15)

type String · Read-only

The payment type for this payment.

plasticpurchase_orderpaypalamazon_mwshostedogonepaypal_ec
gateway_type String · Read-only

The payment gateway type for this payment. This should correspond to a value in hosted_payment_gateways or payment_gateways.

processor_response String · Read-only

The processor response string from the payment gateway. This will include their transaction or reference number.

processor_response_details String · Read-only

If supported by the payment gateway integration, this will include additional information from the payment gateway's response.

purchase_order String · Read-only

The PO value entered by the customer during checkout (for purchase order payment types).

cc_number_masked String · Read-only

The masked credit card number used for this payment (for plastic payment types).

cc_type String (nullable) · Read-only

The type of credit card such as Visa or MasterCard (for plastic payment types).

cc_exp_month String (nullable) · Read-only

The credit card expiration month (for plastic payment types).

cc_exp_year String (nullable) · Read-only

The credit card expiration year (for plastic payment types).

fraud_protection_score Number · Read-only

If this payment gateway set is configured with a fraud protection system, the fraud score for this payment will be listed here.

paypal_payer_id String · Read-only

The payer id for this payment (for Paypal payment types).

third_party_id String · Read-only

The identifier for the third party provider for this payment (for hosted payment types).

amount Number · Read-only

The total amount of this payment.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (4)

self This Payment
fx:store GET PATCH PUT DELETE This Store
fx:transaction GET PATCH PUT POST This Transaction
fx:payment_method_set GET PATCH PUT DELETE Payment Method Set for this payment.

Only present when the payment has an associated payment method set.

https://api.foxycart.com/payments/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/payments/123",
      "title": "This Payment"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:transaction": {
      "href": "https://api.foxycart.com/transactions/999",
      "title": "This Transaction"
    }
  },
  "type": "plastic",
  "gateway_type": "authorize",
  "processor_response": "Authorize.net Transaction ID:2233990980",
  "processor_response_details": "",
  "purchase_order": "",
  "cc_number_masked": "xxxxxxxxxxxx1111",
  "cc_type": "Visa",
  "cc_exp_month": "01",
  "cc_exp_year": "2017",
  "fraud_protection_score": 0,
  "paypal_payer_id": "",
  "third_party_id": "",
  "amount": 20.15,
  "date_created": "2015-05-21T14:22:09-0700",
  "date_modified": "2015-05-21T14:22:09-0700"
}