Sending additional data to Stripe
Edit on GitHubStripe accepts metadata passed using API calls. To send additional data to Stripe, the QuoteTransfer::PAYMENT::ADDITIONAL_PAYMENT_DATA
field is used; the field is a key-value array. When sending requests using Glue API, pass the additionalPaymentData
field in the POST /checkout
request.
POST https://api.your-site.com/checkout
Content-Type: application/json
Accept-Language: en-US
Authorization: Bearer
{
"data": {
"type": "checkout",
"attributes": {
"customer": {
...
},
"idCart": "",
"billingAddress": {
...
},
"shippingAddress": {
...
},
"payments": [
{
"paymentMethodName": "Stripe",
"paymentProviderName": "Stripe",
"additionalPaymentData": {
"custom-field-1": "my custom value 1",
"custom-field-2": "my custom value 2"
}
}
],
"shipment": {
"idShipmentMethod":
}
}
}
}
The metadata sent using the field must meet the following criteria:
ATTRIBUTE | MAXIMUM VALUE |
---|---|
Key length | 40 characters |
Value length | 500 characters |
Key-value pairs | 50 pairs |
Show allHide
When you pass metadata to Stripe, it’s stored in the payment object and can be retrieved later. For example, this way you can pass an external ID to Stripe.
When a PaymentIntent
is created on the Stripe side, you can see your passed additionalPaymentData
in the Stripe Dashboard.
Thank you!
For submitting the form