POST
/
ext-stripe
/
payment-intent
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/ext-stripe/payment-intent \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 1000,
  "currency": "USD",
  "customer": "cus_HRp23wXfXMqSao",
  "confirm": false,
  "off_session": false,
  "payment_method": "pm_1Gsv4BFbKq2PvwXbl4XEl1O3",
  "payment_method_types": [
    "card"
  ],
  "receipt_email": "joedoe@fabric.inc",
  "setup_future_usage": "off_session",
  "capture_method": "manual",
  "application_fee_amount": 100,
  "transfer_data": {
    "destination": "acct_1GtG8vJwgwMmQiI2",
    "amount": 1000
  },
  "metadata": {
    "orderId": "1234-1234-12345"
  }
}'
{
  "id": "pi_1GsyhzFbKq2PvwXbwAI3ZluI",
  "object": "payment_intent",
  "amount": 1000,
  "amount_capturable": 0,
  "amount_received": 0,
  "application": "<string>",
  "application_fee_amount": 123,
  "canceled_at": "<string>",
  "cancellation_reason": "<string>",
  "capture_method": "manual",
  "client_secret": "pi_1GsyhzFbKq2Pvw1bwAI3ZluI_secret_GKG6hcap7VCggeoqJICAqSsRW",
  "confirmation_method": "automatic",
  "created": 1591913835,
  "currency": "usd",
  "customer": "<string>",
  "description": "<string>",
  "invoice": "<string>",
  "last_payment_error": "<string>",
  "livemode": true,
  "metadata": {},
  "next_action": "<string>",
  "on_behalf_of": "<string>",
  "payment_method": "<string>",
  "payment_method_options": {
    "card": {
      "installments": "<string>",
      "network": "<string>",
      "request_three_d_secure": "automatic"
    }
  },
  "payment_method_types": [
    "card"
  ],
  "receipt_email": "<string>",
  "review": "<string>",
  "setup_future_usage": "on_session",
  "shipping": "<string>",
  "source": "<string>",
  "statement_descriptor": "<string>",
  "statement_descriptor_suffix": "<string>",
  "status": "requires_payment_method",
  "transfer_data": "<string>",
  "transfer_group": "<string>",
  "charges": {
    "object": "list",
    "data": [
      "<any>"
    ],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/charges?payment_intent=pi_1GsyhzFbKq2PvwXbwAI3ZluI"
  }
}

Headers

​
x-api-key
string
Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

Body

application/json
​
amount
integer
Required range: x >= 1
Example:

1000

​
currency
string
Required string length: 3
Example:

"USD"

​
customer
string
Example:

"cus_HRp23wXfXMqSao"

​
confirm
boolean
default:false
Example:

false

​
off_session
boolean
default:false
Example:

false

​
payment_method
string
Example:

"pm_1Gsv4BFbKq2PvwXbl4XEl1O3"

​
payment_method_types
enum<string>[]
Available options:
card
Example:
["card"]
​
receipt_email
string
Example:

"joedoe@fabric.inc"

​
setup_future_usage
enum<string>
default:off_session
Available options:
on_session,
off_session
Example:

"off_session"

​
capture_method
enum<string>
default:manual
Available options:
automatic,
manual
Example:

"manual"

​
application_fee_amount
integer
Required range: x >= 1
Example:

100

​
transfer_data
object
​
metadata
object
Example:
{ "orderId": "1234-1234-12345" }

Response

200
application/json
Created stripe payment intent
​
id
string
Example:

"pi_1GsyhzFbKq2PvwXbwAI3ZluI"

​
object
string
Example:

"payment_intent"

​
amount
number
Example:

1000

​
amount_capturable
number
Example:

0

​
amount_received
number
Example:

0

​
application
string
​
application_fee_amount
number
​
canceled_at
string
​
cancellation_reason
string
​
capture_method
string
Example:

"manual"

​
client_secret
string
Example:

"pi_1GsyhzFbKq2Pvw1bwAI3ZluI_secret_GKG6hcap7VCggeoqJICAqSsRW"

​
confirmation_method
string
Example:

"automatic"

​
created
number
Example:

1591913835

​
currency
string
Example:

"usd"

​
customer
string
​
description
string
​
invoice
string
​
last_payment_error
string
​
livemode
boolean
​
metadata
object
​
next_action
string
​
on_behalf_of
string
​
payment_method
string
​
payment_method_options
object
​
payment_method_types
string[]
Example:
["card"]
​
receipt_email
string
​
review
string
​
setup_future_usage
string
Example:

"on_session"

​
shipping
string
​
source
string
​
statement_descriptor
string
​
statement_descriptor_suffix
string
​
status
string
Example:

"requires_payment_method"

​
transfer_data
string
​
transfer_group
string
​
charges
object

Was this page helpful?

Delete paymentOverview