Payment Intent

Storefront Payment Intent API endpoints

Endpoints

POST/payment_intents/{payment_intent}/confirm
GET/payment_intents/{payment_intent}

Confirm payment intent

POST /payment_intents/{payment_intent}/confirm

Confirm payment intent.

Path parameters

payment_intentRequiredstring

PaymentIntent ID

Request body

Confirm payment intent body

external_payment_idoptionalstring

ReturnsPaymentIntent

Payment Intent object response

Error responses

402PaymentIntentError

Payment Intent Error object response

curl -X POST https://api.subbly.co/storefront/v1/payment_intents/{payment_intent}/confirm \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "external_payment_id": "external_payment_id"
}'

Response

{
  "id": "988533fd-80df-4919-9b93-47c807eea53c",
  "payment_method_id": 1,
  "invoice_id": 1,
  "status": "requires_confirmation",
  "token": "pi_3MdtxyJ8pwdPGEaK4jRndVnf_secret_T1tvJ8lHSiaJRaVPGFT2TnXEQ",
  "amount": 100,
  "currency_code": "USD",
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Get payment intent by ID

GET /payment_intents/{payment_intent}

A detailed description of the payment intent.

Path parameters

payment_intentRequiredstring

PaymentIntent ID

ReturnsPaymentIntent

Payment Intent object response

curl https://api.subbly.co/storefront/v1/payment_intents/{payment_intent} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>'

Response

{
  "id": "988533fd-80df-4919-9b93-47c807eea53c",
  "payment_method_id": 1,
  "invoice_id": 1,
  "status": "requires_confirmation",
  "token": "pi_3MdtxyJ8pwdPGEaK4jRndVnf_secret_T1tvJ8lHSiaJRaVPGFT2TnXEQ",
  "amount": 100,
  "currency_code": "USD",
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Payment Intent

Storefront Payment Intent API endpoints

Endpoints

POST/payment_intents/{payment_intent}/confirm
GET/payment_intents/{payment_intent}

Confirm payment intent

POST /payment_intents/{payment_intent}/confirm

Confirm payment intent.

Path parameters

payment_intentRequiredstring

PaymentIntent ID

Request body

Confirm payment intent body

external_payment_idoptionalstring

ReturnsPaymentIntent

Payment Intent object response

idstring

payment_method_idinteger

invoice_idinteger | null

statusstring

Possible values: requires_confirmation, requires_action, failed, confirmed, succeeded.

tokenstring | null

amountinteger | null

currency_codestring

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

Error responses

402PaymentIntentError

Payment Intent Error object response

curl -X POST https://api.subbly.co/storefront/v1/payment_intents/{payment_intent}/confirm \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "external_payment_id": "external_payment_id"
}'

Response

{
  "id": "988533fd-80df-4919-9b93-47c807eea53c",
  "payment_method_id": 1,
  "invoice_id": 1,
  "status": "requires_confirmation",
  "token": "pi_3MdtxyJ8pwdPGEaK4jRndVnf_secret_T1tvJ8lHSiaJRaVPGFT2TnXEQ",
  "amount": 100,
  "currency_code": "USD",
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}

Get payment intent by ID

GET /payment_intents/{payment_intent}

A detailed description of the payment intent.

Path parameters

payment_intentRequiredstring

PaymentIntent ID

ReturnsPaymentIntent

Payment Intent object response

idstring

payment_method_idinteger

invoice_idinteger | null

statusstring

Possible values: requires_confirmation, requires_action, failed, confirmed, succeeded.

tokenstring | null

amountinteger | null

currency_codestring

created_atstring

Format: date-time.

updated_atstring

Format: date-time.

curl https://api.subbly.co/storefront/v1/payment_intents/{payment_intent} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>'

Response

{
  "id": "988533fd-80df-4919-9b93-47c807eea53c",
  "payment_method_id": 1,
  "invoice_id": 1,
  "status": "requires_confirmation",
  "token": "pi_3MdtxyJ8pwdPGEaK4jRndVnf_secret_T1tvJ8lHSiaJRaVPGFT2TnXEQ",
  "amount": 100,
  "currency_code": "USD",
  "created_at": "2022-04-01 00:00:00",
  "updated_at": "2022-04-01 00:00:00"
}