{"id":886,"date":"2025-06-08T10:39:47","date_gmt":"2025-06-08T10:39:47","guid":{"rendered":"https:\/\/lddpay.com\/?post_type=docs&p=886"},"modified":"2025-06-08T10:40:25","modified_gmt":"2025-06-08T10:40:25","password":"","slug":"flow","status":"publish","type":"docs","link":"https:\/\/lddpay.com\/zh\/docs\/flow\/","title":{"rendered":"Flow"},"content":{"rendered":"

<\/a>Request a Payment Session<\/h2>\n\n\n\n

Creates a payment session for Flow. The values you provide in the request will be used to determine the payment methods available to Flow. Some payment methods may require you to provide specific values for certain fields. You must supply the unmodified response body when you initialize Flow.<\/p>\n\n\n\n

Authorizations<\/summary>\n

bearer<\/em><\/p>\n\n\n\n

<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n

HTTP Authorization Scheme: <\/strong>bearer<\/code><\/p>\n\n\n\n

Bearer format: <\/strong>JWT<\/code><\/p>\n<\/details>\n\n\n\n

header Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td>stringBearer token (API Key or OAuth2 Access Token).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Request Body schema: application\/json<\/h5>\n\n\n\n

Request body for creating a Flow payment session.<\/p>\n\n\n\n

amountrequired<\/td>number >= 0 The payment amount in minor units. Provide 0 to perform a card verification.<\/td><\/tr>
currencyrequired<\/td>string = 3 characters The three-letter ISO currency code.<\/td><\/tr>
billingrequired<\/td>objectThe billing details.<\/td><\/tr>
success_urlrequired<\/td>string <= 1024 characters Overrides the default success redirect URL for payment methods that require a redirect.<\/td><\/tr>
failure_urlrequired<\/td>string <= 1024 characters Overrides the default failure redirect URL for payment methods that require a redirect.<\/td><\/tr>
payment_type<\/td>string Default: “Regular” Enum:”Regular””Recurring””MOTO””Installment””Unscheduled”Must be specified for card-not-present (CNP) payments.<\/td><\/tr>
billing_descriptor<\/td>objectA description of the purchase, displayed on the customer’s statement.<\/td><\/tr>
reference<\/td>string <= 50 characters A reference to identify the payment (max 50 chars, Amex: 30, iDEAL: 35, Benefit: unique alphanumeric).<\/td><\/tr>
description<\/td>string <= 100 characters A description for the payment (max 100 chars).<\/td><\/tr>
customer<\/td>objectThe customer’s details. Required if source.type is tamara.<\/td><\/tr>
shipping<\/td>objectThe shipping details.<\/td><\/tr>
recipient<\/td>objectInformation about the recipient of the payment’s funds.<\/td><\/tr>
processing<\/td>objectProcessing options.<\/td><\/tr>
instruction<\/td>objectDetails about the payment instruction.<\/td><\/tr>
processing_channel_id<\/td>string^(pc)_(\\w{26})$The processing channel to use for the payment.<\/td><\/tr>
expires_on<\/td>stringA timestamp specifying when the PaymentSession should expire, as an ISO 8601 code.<\/td><\/tr>
payment_method_configuration<\/td>objectConfigurations for payment method-specific settings.<\/td><\/tr>
enabled_payment_methods<\/td>Array of stringsSpecifies which payment method options to present to the customer.<\/td><\/tr>
disabled_payment_methods<\/td>Array of stringsSpecifies which payment method options to not present to the customer.<\/td><\/tr>
items<\/td>Array of objectsThe line items in the order.<\/td><\/tr>
amount_allocations<\/td>Array of objectsThe sub-entities that the payment is being processed on behalf of.<\/td><\/tr>
risk<\/td>objectConfigures the risk assessment performed during payment processing.<\/td><\/tr>
customer_retry<\/td>objectConfiguration for asynchronous retries.<\/td><\/tr>
display_name<\/td>string <= 255 characters The merchant’s display name.<\/td><\/tr>
metadata<\/td>objectAllows you to store additional information about a transaction with custom fields (up to 18 fields, 255 chars each).<\/td><\/tr>
locale<\/td>string Default: “en-GB”Creates a translated version of the page in the specified language.<\/td><\/tr>
3ds<\/td>objectInformation required for 3D Secure authentication payments.<\/td><\/tr>
sender<\/td>objectThe sender of the payment.<\/td><\/tr>
capture<\/td>boolean Default: trueSpecifies whether to capture the payment, if applicable.<\/td><\/tr>
capture_on<\/td>stringA timestamp specifying when to capture the payment, as an ISO 8601 code.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Responses<\/h5>\n\n\n\n
201 A Payment Session.<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
idrequired<\/td>stringThe Payment Session unique identifier.<\/td><\/tr>
status<\/td>stringThe status of the payment session.<\/td><\/tr>
payment_id<\/td>stringThe payment identifier associated with the session.<\/td><\/tr>
amount<\/td>numberThe payment amount in minor units.<\/td><\/tr>
currency<\/td>stringThe three-letter ISO currency code.<\/td><\/tr>
reference<\/td>stringA reference to identify the payment.<\/td><\/tr>
description<\/td>stringA description for the payment.<\/td><\/tr>
expires_on<\/td>stringA timestamp specifying when the PaymentSession should expire, as an ISO 8601 code.<\/td><\/tr>
customer<\/td>objectThe customer’s details.<\/td><\/tr>
billing<\/td>objectThe billing details.<\/td><\/tr>
products<\/td>Array of objectsThe products in the order.<\/td><\/tr>
payment_session_token<\/td>stringA unique token representing the payment session, which you must provide when you initialize Flow.<\/td><\/tr>
payment_session_secret<\/td>stringThe secret used by Flow to authenticate payment session requests.<\/td><\/tr>
_linksrequired<\/td>objectThe links related to the Payment Session.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

401 Unauthorized<\/p>\n\n\n\n

422 Invalid data was sent.<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
429 Too many requests.<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

502 Bad gateway<\/p>\n\n\n\n

<\/a>Submit a Payment Session Payment<\/h2>\n\n\n\n

Submit a payment attempt for a payment session. Request a payment via your created payment session. This request works with the Flow handleSubmit callback, where you can perform a customized payment submission. You must send the unmodified response body as the response of the handleSubmit callback.<\/p>\n\n\n\n

Authorizations<\/summary>\n

bearer<\/em><\/p>\n\n\n\n

<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n

HTTP Authorization Scheme: <\/strong>bearer<\/code><\/p>\n\n\n\n

Bearer format: <\/strong>JWT<\/code><\/p>\n<\/details>\n\n\n\n

header Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td>stringBearer token (API Key or OAuth2 Access Token).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Request Body schema: application\/json<\/h5>\n\n\n\n

Request body for submitting a payment session payment.<\/p>\n\n\n\n

session_datarequired<\/td>stringA unique token representing the additional customer data captured by Flow, as received from the handleSubmit callback. Do not log or store this value.<\/td><\/tr>
amountrequired<\/td>number >= 0 The payment amount in minor units. Provide 0 to perform a card verification.<\/td><\/tr>
reference<\/td>string <= 50 characters A reference to identify the payment (max 50 chars, Amex: 30, iDEAL: 35, Benefit: unique alphanumeric).<\/td><\/tr>
items<\/td>Array of objectsThe line items in the order.<\/td><\/tr>
3ds<\/td>objectInformation required for 3D Secure authentication payments.<\/td><\/tr>
ip_address<\/td>string <= 45 characters The customer’s IP address. Only IPv4 and IPv6 addresses are accepted.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Responses<\/h5>\n\n\n\n
201 Payment processed successfully<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
idrequired<\/td>stringThe payment identifier.<\/td><\/tr>
statusrequired<\/td>stringThe payment’s status.<\/td><\/tr>
typerequired<\/td>Array of stringsThe payment method name.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
202 Payment asynchronous or further action required<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
idrequired<\/td>stringThe payment identifier.<\/td><\/tr>
statusrequired<\/td>stringThe payment’s status.<\/td><\/tr>
typerequired<\/td>stringThe payment method name.<\/td><\/tr>
actionrequired<\/td>objectInstruction for further payment action.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

401 Unauthorized<\/p>\n\n\n\n

422 Invalid data was sent.<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
429 Too many requests or duplicate request detected<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

502 Bad gateway<\/p>\n\n\n\n

<\/a>Get Payment Session Details<\/h2>\n\n\n\n

Returns the details of the payment session with the specified identifier string.<\/p>\n\n\n\n

Authorizations<\/summary>\n

bearer<\/em><\/p>\n\n\n\n

<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n

HTTP Authorization Scheme: <\/strong>bearer<\/code><\/p>\n\n\n\n

Bearer format: <\/strong>JWT<\/code><\/p>\n<\/details>\n\n\n\n

path Parameters<\/h5>\n\n\n\n
idrequired<\/td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
header Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td>stringBearer token (API Key or OAuth2 Access Token).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
200 Payment session retrieved successfully<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
idrequired<\/td>stringThe Payment Session unique identifier.<\/td><\/tr>
status<\/td>stringThe status of the payment session.<\/td><\/tr>
payment_id<\/td>stringThe payment identifier associated with the session.<\/td><\/tr>
amount<\/td>numberThe payment amount in minor units.<\/td><\/tr>
currency<\/td>stringThe three-letter ISO currency code.<\/td><\/tr>
reference<\/td>stringA reference to identify the payment.<\/td><\/tr>
description<\/td>stringA description for the payment.<\/td><\/tr>
expires_on<\/td>stringA timestamp specifying when the PaymentSession should expire, as an ISO 8601 code.<\/td><\/tr>
customer<\/td>objectThe customer’s details.<\/td><\/tr>
billing<\/td>objectThe billing details.<\/td><\/tr>
products<\/td>Array of objectsThe products in the order.<\/td><\/tr>
payment_session_token<\/td>stringA unique token representing the payment session, which you must provide when you initialize Flow.<\/td><\/tr>
payment_session_secret<\/td>stringThe secret used by Flow to authenticate payment session requests.<\/td><\/tr>
_linksrequired<\/td>objectThe links related to the Payment Session.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

401 Unauthorized
404 Session not found<\/p>","protected":false},"excerpt":{"rendered":"

Request a Payment Session Creates a payment session for Flow. The values you provide in the request will be used […]<\/p>","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"doc_category":[122],"doc_tag":[],"year_month":"2026-04","word_count":977,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"author_nicename":"admin","author_url":"https:\/\/lddpay.com\/zh\/author\/admin\/"},"doc_category_info":[{"term_name":"Temp Solution","term_url":"https:\/\/lddpay.com\/zh\/docs-category\/temp-solution\/"}],"doc_tag_info":[],"author_list":[{"ID":"3","user_login":"jony","display_name":"jony","id":"3"},{"ID":"2","user_login":"Merchantlogin","display_name":"Merchantlogin","id":"2"},{"ID":"1","user_login":"w2863431","display_name":"admin","id":"1"}],"_links":{"self":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/886"}],"collection":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/comments?post=886"}],"version-history":[{"count":1,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/886\/revisions"}],"predecessor-version":[{"id":887,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/886\/revisions\/887"}],"wp:attachment":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/media?parent=886"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/doc_category?post=886"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/doc_tag?post=886"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}