Financial actions API
Beta
Last updated: February 1, 2023
Use our Financial actions
API to query your financial action data and perform near real-time reconciliation.
With this API, you can retrieve financial actions for a specific payment or action during its lifecycle. This gives you full visibility of the financial impact shortly after a payment is successfully processed.
You can query your financial action data by payment ID or action ID.
Information
To learn more, reach out to your Customer Success Manager or support@checkout.com.
Retrieve financial actions
Use this endpoint to get a list of financial actions related to the specified payment_id
or action_id
. Either payment_id
or action_id
are required in the request.
For the full API specification, see the API reference.
get
https://api.checkout.com/financial-actions
Use the following query parameters to filter and refine your search query:
Parameter | Description |
---|---|
conditional | The ID of the payment you want to retrieve financial actions for. Required if |
conditional | The ID of the action you want to retrieve financial actions for. Required if |
optional | The number of results to retrieve per page. The maximum and default value is If the value provided is lower than the total number of results, you'll need to send the response's |
optional | A token used for pagination when a response contains results across multiple pages. If the results for a query are split across multiple pages, the response returns the |
Retrieve financial actions by payment ID
Use the following details to set up a request using a payment_id
.
Request example
1curl --location --request GET 'https://api.checkout.com/financial-actions?payment_id=pay_217gribvy455er6q09hw22qbzt' \2--header 'Authorization: Bearer sk_sbox_wjvrysklsqjmrhn3yoexnshsl72'
Response example
1{2"count": 2,3"data": [4{5"payment_id": "pay_217gribvy455er6q09hw22qbzt",6"action_id": "act_1zmrz19qsltk92cqpc3b9sc50r",7"action_type": "Capture",8"entity_id": "ent_zxmc2csd961nfd2mcwzkvdgmpb",9"currency_account_id": "ca_2x0cfv99yjihgghdsj3eusewlu",10"processed_on": "2022-10-31T01:03:52.5596342Z",11"requested_on": "2022-10-31T01:03:51.192297",12"payment_method": "VISA",13"processing_channel_id": "pc_9zrekqnp5r9lvdjfwmcb971lnp",14"reference": "CAP-111-111",15"mid": "123456",16"response_code": "10000",17"response_description": "Approved",18"region": "Domestic",19"card_type": "Debit",20"card_category": "Consumer",21"issuer_country": "US",22"merchant_category_code": "7372",23"breakdown": [24{25"breakdown_type": "Capture",26"fx_rate_applied": 1,27"holding_currency": "USD",28"holding_currency_amount": 100,29"processing_currency": "USD",30"processing_currency_amount": 100,31"transaction_currency": "USD",32"transaction_currency_amount": 100,33"processing_to_transaction_currency_fx_rate": 1,34"transaction_to_holding_currency_fx_rate": 135},36{37"breakdown_type": "Scheme Fixed Fee",38"fx_rate_applied": 1,39"holding_currency": "USD",40"holding_currency_amount": -0.5654409,41"processing_currency": "USD",42"processing_currency_amount": -0.5654409,43"transaction_currency": "USD",44"transaction_currency_amount": -0.5654409,45"processing_to_transaction_currency_fx_rate": 1,46"transaction_to_holding_currency_fx_rate": 147},48{49"breakdown_type": "Scheme Variable Fee",50"fx_rate_applied": 1,51"holding_currency": "USD",52"holding_currency_amount": -0.2748,53"processing_currency": "USD",54"processing_currency_amount": -0.2748,55"transaction_currency": "USD",56"transaction_currency_amount": -0.2748,57"processing_to_transaction_currency_fx_rate": 1,58"transaction_to_holding_currency_fx_rate": 159}60]61},62{63"payment_id": "pay_217gribvy455er6q09hw22qbzt",64"action_id": "act_184gribvy455er6q09hw22qbzt",65"action_type": "Authorization",66"entity_id": "ent_zxmc2csd961nfd2mcwzkvdgmpb",67"currency_account_id": "ca_2x0cfv99yjihgghdsj3eusewlu",68"processed_on": "2022-10-31T01:03:45.4396342Z",69"requested_on": "2022-10-31T01:03:45.112297",70"payment_method": "VISA",71"processing_channel_id": "pc_9zrekqnp5r9lvdjfwmcb971lnp",72"reference": "AUT-111-111",73"mid": "123456",74"response_code": "10000",75"response_description": "Approved",76"region": "Domestic",77"card_type": "Debit",78"card_category": "Consumer",79"issuer_country": "US",80"merchant_category_code": "7372",81"breakdown": [82{83"breakdown_type": "Gateway Fixed Fee",84"fx_rate_applied": 1,85"holding_currency": "USD",86"holding_currency_amount": -0.022,87"processing_currency": "USD",88"processing_currency_amount": -0.022,89"transaction_currency": "USD",90"transaction_currency_amount": -0.022,91"processing_to_transaction_currency_fx_rate": 1,92"transaction_to_holding_currency_fx_rate": 193},94{95"breakdown_type": "Scheme Fixed Fee",96"fx_rate_applied": 1,97"holding_currency": "USD",98"holding_currency_amount": -0.0027319,99"processing_currency": "USD",100"processing_currency_amount": -0.0027319,101"transaction_currency": "USD",102"transaction_currency_amount": -0.0027319,103"processing_to_transaction_currency_fx_rate": 1,104"transaction_to_holding_currency_fx_rate": 1105}106]107}108],109"_links": {110"self": {111"href": "https://api.checkout.com/financial-actions?pay_217gribvy455er6q09hw22qbzt"112}113}114}
Retrieve financial actions by action ID
Use the following details to set up a request using an action_id
.
Request example
1curl --location --request GET 'https://api.checkout.com/financial-actions?action_id=act_184gribvy455er6q09hw22qbzt' \2--header 'Authorization: Bearer sk_sbox_wjvrysklsqjmrhn3yoexnshsl72'
Response example
1{2"count": 1,3"data": [4{5"payment_id": "pay_217gribvy455er6q09hw22qbzt",6"action_id": "act_184gribvy455er6q09hw22qbzt",7"action_type": "Authorization",8"entity_id": "ent_zxmc2csd961nfd2mcwzkvdgmpb",9"currency_account_id": "ca_2x0cfv99yjihgghdsj3eusewlu",10"processed_on": "2022-10-31T01:03:45.4396342Z",11"requested_on": "2022-10-31T01:03:45.112297",12"payment_method": "VISA",13"processing_channel_id": "pc_9zrekqnp5r9lvdjfwmcb971lnp",14"reference": "AUT-111-111",15"mid": "123456",16"response_code": "10000",17"response_description": "Approved",18"region": "Domestic",19"card_type": "Debit",20"card_category": "Consumer",21"issuer_country": "US",22"merchant_category_code": "7372",23"breakdown": [24{25"breakdown_type": "Gateway Fixed Fee",26"fx_rate_applied": 1,27"holding_currency": "USD",28"holding_currency_amount": -0.022,29"processing_currency": "USD",30"processing_currency_amount": -0.022,31"transaction_currency": "USD",32"transaction_currency_amount": -0.022,33"processing_to_transaction_currency_fx_rate": 1,34"transaction_to_holding_currency_fx_rate": 135},36{37"breakdown_type": "Scheme Fixed Fee",38"fx_rate_applied": 1,39"holding_currency": "USD",40"holding_currency_amount": -0.0027319,41"processing_currency": "USD",42"processing_currency_amount": -0.0027319,43"transaction_currency": "USD",44"transaction_currency_amount": -0.0027319,45"processing_to_transaction_currency_fx_rate": 1,46"transaction_to_holding_currency_fx_rate": 147}48]49}50],51"_links": {52"self": {53"href": "https://api.checkout.com/financial-actions?action_id=act_184gribvy455er6q09hw22qbzt"54}55}56}