Backend API
Updating a payment with the Swell Backend API.
Arguments
Unique identifier for the payment.
ID of the customer's account the payment was made for.
Payment amount denominated in currency. Minimum of 0.01
Method of payment. Can be card, account, amazon, paypal or any one of the manual methods defined in payment settings.
Expandable link to the customer's account that made the payment.
Expandable link to the customer's credit card on file used to make the payment, if applicable.
ID of the customer's credit card on file used to make the payment, if applicable.
Amazon billing details used when method=amazon.
Amazon access token provided when a customer authorizes payment in a storefront.
Amazon order reference ID created when a customer initiates payment in a storefront.
Remaining amount that can be refunded.
Amount of the payment that has been refunded.
Indicates the payment is processed asynchronously. The payment will be updated in the future while success is undefined.
Indicates the payment was authorized before being captured.
Indicates the payment has been captured.
Credit card details used to make the payment, if applicable.
A temp token generated by Swell Checkout or Stripe.js, or a permanent card token assigned after submitting a temporary token (starting with card_).
Two-digit number representing the credit card expiration month.
Four-digit number representing the credit card expiration year.
Credit card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
Last four digits of the card number.
Indicates this is a test card.
When used with a payment gateway that performs address checks and address1 was provided, can be pass, fail, unavailable, or unchecked.
When used with a payment gateway that performs address checks and zip was provided, can be pass, fail, unavailable, or unchecked.
When used with a payment gateway that performs CVC code checks and cvc was provided, can be pass, fail, unavailable, or unchecked.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
Currency percentage used in calculating the fixed amount.
The date of the next time the payment status will be updated.
An object describing an error that occurred while interacting with the payment gateway, if applicable.
Unique error code.
A message describing the error.
ID of the payment gateway that was used to process the payment.
Expandable link to gift card used to make the payment, if applicable.
ID of the gift card used to make the payment, if applicable.
The intent of the external payment provider. See the external payment provider’s documentation for how intent is implemented.
Expandable link to the invoice the payment was applied to, if applicable.
ID of the invoice the payment was applied to, if applicable.
Unique incremental payment number assigned automatically.
Expandable link to the order the payment was applied to, if applicable.
ID of the order the payment was applied to, if applicable.
PayPal billing details used when billing.method=paypal.
PayPal payer ID provided when a customer authorizes payment in a storefront.
PayPal payment ID created when a customer initiates payment in a storefront.
Expandable list of refunds issued for the payment.
Status of the payment. Can be pending, which is awaiting async processing, error, success or authorized.
Possible enum values:
Expandable link to the subscription the payment was applied to, if applicable.
ID of the subscription the payment was applied to, if applicable.
Indicates the payment was successful. When an error occurs with a payment gateway, this status will be false and error field will be populated.
Indicates the payment was made with a gateway in test mode.
External identifier returned by a payment gateway, if applicable.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.put('/payments/{id}', {
id: '5cae685b20a54174dd968afa',
captured: true,
transaction_id: 'ch_1XNoXdEAeofUkt5SrbA6Swow',
});
The payment model
{
"id": "60f199509111e70000000056",
"account_id": "60f199509111e7000000005a",
"amount": 50,
"method": "card",
"account_card_id": "60f199509111e70000000058",
"amount_refundable": 30,
"amount_refunded": 20,
"async": false,
"authorized": true,
"captured": true,
"card": {
"token": "card_1Ds1K7E30PFlZWil6Q7bJ1PD",
"test": true,
"last4": "4242",
"brand": "Visa",
"address_check": "unchecked",
"zip_check": "unchecked",
"cvc_check": "unchecked",
"exp_month": 1,
"exp_year": 2029
},
"currency": "USD",
"date_created": "2021-07-16T14:36:00.313Z",
"date_updated": "2021-07-16T14:36:00.313Z",
"error": null,
"gateway": "stripe",
"number": 2973512,
"order_id": "60f199509111e70000000059",
"status": "success",
"success": true,
"test": true,
"transaction_id": "ch_1XNoXdEAeofUkt5SrbA6Swow"
}