# Payment Intents

Payment Intents help you manage the process of collecting payments from your customers. We recommend creating one Payment Intent per order or customer session in your system. This allows you to track the payment history for a specific session.

Throughout its lifecycle, a Payment Intent moves through various statuses as it interacts with Paytree to handle authentication steps and, ultimately, to complete a successful charge, if applicable.

### Create Payment Intent

{% hint style="warning" %}
Do not send sensitive information, such as card holder data to our API. The "card" object is available for exclusive use to a limited number of customers and requires approval from our compliance team.
{% endhint %}

This method creates a new Payment Intent, which initiates the payment process for a customer, allowing you to collect payment details and manage the payment flow.

When creating a new payment intent request, you can pass the following identifiers used in callbacks to correlate our transaction with your local records.

* `transaction_ref` - Unique transaction reference from your system, for example, an Order ID. Any requests with a previously used `transaction_ref` will be rejected.
* `client_ref` - Unique identifier used to reference your client, this can be your customer ID or email address for example.
* `notification_url` - A callback url where requests will be made every time a status change is triggered.

## POST /v1/transaction/payment\_intent/

>

```json
{"openapi":"3.0.3","info":{"title":"Secured Checkout API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PaymentIntentCreateRequest":{"type":"object","properties":{"transaction_ref":{"type":"string","minLength":1,"maxLength":128},"client_ref":{"type":"string","minLength":1,"maxLength":128},"amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$"},"amount_currency":{"$ref":"#/components/schemas/AmountCurrencyEnum"},"method":{"allOf":[{"$ref":"#/components/schemas/MethodEnum"}],"default":"card"},"card":{"$ref":"#/components/schemas/CardRequest"},"customer":{"$ref":"#/components/schemas/CustomerRequest"},"address":{"$ref":"#/components/schemas/AddressRequest"},"session":{"$ref":"#/components/schemas/SessionRequest"},"callback":{"$ref":"#/components/schemas/CallbackRequest"},"metadata":{},"force_route":{"type":"string","format":"uuid"},"order_items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemRequest"}}},"required":["address","amount","amount_currency","callback","client_ref","customer","session","transaction_ref"]},"AmountCurrencyEnum":{"enum":["AED","AUD","BHD","CAD","CLP","CZK","DKK","EUR","GBP","HKD","KWD","NOK","NZD","OMR","PHP","PLN","QAR","SAR","SEK","USD","ZAR"],"type":"string","description":"* `AED` - AED د.إ\n* `AUD` - AUD $\n* `BHD` - BHD .د.ب\n* `CAD` - CAD $\n* `CLP` - CLP $\n* `CZK` - CZK Kč\n* `DKK` - DKK kr.\n* `EUR` - EUR €\n* `GBP` - GBP £\n* `HKD` - HKD $\n* `KWD` - KWD د.ك\n* `NOK` - NOK kr\n* `NZD` - NZD $\n* `OMR` - OMR ﷼\n* `PHP` - PHP ₱\n* `PLN` - PLN zł\n* `QAR` - QAR ﷼\n* `SAR` - SAR ﷼\n* `SEK` - SEK kr\n* `USD` - USD $\n* `ZAR` - ZAR R"},"MethodEnum":{"enum":["card","crypto","wire","paypal","klarna","ideal","bancontact","trustly","kakaopay","p24","blik"],"type":"string","description":"* `card` - Card\n* `crypto` - Crypto\n* `wire` - Wire\n* `paypal` - Paypal\n* `klarna` - Klarna\n* `ideal` - Ideal\n* `bancontact` - Bancontact\n* `trustly` - Trustly\n* `kakaopay` - KakaoPay\n* `p24` - P24\n* `blik` - Blik"},"CardRequest":{"type":"object","properties":{"number":{"type":"string","minLength":15,"maxLength":16},"exp_month":{"type":"string","minLength":1,"maxLength":2},"exp_year":{"type":"string","minLength":1,"maxLength":4},"cvc":{"type":"string","minLength":1,"maxLength":4}}},"CustomerRequest":{"type":"object","properties":{"first_name":{"type":"string","minLength":1,"maxLength":64},"last_name":{"type":"string","minLength":1,"maxLength":64},"email":{"type":"string","format":"email","minLength":1},"phone":{"type":"string","minLength":1,"maxLength":32}},"required":["email","first_name","last_name"]},"AddressRequest":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":128},"city":{"type":"string","minLength":1,"maxLength":64},"state":{"type":"string","minLength":1,"maxLength":64},"zip":{"type":"string","minLength":1,"maxLength":32},"country":{"$ref":"#/components/schemas/CountryEnum"}},"required":["country"]},"CountryEnum":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CK","CR","CI","HR","CU","CW","CY","CZ","CD","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","KP","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VA","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string","description":"* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas (The)\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `CD` - Democratic Republic of the Congo\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VA` - Vatican City\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe"},"SessionRequest":{"type":"object","properties":{"ip_address":{"type":"string","minLength":1},"user_agent":{"type":"string","minLength":1,"maxLength":512}},"required":["ip_address","user_agent"]},"CallbackRequest":{"type":"object","properties":{"notification_url":{"type":"string","format":"uri","minLength":1},"return_url":{"type":"string","format":"uri","minLength":1},"cancel_url":{"type":"string","format":"uri","minLength":1}},"required":["return_url"]},"OrderItemRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","maxLength":512},"quantity":{"type":"integer","minimum":1},"unit_price":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$"},"sku":{"type":"string","minLength":1,"maxLength":128}},"required":["name","quantity","sku","unit_price"]},"PaymentIntentPostResponseSchema":{"type":"object","properties":{"id":{"type":"integer"},"client_ref":{"type":"string"},"payment_link":{"type":"string","format":"uri"}},"required":["client_ref","id","payment_link"]}}},"paths":{"/v1/transaction/payment_intent/":{"post":{"operationId":"transaction_payment_intent_create","tags":["transaction"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentCreateRequest"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PaymentIntentCreateRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PaymentIntentCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentPostResponseSchema"}}},"description":"The created payment intent"}}}}}}
```

### Get all Payment Intents

This method retrieves a list of all Payment Intents in your account, providing an overview of all payment sessions and their current statuses, useful for tracking multiple payments.

## GET /v1/transaction/payment\_intent/

>

```json
{"openapi":"3.0.3","info":{"title":"Secured Checkout API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PaginatedPaymentIntentList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PaymentIntent"}}}},"PaymentIntent":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"username":{"type":"string","readOnly":true},"transaction_ref":{"type":"string","maxLength":255},"client_ref":{"type":"string","maxLength":255},"first_name":{"type":"string","nullable":true,"maxLength":255},"last_name":{"type":"string","nullable":true,"maxLength":255},"email":{"type":"string","format":"email","nullable":true,"maxLength":254},"phone":{"type":"string","nullable":true,"maxLength":32},"address":{"type":"string","readOnly":true},"amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"currency":{"type":"string","readOnly":true},"base_amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"base_currency":{"type":"string","readOnly":true},"method":{"$ref":"#/components/schemas/MethodEnum"},"payment_link":{"type":"string","readOnly":true},"payment":{"type":"array","items":{"$ref":"#/components/schemas/Payment"},"readOnly":true},"actions":{},"metadata":{},"order_items":{"description":"List of order items with name, description, quantity, unit_price, and sku"},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"created":{"type":"string","format":"date-time","readOnly":true}},"required":["address","amount","base_currency","client_ref","created","currency","id","payment","payment_link","route_id","route_name","transaction_ref","username"]},"MethodEnum":{"enum":["card","crypto","wire","paypal","klarna","ideal","bancontact","trustly","kakaopay","p24","blik"],"type":"string","description":"* `card` - Card\n* `crypto` - Crypto\n* `wire` - Wire\n* `paypal` - Paypal\n* `klarna` - Klarna\n* `ideal` - Ideal\n* `bancontact` - Bancontact\n* `trustly` - Trustly\n* `kakaopay` - KakaoPay\n* `p24` - P24\n* `blik` - Blik"},"Payment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"currency":{"type":"string","readOnly":true},"base_amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"base_currency":{"type":"string","readOnly":true},"fee":{"type":"string","readOnly":true},"refunded":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"status":{"$ref":"#/components/schemas/StatusEnum"},"refund":{"type":"array","items":{"$ref":"#/components/schemas/Refund"},"readOnly":true},"created":{"type":"string","format":"date-time","readOnly":true}},"required":["amount","base_currency","created","currency","fee","id","refund"]},"StatusEnum":{"enum":["pending","partial","success","failed","canceled","expired","authorized","refunded","partial_refunded","disputed","disputed_won","disputed_lost","disputed_close"],"type":"string","description":"* `pending` - Pending\n* `partial` - Partially Paid\n* `success` - Success\n* `failed` - Failed\n* `canceled` - Canceled\n* `expired` - Expired\n* `authorized` - Authorized\n* `refunded` - Refunded\n* `partial_refunded` - Partially Refunded\n* `disputed` - Disputed\n* `disputed_won` - Disputed - Won\n* `disputed_lost` - Disputed - Lost\n* `disputed_close` - Disputed - Closed"},"Refund":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"currency":{"type":"string","readOnly":true},"payment":{"type":"string","format":"uuid"},"gateway_id":{"type":"string","maxLength":255},"created":{"type":"string","format":"date-time","readOnly":true}},"required":["amount","created","currency","gateway_id","id","payment"]}}},"paths":{"/v1/transaction/payment_intent/":{"get":{"operationId":"transaction_payment_intent_list","parameters":[{"in":"query","name":"client_email","schema":{"type":"string"}},{"in":"query","name":"client_ref","schema":{"type":"string"}},{"in":"query","name":"domain","schema":{"type":"string"}},{"in":"query","name":"gateway_id","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}},{"in":"query","name":"route_id","schema":{"type":"string"},"description":"Filter by routing rule UUID used for the payment intent"},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}},{"in":"query","name":"transaction_ref","schema":{"type":"string"}}],"tags":["transaction"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedPaymentIntentList"}}},"description":""}}}}}}
```

### Get Payment Intent

This method fetches detailed information about a specific Payment Intent by its unique identifier, allowing you to retrieve the latest payment status and related details for a particular payment.

## GET /v1/transaction/payment\_intent/{id}/

>

```json
{"openapi":"3.0.3","info":{"title":"Secured Checkout API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PaymentIntent":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"username":{"type":"string","readOnly":true},"transaction_ref":{"type":"string","maxLength":255},"client_ref":{"type":"string","maxLength":255},"first_name":{"type":"string","nullable":true,"maxLength":255},"last_name":{"type":"string","nullable":true,"maxLength":255},"email":{"type":"string","format":"email","nullable":true,"maxLength":254},"phone":{"type":"string","nullable":true,"maxLength":32},"address":{"type":"string","readOnly":true},"amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"currency":{"type":"string","readOnly":true},"base_amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"base_currency":{"type":"string","readOnly":true},"method":{"$ref":"#/components/schemas/MethodEnum"},"payment_link":{"type":"string","readOnly":true},"payment":{"type":"array","items":{"$ref":"#/components/schemas/Payment"},"readOnly":true},"actions":{},"metadata":{},"order_items":{"description":"List of order items with name, description, quantity, unit_price, and sku"},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"created":{"type":"string","format":"date-time","readOnly":true}},"required":["address","amount","base_currency","client_ref","created","currency","id","payment","payment_link","route_id","route_name","transaction_ref","username"]},"MethodEnum":{"enum":["card","crypto","wire","paypal","klarna","ideal","bancontact","trustly","kakaopay","p24","blik"],"type":"string","description":"* `card` - Card\n* `crypto` - Crypto\n* `wire` - Wire\n* `paypal` - Paypal\n* `klarna` - Klarna\n* `ideal` - Ideal\n* `bancontact` - Bancontact\n* `trustly` - Trustly\n* `kakaopay` - KakaoPay\n* `p24` - P24\n* `blik` - Blik"},"Payment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"currency":{"type":"string","readOnly":true},"base_amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"base_currency":{"type":"string","readOnly":true},"fee":{"type":"string","readOnly":true},"refunded":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"status":{"$ref":"#/components/schemas/StatusEnum"},"refund":{"type":"array","items":{"$ref":"#/components/schemas/Refund"},"readOnly":true},"created":{"type":"string","format":"date-time","readOnly":true}},"required":["amount","base_currency","created","currency","fee","id","refund"]},"StatusEnum":{"enum":["pending","partial","success","failed","canceled","expired","authorized","refunded","partial_refunded","disputed","disputed_won","disputed_lost","disputed_close"],"type":"string","description":"* `pending` - Pending\n* `partial` - Partially Paid\n* `success` - Success\n* `failed` - Failed\n* `canceled` - Canceled\n* `expired` - Expired\n* `authorized` - Authorized\n* `refunded` - Refunded\n* `partial_refunded` - Partially Refunded\n* `disputed` - Disputed\n* `disputed_won` - Disputed - Won\n* `disputed_lost` - Disputed - Lost\n* `disputed_close` - Disputed - Closed"},"Refund":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"amount":{"type":"string","format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$"},"currency":{"type":"string","readOnly":true},"payment":{"type":"string","format":"uuid"},"gateway_id":{"type":"string","maxLength":255},"created":{"type":"string","format":"date-time","readOnly":true}},"required":["amount","created","currency","gateway_id","id","payment"]}}},"paths":{"/v1/transaction/payment_intent/{id}/":{"get":{"operationId":"transaction_payment_intent_retrieve","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["transaction"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntent"}}},"description":""}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://paytree.gitbook.io/api/api-methods/payment-intents.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.