{"id":876,"date":"2025-06-04T18:44:23","date_gmt":"2025-06-04T18:44:23","guid":{"rendered":"https:\/\/lddpay.com\/?post_type=docs&#038;p=876"},"modified":"2025-06-08T10:28:52","modified_gmt":"2025-06-08T10:28:52","password":"","slug":"payment","status":"publish","type":"docs","link":"https:\/\/lddpay.com\/zh\/docs\/payment\/","title":{"rendered":"Payment"},"content":{"rendered":"<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/AuthController_getToken\"><\/a>Get access token using client credentials<\/h2>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Token request parameters<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>grant_typerequired<\/td><td>string Value:&#8221;client_credentials&#8221;Must be &#8220;client_credentials&#8221;<\/td><\/tr><tr><td>client_idrequired<\/td><td>stringAccess key ID<\/td><\/tr><tr><td>client_secretrequired<\/td><td>stringAccess key secret<\/td><\/tr><tr><td>scoperequired<\/td><td>stringThe access key scope<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\"><strong>Responses<\/strong><\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>200 A successful access token response as per RFC6749<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>access_tokenrequired<\/td><td>string<\/td><\/tr><tr><td>token_typerequired<\/td><td>string<\/td><\/tr><tr><td>expires_inrequired<\/td><td>number<\/td><\/tr><\/tbody><\/table><figcaption class=\"wp-element-caption\"><br><\/figcaption><\/figure>\n<\/details>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>400 An unsuccessful access token response as per RFC6749<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>errorrequired<\/td><td>string Enum:&#8221;invalid_request&#8221;&#8221;invalid_client&#8221;&#8221;invalid_grant&#8221;&#8221;unauthorized_client&#8221;&#8221;unsupported_grant_type&#8221;&#8221;invalid_scope&#8221;<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_requestPayment\"><\/a><\/h2>\n\n\n\n<h2 class=\"wp-block-heading\">Request a payment or payout<\/h2>\n\n\n\n<p>Send a payment or payout. Successful payout requests will always return a 202 response.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations:<\/summary>\n<p><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<p><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Cko-Idempotency-Key<\/td><td>stringAn optional idempotency key for safely retrying payment requests.<\/td><\/tr><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Request a payment or payout.<\/p>\n\n\n\n<p><strong>Tabs:<\/strong><\/p>\n\n\n\n<ul>\n<li><strong>Payment<\/strong>: Standard payment request.<\/li>\n\n\n\n<li><strong>Payment Context<\/strong>: Use a payment context ID, etc.<\/li>\n\n\n\n<li><strong>Card Payout<\/strong>: Card payout request.<\/li>\n\n\n\n<li><strong>Bank Payout<\/strong>: Bank payout request.<\/li>\n<\/ul>\n\n\n\n<h5 class=\"wp-block-heading\">One of<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>PaymentRequestDto<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>currencyrequired<\/td><td>string = 3 characters The three-letter ISO currency code (required, 3 characters).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Source required &#8211; object &#8211; The source of the payment (e.g., card, bank, etc).<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>typerequired<\/td><td>stringType of payment source<\/td><\/tr><tr><td>number<\/td><td>string<\/td><\/tr><tr><td>expiry_month<\/td><td>number<\/td><\/tr><tr><td>expiry_year<\/td><td>number<\/td><\/tr><tr><td>cvv<\/td><td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n<\/details>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>amount<\/td><td>number &gt;= 0 The payment amount in the minor currency unit (e.g., cents). Omit or set to 0 to perform a card verification.<\/td><\/tr><tr><td>payment_type<\/td><td>string Default: &#8220;Regular&#8221; Enum:&#8221;Regular&#8221;&#8221;Recurring&#8221;&#8221;MOTO&#8221;&#8221;Installment&#8221;&#8221;PayLater&#8221;&#8221;Unscheduled&#8221;The type of payment. Required for cardholder-not-present payments (e.g., mail\/phone orders, MITs). For MITs, must NOT be &#8220;Regular&#8221;. Enum: &#8220;Regular&#8221;, &#8220;Recurring&#8221;, &#8220;MOTO&#8221;, &#8220;Installment&#8221;, &#8220;PayLater&#8221;, &#8220;Unscheduled&#8221;.<\/td><\/tr><tr><td>reference<\/td><td>string &lt;= 80 characters A reference to identify the payment (e.g., order number). Max 80 chars. See Payfac docs for per-scheme limits.<\/td><\/tr><tr><td>description<\/td><td>string &lt;= 100 characters A description of the payment (max 100 characters).<\/td><\/tr><tr><td>authorization_type<\/td><td>string Default: &#8220;Final&#8221; Enum:&#8221;Final&#8221;&#8221;Estimated&#8221;The authorization type. Enum: &#8220;Final&#8221;, &#8220;Estimated&#8221;.<\/td><\/tr><tr><td>capture<\/td><td>boolean Default: trueWhether to capture the payment (if applicable). Default: true.<\/td><\/tr><tr><td>capture_on<\/td><td>string &lt;date-time&gt; A timestamp (ISO 8601) for scheduled capture. Providing this sets capture to true.<\/td><\/tr><tr><td>merchant_initiated<\/td><td>booleanFlags the payment as a merchant-initiated transaction (MIT). Must be true for all MITs. If true, payment_type must not be &#8220;Regular&#8221;.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>201 Payment processed successfully<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>id<\/td><td>string<\/td><\/tr><tr><td>status<\/td><td>string<\/td><\/tr><tr><td>approved<\/td><td>boolean<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>202 Payment asynchronous or further action required<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>id<\/td><td>string<\/td><\/tr><tr><td>status<\/td><td>string<\/td><\/tr><tr><td>approved<\/td><td>boolean<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>401 Unauthorized<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>422 Invalid data was sent<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>429 Too many requests or duplicate request detected<br>502 Bad gateway<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_getPaymentDetails\"><\/a>Get payment details<\/h2>\n\n\n\n<p>Returns the details of the payment with the specified identifier string.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations:<\/summary>\n<p><em>bearer<\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<h5 class=\"wp-block-heading\">path Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string^(pay|sid)_(\\w{26})$The payment or payment session identifier<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<p>200 Payment retrieved successfully<br>Response Schema: application\/json<\/p>\n\n\n\n<h5 class=\"wp-block-heading\">One of<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Object<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>stringPayment unique identifier<\/td><\/tr><tr><td>requested_onrequired<\/td><td>string &lt;date-time&gt; The date\/time the payment was requested<\/td><\/tr><tr><td>amountrequired<\/td><td>integerThe original payment amount<\/td><\/tr><tr><td>currencyrequired<\/td><td>stringThe three-letter ISO currency code of the payment<\/td><\/tr><tr><td>statusrequired<\/td><td>string Enum:&#8221;Pending&#8221;&#8221;Authorized&#8221;&#8221;Card Verified&#8221;&#8221;Voided&#8221;&#8221;Partially Captured&#8221;&#8221;Captured&#8221;&#8221;Partially Refunded&#8221;&#8221;Refunded&#8221;&#8221;Declined&#8221;&#8221;Canceled&#8221;&#8221;Expired&#8221;&#8221;Paid&#8221;&#8221;Retry Scheduled&#8221;The status of the payment<\/td><\/tr><tr><td>approvedrequired<\/td><td>booleanWhether the payment was successful<\/td><\/tr><tr><td>_linksrequired<\/td><td>object &gt;= 2 properties The links related to the payment<\/td><\/tr><tr><td>source<\/td><td>objectThe source of the payment<\/td><\/tr><tr><td>destination<\/td><td>objectThe destination of the payment<\/td><\/tr><tr><td>amount_requested<\/td><td>integer or nullThe full amount from the original authorization, if a partial authorization was requested.<\/td><\/tr><tr><td>payment_type<\/td><td>string or null Default: &#8220;Regular&#8221; Enum:&#8221;Regular&#8221;&#8221;Recurring&#8221;&#8221;MOTO&#8221;&#8221;Installment&#8221;&#8221;PayLater&#8221;&#8221;Unscheduled&#8221;The payment type<\/td><\/tr><tr><td>payment_plan<\/td><td>object or nullThe details of a recurring subscription or installment<\/td><\/tr><tr><td>reference<\/td><td>string or nullYour reference for the payment<\/td><\/tr><tr><td>description<\/td><td>string or nullA description of the payment<\/td><\/tr><tr><td>expires_on<\/td><td>string or nullThe timestamp for when the authorization&#8217;s validity period expires<\/td><\/tr><tr><td>balances<\/td><td>object or nullThe payment balances<\/td><\/tr><tr><td>3ds<\/td><td>object or null3D Secure payment processing info<\/td><\/tr><tr><td>authentication<\/td><td>object or nullAuthentication info<\/td><\/tr><tr><td>risk<\/td><td>object or nullRisk assessment results<\/td><\/tr><tr><td>customer<\/td><td>object or nullThe customer to which this payment is linked<\/td><\/tr><tr><td>billing_descriptor<\/td><td>object or nullBilling descriptor<\/td><\/tr><tr><td>shipping<\/td><td>object or nullShipping details<\/td><\/tr><tr><td>payment_ip<\/td><td>string or nullThe IP address used to make the payment<\/td><\/tr><tr><td>sender<\/td><td>object or nullSender information<\/td><\/tr><tr><td>amount_allocations<\/td><td>Array of objects or nullThe sub-entities that the payment is being processed on behalf of<\/td><\/tr><tr><td>recipient<\/td><td>object or nullRecipient information<\/td><\/tr><tr><td>processing<\/td><td>object or nullProcessing data<\/td><\/tr><tr><td>items<\/td><td>Array of objects or nullOrder line items<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>metadata<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>object or null Additional metadata<\/td><\/tr><tr><td colspan=\"2\">property name*additional property any<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>eci<\/td><td>string or nullECI security level<\/td><\/tr><tr><td>scheme_id<\/td><td>string or nullScheme transaction identifier<\/td><\/tr><tr><td>actions<\/td><td>Array of objects or nullSummary of the payment&#8217;s actions<\/td><\/tr><tr><td>retry<\/td><td>object or nullAsync retry config<\/td><\/tr><tr><td>pan_type_processed<\/td><td>string or null Enum:&#8221;fpan&#8221;&#8221;dpan&#8221;Type of PAN used for the payment<\/td><\/tr><tr><td>cko_network_token_available<\/td><td>boolean or nullIf Checkout Network Token was available<\/td><\/tr><tr><td>instruction<\/td><td>object or nullPayment instruction details<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Object<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>stringPayout unique identifier<\/td><\/tr><tr><td>requested_onrequired<\/td><td>string &lt;date-time&gt; The date\/time the payout was requested<\/td><\/tr><tr><td>sourcerequired<\/td><td>objectThe source of the payout<\/td><\/tr><tr><td>destinationrequired<\/td><td>objectThe destination of the payout<\/td><\/tr><tr><td>amountrequired<\/td><td>integerThe original payout amount<\/td><\/tr><tr><td>currencyrequired<\/td><td>stringThe three-letter ISO currency code of the payout<\/td><\/tr><tr><td>reference<\/td><td>string or nullYour reference for the payout<\/td><\/tr><tr><td>billing_descriptor<\/td><td>object or nullDetails about the billing descriptor<\/td><\/tr><tr><td>statusrequired<\/td><td>string Enum:&#8221;Pending&#8221;&#8221;Paid&#8221;&#8221;Declined&#8221;&#8221;Returned&#8221;The status of the payout<\/td><\/tr><tr><td>approvedrequired<\/td><td>booleanWhether the authorization was successful<\/td><\/tr><tr><td>sender<\/td><td>object or nullInformation about the sender of the payment&#8217;s funds<\/td><\/tr><tr><td>instruction<\/td><td>object or nullDetails about the instruction for payouts to bank accounts<\/td><\/tr><tr><td>_linksrequired<\/td><td>object non-empty Links related to the payouts<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Object<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>stringThe unique identifier for the payout.<\/td><\/tr><tr><td>requested_onrequired<\/td><td>string &lt;date-time&gt; The UTC date and time the payout was requested.<\/td><\/tr><tr><td>processed_onrequired<\/td><td>string or null &lt;date-time&gt; The UTC date and time the payout was approved or declined.<\/td><\/tr><tr><td>sourcerequired<\/td><td>objectThe source of the payout.<\/td><\/tr><tr><td>destinationrequired<\/td><td>objectThe payout destination.<\/td><\/tr><tr><td>amountrequired<\/td><td>integerThe amount to be paid out to the recipient.<\/td><\/tr><tr><td>currencyrequired<\/td><td>stringThe destination currency, as a three-letter ISO 4217 code.<\/td><\/tr><tr><td>statusrequired<\/td><td>string Enum:&#8221;pending&#8221;&#8221;approved&#8221;&#8221;declined&#8221;The status of the payout.<\/td><\/tr><tr><td>linksrequired<\/td><td>objectThe links related to the payment.<\/td><\/tr><tr><td>reference<\/td><td>string or null &lt;= 50 characters An internal reference to identify the payout.<\/td><\/tr><tr><td>billing_descriptor<\/td><td>object or nullDetails about the billing descriptor.<\/td><\/tr><tr><td>sender<\/td><td>object or nullDetails about the payout sender.<\/td><\/tr><tr><td>scheme_id<\/td><td>string or nullThe scheme transaction identifier.<\/td><\/tr><tr><td>instruction<\/td><td>object or nullDetails about the instruction for the payout.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>metadata<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>object or null A set of key-value pairs to attach to the payment.<\/td><\/tr><tr><td colspan=\"2\">property name*additional property any<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n<\/details>\n\n\n\n<p>401 Unauthorized<br>404 Payment not found<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_getPaymentActions\"><\/a>Get payment actions<\/h2>\n\n\n\n<p>Returns all the actions associated with a payment ordered by processing date in descending order (latest first).<\/p>\n\n\n\n<p><\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations<\/summary>\n<p><em>bearer<\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">path Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string^(pay)_(\\w{26})$The payment identifier<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>200 Payment actions retrieved successfully<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Cko-Request-Id<\/td><td>stringThe unique identifier of the request<\/td><\/tr><tr><td>Cko-Version<\/td><td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<p>One of<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>PaymentActionDto<\/summary>\n<p>Array<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string<\/td><\/tr><tr><td>typerequired<\/td><td>string Enum:&#8221;Authorization&#8221;&#8221;Card Verification&#8221;&#8221;Void&#8221;&#8221;Capture&#8221;&#8221;Refund&#8221;&#8221;Payout&#8221;&#8221;Return&#8221;<\/td><\/tr><tr><td>amountrequired<\/td><td>number<\/td><\/tr><tr><td>response_coderequired<\/td><td>string<\/td><\/tr><tr><td>processed_onrequired<\/td><td>string &lt;date-time&gt;<\/td><\/tr><tr><td>approvedrequired<\/td><td>boolean<\/td><\/tr><tr><td>auth_code<\/td><td>string<\/td><\/tr><tr><td>response_summary<\/td><td>string<\/td><\/tr><tr><td>authorization_type<\/td><td>string Enum:&#8221;Final&#8221;&#8221;Estimated&#8221;&#8221;Incremental&#8221;<\/td><\/tr><tr><td>reference<\/td><td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>amount_allocations<\/summary>\n<p>Array<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>id required<\/td><td>string<\/td><\/tr><tr><td>amount required<\/td><td>number<\/td><\/tr><tr><td>reference<\/td><td>string<\/td><\/tr><tr><td>commission<\/td><td>object<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>processing<\/td><td>object<\/td><\/tr><tr><td>items<\/td><td>Array of objects<\/td><\/tr><tr><td>metadata<\/td><td>object<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n<\/details>\n\n\n\n<p>401 Unauthorized<br>404 Payment not found<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_incrementAuthorization\"><\/a>Increment authorization<\/h2>\n\n\n\n<p>Request an incremental authorization to increase the authorization amount or extend the authorization&#8217;s validity period.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations<\/summary>\n<p><em>bearer<\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<p><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">path Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string^(pay)_(\\w{26})$The payment identifier<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><tr><td>Cko-Idempotency-Key<\/td><td>stringAn optional idempotency key for safely retrying payment requests.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Increment authorization request body<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>amount<\/td><td>number &gt;= 0 The amount to increase the authorization by. Omit or set to 0 to only extend the validity period.<\/td><\/tr><tr><td>reference<\/td><td>stringA reference you can later use to identify this authorization request.<\/td><\/tr><tr><td>metadata<\/td><td>objectA set of key-value pairs to attach to the authorization request. Only one level of depth is allowed.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>201 Authorization processed successfully<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Cko-Request-Id<\/td><td>stringThe unique identifier of the request<\/td><\/tr><tr><td>Cko-Version<\/td><td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>action_idrequired<\/td><td>stringThe unique identifier for the action performed against this payment<\/td><\/tr><tr><td>amountrequired<\/td><td>numberThe payment amount<\/td><\/tr><tr><td>currencyrequired<\/td><td>string = 3 characters The three-letter ISO currency code of the payment<\/td><\/tr><tr><td>approvedrequired<\/td><td>booleanWhether or not the authorization was successful<\/td><\/tr><tr><td>statusrequired<\/td><td>string Enum:&#8221;Authorized&#8221;&#8221;Declined&#8221;The status of the payment<\/td><\/tr><tr><td>response_coderequired<\/td><td>stringThe Gateway response code<\/td><\/tr><tr><td>processed_onrequired<\/td><td>string &lt;date-time&gt; The date\/time the payment was processed<\/td><\/tr><tr><td>_linksrequired<\/td><td>objectThe links related to the payment<\/td><\/tr><tr><td>auth_code<\/td><td>stringThe acquirer authorization code if the payment was authorized<\/td><\/tr><tr><td>response_summary<\/td><td>stringThe Gateway response summary<\/td><\/tr><tr><td>expires_on<\/td><td>stringThe timestamp (ISO 8601 code) for when the authorization&#8217;s validity period ends<\/td><\/tr><tr><td>balances<\/td><td>objectThe payment balances<\/td><\/tr><tr><td>reference<\/td><td>stringYour reference for the payment<\/td><\/tr><tr><td>processing<\/td><td>objectReturns information related to the processing of the payment<\/td><\/tr><tr><td>eci<\/td><td>stringThe final Electronic Commerce Indicator (ECI) security level used to authorize the payment<\/td><\/tr><tr><td>scheme_id<\/td><td>stringThe scheme transaction identifier<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>401 Unauthorized<br>403 Incremental authorization not allowed<br>404 Payment not found<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>422 Invalid data was sent<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>502 Bad gateway<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_cancelScheduledRetry\"><\/a>Cancel a scheduled retry<\/h2>\n\n\n\n<p>Cancels an upcoming retry, if there is one scheduled. Cancellation requests are processed asynchronously. You can use workflows to be notified if the cancellation is successful.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations<\/summary>\n<p><em>bearer<\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<p><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">path Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string^(pay)_(\\w{26})$The unique payment identifier.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><tr><td>Cko-Idempotency-Key<\/td><td>stringAn optional idempotency key for safely retrying payment requests.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Cancel retry request body<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>reference<\/td><td>string &lt;= 80 characters A reference you can later use to identify this cancellation request (max 80 characters).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>202 Cancellation accepted<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Cko-Request-Id<\/td><td>stringThe unique identifier of the request<\/td><\/tr><tr><td>Cko-Version<\/td><td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>action_idrequired<\/td><td>stringThe unique identifier for the cancellation action.<\/td><\/tr><tr><td>referencerequired<\/td><td>stringYour reference for the cancellation request.<\/td><\/tr><tr><td>_linksrequired<\/td><td>object &gt;= 2 properties The links related to the cancellation.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>401 Unauthorized<br>403 Cancellation not allowed<br>404 Payment not found<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>422 Invalid data sent<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>502 Bad gateway<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_capturePayment\"><\/a>Capture a payment<\/h2>\n\n\n\n<p>Captures a payment if supported by the payment method. For card payments, capture requests are processed asynchronously. You can use workflows to be notified if the capture is successful.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations:<\/summary>\n<p><em>bearer<\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<p><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">path Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string^(pay)_(\\w{26})$The payment identifier<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><tr><td>Cko-Idempotency-Key<\/td><td>stringAn optional idempotency key for safely retrying payment requests.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Capture payment request body<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>amount<\/td><td>number &gt;= 0 The amount to capture. If not specified, the full payment amount will be captured.<\/td><\/tr><tr><td>capture_type<\/td><td>string Default: &#8220;Final&#8221; Enum:&#8221;NonFinal&#8221;&#8221;Final&#8221;The type of capture. If set to Final, the remaining available-to-capture balance will be voided.<\/td><\/tr><tr><td>reference<\/td><td>string &lt;= 80 characters A reference you can later use to identify this capture request (max 80 chars, Amex: 30 chars).<\/td><\/tr><tr><td>customer<\/td><td>objectThe customer&#8217;s details. Required if source.type is tamara.<\/td><\/tr><tr><td>description<\/td><td>string &lt;= 100 characters A description of the payment (max 100 chars).<\/td><\/tr><tr><td>billing_descriptor<\/td><td>objectBilling descriptor for the capture.<\/td><\/tr><tr><td>shipping<\/td><td>objectThe shipping details.<\/td><\/tr><tr><td>items<\/td><td>Array of objectsThe order line items.<\/td><\/tr><tr><td>amount_allocations<\/td><td>Array of objectsThe sub-entities that the payment is being processed on behalf of.<\/td><\/tr><tr><td>processing<\/td><td>objectProcessing settings for the capture.<\/td><\/tr><tr><td>metadata<\/td><td>objectA set of key-value pairs to attach to the capture request. Only one level of depth is allowed.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>202 Capture accepted<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Cko-Request-Id<\/td><td>stringThe unique identifier of the request<\/td><\/tr><tr><td>Cko-Version<\/td><td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>action_idrequired<\/td><td>stringThe unique identifier for the capture action.<\/td><\/tr><tr><td>referencerequired<\/td><td>stringYour reference for the capture request.<\/td><\/tr><tr><td>_linksrequired<\/td><td>object &gt;= 2 properties The links related to the capture.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>401 Unauthorized<br>403 Capture not allowed<br>404 Payment not found<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>422 Invalid data sent<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>502 Bad gateway<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_refundPayment\"><\/a>Refund a payment<\/h2>\n\n\n\n<p>Refunds a payment if supported by the payment method. For card payments, refund requests are processed asynchronously. You can use workflows to be notified if the refund is successful.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations:<\/summary>\n<p><em>bearer<\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<p><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">path Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string^(pay)_(\\w{26})$The payment identifier<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><tr><td>Cko-Idempotency-Key<\/td><td>stringAn optional idempotency key for safely retrying payment requests.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Refund payment request body<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>site_identifierrequired<\/td><td>stringIdentifies your client site.<\/td><\/tr><tr><td>timestamprequired<\/td><td>stringThe Unix Epoch time of the call.<\/td><\/tr><tr><td>versionrequired<\/td><td>stringThe version of the API.<\/td><\/tr><tr><td>signaturerequired<\/td><td>stringThe HMAC signature for the request.<\/td><\/tr><tr><td>pnm_payment_identifierrequired<\/td><td>stringThe unique, Payfac-created identifier for this payment.<\/td><\/tr><tr><td>refund_amount<\/td><td>numberThe amount to be refunded. This parameter should only be included for partial-amount refunds.<\/td><\/tr><tr><td>refund_currency<\/td><td>stringThe currency for the refund (e.g., USD).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>202 Refund accepted<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Cko-Request-Id<\/td><td>stringThe unique identifier of the request<\/td><\/tr><tr><td>Cko-Version<\/td><td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>action_idrequired<\/td><td>stringThe unique identifier for the refund action.<\/td><\/tr><tr><td>referencerequired<\/td><td>stringYour reference for the refund request.<\/td><\/tr><tr><td>_linksrequired<\/td><td>object &gt;= 2 properties The links related to the refund.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>401 Unauthorized<br>403 Refund not allowed<br>404 Payment not found<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>422 Invalid data sent<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>502 Bad gateway<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_reversePayment\"><\/a>Reverse a payment<\/h2>\n\n\n\n<p>Beta<\/p>\n\n\n\n<p>You can reverse a payment to return funds back to the customer, without having to manage the appropriate action to take based on the payment&#8217;s status.<\/p>\n\n\n\n<p>Depending on the payment&#8217;s current status, requesting a payment reversal will automatically perform one of the following actions:<\/p>\n\n\n\n<ul>\n<li>Fully refund a captured payment.<\/li>\n\n\n\n<li>Void an authorized payment.<\/li>\n\n\n\n<li>Cancel retries on a payment with pending retries.<\/li>\n\n\n\n<li>Refund partially captured funds and void any remaining authorization amount.<\/li>\n\n\n\n<li>Refund all captured funds from a partial refund and void any remaining authorization amount.<\/li>\n<\/ul>\n\n\n\n<p>You can only request a payment reversal for card authorizations, captures, or an authorisation attempt that has a retry scheduled.<\/p>\n\n\n\n<p>You cannot reverse a payment that has already been fully refunded, voided, or cancelled. If you attempt to do so, you&#8217;ll receive a 204 &#8211; No Content response code.<\/p>\n\n\n\n<p>For card payments, reversal requests are processed asynchronously. You can use workflows to be notified when the reversal action completes. Note that the notification will depend on the reversal action taken; for example, for voided payments you will receive a payment_voided notification, and so on.<\/p>\n\n\n\n<p>The reversal request will be rejected with a 403 &#8211; Forbidden response code if the payment cannot be reversed. This may happen if:<\/p>\n\n\n\n<ul>\n<li>the payment is not a card payment<\/li>\n\n\n\n<li>the payment is not authorized and is still in the process of 3D Secure (3DS) authentication<\/li>\n<\/ul>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations:<\/summary>\n<p><em>bearer<\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<p><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">path Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string^(pay)_(\\w{26})$The unique identifier for the payment.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><tr><td>Cko-Idempotency-Key<\/td><td>stringAn optional idempotency key for safely retrying payment requests.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Reverse payment request body<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>site_identifierrequired<\/td><td>stringIdentifies your client site.<\/td><\/tr><tr><td>timestamprequired<\/td><td>stringThe Unix Epoch time of the call.<\/td><\/tr><tr><td>versionrequired<\/td><td>stringThe version of the API.<\/td><\/tr><tr><td>signaturerequired<\/td><td>stringThe HMAC signature for the request.<\/td><\/tr><tr><td>pnm_payment_identifierrequired<\/td><td>stringThe unique, Payfac-created identifier for this payment.<\/td><\/tr><tr><td>agent_identifier<\/td><td>stringThe name or ID of the client agent cancelling the payment.<\/td><\/tr><tr><td>void_if_not_settled<\/td><td>stringSet this parameter to true to completely cancel a payment that has not been settled.<\/td><\/tr><tr><td>refund_amount<\/td><td>numberThe amount to be refunded. This parameter should only be included for partial-amount refunds.<\/td><\/tr><tr><td>refund_currency<\/td><td>stringThe currency for the refund (e.g., USD).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>202 Reversal accepted<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Cko-Request-Id<\/td><td>stringThe unique identifier of the request<\/td><\/tr><tr><td>Cko-Version<\/td><td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>action_idrequired<\/td><td>stringThe unique identifier for the payment reversal action.<\/td><\/tr><tr><td>referencerequired<\/td><td>stringA unique reference for the payment reversal.<\/td><\/tr><tr><td>_linksrequired<\/td><td>objectLinks related to the payment reversal.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>204 Payment has already been reversed<br>401 Unauthorized<br>403 Refund not allowed<br>404 Payment not found<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>422 Invalid data sent<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>502 Bad gateway<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_voidPayment\"><\/a>Void a payment<\/h2>\n\n\n\n<p>Voids a payment if supported by the payment method.<\/p>\n\n\n\n<p>For card payments, void requests are processed asynchronously. You can use workflows to be notified if the void is successful.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations<\/summary>\n<p><em>bearer or <\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<h5 class=\"wp-block-heading\">path Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>string^(pay)_(\\w{26})$The payment identifier<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><tr><td>Cko-Idempotency-Key<\/td><td>stringAn optional idempotency key for safely retrying payment requests.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Void payment request body<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>reference<\/td><td>string &lt;= 80 characters A reference you can later use to identify this void request (max 80 chars, Amex: 30 chars).<\/td><\/tr><tr><td>metadata<\/td><td>objectA set of key-value pairs to attach to the void request. Only one level of depth is allowed.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>202 Void accepted<\/summary>\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Cko-Request-Id<\/td><td>stringThe unique identifier of the request<\/td><\/tr><tr><td>Cko-Version<\/td><td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>action_idrequired<\/td><td>stringThe unique identifier for the void action.<\/td><\/tr><tr><td>referencerequired<\/td><td>stringYour reference for the void request.<\/td><\/tr><tr><td>_linksrequired<\/td><td>object &gt;= 2 properties The links related to the void.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>401 Unauthorized<br>403 Void not allowed<br>404 Payment not found<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>422 Invalid data sent<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>502 Bad gateway<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_searchPayments\"><\/a>Search payments<\/h2>\n\n\n\n<p>Beta<\/p>\n\n\n\n<p>Search and filter through your payment data to retrieve payments that match your query.<\/p>\n\n\n\n<p>If a search returns more results than the value specified in limit, additional results are returned in a new page. A link to the next page of results is returned in the response&#8217;s _links.next.href field.<\/p>\n\n\n\n<p>For more information on search syntax, see the Search and filter payments documentation.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations:<\/summary>\n<p><em>bearer or <\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Request Body schema: application\/json<\/h5>\n\n\n\n<p>Search payments request body<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>queryrequired<\/td><td>string &lt;= 1024 characters The query string.<\/td><\/tr><tr><td>limit<\/td><td>number [ 1 .. 1000 ] Default: 10The number of results to return per page.<\/td><\/tr><tr><td>from<\/td><td>stringThe UTC date and time for the query start in ISO 8601 format. Required if &#8220;to&#8221; is provided.<\/td><\/tr><tr><td>to<\/td><td>stringThe UTC date and time for the query end in ISO 8601 format. Required if &#8220;from&#8221; is provided.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">Responses<\/h5>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>202 Successful search<\/summary>\n<p>Response Schema: application\/json<\/p>\n\n\n\n<p><strong>One of<\/strong><\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Object<\/summary>\n<p>Array<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>stringThe unique identifier of the payment.<\/td><\/tr><tr><td>requested_onrequired<\/td><td>stringThe UTC date and time the payment was requested, in ISO 8601 format.<\/td><\/tr><tr><td>sourcerequired<\/td><td>objectThe source of the payment.<\/td><\/tr><tr><td>amountrequired<\/td><td>numberThe original payment amount.<\/td><\/tr><tr><td>amount_requested<\/td><td>numberThe full amount from the original authorization, if a partial authorization was requested.<\/td><\/tr><tr><td>currencyrequired<\/td><td>stringThe currency of the payment, as a three-letter ISO currency code.<\/td><\/tr><tr><td>payment_type<\/td><td>stringThe type of payment.<\/td><\/tr><tr><td>processing_channel_id<\/td><td>stringThe unique identifier of the processing channel that was used for the payment.<\/td><\/tr><tr><td>reference<\/td><td>stringThe reference for the payment.<\/td><\/tr><tr><td>statusrequired<\/td><td>stringThe status of the payment.<\/td><\/tr><tr><td>balances<\/td><td>objectThe payment&#8217;s balances.<\/td><\/tr><tr><td>3ds<\/td><td>objectDetails relating to payments processed with 3D Secure (3DS).<\/td><\/tr><tr><td>risk<\/td><td>objectThe payment&#8217;s risk assessment results.<\/td><\/tr><tr><td>customer<\/td><td>objectThe customer linked to the payment.<\/td><\/tr><tr><td>billing_descriptor<\/td><td>objectAn optional description displayed on the customer&#8217;s statement identifying a purchase.<\/td><\/tr><tr><td>metadata<\/td><td>objectA set of key-value pairs attached to the payout, used to store additional information.<\/td><\/tr><tr><td>actions<\/td><td>Array of objectsThe actions for the payment.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Object<\/summary>\n<p>Array<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>stringThe unique identifier of the payout.<\/td><\/tr><tr><td>requested_onrequired<\/td><td>stringThe UTC date and time the payment was requested, in ISO 8601 format.<\/td><\/tr><tr><td>destinationrequired<\/td><td>objectThe destination of the payout.<\/td><\/tr><tr><td>amountrequired<\/td><td>numberThe original payout amount.<\/td><\/tr><tr><td>currencyrequired<\/td><td>stringThe currency of the payout, as a three-letter ISO currency code.<\/td><\/tr><tr><td>reference<\/td><td>stringThe reference for the payout.<\/td><\/tr><tr><td>billing_descriptor<\/td><td>objectThe billing descriptor details.<\/td><\/tr><tr><td>statusrequired<\/td><td>stringThe status of the payout.<\/td><\/tr><tr><td>processing_channel_id<\/td><td>stringThe unique identifier of the processing channel that was used for the payout.<\/td><\/tr><tr><td>sender<\/td><td>objectThe payout sender&#8217;s details.<\/td><\/tr><tr><td>actions<\/td><td>Array of objectsThe actions for the payout.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Object<\/summary>\n<p>Array<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>idrequired<\/td><td>stringThe unique identifier of the payout.<\/td><\/tr><tr><td>requested_onrequired<\/td><td>stringThe UTC date and time the payment was requested, in ISO 8601 format.<\/td><\/tr><tr><td>destinationrequired<\/td><td>objectThe destination of the payout.<\/td><\/tr><tr><td>amountrequired<\/td><td>numberThe original payout amount.<\/td><\/tr><tr><td>currencyrequired<\/td><td>stringThe currency of the payout, as a three-letter ISO currency code.<\/td><\/tr><tr><td>reference<\/td><td>stringThe reference for the payout.<\/td><\/tr><tr><td>billing_descriptor<\/td><td>objectThe billing descriptor details.<\/td><\/tr><tr><td>statusrequired<\/td><td>stringThe status of the payout.<\/td><\/tr><tr><td>processing_channel_id<\/td><td>stringThe unique identifier of the processing channel that was used for the payout.<\/td><\/tr><tr><td>sender<\/td><td>objectThe payout sender&#8217;s details.<\/td><\/tr><tr><td>metadata<\/td><td>objectA set of key-value pairs attached to the payout, used to store additional information.<\/td><\/tr><tr><td>actions<\/td><td>Array of objectsThe actions for the payout.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n<\/details>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>400 Invalid input<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<p>401 Unauthorized<br>403 Forbidden<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>422 Invalid data sent<\/summary>\n<h5 class=\"wp-block-heading\">Response Schema: application\/json<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>request_idrequired<\/td><td>stringThe unique request identifier.<\/td><\/tr><tr><td>error_typerequired<\/td><td>stringThe error type.<\/td><\/tr><tr><td>error_codesrequired<\/td><td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"file:\/\/\/C:\/Users\/Administrator\/Downloads\/payfac-doc (1).htm#tag\/Payment\/operation\/CheckoutController_getPaymentsList\"><\/a><\/h2>\n\n\n\n<h2 class=\"wp-block-heading\">Get payment lists<\/h2>\n\n\n\n<p>Returns a list of your business&#8217; payments that match the specified reference. Results are returned in reverse chronological order, with the most recent payments shown first.<\/p>\n\n\n\n<details class=\"wp-block-details is-layout-flow wp-block-details-is-layout-flow\"><summary>Authorizations<\/summary>\n<p><em>bearer or <\/em><em>bearer<\/em><\/p>\n\n\n\n<h5 class=\"wp-block-heading\"><\/h5>\n\n\n\n<h5 class=\"wp-block-heading\">HTTP: bearer<\/h5>\n\n\n\n<p><strong>HTTP Authorization Scheme: <\/strong><code>bearer<\/code><\/p>\n\n\n\n<p><strong>Bearer format: <\/strong><code>JWT<\/code><\/p>\n<\/details>\n\n\n\n<h5 class=\"wp-block-heading\">query Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>referencerequired<\/td><td>stringA reference, such as an order ID, that can be used to identify the payment<\/td><\/tr><tr><td>limit<\/td><td>number [ 1 .. 100 ] Default: 10 Example: limit=10The numbers of results to retrieve<\/td><\/tr><tr><td>skip<\/td><td>number &gt;= 0 Default: 0 Example: skip=0The number of results to skip<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h5 class=\"wp-block-heading\">header Parameters<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>Authorizationrequired<\/td><td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p>202 Payments retrieved successfully<br>401 Unauthorized<br>422 Unprocessable paging<\/p>","protected":false},"excerpt":{"rendered":"<p>Get access token using client credentials Request Body schema: application\/json Token request parameters grant_typerequired string Value:&#8221;client_credentials&#8221;Must be &#8220;client_credentials&#8221; client_idrequired stringAccess [&hellip;]<\/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":3138,"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\/876"}],"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=876"}],"version-history":[{"count":5,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/876\/revisions"}],"predecessor-version":[{"id":885,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/876\/revisions\/885"}],"wp:attachment":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/media?parent=876"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/doc_category?post=876"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/doc_tag?post=876"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}