Overview
Your First Payment
Payment Operations
Advanced Features
Webhooks & Events
Your First Payment
Payments - Confirm
Use this API to confirm the payment and forward it to the BNPL provider.
Alternatively, you can confirm the payment directly in the Payments/Create API by setting confirm=true. After confirmation, the payment may result in one of the following outcomes:
Once payments confirm is successfully completed, we will have payment status as requires_capture or succeeded indicating the amount for customer is authorized by the BNPL provider
- Fail with a
failedstatus. - Transition to a
requires_customer_actionstatus, along with anext_actionblock. - Succeed, with either:
succeeded(for automatic capture), orrequires_capture(for manual capture).
BNPL providers typically use methods like manual_captureormanual_multiple_capture` for capturing payments, as specified in the Payments Create request.
You can configure routing rules to process specific payments through specific connectors. If you would like to route a specific payment with specific connector you can also pass “connector”: [“connector_name”] to process the payment.
POST
/
payments
/
{payment_id}
/
confirm
Copy
curl --request POST \
--url https://api.staging.bnplx.io/payments/{payment_id}/confirm \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{
"payment_method": "pay_later",
"payment_method_data": {
"pay_later": {
"invoice": {}
}
},
"payment_method_type": "invoice"
}'Copy
{
"allowed_payment_method_types": null,
"amount": 10000,
"amount_capturable": 10250,
"attempt_count": 1,
"authentication_type": "no_three_ds",
"billing": {
"address": {
"city": "San Fransico",
"country": "DE",
"first_name": "joseph",
"last_name": "Doe",
"line1": "Schönhauser Allee",
"line2": "Harrison Street",
"line3": "Harrison Street",
"state": "California",
"zip": "24000"
},
"email": "guest@example.com",
"phone": {
"country_code": "+49",
"number": "8056594427"
}
},
"birth_date": "2001-10-19",
"business_country": null,
"business_label": "default",
"business_sub_label": null,
"cancellation_reason": null,
"capture_method": "manual_multiple",
"client_secret": "pay_m7cthQvCluxCi5rfpu69_secret_SxeEfmQp6j76ijKY6cT7",
"connector": "svea",
"connector_label": null,
"connector_mandate_id": null,
"connector_transaction_id": "202501313607",
"created": "2025-05-22T12:14:29.694Z",
"currency": "EUR",
"customer": {
"email": "guest@example.com",
"id": "cust_01",
"name": "john doe",
"phone": "177555923",
"phone_country_code": "+91"
},
"customer_id": "cust_01",
"description": "Its my first payment request",
"email": "guest@example.com",
"ephemeral_key": null,
"error_code": null,
"error_message": null,
"expires_on": "2025-05-22T12:29:29.694Z",
"external_3ds_authentication_attempted": false,
"frm_message": null,
"frm_metadata": null,
"gender": "male",
"locale": "en_US",
"manual_retry_allowed": false,
"merchant_connector_id": "mca_ffitabHi560DWp5QHuk1",
"merchant_id": "merchant_1735914184",
"merchant_order_reference_id": "asdbcdef",
"metadata": {
"birth_date": "2001-10-19",
"buyer_type": "private_person",
"company_name": "Your company GmbH",
"company_vat_id": null,
"customer_locale": "en-GB",
"device_token": "abcddef",
"gender": "M",
"invoice_url": "https://www.google.com",
"legal_form": "gmbh",
"legal_form_category": "einzelunternehmen",
"net_term": 30,
"order_dttm": "2021-10-01 10:10:10.222",
"product_ref": null,
"settlement": "settlement1234",
"user_language_code": 208
},
"name": "john doe",
"net_amount": 10250,
"next_action": null,
"order_details": [
{
"amount": 5000,
"brand": null,
"category": null,
"product_id": "i122",
"product_img_link": null,
"product_link": null,
"product_name": "Apple iphone 15",
"product_tax_code": null,
"product_type": null,
"quantity": 1,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 100,
"tax_percentage": 10,
"total_tax_amount": null
},
{
"amount": 2000,
"brand": null,
"category": null,
"product_id": "i124",
"product_img_link": null,
"product_link": null,
"product_name": "Apple airpods",
"product_tax_code": null,
"product_type": null,
"quantity": 2,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 50,
"tax_percentage": 10,
"total_tax_amount": null
},
{
"amount": 1000,
"brand": null,
"category": null,
"product_id": "i124",
"product_img_link": null,
"product_link": null,
"product_name": "Apple airpods",
"product_tax_code": null,
"product_type": null,
"quantity": 1,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 50,
"tax_percentage": 10,
"total_tax_amount": null
},
{
"amount": 500,
"brand": null,
"category": "shipping_costs",
"product_id": "i123",
"product_img_link": null,
"product_link": null,
"product_name": "Shipping",
"product_tax_code": null,
"product_type": null,
"quantity": 1,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 50,
"tax_percentage": 5,
"total_tax_amount": null
},
{
"amount": 500,
"brand": null,
"category": "voucher",
"product_id": "i123",
"product_img_link": null,
"product_link": null,
"product_name": "Voucher",
"product_tax_code": null,
"product_type": null,
"quantity": 1,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 50,
"tax_percentage": 5,
"total_tax_amount": null
}
],
"order_tax_amount": 250,
"payment_experience": null,
"payment_id": "pay_m7cthQvCluxCi5rfpu69",
"payment_method": "pay_later",
"payment_method_data": {
"billing": null,
"pay_later": {
"klarna_sdk": null
}
},
"payment_method_id": null,
"payment_method_status": null,
"payment_method_type": "invoice",
"phone": "177555923",
"profile_id": "pro_WzNsrevpecY0FYP7Rd9v",
"return_url": "https://google.com/",
"shipping": {
"address": {
"city": "San Fransico",
"country": "DE",
"first_name": "joseph",
"last_name": "Doe",
"line1": "Schönhauser Allee",
"line2": "Harrison Street",
"line3": "Harrison Street",
"state": "California",
"zip": "24000"
},
"phone": {
"country_code": "+49",
"number": "8056594427"
}
},
"split_payments": null,
"ssn": "030883-925M",
"statement_descriptor_name": "joseph",
"statement_descriptor_suffix": "JS",
"status": "requires_capture",
"unified_code": null,
"unified_message": null,
"updated": "2025-05-22T12:15:19.037Z"
}Authorizations
Use the API key created under your merchant account from the GreenBanana dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Path Parameters
The identifier for payment
Body
application/json
Response
200
application/json
Payment confirmed
The response is of type object.
Copy
curl --request POST \
--url https://api.staging.bnplx.io/payments/{payment_id}/confirm \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '{
"payment_method": "pay_later",
"payment_method_data": {
"pay_later": {
"invoice": {}
}
},
"payment_method_type": "invoice"
}'Copy
{
"allowed_payment_method_types": null,
"amount": 10000,
"amount_capturable": 10250,
"attempt_count": 1,
"authentication_type": "no_three_ds",
"billing": {
"address": {
"city": "San Fransico",
"country": "DE",
"first_name": "joseph",
"last_name": "Doe",
"line1": "Schönhauser Allee",
"line2": "Harrison Street",
"line3": "Harrison Street",
"state": "California",
"zip": "24000"
},
"email": "guest@example.com",
"phone": {
"country_code": "+49",
"number": "8056594427"
}
},
"birth_date": "2001-10-19",
"business_country": null,
"business_label": "default",
"business_sub_label": null,
"cancellation_reason": null,
"capture_method": "manual_multiple",
"client_secret": "pay_m7cthQvCluxCi5rfpu69_secret_SxeEfmQp6j76ijKY6cT7",
"connector": "svea",
"connector_label": null,
"connector_mandate_id": null,
"connector_transaction_id": "202501313607",
"created": "2025-05-22T12:14:29.694Z",
"currency": "EUR",
"customer": {
"email": "guest@example.com",
"id": "cust_01",
"name": "john doe",
"phone": "177555923",
"phone_country_code": "+91"
},
"customer_id": "cust_01",
"description": "Its my first payment request",
"email": "guest@example.com",
"ephemeral_key": null,
"error_code": null,
"error_message": null,
"expires_on": "2025-05-22T12:29:29.694Z",
"external_3ds_authentication_attempted": false,
"frm_message": null,
"frm_metadata": null,
"gender": "male",
"locale": "en_US",
"manual_retry_allowed": false,
"merchant_connector_id": "mca_ffitabHi560DWp5QHuk1",
"merchant_id": "merchant_1735914184",
"merchant_order_reference_id": "asdbcdef",
"metadata": {
"birth_date": "2001-10-19",
"buyer_type": "private_person",
"company_name": "Your company GmbH",
"company_vat_id": null,
"customer_locale": "en-GB",
"device_token": "abcddef",
"gender": "M",
"invoice_url": "https://www.google.com",
"legal_form": "gmbh",
"legal_form_category": "einzelunternehmen",
"net_term": 30,
"order_dttm": "2021-10-01 10:10:10.222",
"product_ref": null,
"settlement": "settlement1234",
"user_language_code": 208
},
"name": "john doe",
"net_amount": 10250,
"next_action": null,
"order_details": [
{
"amount": 5000,
"brand": null,
"category": null,
"product_id": "i122",
"product_img_link": null,
"product_link": null,
"product_name": "Apple iphone 15",
"product_tax_code": null,
"product_type": null,
"quantity": 1,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 100,
"tax_percentage": 10,
"total_tax_amount": null
},
{
"amount": 2000,
"brand": null,
"category": null,
"product_id": "i124",
"product_img_link": null,
"product_link": null,
"product_name": "Apple airpods",
"product_tax_code": null,
"product_type": null,
"quantity": 2,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 50,
"tax_percentage": 10,
"total_tax_amount": null
},
{
"amount": 1000,
"brand": null,
"category": null,
"product_id": "i124",
"product_img_link": null,
"product_link": null,
"product_name": "Apple airpods",
"product_tax_code": null,
"product_type": null,
"quantity": 1,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 50,
"tax_percentage": 10,
"total_tax_amount": null
},
{
"amount": 500,
"brand": null,
"category": "shipping_costs",
"product_id": "i123",
"product_img_link": null,
"product_link": null,
"product_name": "Shipping",
"product_tax_code": null,
"product_type": null,
"quantity": 1,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 50,
"tax_percentage": 5,
"total_tax_amount": null
},
{
"amount": 500,
"brand": null,
"category": "voucher",
"product_id": "i123",
"product_img_link": null,
"product_link": null,
"product_name": "Voucher",
"product_tax_code": null,
"product_type": null,
"quantity": 1,
"requires_shipping": null,
"sub_category": null,
"tax_amount": 50,
"tax_percentage": 5,
"total_tax_amount": null
}
],
"order_tax_amount": 250,
"payment_experience": null,
"payment_id": "pay_m7cthQvCluxCi5rfpu69",
"payment_method": "pay_later",
"payment_method_data": {
"billing": null,
"pay_later": {
"klarna_sdk": null
}
},
"payment_method_id": null,
"payment_method_status": null,
"payment_method_type": "invoice",
"phone": "177555923",
"profile_id": "pro_WzNsrevpecY0FYP7Rd9v",
"return_url": "https://google.com/",
"shipping": {
"address": {
"city": "San Fransico",
"country": "DE",
"first_name": "joseph",
"last_name": "Doe",
"line1": "Schönhauser Allee",
"line2": "Harrison Street",
"line3": "Harrison Street",
"state": "California",
"zip": "24000"
},
"phone": {
"country_code": "+49",
"number": "8056594427"
}
},
"split_payments": null,
"ssn": "030883-925M",
"statement_descriptor_name": "joseph",
"statement_descriptor_suffix": "JS",
"status": "requires_capture",
"unified_code": null,
"unified_message": null,
"updated": "2025-05-22T12:15:19.037Z"
}Assistant
Responses are generated using AI and may contain mistakes.