# Cards ## Generate Card Invoice Statement CSV URL > Generate Card Invoice Statement CSV URL for an invoice ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/invoices/{id}/export":{"get":{"callbacks":{},"description":"Generate Card Invoice Statement CSV URL for an invoice","operationId":"TrioFoundationWeb.Banking.Card.InvoiceController.export","parameters":[{"description":"Invoice ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Entity ID","in":"query","name":"entity_id","required":true,"schema":{"type":"string"}},{"description":"Card ID","in":"query","name":"card_id","required":false,"schema":{"type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Statement CSV response"}}},"description":"Created"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Generate Card Invoice Statement CSV URL","tags":["cards"]}}},"components":{"schemas":{"Statement CSV response":{"description":"Statement CSV response","properties":{"data":{"properties":{"from_datetime":{"description":"From datetime","format":"date-time","type":"string"},"to_datetime":{"description":"To datetime","format":"date-time","type":"string"},"url":{"description":"URL","type":"string"}},"type":"object"}},"title":"Statement CSV response","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## List Card Invoices > List Card Invoices ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/invoices":{"get":{"callbacks":{},"description":"List Card Invoices","operationId":"TrioFoundationWeb.Banking.Card.InvoiceController.index","parameters":[{"description":"Entity ID","in":"query","name":"entity_id","required":true,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List card invoices response"}}},"description":"Invoices"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"List Card Invoices","tags":["cards"]}}},"components":{"schemas":{"List card invoices response":{"description":"List card invoices response","properties":{"data":{"items":{"$ref":"#/components/schemas/Card Invoice"},"type":"array"}},"title":"List card invoices response","type":"object"},"Card Invoice":{"description":"An Card Invoice","properties":{"balance":{"description":"Balance (R$)","type":"integer"},"company_id":{"description":"Company ID","type":"string"},"entity_id":{"description":"Entity ID","type":"string"},"from_datetime":{"description":"From datetime","format":"date","type":"string"},"id":{"description":"Unique identifier","type":"string"},"org_id":{"description":"Organization ID","type":"string"},"pending_confirmation_amount":{"description":"Pending confirmation amount (R$)","type":"integer"},"purchase_balance":{"description":"Purchase balance (R$)","type":"integer"},"status":{"description":"Status","enum":["open","closed","paid"],"type":"string"},"to_datetime":{"description":"To datetime","format":"date","type":"string"}},"title":"Card Invoice","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Cancel a card > Cancel an existing card ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/{id}/cancel":{"post":{"callbacks":{},"description":"Cancel an existing card","operationId":"TrioFoundationWeb.Banking.Card.CardController.cancel","parameters":[{"description":"Card ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP 204 No Content"}}},"description":"Canceled"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Cancel a card","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"HTTP 204 No Content":{"format":"string","title":"HTTP 204 No Content","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Get card details > Card sensitive information: holder name, card number, expiration date and cvv ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/{id}/info":{"get":{"callbacks":{},"description":"Card sensitive information: holder name, card number, expiration date and cvv","operationId":"TrioFoundationWeb.Banking.Card.CardController.show_sensitive_info","parameters":[{"description":"Card ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card Sensitive Data"}}},"description":"Card Details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Get card details","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"Card Sensitive Data":{"description":"Card sensitive data","properties":{"data":{"properties":{"expiration_date":{"description":"Expiration date","type":"string"},"holder_name":{"description":"Holder Name","type":"string"},"number":{"description":"Card number","type":"string"},"security_code":{"description":"Security code","type":"string"}},"type":"object"}},"title":"Card Sensitive Data","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Transfer card balance to another card > Transfer card balance to another card ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/{id}/transfer_balance":{"post":{"callbacks":{},"description":"Transfer card balance to another card","operationId":"TrioFoundationWeb.Banking.Card.CardController.transfer_balance","parameters":[{"description":"From card ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card transfer balance params"}}},"description":"Transfer Card Balance","required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP 204 No Content"}}},"description":"Transferred"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Transfer card balance to another card","tags":["cards"]}}},"components":{"schemas":{"Card transfer balance params":{"description":"Card transfer balance params","properties":{"amount":{"description":"Amount to transfer (R$)","type":"integer"},"destination_card_id":{"description":"Destination card UUID","type":"string"},"entity_id":{"description":"Entity UUID","type":"string"}},"required":["entity_id","destination_card_id","amount"],"title":"Card transfer balance params","type":"object"},"HTTP 204 No Content":{"format":"string","title":"HTTP 204 No Content","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## List Card Invoice Lines > List lines for a specific Card Invoice ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/invoices/{id}/lines":{"get":{"callbacks":{},"description":"List lines for a specific Card Invoice","operationId":"TrioFoundationWeb.Banking.Card.InvoiceController.list_lines","parameters":[{"description":"Invoice ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Entity ID","in":"query","name":"entity_id","required":true,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List invoice lines response"}}},"description":"Invoice Lines"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"List Card Invoice Lines","tags":["cards"]}}},"components":{"schemas":{"List invoice lines response":{"description":"List invoice lines response","properties":{"data":{"items":{"$ref":"#/components/schemas/Card Invoice Line"},"type":"array"}},"title":"List invoice lines response","type":"object"},"Card Invoice Line":{"description":"An Card Invoice Line","properties":{"amount":{"description":"Invoice Line Amount","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"card_id":{"description":"Card ID","type":"string"},"card_number":{"description":"Card number","type":"string"},"id":{"description":"Unique identifier","type":"string"},"invoice_id":{"description":"Invoice ID","type":"string"},"line_category":{"description":"Line category","type":"string"},"line_status":{"description":"Line status","enum":["reversed","confirmed","voided"],"type":"string"},"line_title":{"description":"Line title","type":"string"},"ref_id":{"description":"Reference ID","type":"string"},"ref_type":{"description":"Reference type","enum":["purchase","topup","transfer_in","transfer_out"],"type":"string"},"timestamp":{"description":"generation timestamp","format":"date-time","type":"string"}},"title":"Card Invoice Line","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Block a card > Block an existing card ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/{id}/block":{"post":{"callbacks":{},"description":"Block an existing card","operationId":"TrioFoundationWeb.Banking.Card.CardController.block","parameters":[{"description":"Card ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP 204 No Content"}}},"description":"Blocked"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Block a card","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"HTTP 204 No Content":{"format":"string","title":"HTTP 204 No Content","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Get a card > Get an existing card ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/{id}":{"get":{"callbacks":{},"description":"Get an existing card","operationId":"TrioFoundationWeb.Banking.Card.CardController.show","parameters":[{"description":"Card ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card response"}}},"description":"Card"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Get a card","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"Card response":{"description":"Card response","properties":{"data":{"$ref":"#/components/schemas/Card"}},"title":"Card response","type":"object"},"Card":{"description":"Card data","properties":{"balance":{"description":"Card balance (R$)","type":"integer"},"company_id":{"description":"Company UUID","type":"string"},"display_name":{"description":"Display name","type":"string"},"entity_id":{"description":"Entity UUID","type":"string"},"holder_id":{"description":"Holder UUID","type":"string"},"id":{"description":"Unique identifier","type":"string"},"masked_number":{"description":"Masked card number","type":"string"},"org_id":{"description":"Org UUID","type":"string"},"status":{"description":"Card status","enum":["created","pending","active","blocked","expired","canceled"],"type":"string"},"type":{"description":"Card type","enum":["virtual"],"type":"string"}},"title":"Card","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Update a card > Update card display name ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/{id}":{"put":{"callbacks":{},"description":"Update card display name","operationId":"TrioFoundationWeb.Banking.Card.CardController.update","parameters":[{"description":"Card ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card update params"}}},"description":"Update Card","required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP 204 No Content"}}},"description":"Updated"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Update a card","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"Card update params":{"description":"Card update params","properties":{"display_name":{"description":"Display name","type":"string"}},"required":["display_name"],"title":"Card update params","type":"object"},"HTTP 204 No Content":{"format":"string","title":"HTTP 204 No Content","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Get Card current Invoice > Get Card current Invoice ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/invoices/current":{"get":{"callbacks":{},"description":"Get Card current Invoice","operationId":"TrioFoundationWeb.Banking.Card.InvoiceController.get_current","parameters":[{"description":"Entity ID","in":"query","name":"entity_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card Invoice response"}}},"description":"Invoice"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Get Card current Invoice","tags":["cards"]}}},"components":{"schemas":{"Card Invoice response":{"description":"Card Invoice response","properties":{"data":{"$ref":"#/components/schemas/Card Invoice"}},"title":"Card Invoice response","type":"object"},"Card Invoice":{"description":"An Card Invoice","properties":{"balance":{"description":"Balance (R$)","type":"integer"},"company_id":{"description":"Company ID","type":"string"},"entity_id":{"description":"Entity ID","type":"string"},"from_datetime":{"description":"From datetime","format":"date","type":"string"},"id":{"description":"Unique identifier","type":"string"},"org_id":{"description":"Organization ID","type":"string"},"pending_confirmation_amount":{"description":"Pending confirmation amount (R$)","type":"integer"},"purchase_balance":{"description":"Purchase balance (R$)","type":"integer"},"status":{"description":"Status","enum":["open","closed","paid"],"type":"string"},"to_datetime":{"description":"To datetime","format":"date","type":"string"}},"title":"Card Invoice","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## List Card purchase documents > List Card purchase documents ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/purchases":{"get":{"callbacks":{},"description":"List Card purchase documents","operationId":"TrioFoundationWeb.Banking.Card.PurchaseController.index","parameters":[{"description":"Entity ID","in":"query","name":"entity_id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"From datetime","in":"query","name":"from_datetime","required":true,"schema":{"type":"string"}},{"description":"To datetime","in":"query","name":"to_datetime","required":true,"schema":{"type":"string"}},{"description":"Card ID","in":"query","name":"card_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Category Code","in":"query","name":"category_code","required":false,"schema":{"type":"string"}},{"description":"Category Type","in":"query","name":"category_type","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Status","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Order by","in":"query","name":"order_by","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List Purchase Document response"}}},"description":"Documents"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"List Card purchase documents","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"List Purchase Document response":{"description":"A List of Purchase Documents","properties":{"data":{"items":{"$ref":"#/components/schemas/Card Purchase Document"},"type":"array"}},"title":"List Purchase Document response","type":"object"},"Card Purchase Document":{"description":"A Card Purchase Document","properties":{"receipt_url":{"description":"URL to the receipt","type":"string"},"is_partially_allowed":{"description":"Is partially allowed","type":"boolean"},"holder_id":{"description":"Holder identifier","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"wallet_id":{"description":"Wallet identifier","type":"string"},"entity_id":{"description":"Entity identifier","format":"uuid","type":"string"},"issuer_amount":{"description":"Issuer amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"category_type":{"description":"Category type","type":"string"},"tax":{"description":"Tax value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"merchant_country_code":{"description":"Merchant country code","type":"string"},"card_id":{"description":"Card identifier","format":"uuid","type":"string"},"category_code":{"description":"Category code","type":"string"},"method_code":{"description":"Method code","enum":["unknown","manual","magstripe","barcode","ocr","chip","contactless","token","server"],"type":"string"},"company_id":{"description":"Company identifier","format":"uuid","type":"string"},"status":{"description":"Status","enum":["authorized","approved","denied","confirmed","canceled","reversed","voided"],"type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Unique identifier","format":"uuid","type":"string"},"purpose":{"description":"Purpose","type":"string"},"merchant_amount":{"description":"Merchant amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"merchant_currency_symbol":{"description":"Merchant currency symbol","type":"string"},"zip_code":{"description":"Zip code","type":"string"},"merchant_name":{"description":"Merchant name","type":"string"},"category_id":{"description":"Category identifier","format":"uuid","type":"string"},"error_code":{"description":"Error code","type":"string"},"error_message":{"description":"Error message","type":"string"},"end_to_end_id":{"description":"End to end identifier","type":"string"},"timestamp":{"description":"Timestamp","format":"date-time","type":"string"},"org_id":{"description":"Organization identifier","format":"uuid","type":"string"},"compress_timestamp":{"description":"Compress timestamp","format":"date-time","type":"string"},"amount":{"description":"Amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"score":{"description":"Score","type":"string"},"merchant_id":{"description":"Merchant identifier","format":"uuid","type":"string"}},"title":"Card Purchase Document","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Top Up card balance > Top Up card balance ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/{id}/topup":{"post":{"callbacks":{},"description":"Top Up card balance","operationId":"TrioFoundationWeb.Banking.Card.CardController.topup","parameters":[{"description":"Card ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card top up balance params"}}},"description":"Top Up Card Balance","required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP 204 No Content"}}},"description":"Top Up Successful"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Top Up card balance","tags":["cards"]}}},"components":{"schemas":{"Card top up balance params":{"description":"Card top up balance params","properties":{"amount":{"description":"Amount to top up (R$)","type":"integer"},"entity_id":{"description":"Entity UUID","type":"string"},"origin_bank_account_id":{"description":"Source bank account UUID","type":"string"}},"required":["entity_id","origin_bank_account_id","amount"],"title":"Card top up balance params","type":"object"},"HTTP 204 No Content":{"format":"string","title":"HTTP 204 No Content","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## List cards > List cards ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards":{"get":{"callbacks":{},"description":"List cards","operationId":"TrioFoundationWeb.Banking.Card.CardController.index","parameters":[{"description":"Entity ID","in":"query","name":"entity_id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Card Last Four Digits","in":"query","name":"card_last_digits","required":false,"schema":{"type":"string"}},{"description":"Card Display Name","in":"query","name":"display_name","required":false,"schema":{"type":"string"}},{"description":"Card Holder Name","in":"query","name":"holder_name","required":false,"schema":{"type":"string"}},{"description":"Card Holder Tax Number","in":"query","name":"holder_tax_number","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Parameter used for pagination.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List Cards Response"}}},"description":"Cards"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"List cards","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"List Cards Response":{"description":"A list of cards","properties":{"data":{"items":{"$ref":"#/components/schemas/Card"},"type":"array"}},"title":"List Cards Response","type":"object"},"Card":{"description":"Card data","properties":{"balance":{"description":"Card balance (R$)","type":"integer"},"company_id":{"description":"Company UUID","type":"string"},"display_name":{"description":"Display name","type":"string"},"entity_id":{"description":"Entity UUID","type":"string"},"holder_id":{"description":"Holder UUID","type":"string"},"id":{"description":"Unique identifier","type":"string"},"masked_number":{"description":"Masked card number","type":"string"},"org_id":{"description":"Org UUID","type":"string"},"status":{"description":"Card status","enum":["created","pending","active","blocked","expired","canceled"],"type":"string"},"type":{"description":"Card type","enum":["virtual"],"type":"string"}},"title":"Card","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Create a card > Create a new card ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards":{"post":{"callbacks":{},"description":"Create a new card","operationId":"TrioFoundationWeb.Banking.Card.CardController.create","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card create params"}}},"description":"Create Card","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card response"}}},"description":"Card"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Create a card","tags":["cards"]}}},"components":{"schemas":{"Card create params":{"description":"Card create params","properties":{"display_name":{"description":"Display name","type":"string"},"entity_id":{"description":"Entity UUID","type":"string"},"holder_name":{"description":"Holder Name","nullable":true,"type":"string"}},"required":["entity_id","display_name"],"title":"Card create params","type":"object"},"Card response":{"description":"Card response","properties":{"data":{"$ref":"#/components/schemas/Card"}},"title":"Card response","type":"object"},"Card":{"description":"Card data","properties":{"balance":{"description":"Card balance (R$)","type":"integer"},"company_id":{"description":"Company UUID","type":"string"},"display_name":{"description":"Display name","type":"string"},"entity_id":{"description":"Entity UUID","type":"string"},"holder_id":{"description":"Holder UUID","type":"string"},"id":{"description":"Unique identifier","type":"string"},"masked_number":{"description":"Masked card number","type":"string"},"org_id":{"description":"Org UUID","type":"string"},"status":{"description":"Card status","enum":["created","pending","active","blocked","expired","canceled"],"type":"string"},"type":{"description":"Card type","enum":["virtual"],"type":"string"}},"title":"Card","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Show card purchase document by end to end id > Show card purchase document by end to end id ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/purchases/e2e/{id}":{"get":{"callbacks":{},"description":"Show card purchase document by end to end id ","operationId":"TrioFoundationWeb.Banking.Card.PurchaseController.show_by_end_to_end_id","parameters":[{"description":"End to End ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/EndToEndId"}},{"description":"Timestamp","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Purchase Document response"}}},"description":"Document"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Show card purchase document by end to end id","tags":["cards"]}}},"components":{"schemas":{"EndToEndId":{"description":"Unique identifier for transactions","title":"EndToEndId","type":"string"},"Purchase Document response":{"description":"Purchase Document response","properties":{"data":{"$ref":"#/components/schemas/Card Purchase Document with Stages"}},"title":"Purchase Document response","type":"object"},"Card Purchase Document with Stages":{"allOf":[{"$ref":"#/components/schemas/Card Purchase Document"},{"properties":{"stages":{"description":"Stages of the purchase document","items":{"$ref":"#/components/schemas/Purchase Document Stage"},"type":"array"}},"type":"object"}],"description":"A Card Purchase Document with Stages","title":"Card Purchase Document with Stages"},"Card Purchase Document":{"description":"A Card Purchase Document","properties":{"receipt_url":{"description":"URL to the receipt","type":"string"},"is_partially_allowed":{"description":"Is partially allowed","type":"boolean"},"holder_id":{"description":"Holder identifier","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"wallet_id":{"description":"Wallet identifier","type":"string"},"entity_id":{"description":"Entity identifier","format":"uuid","type":"string"},"issuer_amount":{"description":"Issuer amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"category_type":{"description":"Category type","type":"string"},"tax":{"description":"Tax value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"merchant_country_code":{"description":"Merchant country code","type":"string"},"card_id":{"description":"Card identifier","format":"uuid","type":"string"},"category_code":{"description":"Category code","type":"string"},"method_code":{"description":"Method code","enum":["unknown","manual","magstripe","barcode","ocr","chip","contactless","token","server"],"type":"string"},"company_id":{"description":"Company identifier","format":"uuid","type":"string"},"status":{"description":"Status","enum":["authorized","approved","denied","confirmed","canceled","reversed","voided"],"type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Unique identifier","format":"uuid","type":"string"},"purpose":{"description":"Purpose","type":"string"},"merchant_amount":{"description":"Merchant amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"merchant_currency_symbol":{"description":"Merchant currency symbol","type":"string"},"zip_code":{"description":"Zip code","type":"string"},"merchant_name":{"description":"Merchant name","type":"string"},"category_id":{"description":"Category identifier","format":"uuid","type":"string"},"error_code":{"description":"Error code","type":"string"},"error_message":{"description":"Error message","type":"string"},"end_to_end_id":{"description":"End to end identifier","type":"string"},"timestamp":{"description":"Timestamp","format":"date-time","type":"string"},"org_id":{"description":"Organization identifier","format":"uuid","type":"string"},"compress_timestamp":{"description":"Compress timestamp","format":"date-time","type":"string"},"amount":{"description":"Amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"score":{"description":"Score","type":"string"},"merchant_id":{"description":"Merchant identifier","format":"uuid","type":"string"}},"title":"Card Purchase Document","type":"object"},"Purchase Document Stage":{"description":"Stage of the purchase document","properties":{"is_partially_allowed":{"description":"Is partially allowed","type":"boolean"},"holder_id":{"description":"Holder identifier","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"wallet_id":{"description":"Wallet identifier","type":"string"},"entity_id":{"description":"Entity identifier","format":"uuid","type":"string"},"issuer_amount":{"description":"Issuer amount value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"category_type":{"description":"Category type","type":"string"},"tax":{"description":"Tax value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"merchant_country_code":{"description":"Merchant country code","type":"string"},"card_id":{"description":"Card identifier","format":"uuid","type":"string"},"category_code":{"description":"Category code","type":"string"},"method_code":{"description":"Method code","enum":["unknown","manual","magstripe","barcode","ocr","chip","contactless","token","server"],"type":"string"},"company_id":{"description":"Company identifier","format":"uuid","type":"string"},"status":{"description":"Status","enum":["authorized","approved","denied","confirmed","canceled","reversed","voided"],"type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Unique identifier","format":"uuid","type":"string"},"purpose":{"description":"Purpose","type":"string"},"merchant_amount":{"description":"Merchant amount value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"purchase_document_id":{"description":"Purchase document identifier","format":"uuid","type":"string"},"merchant_currency_symbol":{"description":"Merchant currency symbol","type":"string"},"zip_code":{"description":"Zip code","type":"string"},"merchant_name":{"description":"Merchant name","type":"string"},"category_id":{"description":"Category identifier","format":"uuid","type":"string"},"callback_amount":{"description":"Callback amount value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"error_code":{"description":"Error code","type":"string"},"error_message":{"description":"Error message","type":"string"},"end_to_end_id":{"description":"Unique identifier for transactions","title":"EndToEndId","type":"string"},"timestamp":{"description":"Timestamp","format":"date-time","type":"string"},"callback_type":{"description":"Callback type","enum":["authorization","approved","denied","canceled","reversed","voided","confirmed"],"type":"string"},"org_id":{"description":"Organization identifier","format":"uuid","type":"string"},"amount":{"description":"Amount value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"score":{"description":"Score","type":"string"},"merchant_id":{"description":"Merchant identifier","format":"uuid","type":"string"}},"title":"Purchase Document Stage","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Show Card purchase document by id > Show Card purchase document by id ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/purchases/{id}":{"get":{"callbacks":{},"description":"Show Card purchase document by id","operationId":"TrioFoundationWeb.Banking.Card.PurchaseController.show","parameters":[{"description":"Document ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Purchase Document response"}}},"description":"Document"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Show Card purchase document by id","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"Purchase Document response":{"description":"Purchase Document response","properties":{"data":{"$ref":"#/components/schemas/Card Purchase Document with Stages"}},"title":"Purchase Document response","type":"object"},"Card Purchase Document with Stages":{"allOf":[{"$ref":"#/components/schemas/Card Purchase Document"},{"properties":{"stages":{"description":"Stages of the purchase document","items":{"$ref":"#/components/schemas/Purchase Document Stage"},"type":"array"}},"type":"object"}],"description":"A Card Purchase Document with Stages","title":"Card Purchase Document with Stages"},"Card Purchase Document":{"description":"A Card Purchase Document","properties":{"receipt_url":{"description":"URL to the receipt","type":"string"},"is_partially_allowed":{"description":"Is partially allowed","type":"boolean"},"holder_id":{"description":"Holder identifier","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"wallet_id":{"description":"Wallet identifier","type":"string"},"entity_id":{"description":"Entity identifier","format":"uuid","type":"string"},"issuer_amount":{"description":"Issuer amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"category_type":{"description":"Category type","type":"string"},"tax":{"description":"Tax value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"merchant_country_code":{"description":"Merchant country code","type":"string"},"card_id":{"description":"Card identifier","format":"uuid","type":"string"},"category_code":{"description":"Category code","type":"string"},"method_code":{"description":"Method code","enum":["unknown","manual","magstripe","barcode","ocr","chip","contactless","token","server"],"type":"string"},"company_id":{"description":"Company identifier","format":"uuid","type":"string"},"status":{"description":"Status","enum":["authorized","approved","denied","confirmed","canceled","reversed","voided"],"type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Unique identifier","format":"uuid","type":"string"},"purpose":{"description":"Purpose","type":"string"},"merchant_amount":{"description":"Merchant amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"merchant_currency_symbol":{"description":"Merchant currency symbol","type":"string"},"zip_code":{"description":"Zip code","type":"string"},"merchant_name":{"description":"Merchant name","type":"string"},"category_id":{"description":"Category identifier","format":"uuid","type":"string"},"error_code":{"description":"Error code","type":"string"},"error_message":{"description":"Error message","type":"string"},"end_to_end_id":{"description":"End to end identifier","type":"string"},"timestamp":{"description":"Timestamp","format":"date-time","type":"string"},"org_id":{"description":"Organization identifier","format":"uuid","type":"string"},"compress_timestamp":{"description":"Compress timestamp","format":"date-time","type":"string"},"amount":{"description":"Amount value of the document","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"score":{"description":"Score","type":"string"},"merchant_id":{"description":"Merchant identifier","format":"uuid","type":"string"}},"title":"Card Purchase Document","type":"object"},"Purchase Document Stage":{"description":"Stage of the purchase document","properties":{"is_partially_allowed":{"description":"Is partially allowed","type":"boolean"},"holder_id":{"description":"Holder identifier","format":"uuid","type":"string"},"inserted_at":{"description":"Inserted at","format":"date-time","type":"string"},"wallet_id":{"description":"Wallet identifier","type":"string"},"entity_id":{"description":"Entity identifier","format":"uuid","type":"string"},"issuer_amount":{"description":"Issuer amount value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"category_type":{"description":"Category type","type":"string"},"tax":{"description":"Tax value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"merchant_country_code":{"description":"Merchant country code","type":"string"},"card_id":{"description":"Card identifier","format":"uuid","type":"string"},"category_code":{"description":"Category code","type":"string"},"method_code":{"description":"Method code","enum":["unknown","manual","magstripe","barcode","ocr","chip","contactless","token","server"],"type":"string"},"company_id":{"description":"Company identifier","format":"uuid","type":"string"},"status":{"description":"Status","enum":["authorized","approved","denied","confirmed","canceled","reversed","voided"],"type":"string"},"updated_at":{"description":"Updated at","format":"date-time","type":"string"},"description":{"description":"Description","type":"string"},"id":{"description":"Unique identifier","format":"uuid","type":"string"},"purpose":{"description":"Purpose","type":"string"},"merchant_amount":{"description":"Merchant amount value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"purchase_document_id":{"description":"Purchase document identifier","format":"uuid","type":"string"},"merchant_currency_symbol":{"description":"Merchant currency symbol","type":"string"},"zip_code":{"description":"Zip code","type":"string"},"merchant_name":{"description":"Merchant name","type":"string"},"category_id":{"description":"Category identifier","format":"uuid","type":"string"},"callback_amount":{"description":"Callback amount value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"error_code":{"description":"Error code","type":"string"},"error_message":{"description":"Error message","type":"string"},"end_to_end_id":{"description":"Unique identifier for transactions","title":"EndToEndId","type":"string"},"timestamp":{"description":"Timestamp","format":"date-time","type":"string"},"callback_type":{"description":"Callback type","enum":["authorization","approved","denied","canceled","reversed","voided","confirmed"],"type":"string"},"org_id":{"description":"Organization identifier","format":"uuid","type":"string"},"amount":{"description":"Amount value of the stage","properties":{"amount":{"description":"Amount","type":"integer"},"currency":{"description":"Currency","type":"string"}},"type":"object"},"score":{"description":"Score","type":"string"},"merchant_id":{"description":"Merchant identifier","format":"uuid","type":"string"}},"title":"Purchase Document Stage","type":"object"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` ## Unblock a card > Unblock an existing card ```json {"openapi":"3.0.0","info":{"title":"Trio API","version":"0.1.0"},"servers":[{"url":"https://api.sandbox.trio.com.br","variables":{}},{"url":"https://api.qa.trio.com.br","variables":{}},{"url":"https://api.trio.com.br","variables":{}}],"paths":{"/banking/cards/{id}/unblock":{"post":{"callbacks":{},"description":"Unblock an existing card","operationId":"TrioFoundationWeb.Banking.Card.CardController.unblock","parameters":[{"description":"Card ID","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP 204 No Content"}}},"description":"Unblocked"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonErrorResponse"}}},"description":"Unprocessable Entity"}},"summary":"Unblock a card","tags":["cards"]}}},"components":{"schemas":{"UUID":{"description":"Unique identifier","format":"uuid","title":"UUID","type":"string"},"HTTP 204 No Content":{"format":"string","title":"HTTP 204 No Content","type":"string"},"JsonErrorResponse":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"required":["pointer"],"type":"object"},"title":{"type":"string"}},"required":["title","source","detail"],"type":"object"},"type":"array"}},"required":["errors"],"title":"JsonErrorResponse","type":"object"}}}} ``` --- # 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://docs.trio.com.br/api_reference/banking-api/cards.md?ask= ``` 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.