{
"openapi": "3.1.0",
"info": {
"title": "ProcessOut API",
"version": "1.0.3",
"description": "ProcessOut is a payments technical layer that standardizes merchant connections to 100+ payment providers (PSPs/APMs), with a PCI DSS card vault, tokenization for recurring payments, dynamic/no-code checkout, ML-based smart routing, analytics and transaction reconciliation. Authentication is HTTP Basic using a project ID (username) and secret API key (password). This OpenAPI 3.1 description was assembled by API Evangelist from the per-operation OpenAPI fragments ProcessOut publishes in each ReadMe API-reference page.",
"contact": {
"email": "help@processout.com",
"url": "https://docs.processout.com"
}
},
"servers": [
{
"url": "https://api.processout.com",
"description": "Production"
}
],
"security": [
{
"sec0": []
}
],
"tags": [],
"paths": {
"/invoices/{invoice_id}/authorize": {
"post": {
"summary": "Authorizing an invoice",
"description": "",
"operationId": "authorizing-an-invoice",
"parameters": [
{
"name": "invoice_id",
"in": "path",
"description": "The invoice ID generated by ProcessOut during the invoice creation",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "Source used to authorization the payment. Can be a card, a token or a gateway request."
},
"save_source": {
"type": "boolean",
"description": "Optional if you want us to save the payment source (card or APM) by creating a customer token during the authorisation"
},
"initial_scheme_transaction_id": {
"type": "string",
"description": "Override the scheme ID"
},
"incremental": {
"type": "boolean",
"description": "Request a pre-authorization that can be incremented at a later stage",
"default": false
},
"preferred_scheme": {
"type": "string",
"description": "Scheme the customer would prefer to process transaction on. Ex: `carte bancaire`. If there is already a default set on the card object, then you can override it using this field. Please use `none` if you wish to override it back to empty for this request.
_Only supported on compatible payment providers_."
},
"external_three_d_s": {
"type": "object",
"description": "Allow you to pass 3DS data obtained from an external provider outside of ProcessOut. Please contact your CSM to ensure the PSPs you are routing towards support this functionality.",
"properties": {
"xid": {
"type": "string",
"description": "Base64 encoded XID - Transaction identifier resulting from authentication processing."
},
"trans_status": {
"type": "string",
"description": "AResTransStatus (fingerprint) or CResTransStatus (challenge) from the 3DS response"
},
"eci": {
"type": "string",
"description": "Electronic Commerce Indicator"
},
"cavv": {
"type": "string",
"description": "Cardholder Authentication Verification Value (CAVV), Authentication Verification Value (AVV) or Universal Cardholder Authentication Field (UCAF). Must be in Base64 encoded format."
},
"ds_trans_id": {
"type": "string",
"description": "Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction."
},
"version": {
"type": "string",
"description": "3DS version used e.g. 2.2.0"
},
"authentication_flow": {
"type": "string",
"description": "Denotes the flow which 3DS took. Frictionless meaning no challenge taken place from the customer's point of view. Accepted values: `FRICTIONLESS` or `CHALLENGE`",
"enum": [
"\"FRICTIONLESS\"",
"\"CHALLENGE\""
]
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true,\n \"transaction\": {\n \"id\": \"tr_7FPylQ0EOrLpcYw3E6OhdCEVnRCdFqoZ\",\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"customer_id\": \"cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw\",\n \"routing_tags\": [\"route-1\", \"route-2\"],\n \"fraud_service_results\": null,\n \"operations\": [\n {\n \"id\": \"tr_op_ufSmIq7kU3bB6bVoiislmqeMNmxquzpX\",\n \"transaction_id\": \"tr_7FPylQ0EOrLpcYw3E6OhdCEVnRCdFqoZ\",\n \"authenticated_transaction_id\": \"8284686045\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"card_id\": \"card_TVeLAxjOaiHzru3m7T1o0ZLUg6cXIQe8\",\n \"amount\": \"29\",\n \"amount_local\": \"31.8321371\",\n \"currency\": \"EUR\",\n \"is_attempt\": false,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"request\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"eci\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"8284686045\",\n \"initial_scheme_transaction_id\": \"\",\n \"gateway_operation_id\": \"\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-21T20:24:43.342363262Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n },\n {\n \"id\": \"tr_op_FVJD7TG7tBrldTEoSRNr0uA48XQgskVZ\",\n \"transaction_id\": \"tr_7FPylQ0EOrLpcYw3E6OhdCEVnRCdFqoZ\",\n \"authenticated_transaction_id\": \"8284686045\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"card_id\": \"card_TVeLAxjOaiHzru3m7T1o0ZLUg6cXIQe8\",\n \"amount\": \"29\",\n \"amount_local\": \"31.8321371\",\n \"currency\": \"EUR\",\n \"is_attempt\": true,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"authorization\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"acquirer_name\": null,\n \"eci\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"8284686045\",\n \"initial_scheme_transaction_id\": \"\",\n \"gateway_operation_id\": \"test-valid-17580cef700c691a\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-21T20:24:43.342417133Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n },\n {\n \"id\": \"tr_op_fLlh7plcTzPelsHiVRoTf6qaURfZLDTm\",\n \"transaction_id\": \"tr_7FPylQ0EOrLpcYw3E6OhdCEVnRCdFqoZ\",\n \"authenticated_transaction_id\": \"8284686045\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"card_id\": \"card_TVeLAxjOaiHzru3m7T1o0ZLUg6cXIQe8\",\n \"amount\": \"29\",\n \"amount_local\": \"31.8321371\",\n \"currency\": \"EUR\",\n \"is_attempt\": false,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"authorization\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"acquirer_name\": null,\n \"eci\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"8284686045\",\n \"initial_scheme_transaction_id\": \"\",\n \"gateway_operation_id\": \"test-valid-17580cef700c691a\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-21T20:24:43.342463204Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n }\n ],\n \"name\": \"Amazing Product\",\n \"currency\": \"EUR\",\n \"metadata\": {\n \"fruit\": \"banana\"\n },\n \"sandbox\": true,\n \"created_at\": \"2023-04-21T20:24:37.850357Z\",\n \"invoice_id\": \"iv_RRW65C1I2jAGiFuwhEtW5UGU1tMkBRBS\",\n \"gateway_name\": \"sandbox\",\n \"status\": \"authorized\",\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"card_id\": \"card_TVeLAxjOaiHzru3m7T1o0ZLUg6cXIQe8\",\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"eci\": null,\n \"cvc_check\": \"passed\",\n \"avs_check\": \"passed\",\n \"card_checks\": {\n \"cvc_check\": \"passed\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"passed\",\n \"avs_postal_check\": \"passed\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"passed\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"passed\",\n \"avs_name_check_reason\": null\n },\n \"amount\": \"29\",\n \"amount_local\": \"31.8321371\",\n \"authorized_amount\": \"29\",\n \"authorized_amount_local\": \"31.8321371\",\n \"captured_amount\": \"0\",\n \"captured_amount_local\": \"0\",\n \"available_amount\": \"0\",\n \"available_amount_local\": \"0\",\n \"incremented_amount\": \"0\",\n \"incremented_amount_local\": \"0\",\n \"refunded_amount\": \"0\",\n \"refunded_amount_local\": \"0\",\n \"authorized_at\": \"2023-04-21T20:24:43.342463204Z\",\n \"captured_at\": null,\n \"refunded_at\": null,\n \"voided_at\": null,\n \"chargedback_at\": null,\n \"received_fraud_notification\": false,\n \"received_retrieval_request\": false,\n \"acquirer_name\": null,\n \"attempts_count\": 1,\n \"authorized\": true,\n \"captured\": false,\n \"refunded\": false,\n \"voided\": false,\n \"chargedback\": false,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"scheme_id\": \"8284686045\",\n \"initial_scheme_transaction_id\": null,\n \"sca\": {\n \"scope\": \"out-of-scope\",\n \"out_of_scope_reason\": \"mit\",\n \"inscope_compliance\": \"not-applicable\",\n \"challenge_result\": \"honoured\",\n \"exemption_result\": \"no-exemption-reason-set\"\n },\n \"refunds\": null,\n \"duplicate_distance_seconds\": null\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"transaction": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_7FPylQ0EOrLpcYw3E6OhdCEVnRCdFqoZ"
},
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"customer_id": {
"type": "string",
"example": "cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw"
},
"routing_tags": {
"type": "array",
"items": {
"type": "string",
"example": "route-1"
}
},
"fraud_service_results": {},
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_op_ufSmIq7kU3bB6bVoiislmqeMNmxquzpX"
},
"transaction_id": {
"type": "string",
"example": "tr_7FPylQ0EOrLpcYw3E6OhdCEVnRCdFqoZ"
},
"authenticated_transaction_id": {
"type": "string",
"example": "8284686045"
},
"authorization_code": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"card_id": {
"type": "string",
"example": "card_TVeLAxjOaiHzru3m7T1o0ZLUg6cXIQe8"
},
"amount": {
"type": "string",
"example": "29"
},
"amount_local": {
"type": "string",
"example": "31.8321371"
},
"currency": {
"type": "string",
"example": "EUR"
},
"is_attempt": {
"type": "boolean",
"example": false,
"default": true
},
"has_failed": {
"type": "boolean",
"example": false,
"default": true
},
"is_accountable": {
"type": "boolean",
"example": false,
"default": true
},
"type": {
"type": "string",
"example": "request"
},
"metadata": {
"type": "object",
"properties": {
"is_sale": {
"type": "string",
"example": "false"
}
}
},
"error_code": {},
"error_message": {},
"payment_type": {
"type": "string",
"example": "card"
},
"eci": {},
"is_on_us": {},
"arn": {},
"scheme_id": {
"type": "string",
"example": "8284686045"
},
"initial_scheme_transaction_id": {
"type": "string",
"example": ""
},
"gateway_operation_id": {
"type": "string",
"example": ""
},
"gateway_data": {
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "test-valid"
}
}
},
"chargeback_reason": {},
"created_at": {
"type": "string",
"example": "2023-04-21T20:24:43.342363262Z"
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"challenge_indicator": {
"type": "string",
"example": "no-preference"
},
"sca_exemption_reason": {
"type": "string",
"example": ""
}
}
}
},
"name": {
"type": "string",
"example": "Amazing Product"
},
"currency": {
"type": "string",
"example": "EUR"
},
"metadata": {
"type": "object",
"properties": {
"fruit": {
"type": "string",
"example": "banana"
}
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-21T20:24:37.850357Z"
},
"invoice_id": {
"type": "string",
"example": "iv_RRW65C1I2jAGiFuwhEtW5UGU1tMkBRBS"
},
"gateway_name": {
"type": "string",
"example": "sandbox"
},
"status": {
"type": "string",
"example": "authorized"
},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"card_id": {
"type": "string",
"example": "card_TVeLAxjOaiHzru3m7T1o0ZLUg6cXIQe8"
},
"error_code": {},
"error_message": {},
"payment_type": {
"type": "string",
"example": "card"
},
"eci": {},
"cvc_check": {
"type": "string",
"example": "passed"
},
"avs_check": {
"type": "string",
"example": "passed"
},
"card_checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "passed"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "passed"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "passed"
},
"avs_name_check_reason": {}
}
},
"amount": {
"type": "string",
"example": "29"
},
"amount_local": {
"type": "string",
"example": "31.8321371"
},
"authorized_amount": {
"type": "string",
"example": "29"
},
"authorized_amount_local": {
"type": "string",
"example": "31.8321371"
},
"captured_amount": {
"type": "string",
"example": "0"
},
"captured_amount_local": {
"type": "string",
"example": "0"
},
"available_amount": {
"type": "string",
"example": "0"
},
"available_amount_local": {
"type": "string",
"example": "0"
},
"incremented_amount": {
"type": "string",
"example": "0"
},
"incremented_amount_local": {
"type": "string",
"example": "0"
},
"refunded_amount": {
"type": "string",
"example": "0"
},
"refunded_amount_local": {
"type": "string",
"example": "0"
},
"authorized_at": {
"type": "string",
"example": "2023-04-21T20:24:43.342463204Z"
},
"captured_at": {},
"refunded_at": {},
"voided_at": {},
"chargedback_at": {},
"received_fraud_notification": {
"type": "boolean",
"example": false,
"default": true
},
"received_retrieval_request": {
"type": "boolean",
"example": false,
"default": true
},
"acquirer_name": {},
"attempts_count": {
"type": "integer",
"example": 1,
"default": 0
},
"authorized": {
"type": "boolean",
"example": true,
"default": true
},
"captured": {
"type": "boolean",
"example": false,
"default": true
},
"refunded": {
"type": "boolean",
"example": false,
"default": true
},
"voided": {
"type": "boolean",
"example": false,
"default": true
},
"chargedback": {
"type": "boolean",
"example": false,
"default": true
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"scheme_id": {
"type": "string",
"example": "8284686045"
},
"initial_scheme_transaction_id": {},
"sca": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"example": "out-of-scope"
},
"out_of_scope_reason": {
"type": "string",
"example": "mit"
},
"inscope_compliance": {
"type": "string",
"example": "not-applicable"
},
"challenge_result": {
"type": "string",
"example": "honoured"
},
"exemption_result": {
"type": "string",
"example": "no-exemption-reason-set"
}
}
},
"refunds": {},
"duplicate_distance_seconds": {}
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.invoice.not-found\",\n \"message\": \"The invoice could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.invoice.not-found"
},
"message": {
"type": "string",
"example": "The invoice could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"410": {
"description": "410",
"content": {
"application/json": {
"examples": {
"Transaction error": {
"value": "{\n \"error_type\": \"card.do-not-honor\",\n \"message\": \"The bank has returned a do-not-honor error\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "card.do-not-honor"
},
"message": {
"type": "string",
"example": "The bank has returned a do-not-honor error"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\n// The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ninvoice.authorize(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\", {\n // optional if you want us to auto capture for you\n \"auto_capture_at\": \"2022-10-02T15:00:00Z\"\n}).then(\n function(transaction) {\n // The invoice was authorized and returned a transaction\n\n }, function(err) {\n // The invoice could not be authorized\n });",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\n# The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ntransaction = invoice.authorize(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\", {\n # optional if you want us to auto capture for you\n \"auto_capture_at\": \"2022-10-02T15:00:00Z\"\n})"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\n# The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ntransaction = invoice.authorize(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\", (\n # optional if you want us to auto capture for you\n auto_capture_at: \"2022-10-02T15:00:00Z\"\n))"
},
{
"language": "php",
"code": "authorize(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\", array(\n // optional if you want us to auto capture for you\n \"auto_capture_at\" => \"2022-10-02T15:00:00Z\"\n));"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\n// The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ntr, _ := iv.Authorize(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\", InvoiceAuthorizeParameters{\n AutoCaptureAt: \"2022-10-02T15:00:00Z\",\n})"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/invoices/{invoice_id}/capture": {
"post": {
"summary": "Capture an invoice",
"description": "",
"operationId": "capture-an-invoice",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
},
{
"name": "invoice_id",
"in": "path",
"description": "The invoice ID generated by ProcessOut during the invoice creation",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "Source used to capture the payment. Can be a card, a token or a gateway request."
},
"invoice_detail_ids": {
"type": "array",
"description": "Array of invoice details created with the invoice to capture.
_Only supported on compatible payment providers_",
"items": {
"type": "string"
}
},
"capture_amount": {
"type": "string",
"description": "Amount to capture partially the transaction"
},
"capture_statement_descriptor": {
"type": "string",
"description": "Some payment providers are supporting different statement descriptor for the capture. Use this field to send a different one. By default, the one sent during the authorization will be forwarded."
},
"initial_scheme_transaction_id": {
"type": "string",
"description": "Override the scheme ID"
},
"split_allocations": {
"type": "array",
"items": {
"properties": {
"provider_recipient_reference": {
"type": "string",
"description": "The unique identifier for the recipient's account. This is the destination account that will receive this portion of the funds."
},
"type": {
"type": "string",
"description": "Defines the purpose of the split. It determines how the funds are categorized and processed.",
"enum": [
"PURCHASE",
"VAT",
"FEE",
"COMMISSION",
"MARKETPLACE",
"SHIPPING"
]
},
"amount": {
"type": "string",
"description": "The specific amount of money for this individual split. Maximum 4 decimal places supported as per ISO 4217."
},
"currency": {
"type": "string",
"description": "Currency for payment of the individual split, in ISO 4217 format (for example, USD). Must be a valid ISO 4217 currency code with 3 characters"
},
"description": {
"type": "string",
"description": "A short, human-readable description for this split. This description will appear in transaction reports and can be useful for reconciliation."
},
"payment_reference": {
"type": "string",
"description": "Your own unique reference ID for this specific split. Providing a unique reference is critical for tracking the status of each individual split via webhooks and for reconciling your accounts. Recommended to include."
}
},
"type": "object",
"required": [
"provider_recipient_reference",
"type",
"amount",
"currency"
]
},
"description": "An array of allocation objects that defines how the capture payment should be divided among different recipients. Each object in this array represents one \"split\" of the total invoice amount. This object will override the invoice's default split allocations."
},
"capture_type": {
"type": "string",
"description": "Whether this partial capture is \"final\" or \"non-final\". "
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true,\n \"transaction\": {\n \"id\": \"tr_6uooTOHO71Fq0wysK8FpxBH6t45SEBrg\",\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"customer_id\": \"cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw\",\n \"routing_tags\": [\n \"rule-2-route\",\n \"GB1\",\n \"rule-3-dynamic_3ds\",\n \"country == FR\",\n \"currency == EUR\",\n \"card_last4 == 0001\",\n \"rule-4-dynamic_3ds\",\n \"card_country == FR\",\n \"currency == EUR\",\n \"amount > 30\",\n \"rule-5-dynamic_3ds\",\n \"card_country == FR\",\n \"currency == EUR\",\n \"amount > 30\"\n ],\n \"fraud_service_results\": null,\n \"operations\": null,\n \"name\": \"Amazing Product\",\n \"currency\": \"EUR\",\n \"details\": {\n \"country\": \"GB\"\n },\n \"metadata\": {\n \"fruit\": \"banana\"\n },\n \"sandbox\": true,\n \"created_at\": \"2023-04-21T20:33:21.000245Z\",\n \"invoice_id\": \"iv_YGmmz4fijVppMTtwX3nwDQHeojCsNLB4\",\n \"gateway_name\": \"sandbox\",\n \"status\": \"voided\",\n \"three_d_s_status\": \"unchecked\",\n \"three_d_s_version\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_4blVmiFfRqXokRuAT2YcSE3pbaX5fdYi\",\n \"error_code\": null,\n \"error_message\": null,\n \"three_d_s\": null,\n \"payment_type\": \"card\",\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"cvc_check\": \"passed\",\n \"avs_check\": \"passed\",\n \"card_checks\": {\n \"cvc_check\": \"passed\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"passed\",\n \"avs_postal_check\": \"passed\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"passed\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"passed\",\n \"avs_name_check_reason\": null\n },\n \"amount\": \"29\",\n \"amount_local\": \"31.83\",\n \"authorized_amount\": \"29\",\n \"authorized_amount_local\": \"31.83\",\n \"captured_amount\": \"0\",\n \"captured_amount_local\": \"0\",\n \"available_amount\": \"0\",\n \"available_amount_local\": \"0\",\n \"incremented_amount\": \"0\",\n \"incremented_amount_local\": \"0\",\n \"refunded_amount\": \"0\",\n \"refunded_amount_local\": \"0\",\n \"currency_fee\": null,\n \"gateway_fee\": \"0\",\n \"gateway_fee_local\": \"0\",\n \"authorized_at\": \"2023-04-21T20:33:26.027707Z\",\n \"captured_at\": null,\n \"refunded_at\": null,\n \"voided_at\": \"2023-04-21T20:33:28.802301Z\",\n \"chargedback_at\": null,\n \"received_fraud_notification\": false,\n \"received_retrieval_request\": false,\n \"acquirer_name\": null,\n \"attempts_count\": 1,\n \"authorized\": true,\n \"captured\": false,\n \"refunded\": false,\n \"voided\": true,\n \"chargedback\": false,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"scheme_id\": \"363823005\",\n \"initial_scheme_transaction_id\": null,\n \"sca\": null,\n \"subscription_cycle\": null,\n \"error_recommendations\": [],\n \"gateway_fee_details\": {\n \"processing_fee\": \"0\",\n \"exchange_fee\": \"0\",\n \"refund_fee\": \"0\",\n \"interchange_fee\": \"0\",\n \"scheme_fee\": \"0\",\n \"markup_fee\": \"0\",\n \"interchange_fee_estimate\": \"0\",\n \"scheme_fee_estimate\": \"0\"\n },\n \"estimated_fee\": \"1.17\",\n \"refunds\": null,\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\"\n },\n \"is_on_us\": null,\n \"processout_fee\": \"0\",\n \"subscription_id\": null,\n \"duplicate_distance_seconds\": null\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"transaction": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_6uooTOHO71Fq0wysK8FpxBH6t45SEBrg"
},
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"customer_id": {
"type": "string",
"example": "cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw"
},
"routing_tags": {
"type": "array",
"items": {
"type": "string",
"example": "rule-2-route"
}
},
"fraud_service_results": {},
"operations": {},
"name": {
"type": "string",
"example": "Amazing Product"
},
"currency": {
"type": "string",
"example": "EUR"
},
"details": {
"type": "object",
"properties": {
"country": {
"type": "string",
"example": "GB"
}
}
},
"metadata": {
"type": "object",
"properties": {
"fruit": {
"type": "string",
"example": "banana"
}
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-21T20:33:21.000245Z"
},
"invoice_id": {
"type": "string",
"example": "iv_YGmmz4fijVppMTtwX3nwDQHeojCsNLB4"
},
"gateway_name": {
"type": "string",
"example": "sandbox"
},
"status": {
"type": "string",
"example": "voided"
},
"three_d_s_status": {
"type": "string",
"example": "unchecked"
},
"three_d_s_version": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"token_id": {},
"card_id": {
"type": "string",
"example": "card_4blVmiFfRqXokRuAT2YcSE3pbaX5fdYi"
},
"error_code": {},
"error_message": {},
"three_d_s": {},
"payment_type": {
"type": "string",
"example": "card"
},
"eci": {},
"mcc": {},
"merchant_account_id": {},
"cvc_check": {
"type": "string",
"example": "passed"
},
"avs_check": {
"type": "string",
"example": "passed"
},
"card_checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "passed"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "passed"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "passed"
},
"avs_name_check_reason": {}
}
},
"amount": {
"type": "string",
"example": "29"
},
"amount_local": {
"type": "string",
"example": "31.83"
},
"authorized_amount": {
"type": "string",
"example": "29"
},
"authorized_amount_local": {
"type": "string",
"example": "31.83"
},
"captured_amount": {
"type": "string",
"example": "0"
},
"captured_amount_local": {
"type": "string",
"example": "0"
},
"available_amount": {
"type": "string",
"example": "0"
},
"available_amount_local": {
"type": "string",
"example": "0"
},
"incremented_amount": {
"type": "string",
"example": "0"
},
"incremented_amount_local": {
"type": "string",
"example": "0"
},
"refunded_amount": {
"type": "string",
"example": "0"
},
"refunded_amount_local": {
"type": "string",
"example": "0"
},
"currency_fee": {},
"gateway_fee": {
"type": "string",
"example": "0"
},
"gateway_fee_local": {
"type": "string",
"example": "0"
},
"authorized_at": {
"type": "string",
"example": "2023-04-21T20:33:26.027707Z"
},
"captured_at": {},
"refunded_at": {},
"voided_at": {
"type": "string",
"example": "2023-04-21T20:33:28.802301Z"
},
"chargedback_at": {},
"received_fraud_notification": {
"type": "boolean",
"example": false,
"default": true
},
"received_retrieval_request": {
"type": "boolean",
"example": false,
"default": true
},
"acquirer_name": {},
"attempts_count": {
"type": "integer",
"example": 1,
"default": 0
},
"authorized": {
"type": "boolean",
"example": true,
"default": true
},
"captured": {
"type": "boolean",
"example": false,
"default": true
},
"refunded": {
"type": "boolean",
"example": false,
"default": true
},
"voided": {
"type": "boolean",
"example": true,
"default": true
},
"chargedback": {
"type": "boolean",
"example": false,
"default": true
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"scheme_id": {
"type": "string",
"example": "363823005"
},
"initial_scheme_transaction_id": {},
"sca": {},
"subscription_cycle": {},
"error_recommendations": {
"type": "array"
},
"gateway_fee_details": {
"type": "object",
"properties": {
"processing_fee": {
"type": "string",
"example": "0"
},
"exchange_fee": {
"type": "string",
"example": "0"
},
"refund_fee": {
"type": "string",
"example": "0"
},
"interchange_fee": {
"type": "string",
"example": "0"
},
"scheme_fee": {
"type": "string",
"example": "0"
},
"markup_fee": {
"type": "string",
"example": "0"
},
"interchange_fee_estimate": {
"type": "string",
"example": "0"
},
"scheme_fee_estimate": {
"type": "string",
"example": "0"
}
}
},
"estimated_fee": {
"type": "string",
"example": "1.17"
},
"refunds": {},
"buyer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
},
"address": {
"type": "string",
"example": ""
},
"phone": {
"type": "string",
"example": ""
}
}
},
"is_on_us": {},
"processout_fee": {
"type": "string",
"example": "0"
},
"subscription_id": {},
"duplicate_distance_seconds": {}
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.invoice.not-found\",\n \"message\": \"The invoice could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.invoice.not-found"
},
"message": {
"type": "string",
"example": "The invoice could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"410": {
"description": "410",
"content": {
"application/json": {
"examples": {
"Transaction error": {
"value": "{\n \"error_type\": \"card.do-not-honor\",\n \"message\": \"The bank has returned a do-not-honor error\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "card.do-not-honor"
},
"message": {
"type": "string",
"example": "The bank has returned a do-not-honor error"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\n// The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ninvoice.capture(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\").then(\n function(transaction) {\n // The invoice was captured and returned a transaction\n\n }, function(err) {\n // The invoice could not be captured\n });",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\n# The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ntransaction = invoice.capture(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\")"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\n# The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ntransaction = invoice.capture(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\")"
},
{
"language": "php",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\n// The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ntr, _ := iv.Capture(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\")"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\n// The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ntr, _ := iv.Authorize(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\", InvoiceAuthorizeParameters{\n AutoCaptureAt: \"2022-10-02T15:00:00Z\",\n})"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/invoices": {
"post": {
"summary": "Create an invoice",
"description": "",
"operationId": "create-an-invoice",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"amount",
"currency"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the invoice (often an internal ID code from the merchant\u2019s systems)."
},
"amount": {
"type": "string",
"description": "Amount to be paid. Maximum 4 decimal places supported as per ISO 4217."
},
"tax": {
"type": "object",
"description": "Tax information for the invoice.",
"properties": {
"amount": {
"type": "string",
"description": "Amount is zero or a positive number representing the tax included in the amount."
},
"rate": {
"type": "string",
"description": "Rate is a percentage (0 to 100) representing the rate of tax included in the amount."
}
}
},
"currency": {
"type": "string",
"description": "Currency for payment of the invoice, in ISO 4217 format (for example, USD). Must be a valid ISO 4217 currency code with 3 characters"
},
"order_id": {
"type": "string",
"description": "Your unique identifier for the order associated with this invoice. This field is displayed in the Dashboard and ProcessOut uses it to deduplicate invoices and transactions."
},
"customer_id": {
"type": "string",
"description": "**_Resource expandable_**
Customer linked to the invoice (generally the one making the purchase)."
},
"verification": {
"type": "boolean",
"description": "Tags an invoice to be used as an verification invoice. When this is set to true, we will attempt to automatically utilise the lowest amount applicable for a given PSP & Currency. Otherwise, we will default to utilising the invoice amount provided."
},
"expires_at": {
"type": "string",
"description": "Expiry date for the invoice",
"format": "date"
},
"auto_capture_at": {
"type": "string",
"description": "Optional if you want us to auto capture for you. Expected value is a date and time in RFC 3339 format. (UTC only such as \"2026-05-11T17:33:00Z\". Timezone offset will get stripped)",
"format": "date"
},
"details": {
"type": "object",
"description": "Details of the items or products that are being purchased.",
"required": [
"name",
"amount"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the item or product, which represents an item on a receipt.
_Maximum 80 characters long_"
},
"amount": {
"type": "string",
"description": "Amount charged for this item or product."
},
"type": {
"type": "string",
"description": "Item or product type. Set this to anything suitable.
_Maximum 30 characters long_"
},
"quantity": {
"type": "integer",
"description": "Quantity of the item or product. Default value is 1.",
"format": "int32",
"default": ""
},
"metadata": {
"type": "object",
"description": "Metadata related to the invoice detail, in the form of key-value pairs (string - string).",
"properties": {}
},
"category": {
"type": "string",
"description": "Category of the item or product. Can be `food`, `entertainment`, `home`, `appliance`, `bidding`, `gift`, `technology`, `media`, `communication`, `health`, `sport`, `personal-service`, `professional-service`, `clothing`, `travel`, `tickets`, `transport` or `other`."
},
"reference": {
"type": "string",
"description": "Reference of the item or product.
_Maximum 255 characters long_"
},
"description": {
"type": "string",
"description": "Description of the item or product.
_Maximum 255 characters long_"
},
"brand": {
"type": "string",
"description": "Brand of the item or product.
_Maximum 80 characters long_"
},
"model": {
"type": "string",
"description": "Model of the item or product.
_Maximum 80 characters long_"
},
"discount_amount": {
"type": "string",
"description": "Discount amount (when the discount is listed as a separate item on a receipt)."
},
"condition": {
"type": "string",
"description": "Condition of the product. Can be `new`, `refurbished`, `used` or `other`."
},
"marketplace_merchant": {
"type": "string",
"description": "Marketplace merchant ID of the item or product."
},
"marketplace_merchant_is_business": {
"type": "boolean",
"description": "Denotes whether or not the marketplace merchant is a business."
},
"marketplace_merchant_created_at": {
"type": "string",
"description": "Date and time when the merchant was created.
_RFC1123 date or timestamp_",
"format": "date"
},
"name1": {
"type": "string"
},
"name2": {
"type": "string"
}
}
},
"risk": {
"type": "object",
"description": "Risk assessment for the invoice.",
"properties": {
"score": {
"type": "string",
"description": "Scoring of the invoice. No validation done on this field because it is used to forward risk information to compatible payment providers.
_Maximum 12 characters long_"
},
"is_legit": {
"type": "boolean",
"description": "Denotes whether or not the invoice is legitimate."
},
"skip_gateway_rules": {
"type": "boolean",
"description": "Flag to skip payment gateway fraud engine rules. (This is only available on certain compatible gateways. Contact us for more information.)"
}
}
},
"device": {
"type": "object",
"description": "Information about the device and channel used by the customer to initiate the payment.",
"properties": {
"id": {
"type": "string",
"description": "ID of the device. This can be anything but would usually be a UUID generated by a third-party anti-fraud solution.
_Maximum 100 characters long_"
},
"threeds_sdk": {
"type": "string",
"description": "Denotes if using a native experience for 3DS via SDKs e.g. Mobile 3DS SDK, or ProcessOut.JS SDK. If `ios` or `android` is provided, we will assume you can handle 3DS via native mobile SDK implementations. \n\nCan be `web`, `ios` or `android`.",
"default": ""
},
"platform": {
"type": "string",
"description": "An informative field denoting the device platform used for the transaction.\n\nCan be `web`, `ios`, `android` or `other`."
},
"ip_address": {
"type": "string",
"description": "IP address of the device.
_Must be a valid IP address_"
}
}
},
"external_fraud_tools": {
"type": "object",
"description": "Information to forward to external fraud tools.",
"properties": {
"forter": {
"type": "string",
"description": "Information for the Forter fraud prevention service.",
"format": "json"
},
"signifyd": {
"type": "string",
"description": "Information for the Signifyd fraud prevention service.",
"format": "json"
},
"ravelin": {
"type": "string",
"description": "Information for the Ravelin fraud prevention service.",
"format": "json"
}
}
},
"shipping": {
"type": "object",
"description": "Shipping information for the invoice.",
"properties": {
"amount": {
"type": "string",
"description": "Amount charged for shipping."
},
"method": {
"type": "string",
"description": "Delivery method. Can be `web`, `collect-at-shop`, `relay`, `travel-station`, `home`, `shipping`, `locker` or `other`."
},
"provider": {
"type": "string",
"description": "Delivery provider.
_Maximum 32 characters long_"
},
"delay": {
"type": "string",
"description": "Shipment delay. Can be `express`, `priority`, `standard` or `other`."
},
"address1": {
"type": "string",
"description": "First line of the delivery address.
_Maximum 255 characters long_"
},
"address2": {
"type": "string",
"description": "Second line of the delivery address.
_Maximum 255 characters long_"
},
"state": {
"type": "string",
"description": "State or county of the delivery address.
_Maximum 80 characters long_"
},
"city": {
"type": "string",
"description": "City of the delivery address.
_Maximum 80 characters long_"
},
"country_code": {
"type": "string",
"description": "Country code (`US`, `FR`...) of the delivery address.
_Must be a valid ISO 3166 country code with 2 characters_"
},
"zip": {
"type": "string",
"description": "ZIP code of the delivery address.
_Maximum 16 characters long_"
},
"phone_number": {
"type": "object",
"description": "Phone number of the shipment recipient",
"properties": {}
},
"expects_shipping_at": {
"type": "string",
"description": "Expected date of delivery.
_RFC1123 date or timestamp_",
"format": "date"
},
"relay_store_name": {
"type": "string",
"description": "Name of the store that the order must be collected from.
_Maximum 100 characters long_"
},
"email": {
"type": "string",
"description": "Shipping email address.
_Must be a valid email_"
},
"first_name": {
"type": "string",
"description": "First name of the shipping address.
_Maximum 80 characters long. Automatically sanitised on write \u2014 emoji, currency symbols, and non-printable characters are stripped, and underscores are converted to spaces. All Unicode scripts are supported._"
},
"last_name": {
"type": "string",
"description": "Last name of the shipping address.
_Maximum 80 characters long. Automatically sanitised on write \u2014 emoji, currency symbols, and non-printable characters are stripped, and underscores are converted to spaces. All Unicode scripts are supported._"
}
}
},
"billing": {
"type": "object",
"description": "Billing information for the invoice. This address will be used to populate the Customer and Card address if empty.",
"properties": {
"address1": {
"type": "string",
"description": "First line of the billing address.
_Maximum 255 characters long_"
},
"address2": {
"type": "string",
"description": "Second line of the billing address.
_Maximum 255 characters long_"
},
"state": {
"type": "string",
"description": "State or county of the billing address.
_Maximum 80 characters long_"
},
"city": {
"type": "string",
"description": "City of the billing address.
_Maximum 80 characters long_"
},
"country_code": {
"type": "string",
"description": "Country code (`US`, `FR`...) of the address."
},
"zip": {
"type": "string",
"description": "ZIP code of the address.
_Maximum 16 characters long_"
}
}
},
"statement_descriptor": {
"type": "string",
"description": "Item that will be listed for this purchase on the customer\u2019s bank statement.
_Maximum 25 characters long, should only contain letters, numbers, spaces, dots, asterisks and forward slashes_"
},
"statement_descriptor_phone": {
"type": "string",
"description": "Support phone number for this purchase on the customer\u2019s bank statement."
},
"statement_descriptor_city": {
"type": "string",
"description": "City shown for this purchase on the customer\u2019s bank statement. Maximum 22 characters long. Should only contain letters and numbers."
},
"statement_descriptor_company": {
"type": "string",
"description": "Your company name to show on the customer\u2019s bank statement."
},
"statement_descriptor_url": {
"type": "string",
"description": "Support URL for this purchase on the customer\u2019s bank statement."
},
"initiation_type": {
"type": "string",
"description": "Represent the initiation type of the transaction which can be Customer Initiated Transaction (`cit`) or Merchant Initiated Transaction (`mit`).
_Allowed values are: `cit` or `mit`_"
},
"payment_intent": {
"type": "string",
"description": "The type of payment flow that generated the transaction.
_Allowed values are: `one-off`, `recurring`, `recurring-standing-order`, `recurring-subscription`, `installment`, `unscheduled`, `unscheduled-delayed-charge`, `unscheduled-resubmission`, `unscheduled-no-show` or `unscheduled-reauthorization`_.
This field should be used in combination with the `initiation_type` field to tag scenarios such as initial CIT of a recurring sequence."
},
"payment_type": {
"type": "string",
"description": "Optional information about the payment type
_Allowed values are \u201cmoto\u201d or \u201cecommerce\u201d_"
},
"return_url": {
"type": "string",
"description": "For [APMs](../docs/alternative-payment-methods), this is the URL to return to the app after payment is accepted.
_Must be a valid URL_"
},
"webhook_url": {
"type": "string",
"description": "Custom [webhook](/webhooks) URL for this purchase.
_Must be a valid URL_"
},
"sca_exemption_reason": {
"type": "string",
"description": "Optional reason for requesting SCA exemption (Note: This must also be supported by the PSP. Please contact us for more information.)
_Allowed values are: `low-value`, `trusted-beneficiary` or `transaction-risk-analysis`_"
},
"challenge_indicator": {
"type": "string",
"description": "Optional challenge indicator field when requesting 3DS2 (Note: This must also be supported by the PSP. Please contact us for more information.)
_Allowed values are: `no-preference`, `no-challenge-requested`, `challenge-requested`, `challenge-requested-mandate`, `no-challenge-requested-tra-performed`, `no-challenge-requested-data-share-only`, `no-challenge-requested-sca-performed`, `no-challenge-requested-whitelist-exemption`, `challenge-requested-whitelist-prompt` or `cb-scoring`_"
},
"unsupported_feature_bypass": {
"type": "object",
"description": "Bypass payment provider unsupported features set in the transaction",
"properties": {
"incremental_authorization": {
"type": "boolean",
"description": "Ignore incremental authorization requests on PSP that do not support it",
"default": false
},
"split_payments": {
"type": "boolean",
"description": "Ignore split requests on PSP that do not support it",
"default": "false"
}
}
},
"metadata": {
"type": "string",
"description": "Custom key/value pair (string/string) metadata that can be used to identify the transaction. This information is passed to upstream payment providers that support similar metadata objects. Do not include personal data in this field.",
"default": "{}",
"format": "json"
},
"gateway_data": {
"type": "string",
"description": "Used for custom logics / data sent to payment providers.
This field is not standard across providers.",
"default": "{}",
"format": "json"
},
"split_allocations": {
"type": "array",
"items": {
"properties": {
"provider_recipient_reference": {
"type": "string",
"description": "The unique identifier for the recipient's account. This is the destination account that will receive this portion of the funds."
},
"type": {
"type": "string",
"description": "Defines the purpose of the split. It determines how the funds are categorized and processed.",
"enum": [
"PURCHASE",
"FEE",
"VAT",
"COMMISSION",
"MARKETPLACE",
"SHIPPING"
]
},
"amount": {
"type": "string",
"description": "The specific amount of money for this individual split. Maximum 4 decimal places supported as per ISO 4217."
},
"currency": {
"type": "string",
"description": "Currency for payment of the individual split, in ISO 4217 format (for example, USD). Must be a valid ISO 4217 currency code with 3 characters"
},
"description": {
"type": "string",
"description": "A short, human-readable description for this split. This description will appear in transaction reports and can be useful for reconciliation."
},
"payment_reference": {
"type": "string",
"description": "Your own unique reference ID for this specific split. Providing a unique reference is critical for tracking the status of each individual split via webhooks and for reconciling your accounts. Recommended to include."
}
},
"type": "object",
"required": [
"provider_recipient_reference",
"type",
"amount",
"currency"
]
},
"description": "An array of allocation objects that defines how a single payment should be divided among different recipients. Each object in this array represents one \"split\" of the total invoice amount."
},
"submerchant": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Unique identifier for the submerchant"
},
"name": {
"type": "string",
"description": "Business name as registered"
},
"mcc": {
"type": "string",
"description": "MCC code. Max length: 4"
},
"email": {
"type": "string",
"description": "Valid email format"
},
"tax_reference": {
"type": "string",
"description": "Country-specific tax ID"
},
"service_establishment_number": {
"type": "string",
"description": "Used by card networks for PayFac identification"
},
"address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country_code": {
"type": "string"
},
"zip": {
"type": "string"
},
"county": {
"type": "string"
}
}
},
"phone_number": {
"type": "object",
"properties": {
"dialing_code": {
"type": "string",
"description": "With or without + prefix"
},
"number": {
"type": "string",
"description": "Digits only"
}
}
}
},
"description": "All fields are optional. The submerchant data is passed to payment processors that support PayFac/marketplace scenarios for compliance and settlement purposes.\nPlease speak to your Account Manager to confirm this is supported on your Connections."
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"invoice\": {\n \"id\": \"iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG\",\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"subscription_id\": null,\n \"customer_id\": \"cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw\",\n \"token_id\": null,\n \"details\": [\n {\n \"id\": \"iv_det_M2LqRkMXxkTSu4CWTMY0X4QKrzz2Urbu\",\n \"name\": \"iPhone 14 Pro\",\n \"type\": \"Smartphone\",\n \"amount\": \"1000\",\n \"quantity\": 1,\n \"reference\": \"12221341242\",\n \"description\": \"iPhone 11 Pro 256Gb Red blablabla\",\n \"brand\": \"Apple\",\n \"model\": \"14 Pro\",\n \"discount_amount\": \"0\",\n \"condition\": \"new\",\n \"marketplace_merchant\": null,\n \"marketplace_merchant_is_business\": null,\n \"marketplace_merchant_created_at\": null,\n \"category\": \"technology\",\n \"metadata\": {}\n }\n ],\n \"transaction_id\": \"tr_Cln3zmZ31m5Crcgz5sfggomIiMm3Mmbm\",\n \"name\": \"Amazing Product\",\n \"order_id\": \"123456\",\n \"amount\": \"29\",\n \"currency\": \"EUR\",\n \"metadata\": {\n \"fruit\": \"banana\"\n },\n \"gateway_data\": {},\n \"exemption_reason_3ds2\": \"\",\n \"challenge_indicator\": \"\",\n \"sca_exemption_reason\": \"\",\n \"statement_descriptor\": \"My Company\",\n \"merchant_initiator_type\": null,\n \"initiation_type\": \"MIT\",\n \"payment_intent\": \"recurring\",\n \"require_backend_capture\": null,\n \"card_verification\": null,\n \"return_url\": \"https://mycompany.com/return-url\",\n \"cancel_url\": null,\n \"webhook_url\": \"https://mycompany.com/webhook\",\n \"sandbox\": true,\n \"url\": \"https://checkout.processout.com/test-proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S/iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG\",\n \"created_at\": \"2023-04-21T17:57:22.807583563Z\",\n \"expires_at\": null,\n \"risk\": {\n \"score\": \"100\",\n \"is_legit\": true,\n \"skip_gateway_rules\": false\n },\n \"device\": {\n \"id\": \"112233445566\",\n \"channel\": \"ios\",\n \"ip_address\": \"1.1.1.1\"\n },\n \"shipping\": {\n \"amount\": \"12\",\n \"method\": \"home\",\n \"provider\": \"DHL\",\n \"delay\": \"express\",\n \"address1\": \"133 Rue Lamarck\",\n \"address2\": \"CEDEX 1\",\n \"city\": \"Paris\",\n \"state\": \"Ile De France\",\n \"country_code\": \"FR\",\n \"zip\": \"75018\",\n \"phone\": {\n \t\t\"number\": \"684758495\",\n \t\t\"dialing_code\": \"0033\"\n \t\t},\n \"expects_shipping_at\": \"2023-04-21T17:52:47.828402061Z\",\n \"relay_store_name\": \"none\"\n },\n \"incremental\": false,\n \"tax\": {\n \"rate\": \"1\",\n \"amount\": \"10\"\n },\n \"payment_type\": null,\n \"payment_methods\": [\n {\n \"type\": \"applepay\",\n \"flow\": \"express\",\n \"applepay\": {\n \"merchant_id\": \"merchant.mycompany.processout.com\",\n \"country_code\": \"GB\",\n \"supported_networks\": [\n \"american express\",\n \"visa\"\n ],\n \"merchant_capabilities\": [\n \"supports3DS\",\n \"supportsCredit\",\n \"supportsDebit\",\n \"supportsEMV\"\n ]\n }\n },\n {\n \"type\": \"googlepay\",\n \"flow\": \"express\",\n \"googlepay\": {\n \"allowed_auth_methods\": [\n \"PAN_ONLY\",\n \"CRYPTOGRAM_3DS\"\n ],\n \"allowed_card_networks\": [\n \"AMEX\",\n \"DISCOVER\",\n \"JCB\",\n \"MASTERCARD\",\n \"VISA\"\n ],\n \"allow_prepaid_cards\": true,\n \"allow_credit_cards\": true,\n \"gateway\": \"processout\",\n \"gateway_merchant_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\"\n }\n },\n {\n \"type\": \"apm\",\n \"display\": {\n \"name\": \"Everypay\",\n \"logo\": {\n \"light_url\": {\n \"vector\": \"https://js.processout.com/images/payment-methods/square/everypay.svg\",\n \"raster\": \"https://js.processout.com/images/payment-methods/square/everypay-m@4x.png\"\n },\n \"dark_url\": {\n \"vector\": \"https://js.processout.com/images/payment-methods/square/everypay.svg\",\n \"raster\": \"https://js.processout.com/images/payment-methods/square/everypay-m@4x.png\"\n }\n },\n \"brand_color\": {\n \"light\": \"0x000000FF\",\n \"dark\": \"0xFFFFFFFF\"\n }\n },\n \"apm\": {\n \"gateway_configuration_id\": \"gway_conf_yt57esj68rj0ic4egt8bkjp4iin0dwpm.everypay\",\n \"redirect_url\": \"https://checkout.processout.com/proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S/iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG/redirect/gway_conf_yt57esj68rj0ic4egt8bkjp4iin0dwpm.everypay\"\n }\n },\n {\n \"type\": \"card\",\n \"display\": {\n \"name\": \"Card\",\n \"logo\": {\n \"light_url\": {\n \"vector\": \"https://js.processout.com/images/payment-methods/square/card.svg\",\n \"raster\": \"https://js.processout.com/images/payment-methods/square/card-m@4x.png\"\n },\n \"dark_url\": {\n \"vector\": \"https://js.processout.com/images/payment-methods/square/card.svg\",\n \"raster\": \"https://js.processout.com/images/payment-methods/square/card-m@4x.png\"\n }\n },\n \"brand_color\": {\n \"light\": \"0x000000FF\",\n \"dark\": \"0xFFFFFFFF\"\n }\n },\n \"card\": {\n \"cvc_required\": true,\n \"cardholder_name_required\": true,\n \"scheme_selection_allowed\": true,\n \"billing_address\": {\n \"collection_mode\": \"full\",\n \"restrict_to_country_codes\": [\n \"GB\"\n ]\n },\n \"saving_allowed\": false\n }\n }\n ]\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"invoice": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG"
},
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"subscription_id": {},
"customer_id": {
"type": "string",
"example": "cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw"
},
"token_id": {},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "iv_det_M2LqRkMXxkTSu4CWTMY0X4QKrzz2Urbu"
},
"name": {
"type": "string",
"example": "iPhone 14 Pro"
},
"type": {
"type": "string",
"example": "Smartphone"
},
"amount": {
"type": "string",
"example": "1000"
},
"quantity": {
"type": "integer",
"example": 1,
"default": "1"
},
"reference": {
"type": "string",
"example": "12221341242"
},
"description": {
"type": "string",
"example": "iPhone 11 Pro 256Gb Red blablabla"
},
"brand": {
"type": "string",
"example": "Apple"
},
"model": {
"type": "string",
"example": "14 Pro"
},
"discount_amount": {
"type": "string",
"example": "0"
},
"condition": {
"type": "string",
"example": "new"
},
"marketplace_merchant": {},
"marketplace_merchant_is_business": {},
"marketplace_merchant_created_at": {},
"category": {
"type": "string",
"example": "technology"
},
"metadata": {
"type": "object",
"properties": {}
}
}
}
},
"transaction_id": {
"type": "string",
"example": "tr_Cln3zmZ31m5Crcgz5sfggomIiMm3Mmbm"
},
"name": {
"type": "string",
"example": "Amazing Product"
},
"order_id": {
"type": "string",
"example": "123456"
},
"amount": {
"type": "string",
"example": "29"
},
"currency": {
"type": "string",
"example": "EUR"
},
"metadata": {
"type": "object",
"properties": {
"fruit": {
"type": "string",
"example": "banana"
}
}
},
"gateway_data": {
"type": "object",
"properties": {}
},
"exemption_reason_3ds2": {
"type": "string",
"example": ""
},
"challenge_indicator": {
"type": "string",
"example": ""
},
"sca_exemption_reason": {
"type": "string",
"example": ""
},
"statement_descriptor": {
"type": "string",
"example": "My Company"
},
"merchant_initiator_type": {},
"initiation_type": {
"type": "string",
"example": "MIT"
},
"payment_intent": {
"type": "string",
"example": "recurring"
},
"require_backend_capture": {},
"card_verification": {},
"return_url": {
"type": "string",
"example": "https://mycompany.com/return-url"
},
"cancel_url": {},
"webhook_url": {
"type": "string",
"example": "https://mycompany.com/webhook"
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"url": {
"type": "string",
"example": "https://checkout.processout.com/test-proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S/iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG"
},
"created_at": {
"type": "string",
"example": "2023-04-21T17:57:22.807583563Z"
},
"expires_at": {},
"risk": {
"type": "object",
"properties": {
"score": {
"type": "string",
"example": "100"
},
"is_legit": {
"type": "boolean",
"example": true,
"default": true
},
"skip_gateway_rules": {
"type": "boolean",
"example": false,
"default": true
}
}
},
"device": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "112233445566"
},
"channel(deprecated)": {
"type": "string",
"example": "ios"
},
"threeds_sdk": {
"type": "string"
},
"platform": {
"type": "string"
},
"ip_address": {
"type": "string",
"example": "1.1.1.1"
}
}
},
"shipping": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"example": "12"
},
"method": {
"type": "string",
"example": "home"
},
"provider": {
"type": "string",
"example": "DHL"
},
"delay": {
"type": "string",
"example": "express"
},
"address1": {
"type": "string",
"example": "133 Rue Lamarck"
},
"address2": {
"type": "string",
"example": "CEDEX 1"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "FR"
},
"zip": {
"type": "string",
"example": "75018"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string",
"example": "684758495"
},
"dialing_code": {
"type": "string",
"example": "0033"
}
}
},
"expects_shipping_at": {
"type": "string",
"example": "2023-04-21T17:52:47.828402061Z"
},
"relay_store_name": {
"type": "string",
"example": "none"
}
}
},
"incremental": {
"type": "boolean",
"example": false,
"default": true
},
"tax": {
"type": "object",
"properties": {
"rate": {
"type": "string",
"example": "1"
},
"amount": {
"type": "string",
"example": "10"
}
}
},
"payment_type": {},
"payment_methods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "applepay"
},
"flow": {
"type": "string",
"example": "express"
},
"applepay": {
"type": "object",
"properties": {
"merchant_id": {
"type": "string",
"example": "merchant.mycompany.processout.com"
},
"country_code": {
"type": "string",
"example": "GB"
},
"supported_networks": {
"type": "array",
"items": {
"type": "string",
"example": "american express"
}
},
"merchant_capabilities": {
"type": "array",
"items": {
"type": "string",
"example": "supports3DS"
}
}
}
}
}
}
}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"request.validation.invalid-phone-number\",\n \"message\": \"The phone number should not exceed 17 characters.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "request.validation.invalid-phone-number"
},
"message": {
"type": "string",
"example": "The phone number should not exceed 17 characters."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newInvoice().create({\n customer_id: \"cust_LvjCcLOVe6iWn2aeCNhNmK7RbbG6K8XF\",\n name: \"Amazing item\",\n statement_descriptor: \"amazing item\",\n amount: \"4.99\",\n currency: \"USD\",\n \torder_id: \t\t\t\t\t\t\"#123456\"\n}).then(function(invoice) {\n //\n\n}, function(err) {\n // An error occured\n\n});",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ninvoice = client.new_invoice().create({\n \"customer_id\": \"cust_LvjCcLOVe6iWn2aeCNhNmK7RbbG6K8XF\",\n \"name\": \"Amazing item\",\n \"statement_descriptor\": \"amazing item\",\n \"amount\": \"4.99\",\n \"currency\": \"USD\",\n \t\"order_id\": \t\t\t\t\t\t\"#123456\"\n})"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ninvoice = client.invoice.create(\n \"customer_id\": \"cust_LvjCcLOVe6iWn2aeCNhNmK7RbbG6K8XF\",\n name: \"Amazing item\",\n statement_descriptor: \"amazing item\",\n amount: \"4.99\",\n currency: \"USD\",\n \torder_id: \t\t\t\t\t\t\"#123456\"\n)"
},
{
"language": "php",
"code": "newInvoice()->create(array(\n \"customer_id\" => \"cust_LvjCcLOVe6iWn2aeCNhNmK7RbbG6K8XF\",\n \"name\" => \"Amazing item\",\n \"statement_descriptor\" => \"amazing item\",\n \"amount\" => \"4.99\",\n \"currency\" => \"USD\",\n \t\"order_id\" \t\t\t\t\t\t =>\"#123456\"\n));"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\niv, err := client.NewInvoice().Create(processout.InvoiceCreateParameters{\n Invoice: &processout.Invoice{\n CustomerID: processout.String(\"cust_LvjCcLOVe6iWn2aeCNhNmK7RbbG6K8XF\"),\n Name: processout.String(\"Amazing item\"),\n StatementDescriptor: processout.String(\"amazing item\"),\n Amount: processout.String(\"4.99\"),\n Currency: processout.String(\"USD\"),\n \torder_id: \t\t\t\t\t processout.String(\"#123456\"),\n },\n})"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/cards": {
"post": {
"summary": "Creating a card",
"description": "",
"operationId": "creating-a-card",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"number",
"exp_year",
"exp_month"
],
"properties": {
"number": {
"type": "string",
"description": "Number of the card (PAN)
_Must respect the Luhn check_"
},
"exp_year": {
"type": "string",
"description": "Expiration year of the card"
},
"exp_month": {
"type": "string",
"description": "Expiration month of the card"
},
"cvc2": {
"type": "string",
"description": "CVC of the card"
},
"name": {
"type": "string",
"description": "Cardholder\u2019s name.
_Maximum 255 characters long. Automatically sanitised on write \u2014 emoji, currency symbols, and non-printable characters are stripped, and underscores are converted to spaces. All Unicode scripts are supported._"
},
"contact": {
"type": "object",
"description": "Card billing details",
"properties": {
"address1": {
"type": "string",
"description": "First line of the cardholder's address.
_Maximum 80 characters long_"
},
"address2": {
"type": "string",
"description": "Second line of the cardholder's address.
_Maximum 80 characters long_"
},
"city": {
"type": "string",
"description": "City of the cardholder's address.
_Maximum 80 characters long_"
},
"state": {
"type": "string",
"description": "State or county of the cardholder's address.
_Maximum 80 characters long_"
},
"country_code": {
"type": "string",
"description": "Deprecated alias for billing_country_code. Country code of the cardholder's address (`US`, `FR`...).
Kept for backward compatibility; prefer billing_country_code.
_Must be a valid ISO 3166 country code with 2 characters_"
},
"billing_country_code": {
"type": "string",
"description": "Country code of the cardholder's address (US, FR...).
Takes precedence over country_code when both are supplied.
_Must be a valid ISO 3166 country code with 2 characters_"
},
"zip": {
"type": "string",
"description": "ZIP code of the cardholders's address.
_Maximum 16 characters long_"
}
}
},
"device": {
"type": "object",
"description": "Object used to override end user parameters",
"properties": {
"request_origin": {
"type": "string",
"description": "Must be `backend` for any request made by merchant's backend"
},
"ip_address": {
"type": "string",
"description": "Override the IP address being saved on the card
_Must be a valid IPv4 or IPv6 address_"
}
}
},
"preferred_scheme": {
"type": "string",
"description": "You can offer the customer a preferred scheme to pay on, say, if the customer's card supports co-schemes such as carte bancaire. This will be used as default for future transactions for this card."
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": {
"card": {
"project_id": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S",
"update_type": null,
"update_reason_code": null,
"scheme": "visa",
"co_scheme": null,
"preferred_scheme": null,
"type": "credit",
"bank_name": null,
"brand": null,
"category": null,
"iin": "400000",
"last_4_digits": "0101",
"fingerprint": "0f041fb914a50c7555df2318df1a9f9571cc96305c07b4f944e29fd17bfd1691",
"exp_month": 11,
"exp_year": 2026,
"cvc_check": "unavailable",
"avs_check": "unavailable",
"checks": {
"cvc_check": "unavailable",
"cvc_check_reason": null,
"avs_check": "unavailable",
"avs_postal_check": "unavailable",
"avs_postal_check_reason": null,
"avs_street_check": "unavailable",
"avs_street_check_reason": null,
"avs_name_check": "unavailable",
"avs_name_check_reason": null
},
"token_type": null,
"name": "Mat\u00e9o Garnier",
"address1": "133 rue Lamarck",
"address2": "Cedex 7",
"city": "Paris",
"state": "Ile De France",
"country_code": "US",
"billing_country_code": "FR",
"zip": "75018",
"ip_address": "1.2.3.4",
"user_agent": "PostmanRuntime/7.32.2",
"header_accept": "*/*",
"app_color_depth": null,
"app_java_enabled": null,
"app_language": null,
"app_screen_height": null,
"app_screen_width": null,
"app_timezone_offset": null,
"header_referer": null,
"expires_soon": false,
"metadata": {},
"used": null,
"sandbox": true,
"created_at": "2023-04-22T10:10:21.019103785Z",
"updated_at": "2023-04-22T10:10:21.019103681Z",
"id": "card_zZAeVmdrJjN58PbB8lVSrqh3rqEuH3Ai",
"cvc_tokenized": true,
"tokenization_method": null,
"payment_source_detail": null
},
"success": true
}
}
},
"schema": {
"type": "object",
"properties": {
"card": {
"type": "object",
"properties": {
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"update_type": {},
"update_reason_code": {},
"scheme": {
"type": "string",
"example": "visa"
},
"co_scheme": {},
"preferred_scheme": {},
"type": {
"type": "string",
"example": "credit"
},
"bank_name": {},
"brand": {},
"category": {},
"iin": {
"type": "string",
"example": "400000"
},
"last_4_digits": {
"type": "string",
"example": "0101"
},
"fingerprint": {
"type": "string",
"example": "0f041fb914a50c7555df2318df1a9f9571cc96305c07b4f944e29fd17bfd1691"
},
"exp_month": {
"type": "integer",
"example": 11,
"default": 0
},
"exp_year": {
"type": "integer",
"example": 2026,
"default": 0
},
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unavailable"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "unavailable"
},
"avs_name_check_reason": {}
}
},
"token_type": {},
"name": {
"type": "string",
"example": "Mat\u00e9o Garnier"
},
"address1": {
"type": "string",
"example": "133 rue Lamarck"
},
"address2": {
"type": "string",
"example": "Cedex 7"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "US"
},
"billing_country_code": {
"type": "string"
},
"zip": {
"type": "string",
"example": "75018"
},
"ip_address": {
"type": "string",
"example": "1.2.3.4"
},
"user_agent": {
"type": "string",
"example": "PostmanRuntime/7.32.2"
},
"header_accept": {
"type": "string",
"example": "*/*"
},
"app_color_depth": {},
"app_java_enabled": {},
"app_language": {},
"app_screen_height": {},
"app_screen_width": {},
"app_timezone_offset": {},
"header_referer": {},
"expires_soon": {
"type": "boolean",
"example": false,
"default": true
},
"metadata": {
"type": "object",
"properties": {}
},
"used": {},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T10:10:21.019103785Z"
},
"updated_at": {
"type": "string",
"example": "2023-04-22T10:10:21.019103681Z"
},
"id": {
"type": "string",
"example": "card_zZAeVmdrJjN58PbB8lVSrqh3rqEuH3Ai"
},
"cvc_tokenized": {
"type": "boolean",
"example": true,
"default": true
},
"tokenization_method": {},
"payment_source_detail": {}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\":false,\n \"error_type\":\"card.invalid-number\",\n \"message\":\"Your card\u2019s number is invalid.\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"error_type": {
"type": "string",
"example": "card.invalid-number"
},
"message": {
"type": "string",
"example": "Your card\u2019s number is invalid."
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
}
}
},
"/customers": {
"post": {
"summary": "Creating a customer",
"description": "",
"operationId": "creating-a-customer",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "First name of the customer.
_Maximum 80 characters long. Automatically sanitised on write \u2014 emoji, currency symbols, and non-printable characters are stripped, and underscores are converted to spaces. All Unicode scripts are supported._"
},
"last_name": {
"type": "string",
"description": "Last name of the customer.
_Maximum 80 characters long. Automatically sanitised on write \u2014 emoji, currency symbols, and non-printable characters are stripped, and underscores are converted to spaces. All Unicode scripts are supported._"
},
"email": {
"type": "string",
"description": "Customer\u2019s email address.
_Must be a valid email_"
},
"address1": {
"type": "string",
"description": "First line of the customer\u2019s address.
_Maximum 80 characters long_"
},
"address2": {
"type": "string",
"description": "Second line of the customer\u2019s address.
_Maximum 80 characters long_"
},
"city": {
"type": "string",
"description": "City of the customer\u2019s address.
_Maximum 80 characters long_"
},
"state": {
"type": "string",
"description": "State or county of the customer\u2019s address.
_Maximum 80 characters long_"
},
"zip": {
"type": "string",
"description": "ZIP code of the customer\u2019s address.
_Maximum 16 characters long_"
},
"country_code": {
"type": "string",
"description": "Country code of the customer's address (`US`, `FR`...).
_Must be a valid ISO 3166 country code with 2 characters_"
},
"phone": {
"type": "object",
"description": "Phone number of the customer.",
"properties": {
"number": {
"type": "string",
"description": "Phone number without the dialing code.
_Maximum 14 characters long_"
},
"dialing_code": {
"type": "string",
"description": "International dialing code (Note: \u201c+\u201d will be treated as \u201c00\u201d)"
}
}
},
"legal_document": {
"type": "string",
"description": "Legal document number (required in some countries).
_Maximum 255 characters long; example for a CPF document in Brazil: 853.513.468-93_"
},
"ip_address": {
"type": "string",
"description": "IP address of the customer.
_Must be a valid IPv4 or IPv6 address_"
},
"sex": {
"type": "string",
"description": "Sex of the customer. Can be `male` or `female`."
},
"date_of_birth": {
"type": "string",
"description": "Customer\u2019s date of birth.
_RFC1123 date or timestamp_",
"format": "date"
},
"is_business": {
"type": "boolean",
"description": "Denotes whether or not the customer represents a business."
},
"metadata": {
"type": "string",
"description": "Metadata related to the customer, in the form of key-value pairs (string - string).",
"default": "{}",
"format": "json"
},
"registered_at": {
"type": "string",
"description": "Date when the customer was registered on your platform. This defaults to the same date as `created_at` if you omit it.
_RFC1123 date or timestamp_",
"format": "date"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"customer\": {\n \"id\": \"cust_IaR72c6JPoYdWvr5N1XX3blkH2ilRIvK\",\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"tokens\": null,\n \"subscriptions\": null,\n \"transactions\": null,\n \"balance\": \"0\",\n \"currency\": null,\n \"email\": \"lorenzo.roger@example.com\",\n \"first_name\": \"Lorenzo\",\n \"last_name\": \"Roger\",\n \"address1\": \"4848 Rue Abel\",\n \"address2\": \"Cedex 7\",\n \"city\": \"Poitiers\",\n \"state\": \"Pyr\u00e9n\u00e9es-Orientales\",\n \"zip\": \"29173\",\n \"country_code\": \"FR\",\n \"ip_address\": \"1.1.1.1\",\n \"phone\": {\n \"number\": \"685869595\",\n \"dialing_code\": \"0033\"\n },\n \"legal_document\": \"1122.434.234\",\n \"date_of_birth\": \"2001-11-11T04:56:05Z\",\n \"metadata\": {},\n \"sandbox\": true,\n \"created_at\": \"2023-04-22T08:55:55.645447048Z\",\n \"registered_at\": \"2005-08-07T23:19:49Z\",\n \"is_business\": false,\n \"sex\": \"male\",\n \"default_token_id\": null\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "cust_IaR72c6JPoYdWvr5N1XX3blkH2ilRIvK"
},
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"tokens": {},
"subscriptions": {},
"transactions": {},
"balance": {
"type": "string",
"example": "0"
},
"currency": {},
"email": {
"type": "string",
"example": "lorenzo.roger@example.com"
},
"first_name": {
"type": "string",
"example": "Lorenzo"
},
"last_name": {
"type": "string",
"example": "Roger"
},
"address1": {
"type": "string",
"example": "4848 Rue Abel"
},
"address2": {
"type": "string",
"example": "Cedex 7"
},
"city": {
"type": "string",
"example": "Poitiers"
},
"state": {
"type": "string",
"example": "Pyr\u00e9n\u00e9es-Orientales"
},
"zip": {
"type": "string",
"example": "29173"
},
"country_code": {
"type": "string",
"example": "FR"
},
"ip_address": {
"type": "string",
"example": "1.1.1.1"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string",
"example": "685869595"
},
"dialing_code": {
"type": "string",
"example": "0033"
}
}
},
"legal_document": {
"type": "string",
"example": "1122.434.234"
},
"date_of_birth": {
"type": "string",
"example": "2001-11-11T04:56:05Z"
},
"metadata": {
"type": "object",
"properties": {}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T08:55:55.645447048Z"
},
"registered_at": {
"type": "string",
"example": "2005-08-07T23:19:49Z"
},
"is_business": {
"type": "boolean",
"example": false,
"default": true
},
"sex": {
"type": "string",
"example": "male"
},
"default_token_id": {}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"request.validation.invalid-ip-address\",\n \"message\": \"The customer IP address is invalid.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "request.validation.invalid-ip-address"
},
"message": {
"type": "string",
"example": "The customer IP address is invalid."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nvar customer = client.newCustomer().create({\n \"email\": \"john@smith.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n}).then(function(customer) {\n //\n\n}, function(err) {\n // An error occured\n\n});",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ncustomer = client.new_customer().create({\n \"email\": \"john@smith.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n})"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ncustomer = client.customer.create(\n email: \"john@smith.com\",\n first_name: \"John\",\n last_name: \"Smith\"\n)"
},
{
"language": "php",
"code": "newCustomer()->create(array(\n \"email\" => \"john@smith.com\",\n \"first_name\" => \"John\",\n \"last_name\" => \"Smith\"\n));"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\ncust, err := client.NewCustomer().Create(processout.CustomerCreateParameters{\n Customer: &processout.Customer{\n Email: processout.String(\"john@smith.com\"),\n FirstName: processout.String(\"John\"),\n LastName: processout.String(\"Smith\"),\n },\n})"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/customers/{customer_id}/tokens": {
"post": {
"summary": "Creating a token",
"description": "",
"operationId": "creating-a-token",
"parameters": [
{
"name": "customer_id",
"in": "path",
"description": "ID of your customer",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"properties": {},
"type": "object"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"invoice_id": {
"type": "string",
"description": "Invoice ID that'll be used to verify the token. By default, ProcessOut will create its own invoice."
},
"description": {
"type": "string",
"description": "Description that will be sent to the tokenization gateway service."
},
"invoice_return_url": {
"type": "string",
"description": "This is the URL to be set on the invoice that is created for card verification (when `verify` is set to `true`).
_Must be a valid URL_"
},
"return_url": {
"type": "string",
"description": "For APMs, this is the URL to return to the app after payment is accepted.
_Must be a valid URL_"
},
"cancel_url": {
"type": "string",
"description": "For APMs, this is the URL to return to the app after payment is canceled.
_Must be a valid URL_"
},
"metadata": {
"type": "object",
"description": "Metadata related to the token, in the form of key-value pairs (string - string).",
"properties": {}
},
"source": {
"type": "string",
"description": "If you already have the payment details (`card_` or `gway_req_`), you can already assign it to the token."
},
"verify": {
"type": "boolean",
"description": "Flag if you wish to verify the customer token by making zero value transaction. Applicable for cards only."
},
"verify_statement_descriptor": {
"type": "string",
"description": "Statement descriptor set for invoice in verification flow. Used only when `verify` is true."
},
"verify_metadata": {
"type": "string",
"description": "Metadata set for invoice in verification flow. Used only when `verify` is true and no custom invoice ID passed in."
},
"manual_invoice_cancellation": {
"type": "boolean",
"description": "If set to true, verification invoice will not automatically be voided after verification. This parameter controls autovoid when a custom invoice is created for token verification.
This is to perform verification on PSPs that do not support explicit verification, or you are wanting to conduct a buy and tokenize flow whereby this must be set to true (Please reach out to your account manager to understand PSP Support for this.)"
},
"webhook_url": {
"type": "string",
"description": "Custom webhook URL for this customer token. Customer token events will be sent to this URL on top off your webhook endpoint URL.
_Must be a valid URL_"
},
"device": {
"type": "object",
"description": "Information about the device and channel used by the customer to initiate the payment.",
"properties": {
"id": {
"type": "string",
"description": "ID of the device. This can be anything but would usually be a UUID generated by a third-party anti-fraud solution.
_Maximum 100 characters long_"
},
"channel": {
"type": "string",
"description": "Channel used by the device. Must be `web`, `ios`, `android` or `other`. Note: Please only set this field to `ios` or `android` if you are utilising our mobile SDKs."
},
"ip_address": {
"type": "string",
"description": "IP address of the device.
_Must be a valid IP address_"
}
}
},
"preferred_scheme": {
"type": "string",
"description": "The scheme the customer would prefer to process the transaction on. Ex: carte bancaire vs visa. This only applies to card verifications."
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Card token attached": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": null,\n \"gateway_configuration_sub_account\": null,\n \"card\": {\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"update_type\": null,\n \"update_reason_code\": null,\n \"scheme\": \"visa\",\n \"co_scheme\": null,\n \"preferred_scheme\": null,\n \"type\": \"credit\",\n \"bank_name\": null,\n \"brand\": null,\n \"category\": null,\n \"iin\": \"400000\",\n \"last_4_digits\": \"0101\",\n \"fingerprint\": \"43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"cvc_check\": \"unavailable\",\n \"avs_check\": \"unavailable\",\n \"checks\": {\n \"cvc_check\": \"unavailable\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"unavailable\",\n \"avs_postal_check\": \"unavailable\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unavailable\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"unavailable\",\n \"avs_name_check_reason\": null\n },\n \"token_type\": null,\n \"name\": \"Mat\u00e9o Garnier\",\n \"address1\": \"133 rue Lamarck\",\n \"address2\": \"Cedex 7\",\n \"city\": \"Paris\",\n \"state\": \"Ile De France\",\n \"country_code\": \"US\",\n \"zip\": \"75018\",\n \"ip_address\": \"176.27.120.213\",\n \"user_agent\": \"PostmanRuntime/7.32.2\",\n \"header_accept\": \"*/*\",\n \"app_color_depth\": null,\n \"app_java_enabled\": null,\n \"app_language\": null,\n \"app_screen_height\": null,\n \"app_screen_width\": null,\n \"app_timezone_offset\": null,\n \"header_referer\": null,\n \"expires_soon\": false,\n \"metadata\": {},\n \"used\": null,\n \"sandbox\": true,\n \"created_at\": \"2023-04-22T10:37:15.854105Z\",\n \"updated_at\": \"2023-04-22T10:37:15.854104Z\",\n \"id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"cvc_tokenized\": true,\n \"tokenization_method\": null,\n \"payment_source_detail\": null\n },\n \"card_id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"is_subscription_only\": false,\n \"is_default\": true,\n \"return_url\": \"https://mymerchant.com/return\",\n \"cancel_url\": \"https://mymerchant.com/cancel\",\n \"is_chargeable\": true,\n \"type\": \"card\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T10:37:17.950649Z\",\n \"summary\": \"**** **** **** 0101\",\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": null\n }\n}"
},
"APM token attached": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_X6kIALJ8FR1x8wDuzOoWQRyZIbtzpA22\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"gateway_configuration_sub_account\": null,\n \"card_id\": null,\n \"is_subscription_only\": false,\n \"is_default\": false,\n \"return_url\": null,\n \"cancel_url\": null,\n \"is_chargeable\": true,\n \"type\": \"gateway_token\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T09:36:33.798042Z\",\n \"summary\": \"test_summary\",\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": true\n }\n}"
},
"Empty token": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_ETX8PdnQtKduob3ypkrJiHTNlK0skH6c\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": null,\n \"gateway_configuration_sub_account\": null,\n \"card_id\": null,\n \"is_subscription_only\": false,\n \"is_default\": false,\n \"return_url\": \"https://mymerchant.com/return\",\n \"cancel_url\": \"https://mymerchant.com/cancel\",\n \"is_chargeable\": false,\n \"type\": \"pending\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T10:39:09.826201718Z\",\n \"summary\": null,\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": null\n }\n}"
},
"Card token with Network Token pending": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": null,\n \"gateway_configuration_sub_account\": null,\n \"network_token\": {\n \t\t\"id\": \"nt_3f9jfiojfewFEW3fkaio3FdfaOL\",\n \t\"status\": \"pending\"\n },\n \"card\": {\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"update_type\": null,\n \"update_reason_code\": null,\n \"scheme\": \"visa\",\n \"co_scheme\": null,\n \"preferred_scheme\": null,\n \"type\": \"credit\",\n \"bank_name\": null,\n \"brand\": null,\n \"category\": null,\n \"iin\": \"400000\",\n \"last_4_digits\": \"0101\",\n \"fingerprint\": \"43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"cvc_check\": \"unavailable\",\n \"avs_check\": \"unavailable\",\n \"checks\": {\n \"cvc_check\": \"unavailable\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"unavailable\",\n \"avs_postal_check\": \"unavailable\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unavailable\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"unavailable\",\n \"avs_name_check_reason\": null\n },\n \"token_type\": null,\n \"name\": \"Mat\u00e9o Garnier\",\n \"address1\": \"133 rue Lamarck\",\n \"address2\": \"Cedex 7\",\n \"city\": \"Paris\",\n \"state\": \"Ile De France\",\n \"country_code\": \"US\",\n \"zip\": \"75018\",\n \"ip_address\": \"176.27.120.213\",\n \"user_agent\": \"PostmanRuntime/7.32.2\",\n \"header_accept\": \"*/*\",\n \"app_color_depth\": null,\n \"app_java_enabled\": null,\n \"app_language\": null,\n \"app_screen_height\": null,\n \"app_screen_width\": null,\n \"app_timezone_offset\": null,\n \"header_referer\": null,\n \"expires_soon\": false,\n \"metadata\": {},\n \"used\": null,\n \"sandbox\": true,\n \"created_at\": \"2023-04-22T10:37:15.854105Z\",\n \"updated_at\": \"2023-04-22T10:37:15.854104Z\",\n \"id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"cvc_tokenized\": true,\n \"tokenization_method\": null,\n \"payment_source_detail\": null\n },\n \"card_id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"is_subscription_only\": false,\n \"is_default\": true,\n \"return_url\": \"https://mymerchant.com/return\",\n \"cancel_url\": \"https://mymerchant.com/cancel\",\n \"is_chargeable\": true,\n \"type\": \"card\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T10:37:17.950649Z\",\n \"summary\": \"**** **** **** 0101\",\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": null\n }\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Card token attached",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {},
"gateway_configuration_sub_account": {},
"card": {
"type": "object",
"properties": {
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"update_type": {},
"update_reason_code": {},
"scheme": {
"type": "string",
"example": "visa"
},
"co_scheme": {},
"preferred_scheme": {},
"type": {
"type": "string",
"example": "credit"
},
"bank_name": {},
"brand": {},
"category": {},
"iin": {
"type": "string",
"example": "400000"
},
"last_4_digits": {
"type": "string",
"example": "0101"
},
"fingerprint": {
"type": "string",
"example": "43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79"
},
"exp_month": {
"type": "integer",
"example": 7,
"default": 0
},
"exp_year": {
"type": "integer",
"example": 2026,
"default": 0
},
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unavailable"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "unavailable"
},
"avs_name_check_reason": {}
}
},
"token_type": {},
"name": {
"type": "string",
"example": "Mat\u00e9o Garnier"
},
"address1": {
"type": "string",
"example": "133 rue Lamarck"
},
"address2": {
"type": "string",
"example": "Cedex 7"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "US"
},
"zip": {
"type": "string",
"example": "75018"
},
"ip_address": {
"type": "string",
"example": "176.27.120.213"
},
"user_agent": {
"type": "string",
"example": "PostmanRuntime/7.32.2"
},
"header_accept": {
"type": "string",
"example": "*/*"
},
"app_color_depth": {},
"app_java_enabled": {},
"app_language": {},
"app_screen_height": {},
"app_screen_width": {},
"app_timezone_offset": {},
"header_referer": {},
"expires_soon": {
"type": "boolean",
"example": false,
"default": true
},
"metadata": {
"type": "object",
"properties": {}
},
"used": {},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854105Z"
},
"updated_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854104Z"
},
"id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"cvc_tokenized": {
"type": "boolean",
"example": true,
"default": true
},
"tokenization_method": {},
"payment_source_detail": {}
}
},
"card_id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": true,
"default": true
},
"return_url": {
"type": "string",
"example": "https://mymerchant.com/return"
},
"cancel_url": {
"type": "string",
"example": "https://mymerchant.com/cancel"
},
"is_chargeable": {
"type": "boolean",
"example": true,
"default": true
},
"type": {
"type": "string",
"example": "card"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:17.950649Z"
},
"summary": {
"type": "string",
"example": "**** **** **** 0101"
},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {}
}
}
}
},
{
"title": "APM token attached",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_X6kIALJ8FR1x8wDuzOoWQRyZIbtzpA22"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"gateway_configuration_sub_account": {},
"card_id": {},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": false,
"default": true
},
"return_url": {},
"cancel_url": {},
"is_chargeable": {
"type": "boolean",
"example": true,
"default": true
},
"type": {
"type": "string",
"example": "gateway_token"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T09:36:33.798042Z"
},
"summary": {
"type": "string",
"example": "test_summary"
},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
},
{
"title": "Empty token",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_ETX8PdnQtKduob3ypkrJiHTNlK0skH6c"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {},
"gateway_configuration_sub_account": {},
"card_id": {},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": false,
"default": true
},
"return_url": {
"type": "string",
"example": "https://mymerchant.com/return"
},
"cancel_url": {
"type": "string",
"example": "https://mymerchant.com/cancel"
},
"is_chargeable": {
"type": "boolean",
"example": false,
"default": true
},
"type": {
"type": "string",
"example": "pending"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T10:39:09.826201718Z"
},
"summary": {},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {}
}
}
}
},
{
"title": "Card token with Network Token pending",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {},
"gateway_configuration_sub_account": {},
"network_token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "nt_3f9jfiojfewFEW3fkaio3FdfaOL"
},
"status": {
"type": "string",
"example": "pending"
}
}
},
"card": {
"type": "object",
"properties": {
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"update_type": {},
"update_reason_code": {},
"scheme": {
"type": "string",
"example": "visa"
},
"co_scheme": {},
"preferred_scheme": {},
"type": {
"type": "string",
"example": "credit"
},
"bank_name": {},
"brand": {},
"category": {},
"iin": {
"type": "string",
"example": "400000"
},
"last_4_digits": {
"type": "string",
"example": "0101"
},
"fingerprint": {
"type": "string",
"example": "43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79"
},
"exp_month": {
"type": "integer",
"example": 7,
"default": 0
},
"exp_year": {
"type": "integer",
"example": 2026,
"default": 0
},
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unavailable"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "unavailable"
},
"avs_name_check_reason": {}
}
},
"token_type": {},
"name": {
"type": "string",
"example": "Mat\u00e9o Garnier"
},
"address1": {
"type": "string",
"example": "133 rue Lamarck"
},
"address2": {
"type": "string",
"example": "Cedex 7"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "US"
},
"zip": {
"type": "string",
"example": "75018"
},
"ip_address": {
"type": "string",
"example": "176.27.120.213"
},
"user_agent": {
"type": "string",
"example": "PostmanRuntime/7.32.2"
},
"header_accept": {
"type": "string",
"example": "*/*"
},
"app_color_depth": {},
"app_java_enabled": {},
"app_language": {},
"app_screen_height": {},
"app_screen_width": {},
"app_timezone_offset": {},
"header_referer": {},
"expires_soon": {
"type": "boolean",
"example": false,
"default": true
},
"metadata": {
"type": "object",
"properties": {}
},
"used": {},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854105Z"
},
"updated_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854104Z"
},
"id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"cvc_tokenized": {
"type": "boolean",
"example": true,
"default": true
},
"tokenization_method": {},
"payment_source_detail": {}
}
},
"card_id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": true,
"default": true
},
"return_url": {
"type": "string",
"example": "https://mymerchant.com/return"
},
"cancel_url": {
"type": "string",
"example": "https://mymerchant.com/cancel"
},
"is_chargeable": {
"type": "boolean",
"example": true,
"default": true
},
"type": {
"type": "string",
"example": "card"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:17.950649Z"
},
"summary": {
"type": "string",
"example": "**** **** **** 0101"
},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {}
}
}
}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"request.validation.invalid-description\",\n \"message\": \"The description Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... must be at most 255 characters long.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "request.validation.invalid-description"
},
"message": {
"type": "string",
"example": "The description Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... must be at most 255 characters long."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.customer.not-found\",\n \"message\": \"The customer could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.customer.not-found"
},
"message": {
"type": "string",
"example": "The customer could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newToken().create({\n customer_id: \"cust_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\", \n source: \"card_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\"\n}).then(function(token) {\n // \n\n}, function(err) {\n // An error occured\n\n});",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ntoken = client.new_token().create({\n \"customer_id\": \"cust_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\",\n \"source\": \"card_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\"\n})"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ntoken = client.token.create(\n customer_id: \"cust_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\",\n source: \"card_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\"\n)"
},
{
"language": "php",
"code": "newToken()->create(array(\n \"customer_id\" => \"cust_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\",\n \"source\" => \"card_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\"\n));"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\ntoken, err := client.NewToken().Create(processout.TokenCreateParameters{\n Token: &processout.Token{\n CustomerID: processout.String(\"cust_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\"),\n },\n Source: \"card_C4hZXQTU0aWoYeenHYC0DektYDqf8ocj\",\n})"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/invoices/{invoice_id}": {
"delete": {
"summary": "Delete an invoice",
"description": "Delete invoices that have not had a payment started yet.",
"operationId": "delete-an-invoice",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
},
{
"name": "invoice_id",
"in": "path",
"description": "The invoice ID generated by ProcessOut during the invoice creation",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.invoice.not-found\",\n \"message\": \"The invoice could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.invoice.not-found"
},
"message": {
"type": "string",
"example": "The invoice could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newInvoice().delete(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\").then(\n function(invoice) {\n // The invoice was deleted\n\n }, function(err) {\n // The invoice could not be found\n });",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ninvoice = client.new_invoice().delete(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\")"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ninvoice = client.invoice.delete(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\")"
},
{
"language": "php",
"code": "newInvoice()->delete(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\");"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\niv, err := client.NewInvoice().Delete(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\")"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
},
"get": {
"summary": "Fetch an invoice",
"description": "",
"operationId": "fetch-an-invoice",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
},
{
"name": "invoice_id",
"in": "path",
"description": "The invoice ID generated by ProcessOut during the invoice creation",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"invoice\": {\n \"id\": \"iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG\",\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"subscription_id\": null,\n \"customer_id\": \"cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw\",\n \"token_id\": null,\n \"details\": [\n {\n \"id\": \"iv_det_M2LqRkMXxkTSu4CWTMY0X4QKrzz2Urbu\",\n \"name\": \"iPhone 14 Pro\",\n \"type\": \"Smartphone\",\n \"amount\": \"1000\",\n \"quantity\": 1,\n \"reference\": \"12221341242\",\n \"description\": \"iPhone 11 Pro 256Gb Red blablabla\",\n \"brand\": \"Apple\",\n \"model\": \"14 Pro\",\n \"discount_amount\": \"0\",\n \"condition\": \"new\",\n \"marketplace_merchant\": null,\n \"marketplace_merchant_is_business\": null,\n \"marketplace_merchant_created_at\": null,\n \"category\": \"technology\",\n \"metadata\": {}\n }\n ],\n \"transaction_id\": \"tr_Cln3zmZ31m5Crcgz5sfggomIiMm3Mmbm\",\n \"name\": \"Amazing Product\",\n \"order_id\": \"123456\",\n \"amount\": \"29\",\n \"currency\": \"EUR\",\n \"metadata\": {\n \"fruit\": \"banana\"\n },\n \"gateway_data\": {},\n \"exemption_reason_3ds2\": \"\",\n \"challenge_indicator\": \"\",\n \"sca_exemption_reason\": \"\",\n \"statement_descriptor\": \"My Company\",\n \"merchant_initiator_type\": null,\n \"initiation_type\": \"MIT\",\n \"payment_intent\": \"recurring\",\n \"require_backend_capture\": null,\n \"card_verification\": null,\n \"return_url\": \"https://mycompany.com/return-url\",\n \"cancel_url\": null,\n \"webhook_url\": \"https://mycompany.com/webhook\",\n \"sandbox\": true,\n \"url\": \"https://checkout.processout.com/test-proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S/iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG\",\n \"created_at\": \"2023-04-21T17:57:22.807583563Z\",\n \"expires_at\": null,\n \"risk\": {\n \"score\": \"100\",\n \"is_legit\": true,\n \"skip_gateway_rules\": false\n },\n \"device\": {\n \"id\": \"112233445566\",\n \"channel\": \"ios\",\n \"ip_address\": \"1.1.1.1\"\n },\n \"shipping\": {\n \"amount\": \"12\",\n \"method\": \"home\",\n \"provider\": \"DHL\",\n \"delay\": \"express\",\n \"address1\": \"133 Rue Lamarck\",\n \"address2\": \"CEDEX 1\",\n \"city\": \"Paris\",\n \"state\": \"Ile De France\",\n \"country_code\": \"FR\",\n \"zip\": \"75018\",\n \"phone\": {\n \"number\": \"685869595\",\n \"dialing_code\": \"0033\"\n },\n \"expects_shipping_at\": \"2023-04-21T17:52:47.828402061Z\",\n \"relay_store_name\": \"none\"\n },\n \"incremental\": false,\n \"tax\": {\n \"rate\": \"1\",\n \"amount\": \"10\"\n },\n \"payment_type\": null\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"invoice": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG"
},
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"subscription_id": {},
"customer_id": {
"type": "string",
"example": "cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw"
},
"token_id": {},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "iv_det_M2LqRkMXxkTSu4CWTMY0X4QKrzz2Urbu"
},
"name": {
"type": "string",
"example": "iPhone 14 Pro"
},
"type": {
"type": "string",
"example": "Smartphone"
},
"amount": {
"type": "string",
"example": "1000"
},
"quantity": {
"type": "integer",
"example": 1,
"default": "1"
},
"reference": {
"type": "string",
"example": "12221341242"
},
"description": {
"type": "string",
"example": "iPhone 11 Pro 256Gb Red blablabla"
},
"brand": {
"type": "string",
"example": "Apple"
},
"model": {
"type": "string",
"example": "14 Pro"
},
"discount_amount": {
"type": "string",
"example": "0"
},
"condition": {
"type": "string",
"example": "new"
},
"marketplace_merchant": {},
"marketplace_merchant_is_business": {},
"marketplace_merchant_created_at": {},
"category": {
"type": "string",
"example": "technology"
},
"metadata": {
"type": "object",
"properties": {}
}
}
}
},
"transaction_id": {
"type": "string",
"example": "tr_Cln3zmZ31m5Crcgz5sfggomIiMm3Mmbm"
},
"name": {
"type": "string",
"example": "Amazing Product"
},
"order_id": {
"type": "string",
"example": "123456"
},
"amount": {
"type": "string",
"example": "29"
},
"currency": {
"type": "string",
"example": "EUR"
},
"metadata": {
"type": "object",
"properties": {
"fruit": {
"type": "string",
"example": "banana"
}
}
},
"gateway_data": {
"type": "object",
"properties": {}
},
"exemption_reason_3ds2": {
"type": "string",
"example": ""
},
"challenge_indicator": {
"type": "string",
"example": ""
},
"sca_exemption_reason": {
"type": "string",
"example": ""
},
"statement_descriptor": {
"type": "string",
"example": "My Company"
},
"merchant_initiator_type": {},
"initiation_type": {
"type": "string",
"example": "MIT"
},
"payment_intent": {
"type": "string",
"example": "recurring"
},
"require_backend_capture": {},
"card_verification": {},
"return_url": {
"type": "string",
"example": "https://mycompany.com/return-url"
},
"cancel_url": {},
"webhook_url": {
"type": "string",
"example": "https://mycompany.com/webhook"
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"url": {
"type": "string",
"example": "https://checkout.processout.com/test-proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S/iv_MyNUnrEwNf7mrXZO1x6x8eeCoTWC8OQG"
},
"created_at": {
"type": "string",
"example": "2023-04-21T17:57:22.807583563Z"
},
"expires_at": {},
"risk": {
"type": "object",
"properties": {
"score": {
"type": "string",
"example": "100"
},
"is_legit": {
"type": "boolean",
"example": true,
"default": true
},
"skip_gateway_rules": {
"type": "boolean",
"example": false,
"default": true
}
}
},
"device": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "112233445566"
},
"channel(deprecated)": {
"type": "string",
"example": "ios"
},
"threeds_sdk": {
"type": "string"
},
"platform": {
"type": "string"
},
"ip_address": {
"type": "string",
"example": "1.1.1.1"
}
}
},
"shipping": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"example": "12"
},
"method": {
"type": "string",
"example": "home"
},
"provider": {
"type": "string",
"example": "DHL"
},
"delay": {
"type": "string",
"example": "express"
},
"address1": {
"type": "string",
"example": "133 Rue Lamarck"
},
"address2": {
"type": "string",
"example": "CEDEX 1"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "FR"
},
"zip": {
"type": "string",
"example": "75018"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string",
"example": "685869595"
},
"dialing_code": {
"type": "string",
"example": "0033"
}
}
},
"expects_shipping_at": {
"type": "string",
"example": "2023-04-21T17:52:47.828402061Z"
},
"relay_store_name": {
"type": "string",
"example": "none"
}
}
},
"incremental": {
"type": "boolean",
"example": false,
"default": true
},
"tax": {
"type": "object",
"properties": {
"rate": {
"type": "string",
"example": "1"
},
"amount": {
"type": "string",
"example": "10"
}
}
},
"payment_type": {}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.invoice.not-found\",\n \"message\": \"The invoice could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.invoice.not-found"
},
"message": {
"type": "string",
"example": "The invoice could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newInvoice().find(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\").then(\n function(invoice) {\n // The invoice was fetched\n\n }, function(err) {\n // The invoice could not be found\n });",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ninvoice = client.new_invoice().find(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\")"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ninvoice = client.invoice.find(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\")"
},
{
"language": "php",
"code": "newInvoice()->find(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\");"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\niv, err := client.NewInvoice().Find(\"iv_MgeLS2Rr3ZGwjqOvDvYSuWx7ce88luXl\")"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/payouts/{payout_id}": {
"delete": {
"summary": "Deleting payout",
"description": "",
"operationId": "deleting-payout",
"parameters": [
{
"name": "payout_id",
"in": "path",
"description": "ID of the payout",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Fetching a payout",
"description": "",
"operationId": "fetching-a-payout",
"parameters": [
{
"name": "payout_id",
"in": "path",
"description": "ID of the payout, received via webhooks or fetched with the API",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"payout\": {\n \"id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_configuration\": {\n \"id\": \"gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_id\": 6,\n \"gateway_name\": \"stripe\",\n \"name\": \"Stripe US\",\n \"default_currency\": \"USD\",\n \"processing_region\": null,\n \"merchant_account_country_code\": null,\n \"enabled\": true,\n \"sub_accounts_enabled\": [\n \"stripe\"\n ],\n \"public_keys\": {\n \"public_key\": \"pk_test_pFEddfERFEdfEFE\"\n },\n \"is_pulling\": false,\n \"config_entries\": null,\n \"sandbox\": false,\n \"created_at\": \"2017-12-12T16:25:49.238147Z\",\n \"enabled_at\": \"2017-12-12T16:25:50.553585Z\"\n },\n \"gateway_configuration_id\": \"gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2\",\n \"report_ids\": [\n \"rep_123CLedNlW2WSdqEF0DlxWJtBOZfvMK0\",\n \"rep_456CLedNlW2WSdqEF0DlxWJtBOZfvMK1\"\n ],\n \"gateway_resource_id\": \"po_1GZ5A3GY1kBCI7IQNUjT6oeK\",\n \"status\": \"received\",\n \"failure_reason_code\": null,\n \"failure_reason\": null,\n \"metadata\": {},\n \"amount\": \"5315.26\",\n \"currency\": \"EUR\",\n \"bank_name\": \"N26 BANK GMBH\",\n \"bank_summary\": \"\",\n \"sales_transactions\": 617,\n \"sales_volume\": \"5549.72\",\n \"sales_fees\": \"-234.46\",\n \"refunds_transactions\": 0,\n \"refunds_volume\": \"0\",\n \"refunds_fees\": \"0\",\n \"chargebacks_transactions\": 0,\n \"chargebacks_volume\": \"0\",\n \"chargebacks_fees\": \"0\",\n \"fees\": \"-234.46\",\n\t\t\t \"adjustments\": \"0\",\n \"adjustments_volume\": \"0\",\n \"adjustments_fees\": \"0\",\n \"reserve\": \"0\",\n \"reserve_volume\": \"0\",\n \"reserve_fees\": \"0\",\n \"settled_at\": \"2020-04-16T23:59:25Z\",\n \"created_at\": \"2020-04-18T01:17:48.755358Z\"\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"payout": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe"
},
"project_id": {
"type": "string",
"example": "proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh"
},
"gateway_configuration": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2"
},
"project_id": {
"type": "string",
"example": "proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh"
},
"gateway_id": {
"type": "integer",
"example": 6,
"default": 0
},
"gateway_name": {
"type": "string",
"example": "stripe"
},
"name": {
"type": "string",
"example": "Stripe US"
},
"default_currency": {
"type": "string",
"example": "USD"
},
"processing_region": {},
"merchant_account_country_code": {},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"sub_accounts_enabled": {
"type": "array",
"items": {
"type": "string",
"example": "stripe"
}
},
"public_keys": {
"type": "object",
"properties": {
"public_key": {
"type": "string",
"example": "pk_test_pFEddfERFEdfEFE"
}
}
},
"is_pulling": {
"type": "boolean",
"example": false,
"default": true
},
"config_entries": {},
"sandbox": {
"type": "boolean",
"example": false,
"default": true
},
"created_at": {
"type": "string",
"example": "2017-12-12T16:25:49.238147Z"
},
"enabled_at": {
"type": "string",
"example": "2017-12-12T16:25:50.553585Z"
}
}
},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2"
},
"report_ids": {
"type": "array",
"items": {
"type": "string",
"example": "rep_123CLedNlW2WSdqEF0DlxWJtBOZfvMK0"
}
},
"gateway_resource_id": {
"type": "string",
"example": "po_1GZ5A3GY1kBCI7IQNUjT6oeK"
},
"status": {
"type": "string",
"example": "received"
},
"failure_reason_code": {},
"failure_reason": {},
"metadata": {
"type": "object",
"properties": {}
},
"amount": {
"type": "string",
"example": "5315.26"
},
"currency": {
"type": "string",
"example": "EUR"
},
"bank_name": {
"type": "string",
"example": "N26 BANK GMBH"
},
"bank_summary": {
"type": "string",
"example": ""
},
"sales_transactions": {
"type": "integer",
"example": 617,
"default": 0
},
"sales_volume": {
"type": "string",
"example": "5549.72"
},
"sales_fees": {
"type": "string",
"example": "-234.46"
},
"refunds_transactions": {
"type": "integer",
"example": 0,
"default": 0
},
"refunds_volume": {
"type": "string",
"example": "0"
},
"refunds_fees": {
"type": "string",
"example": "0"
},
"chargebacks_transactions": {
"type": "integer",
"example": 0,
"default": 0
},
"chargebacks_volume": {
"type": "string",
"example": "0"
},
"chargebacks_fees": {
"type": "string",
"example": "0"
},
"fees": {
"type": "string",
"example": "-234.46"
},
"adjustments": {
"type": "string",
"example": "0"
},
"adjustments_volume": {
"type": "string",
"example": "0"
},
"adjustments_fees": {
"type": "string",
"example": "0"
},
"reserve": {
"type": "string",
"example": "0"
},
"reserve_volume": {
"type": "string",
"example": "0"
},
"reserve_fees": {
"type": "string",
"example": "0"
},
"settled_at": {
"type": "string",
"example": "2020-04-16T23:59:25Z"
},
"created_at": {
"type": "string",
"example": "2020-04-18T01:17:48.755358Z"
}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\":\"resource.payout.not-found\",\n \"message\":\"The payout could not be found.\",\n \"success\":false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.payout.not-found"
},
"message": {
"type": "string",
"example": "The payout could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newPayout().find(\"payt_3vfLtjoiQxpXZrdd6dc8Qgxxe26vy0aH\").then(\n function(payout) {\n // The payout was fetched\n\n }, function(err) {\n // The payout could not be found\n });",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\npayout = client.new_payout().find(\"payt_3vfLtjoiQxpXZrdd6dc8Qgxxe26vy0aH\")"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\npayout = client.payout.find(\"payt_3vfLtjoiQxpXZrdd6dc8Qgxxe26vy0aH\")"
},
{
"language": "php",
"code": "newPayout()->find(\"payt_3vfLtjoiQxpXZrdd6dc8Qgxxe26vy0aH\");"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\npayout, err := client.NewPayout().Find(\"payt_3vfLtjoiQxpXZrdd6dc8Qgxxe26vy0aH\")"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/projects/{project_id}/sftp-settings": {
"delete": {
"summary": "Deleting SFTP payouts export",
"description": "",
"operationId": "deleting-sftp-payouts-export",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "ID of the project for which the SFTP settings are updated",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Setting up SFTP payouts export",
"description": "",
"operationId": "setting-up-sftp-payouts-export",
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "ID of the project for which the SFTP settings are updated",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"endpoint",
"username"
],
"properties": {
"endpoint": {
"type": "string",
"description": "SFTP server endpoint, port should be included. For example: 'example.com:22'"
},
"username": {
"type": "string",
"description": "SFTP server username"
},
"password": {
"type": "string",
"description": "SFTP server password, required when no 'private_key' is passed"
},
"private_key": {
"type": "string",
"description": "SFTP server private key encoded in base64 format, required when no 'password' is passed"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
}
},
"/uploads/reports/{report_id}": {
"delete": {
"summary": "Deleting uploaded report",
"description": "",
"operationId": "deleting-uploaded-report",
"parameters": [
{
"name": "report_id",
"in": "path",
"description": "ID of the uploaded report",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Fetching report",
"description": "",
"operationId": "fetching-report",
"parameters": [
{
"name": "report_id",
"in": "path",
"description": "ID of the report",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"report\": {\n \"id\": \"rep_123CLedNlW2WSdqEF0DlxWJtBOZfvMK0\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_configuration_id\": \"gway_conf_123exd5kivrg3iwpdt2rcbovgx9ixa7\",\n \"gateway_resource_id\": null,\n \"description\": \"file1.csv\",\n \"error\": null,\n \"is_processed\": true,\n \"payload_size_bytes\": 65901,\n \"processed_bytes\": 65901,\n \"status\": \"processed\",\n \"progress_percentage\": 100,\n \"contains_data_from\": null,\n \"contains_data_to\": null,\n \"created_at\": \"2024-07-25T09:36:21.144754Z\"\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"report": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "rep_123CLedNlW2WSdqEF0DlxWJtBOZfvMK0"
},
"project_id": {
"type": "string",
"example": "proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh"
},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_123exd5kivrg3iwpdt2rcbovgx9ixa7"
},
"gateway_resource_id": {},
"description": {
"type": "string",
"example": "file1.csv"
},
"error": {},
"is_processed": {
"type": "boolean",
"example": true,
"default": true
},
"payload_size_bytes": {
"type": "integer",
"example": 65901,
"default": 0
},
"processed_bytes": {
"type": "integer",
"example": 65901,
"default": 0
},
"status": {
"type": "string",
"example": "processed"
},
"progress_percentage": {
"type": "integer",
"example": 100,
"default": 0
},
"contains_data_from": {},
"contains_data_to": {},
"created_at": {
"type": "string",
"example": "2024-07-25T09:36:21.144754Z"
}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\":\"resource.report.not-found\",\n \"message\":\"The report could not be found.\",\n \"success\":false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.report.not-found"
},
"message": {
"type": "string",
"example": "The report could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
}
},
"/uploads/reports/{report_id}/raw": {
"get": {
"summary": "Downloading raw PSP report",
"description": "",
"operationId": "downloading-raw-psp-report",
"parameters": [
{
"name": "report_id",
"in": "path",
"description": "ID of the report",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{ \"download_url\": \"...\" }"
}
},
"schema": {
"type": "object",
"properties": {
"download_url": {
"type": "string",
"example": "..."
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\":\"resource.report.not-found\",\n \"message\":\"The report could not be found.\",\n \"success\":false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.report.not-found"
},
"message": {
"type": "string",
"example": "The report could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
}
},
"/balances/tokens/{token_id}": {
"get": {
"summary": "Fetch a token balance",
"description": "",
"operationId": "fetch-a-token-balance",
"parameters": [
{
"name": "token_id",
"in": "path",
"description": "ID of the customer token",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"200 OK - Amount": {
"value": "{\n \"balances\": {\n \"vouchers\": [{\n \"amount\": \"1500\",\n \"currency\": \"RON\",\n \"expiry\": null\n }],\n \"available_balance\": {\n \"amount\": \"1500\",\n \"currency\": \"RON\",\n \"expiry\": null\n },\n \"customer_action\": {\n \t\t\"type\": \"REDIRECT\",\n \t\t\"value\": \"path\"\n \t\t}\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"balances": {
"type": "object",
"properties": {
"vouchers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"example": "1500"
},
"currency": {
"type": "string",
"example": "RON"
},
"expiry": {}
}
}
},
"available_balance": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"example": "1500"
},
"currency": {
"type": "string",
"example": "RON"
},
"expiry": {}
}
},
"customer_action": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "REDIRECT"
},
"value": {
"type": "string",
"example": "path"
}
}
}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "const ProcessOut = require(\"processout\");\nconst client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\n// ...\n\nconst balances = await client.newBalances().find(\"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\");"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\n# use customer payment token to retrieve any available balance\nbalances = client.new_balances().find(\"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\")"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\n# use customer payment token to retrieve any available balance\nbalances = client.balances.find(\"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\")"
},
{
"language": "php",
"code": "newBalances()->find(\"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\");\n?>"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nclient := processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\n// use customer payment token to retrieve any available balance\nbalances, err := client.NewBalances().Find(\"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\")"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/customers/{customer_id}/tokens/{token_id}": {
"get": {
"summary": "Fetching a token",
"description": "",
"operationId": "fetching-a-token",
"parameters": [
{
"name": "customer_id",
"in": "path",
"description": "ID of your customer",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
},
{
"name": "token_id",
"in": "path",
"description": "ID of the customer token",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Card token attached": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": null,\n \"gateway_configuration_sub_account\": null,\n \"card\": {\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"update_type\": null,\n \"update_reason_code\": null,\n \"scheme\": \"visa\",\n \"co_scheme\": null,\n \"preferred_scheme\": null,\n \"type\": \"credit\",\n \"bank_name\": null,\n \"brand\": null,\n \"category\": null,\n \"iin\": \"400000\",\n \"last_4_digits\": \"0101\",\n \"fingerprint\": \"43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"cvc_check\": \"unavailable\",\n \"avs_check\": \"unavailable\",\n \"checks\": {\n \"cvc_check\": \"unavailable\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"unavailable\",\n \"avs_postal_check\": \"unavailable\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unavailable\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"unavailable\",\n \"avs_name_check_reason\": null\n },\n \"token_type\": null,\n \"name\": \"Mat\u00e9o Garnier\",\n \"address1\": \"133 rue Lamarck\",\n \"address2\": \"Cedex 7\",\n \"city\": \"Paris\",\n \"state\": \"Ile De France\",\n \"country_code\": \"US\",\n \"zip\": \"75018\",\n \"ip_address\": \"176.27.120.213\",\n \"user_agent\": \"PostmanRuntime/7.32.2\",\n \"header_accept\": \"*/*\",\n \"app_color_depth\": null,\n \"app_java_enabled\": null,\n \"app_language\": null,\n \"app_screen_height\": null,\n \"app_screen_width\": null,\n \"app_timezone_offset\": null,\n \"header_referer\": null,\n \"expires_soon\": false,\n \"metadata\": {},\n \"used\": null,\n \"sandbox\": true,\n \"created_at\": \"2023-04-22T10:37:15.854105Z\",\n \"updated_at\": \"2023-04-22T10:37:15.854104Z\",\n \"id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"cvc_tokenized\": true,\n \"tokenization_method\": null,\n \"payment_source_detail\": null\n },\n \"card_id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"is_subscription_only\": false,\n \"is_default\": true,\n \"return_url\": \"https://mymerchant.com/return\",\n \"cancel_url\": \"https://mymerchant.com/cancel\",\n \"is_chargeable\": true,\n \"type\": \"card\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T10:37:17.950649Z\",\n \"summary\": \"**** **** **** 0101\",\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": null\n }\n}"
},
"APM token attached": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_X6kIALJ8FR1x8wDuzOoWQRyZIbtzpA22\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"gateway_configuration_sub_account\": null,\n \"card_id\": null,\n \"is_subscription_only\": false,\n \"is_default\": false,\n \"return_url\": null,\n \"cancel_url\": null,\n \"is_chargeable\": true,\n \"type\": \"gateway_token\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T09:36:33.798042Z\",\n \"summary\": \"test_summary\",\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": true\n }\n}"
},
"Empty token": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_ETX8PdnQtKduob3ypkrJiHTNlK0skH6c\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": null,\n \"gateway_configuration_sub_account\": null,\n \"card_id\": null,\n \"is_subscription_only\": false,\n \"is_default\": false,\n \"return_url\": \"https://mymerchant.com/return\",\n \"cancel_url\": \"https://mymerchant.com/cancel\",\n \"is_chargeable\": false,\n \"type\": \"pending\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T10:39:09.826201718Z\",\n \"summary\": null,\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": null\n }\n}"
},
"Card token with Network Token active": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": null,\n \"gateway_configuration_sub_account\": null,\n \"network_token\": {\n \t\t\"id\": \"nt_3f9jfiojfewFEW3fkaio3FdfaOL\",\n \t\"status\": \"active\"\n },\n \"card\": {\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"update_type\": null,\n \"update_reason_code\": null,\n \"scheme\": \"visa\",\n \"co_scheme\": null,\n \"preferred_scheme\": null,\n \"type\": \"credit\",\n \"bank_name\": null,\n \"brand\": null,\n \"category\": null,\n \"iin\": \"400000\",\n \"last_4_digits\": \"0101\",\n \"fingerprint\": \"43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"cvc_check\": \"unavailable\",\n \"avs_check\": \"unavailable\",\n \"checks\": {\n \"cvc_check\": \"unavailable\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"unavailable\",\n \"avs_postal_check\": \"unavailable\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unavailable\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"unavailable\",\n \"avs_name_check_reason\": null\n },\n \"token_type\": null,\n \"name\": \"Mat\u00e9o Garnier\",\n \"address1\": \"133 rue Lamarck\",\n \"address2\": \"Cedex 7\",\n \"city\": \"Paris\",\n \"state\": \"Ile De France\",\n \"country_code\": \"US\",\n \"zip\": \"75018\",\n \"ip_address\": \"176.27.120.213\",\n \"user_agent\": \"PostmanRuntime/7.32.2\",\n \"header_accept\": \"*/*\",\n \"app_color_depth\": null,\n \"app_java_enabled\": null,\n \"app_language\": null,\n \"app_screen_height\": null,\n \"app_screen_width\": null,\n \"app_timezone_offset\": null,\n \"header_referer\": null,\n \"expires_soon\": false,\n \"metadata\": {},\n \"used\": null,\n \"sandbox\": true,\n \"created_at\": \"2023-04-22T10:37:15.854105Z\",\n \"updated_at\": \"2023-04-22T10:37:15.854104Z\",\n \"id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"cvc_tokenized\": true,\n \"tokenization_method\": null,\n \"payment_source_detail\": null\n },\n \"card_id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"is_subscription_only\": false,\n \"is_default\": true,\n \"return_url\": \"https://mymerchant.com/return\",\n \"cancel_url\": \"https://mymerchant.com/cancel\",\n \"is_chargeable\": true,\n \"type\": \"card\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T10:37:17.950649Z\",\n \"summary\": \"**** **** **** 0101\",\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": null\n }\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Card token attached",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {},
"gateway_configuration_sub_account": {},
"card": {
"type": "object",
"properties": {
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"update_type": {},
"update_reason_code": {},
"scheme": {
"type": "string",
"example": "visa"
},
"co_scheme": {},
"preferred_scheme": {},
"type": {
"type": "string",
"example": "credit"
},
"bank_name": {},
"brand": {},
"category": {},
"iin": {
"type": "string",
"example": "400000"
},
"last_4_digits": {
"type": "string",
"example": "0101"
},
"fingerprint": {
"type": "string",
"example": "43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79"
},
"exp_month": {
"type": "integer",
"example": 7,
"default": 0
},
"exp_year": {
"type": "integer",
"example": 2026,
"default": 0
},
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unavailable"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "unavailable"
},
"avs_name_check_reason": {}
}
},
"token_type": {},
"name": {
"type": "string",
"example": "Mat\u00e9o Garnier"
},
"address1": {
"type": "string",
"example": "133 rue Lamarck"
},
"address2": {
"type": "string",
"example": "Cedex 7"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "US"
},
"zip": {
"type": "string",
"example": "75018"
},
"ip_address": {
"type": "string",
"example": "176.27.120.213"
},
"user_agent": {
"type": "string",
"example": "PostmanRuntime/7.32.2"
},
"header_accept": {
"type": "string",
"example": "*/*"
},
"app_color_depth": {},
"app_java_enabled": {},
"app_language": {},
"app_screen_height": {},
"app_screen_width": {},
"app_timezone_offset": {},
"header_referer": {},
"expires_soon": {
"type": "boolean",
"example": false,
"default": true
},
"metadata": {
"type": "object",
"properties": {}
},
"used": {},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854105Z"
},
"updated_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854104Z"
},
"id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"cvc_tokenized": {
"type": "boolean",
"example": true,
"default": true
},
"tokenization_method": {},
"payment_source_detail": {}
}
},
"card_id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": true,
"default": true
},
"return_url": {
"type": "string",
"example": "https://mymerchant.com/return"
},
"cancel_url": {
"type": "string",
"example": "https://mymerchant.com/cancel"
},
"is_chargeable": {
"type": "boolean",
"example": true,
"default": true
},
"type": {
"type": "string",
"example": "card"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:17.950649Z"
},
"summary": {
"type": "string",
"example": "**** **** **** 0101"
},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {}
}
}
}
},
{
"title": "APM token attached",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_X6kIALJ8FR1x8wDuzOoWQRyZIbtzpA22"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"gateway_configuration_sub_account": {},
"card_id": {},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": false,
"default": true
},
"return_url": {},
"cancel_url": {},
"is_chargeable": {
"type": "boolean",
"example": true,
"default": true
},
"type": {
"type": "string",
"example": "gateway_token"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T09:36:33.798042Z"
},
"summary": {
"type": "string",
"example": "test_summary"
},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
},
{
"title": "Empty token",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_ETX8PdnQtKduob3ypkrJiHTNlK0skH6c"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {},
"gateway_configuration_sub_account": {},
"card_id": {},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": false,
"default": true
},
"return_url": {
"type": "string",
"example": "https://mymerchant.com/return"
},
"cancel_url": {
"type": "string",
"example": "https://mymerchant.com/cancel"
},
"is_chargeable": {
"type": "boolean",
"example": false,
"default": true
},
"type": {
"type": "string",
"example": "pending"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T10:39:09.826201718Z"
},
"summary": {},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {}
}
}
}
},
{
"title": "Card token with Network Token active",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {},
"gateway_configuration_sub_account": {},
"network_token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "nt_3f9jfiojfewFEW3fkaio3FdfaOL"
},
"status": {
"type": "string",
"example": "active"
}
}
},
"card": {
"type": "object",
"properties": {
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"update_type": {},
"update_reason_code": {},
"scheme": {
"type": "string",
"example": "visa"
},
"co_scheme": {},
"preferred_scheme": {},
"type": {
"type": "string",
"example": "credit"
},
"bank_name": {},
"brand": {},
"category": {},
"iin": {
"type": "string",
"example": "400000"
},
"last_4_digits": {
"type": "string",
"example": "0101"
},
"fingerprint": {
"type": "string",
"example": "43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79"
},
"exp_month": {
"type": "integer",
"example": 7,
"default": 0
},
"exp_year": {
"type": "integer",
"example": 2026,
"default": 0
},
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unavailable"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "unavailable"
},
"avs_name_check_reason": {}
}
},
"token_type": {},
"name": {
"type": "string",
"example": "Mat\u00e9o Garnier"
},
"address1": {
"type": "string",
"example": "133 rue Lamarck"
},
"address2": {
"type": "string",
"example": "Cedex 7"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "US"
},
"zip": {
"type": "string",
"example": "75018"
},
"ip_address": {
"type": "string",
"example": "176.27.120.213"
},
"user_agent": {
"type": "string",
"example": "PostmanRuntime/7.32.2"
},
"header_accept": {
"type": "string",
"example": "*/*"
},
"app_color_depth": {},
"app_java_enabled": {},
"app_language": {},
"app_screen_height": {},
"app_screen_width": {},
"app_timezone_offset": {},
"header_referer": {},
"expires_soon": {
"type": "boolean",
"example": false,
"default": true
},
"metadata": {
"type": "object",
"properties": {}
},
"used": {},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854105Z"
},
"updated_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854104Z"
},
"id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"cvc_tokenized": {
"type": "boolean",
"example": true,
"default": true
},
"tokenization_method": {},
"payment_source_detail": {}
}
},
"card_id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": true,
"default": true
},
"return_url": {
"type": "string",
"example": "https://mymerchant.com/return"
},
"cancel_url": {
"type": "string",
"example": "https://mymerchant.com/cancel"
},
"is_chargeable": {
"type": "boolean",
"example": true,
"default": true
},
"type": {
"type": "string",
"example": "card"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:17.950649Z"
},
"summary": {
"type": "string",
"example": "**** **** **** 0101"
},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {}
}
}
}
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.token.not-found\",\n \"message\": \"The token could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.token.not-found"
},
"message": {
"type": "string",
"example": "The token could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newToken().find(\"cust_WtaVdUjAGpOlbLiYWYXBR67whr91Rlks\",\n \"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\").then(\n function(token) {\n // And let's say our customer wants to remove its token\n token.delete(); \n\n }, function(err) {\n // The customer's token could not be fetched\n });",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ntoken = client.new_token().find(\"cust_WtaVdUjAGpOlbLiYWYXBR67whr91Rlks\",\n \"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\")"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ntoken = client.token.find(\"cust_WtaVdUjAGpOlbLiYWYXBR67whr91Rlks\",\n \"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\")"
},
{
"language": "php",
"code": "newToken()->find(\"cust_WtaVdUjAGpOlbLiYWYXBR67whr91Rlks\",\n \"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\");"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\ntok, err := client.NewToken().Find(\"cust_WtaVdUjAGpOlbLiYWYXBR67whr91Rlks\",\n \"tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\")"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
},
"put": {
"summary": "Update a token",
"description": "",
"operationId": "update-a-token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source represents the token (`card_` or `gway_req_`) to save on the customer token"
},
"metadata": {
"type": "string",
"description": "Metadata related to the token, in the form of key-value pairs (string - string).",
"format": "json"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Card token attached": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": null,\n \"gateway_configuration_sub_account\": null,\n \"card\": {\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"update_type\": null,\n \"update_reason_code\": null,\n \"scheme\": \"visa\",\n \"co_scheme\": null,\n \"preferred_scheme\": null,\n \"type\": \"credit\",\n \"bank_name\": null,\n \"brand\": null,\n \"category\": null,\n \"iin\": \"400000\",\n \"last_4_digits\": \"0101\",\n \"fingerprint\": \"43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79\",\n \"exp_month\": 7,\n \"exp_year\": 2026,\n \"cvc_check\": \"unavailable\",\n \"avs_check\": \"unavailable\",\n \"checks\": {\n \"cvc_check\": \"unavailable\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"unavailable\",\n \"avs_postal_check\": \"unavailable\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unavailable\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"unavailable\",\n \"avs_name_check_reason\": null\n },\n \"token_type\": null,\n \"name\": \"Mat\u00e9o Garnier\",\n \"address1\": \"133 rue Lamarck\",\n \"address2\": \"Cedex 7\",\n \"city\": \"Paris\",\n \"state\": \"Ile De France\",\n \"country_code\": \"US\",\n \"zip\": \"75018\",\n \"ip_address\": \"176.27.120.213\",\n \"user_agent\": \"PostmanRuntime/7.32.2\",\n \"header_accept\": \"*/*\",\n \"app_color_depth\": null,\n \"app_java_enabled\": null,\n \"app_language\": null,\n \"app_screen_height\": null,\n \"app_screen_width\": null,\n \"app_timezone_offset\": null,\n \"header_referer\": null,\n \"expires_soon\": false,\n \"metadata\": {},\n \"used\": null,\n \"sandbox\": true,\n \"created_at\": \"2023-04-22T10:37:15.854105Z\",\n \"updated_at\": \"2023-04-22T10:37:15.854104Z\",\n \"id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"cvc_tokenized\": true,\n \"tokenization_method\": null,\n \"payment_source_detail\": null\n },\n \"card_id\": \"card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy\",\n \"is_subscription_only\": false,\n \"is_default\": true,\n \"return_url\": \"https://mymerchant.com/return\",\n \"cancel_url\": \"https://mymerchant.com/cancel\",\n \"is_chargeable\": true,\n \"type\": \"card\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T10:37:17.950649Z\",\n \"summary\": \"**** **** **** 0101\",\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": null\n }\n}"
},
"APM token attached": {
"value": "{\n \"success\": true,\n \"token\": {\n \"id\": \"tok_X6kIALJ8FR1x8wDuzOoWQRyZIbtzpA22\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"invoice_id\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"gateway_configuration_sub_account\": null,\n \"card_id\": null,\n \"is_subscription_only\": false,\n \"is_default\": false,\n \"return_url\": null,\n \"cancel_url\": null,\n \"is_chargeable\": true,\n \"type\": \"gateway_token\",\n \"metadata\": {\n \"test\": \"23456789\"\n },\n \"description\": null,\n \"created_at\": \"2023-04-22T09:36:33.798042Z\",\n \"summary\": \"test_summary\",\n \"verification_status\": \"not-requested\",\n \"manual_invoice_cancellation\": null,\n \"can_get_balance\": true\n }\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Card token attached",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_4H77e0IrpFrp3YhvBGmbuJr54MRob5yl"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {},
"gateway_configuration_sub_account": {},
"card": {
"type": "object",
"properties": {
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"update_type": {},
"update_reason_code": {},
"scheme": {
"type": "string",
"example": "visa"
},
"co_scheme": {},
"preferred_scheme": {},
"type": {
"type": "string",
"example": "credit"
},
"bank_name": {},
"brand": {},
"category": {},
"iin": {
"type": "string",
"example": "400000"
},
"last_4_digits": {
"type": "string",
"example": "0101"
},
"fingerprint": {
"type": "string",
"example": "43d7ff88cb38993d87311c2e54779cc9ec0c20298a5ef84c31e519ef6a068a79"
},
"exp_month": {
"type": "integer",
"example": 7,
"default": 0
},
"exp_year": {
"type": "integer",
"example": 2026,
"default": 0
},
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unavailable"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "unavailable"
},
"avs_name_check_reason": {}
}
},
"token_type": {},
"name": {
"type": "string",
"example": "Mat\u00e9o Garnier"
},
"address1": {
"type": "string",
"example": "133 rue Lamarck"
},
"address2": {
"type": "string",
"example": "Cedex 7"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "US"
},
"zip": {
"type": "string",
"example": "75018"
},
"ip_address": {
"type": "string",
"example": "176.27.120.213"
},
"user_agent": {
"type": "string",
"example": "PostmanRuntime/7.32.2"
},
"header_accept": {
"type": "string",
"example": "*/*"
},
"app_color_depth": {},
"app_java_enabled": {},
"app_language": {},
"app_screen_height": {},
"app_screen_width": {},
"app_timezone_offset": {},
"header_referer": {},
"expires_soon": {
"type": "boolean",
"example": false,
"default": true
},
"metadata": {
"type": "object",
"properties": {}
},
"used": {},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854105Z"
},
"updated_at": {
"type": "string",
"example": "2023-04-22T10:37:15.854104Z"
},
"id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"cvc_tokenized": {
"type": "boolean",
"example": true,
"default": true
},
"tokenization_method": {},
"payment_source_detail": {}
}
},
"card_id": {
"type": "string",
"example": "card_WtbRZBADSSL0MJSTKrbYZHuPuCkSVGBy"
},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": true,
"default": true
},
"return_url": {
"type": "string",
"example": "https://mymerchant.com/return"
},
"cancel_url": {
"type": "string",
"example": "https://mymerchant.com/cancel"
},
"is_chargeable": {
"type": "boolean",
"example": true,
"default": true
},
"type": {
"type": "string",
"example": "card"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T10:37:17.950649Z"
},
"summary": {
"type": "string",
"example": "**** **** **** 0101"
},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {}
}
}
}
},
{
"title": "APM token attached",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"token": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tok_X6kIALJ8FR1x8wDuzOoWQRyZIbtzpA22"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"invoice_id": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"gateway_configuration_sub_account": {},
"card_id": {},
"is_subscription_only": {
"type": "boolean",
"example": false,
"default": true
},
"is_default": {
"type": "boolean",
"example": false,
"default": true
},
"return_url": {},
"cancel_url": {},
"is_chargeable": {
"type": "boolean",
"example": true,
"default": true
},
"type": {
"type": "string",
"example": "gateway_token"
},
"metadata": {
"type": "object",
"properties": {
"test": {
"type": "string",
"example": "23456789"
}
}
},
"description": {},
"created_at": {
"type": "string",
"example": "2023-04-22T09:36:33.798042Z"
},
"summary": {
"type": "string",
"example": "test_summary"
},
"verification_status": {
"type": "string",
"example": "not-requested"
},
"manual_invoice_cancellation": {},
"can_get_balance": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.customer.not-found\",\n \"message\": \"The customer could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "request.validation.invalid-description"
},
"message": {
"type": "string",
"example": "The description Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... Description too long ... must be at most 255 characters long."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
},
{
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.customer.not-found"
},
"message": {
"type": "string",
"example": "The customer could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/transactions/{transaction_id}": {
"get": {
"summary": "Fetching a transaction",
"description": "",
"operationId": "fetching-a-transaction",
"parameters": [
{
"name": "transaction_id",
"in": "path",
"description": "ID of the transaction",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true,\n \"transaction\": {\n \"id\": \"tr_msUOyQgmJp8UduKANzblNwa5hrjQGag5\",\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"routing_tags\": [\n \"rule-2-route\",\n \"GB1\",\n \"rule-3-dynamic_3ds\",\n \"country == FR\",\n \"currency == EUR\",\n \"card_last4 == 0001\",\n \"rule-4-dynamic_3ds\",\n \"card_country == FR\",\n \"currency == EUR\",\n \"amount > 30\",\n \"rule-5-dynamic_3ds\",\n \"card_country == FR\",\n \"currency == EUR\",\n \"amount > 30\"\n ],\n \"fraud_service_results\": null,\n \"operations\": null,\n \"name\": \"Amazing Product\",\n \"currency\": \"EUR\",\n \"details\": {\n \"country\": \"GB\"\n },\n \"metadata\": {\n \"fruit\": \"banana\"\n },\n \"sandbox\": true,\n \"created_at\": \"2023-04-22T15:19:08.653492Z\",\n \"invoice_id\": \"iv_cyxGn7nrOHuqQO4X5jbbwv16eN7GkZvB\",\n \"gateway_name\": \"sandbox\",\n \"status\": \"authorized\",\n \"three_d_s_status\": \"unchecked\",\n \"three_d_s_version\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_DOekWV1nHVVloKxjqDOuZFr4CmSGj5rx\",\n \"error_code\": null,\n \"error_message\": null,\n \"three_d_s\": null,\n \"payment_type\": \"card\",\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"cvc_check\": \"passed\",\n \"avs_check\": \"passed\",\n \"card_checks\": {\n \"cvc_check\": \"passed\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"passed\",\n \"avs_postal_check\": \"passed\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"passed\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"passed\",\n \"avs_name_check_reason\": null\n },\n \"amount\": \"29\",\n \"amount_local\": \"32.18\",\n \"authorized_amount\": \"29\",\n \"authorized_amount_local\": \"32.18\",\n \"captured_amount\": \"0\",\n \"captured_amount_local\": \"0\",\n \"available_amount\": \"0\",\n \"available_amount_local\": \"0\",\n \"incremented_amount\": \"0\",\n \"incremented_amount_local\": \"0\",\n \"refunded_amount\": \"0\",\n \"refunded_amount_local\": \"0\",\n \"currency_fee\": null,\n \"gateway_fee\": \"0\",\n \"gateway_fee_local\": \"0\",\n \"authorized_at\": \"2023-04-22T15:19:13.048765Z\",\n \"captured_at\": null,\n \"refunded_at\": null,\n \"voided_at\": null,\n \"chargedback_at\": null,\n \"received_fraud_notification\": false,\n \"received_retrieval_request\": false,\n \"acquirer_name\": null,\n \"attempts_count\": 1,\n \"authorized\": true,\n \"captured\": false,\n \"refunded\": false,\n \"voided\": false,\n \"chargedback\": false,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"scheme_id\": \"5196843282\",\n \"initial_scheme_transaction_id\": null,\n \"sca\": null,\n \"subscription_cycle\": null,\n \"error_recommendations\": [],\n \"gateway_fee_details\": {\n \"processing_fee\": \"0\",\n \"exchange_fee\": \"0\",\n \"refund_fee\": \"0\",\n \"interchange_fee\": \"0\",\n \"scheme_fee\": \"0\",\n \"markup_fee\": \"0\",\n \"interchange_fee_estimate\": \"0\",\n \"scheme_fee_estimate\": \"0\"\n },\n \"external_details\": {\n \t\t\"customer\": {\n \"last_name\": \"\",\n \"first_name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"country_code\": \"\",\n \"phone_number\": \"\",\n \"email\": \"\"\n \t\t\t\t\t},\n \t\t\t\t\t\"shipping\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"country_code\": \"\"\n \t\t\t\t\t}\n }, \n \"estimated_fee\": \"1.17\",\n \"refunds\": null,\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\"\n },\n \"is_on_us\": null,\n \"processout_fee\": \"0\",\n \"subscription_id\": null,\n \"duplicate_distance_seconds\": null\n }\n}"
},
"Payout Items expanded": {
"value": "{\n \"success\": true,\n \"transaction\": {\n \"id\": \"tr_RbYZcNz86hRLVNOGKOGmIyyibguwFds5\",\n \"project_id\": \"proj_nC8kogl1spXADQdfWjnKa1qz2cOebyvH\",\n \"customer_id\": \"cust_4d5OfJzmyMt1dsLLk1mbNGrNGJkdpmjd\",\n \"payout_items\": [\n {\n \"id\": \"payt_itm_v8ml10kZ7CKSv2Tn0ThbRuwjBJ0yTgsn\",\n \"project_id\": \"proj_nC8kogl1spXADQdfWjnKa1qz2cOebyvH\",\n \"payout_id\": \"payt_6qb4XAzPbQcA8pcVtQyTsMjU8AA44YHD\",\n \"transaction_id\": \"tr_RbYZcNz86hRLVNOGKOGmIyyibguwFds5\",\n \"type\": \"sale\",\n \"payment_provider_type\": \"SettledInstallment\",\n \"gateway_resource_id\": \"EXAMPLE123\",\n \"amount\": \"40\",\n \"fees\": \"-5.8\",\n \"metadata\": {\n \"batch_number\": \"602\",\n \"settlement_type\": \"SettledInstallment\"\n },\n \"breakdown\": {\n \"scheme_fee\": \"-0.4\",\n \"interchange_fee\": \"-5\",\n \"gateway_fee\": null,\n \"markup_fee\": \"-0.4\",\n \"acquirer_fee\": null,\n \"other_fee\": null\n },\n \"created_at\": \"2024-02-22T18:30:30Z\"\n }\n ],\n \"payout_summary\": {\n \"currency\": null,\n \"is_settled\": true,\n \"settled_at\": \"2024-02-22T18:30:30Z\",\n \"total_amount\": \"40\",\n \"settled_amount\": \"40\",\n \"settled_amount_local\": \"43.3291992\",\n \"fees\": \"-5.8\",\n \"fees_local\": \"-6.282733884\",\n \"fees_breakdown\": {\n \"scheme_fee\": \"-0.4\",\n \"interchange_fee\": \"-5\",\n \"gateway_fee\": \"0\",\n \"markup_fee\": \"-0.4\",\n \"acquirer_fee\": \"0\",\n \"other_fee\": \"0\"\n },\n \"settlement_status\": \"settled\"\n },\n \"routing_tags\": [\n \"rule-2-route\",\n \"Adyen_reporting_Test\"\n ],\n \"fraud_service_results\": null,\n \"operations\": null,\n \"name\": \"adyen_report_test\",\n \"currency\": \"EUR\",\n \"details\": {\n \"country\": \"PL\"\n },\n \"metadata\": {},\n \"sandbox\": true,\n \"created_at\": \"2024-02-26T08:20:38.77234Z\",\n \"invoice_id\": \"iv_xILrHuS1UQQCGSkbTxf6v6YF6DHzMT3Z\",\n \"gateway_name\": \"adyen\",\n \"status\": \"completed\",\n \"three_d_s_status\": \"unchecked\",\n \"three_d_s_version\": null,\n \"gateway_configuration_id\": \"gway_conf_6mds752ax40tscbca43qbw1r263u1y55\",\n \"token_id\": null,\n \"card_id\": \"card_MdpvCTbTyNvd0RBIZYg0xqIRl212aKt0\",\n \"error_code\": null,\n \"error_message\": null,\n \"three_d_s\": null,\n \"payment_type\": \"card\",\n \"eci\": \"N/A\",\n \"mcc\": null,\n \"merchant_account_id\": \"\",\n \"cvc_check\": \"unchecked\",\n \"avs_check\": \"failed\",\n \"card_checks\": {\n \"cvc_check\": \"unchecked\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"failed\",\n \"avs_postal_check\": \"failed\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"failed\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"unknown\",\n \"avs_name_check_reason\": null\n },\n \"amount\": \"40\",\n \"amount_local\": \"43.33\",\n \"authorized_amount\": \"40\",\n \"authorized_amount_local\": \"43.33\",\n \"captured_amount\": \"40\",\n \"captured_amount_local\": \"43.33\",\n \"available_amount\": \"40\",\n \"available_amount_local\": \"43.33\",\n \"incremented_amount\": \"0\",\n \"incremented_amount_local\": \"0\",\n \"refunded_amount\": \"0\",\n \"refunded_amount_local\": \"0\",\n \"voided_amount\": \"0\",\n \"voided_amount_local\": \"0\",\n \"currency_fee\": \"EUR\",\n \"gateway_fee\": \"0\",\n \"gateway_fee_local\": \"0\",\n \"authorized_at\": \"2024-02-26T08:20:45.804061Z\",\n \"captured_at\": \"2024-02-26T08:20:50Z\",\n \"refunded_at\": null,\n \"voided_at\": null,\n \"chargedback_at\": null,\n \"received_fraud_notification\": false,\n \"received_retrieval_request\": false,\n \"acquirer_name\": \"\",\n \"attempts_count\": 1,\n \"authorized\": true,\n \"captured\": true,\n \"refunded\": false,\n \"voided\": false,\n \"chargedback\": false,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"scheme_id\": \"285987934832252\",\n \"initial_scheme_transaction_id\": null,\n \"sca\": null,\n \"external_details\": null,\n \"subscription_cycle\": null,\n \"error_recommendations\": [],\n \"gateway_fee_details\": {\n \"processing_fee\": \"0\",\n \"exchange_fee\": \"0\",\n \"refund_fee\": \"0\",\n \"interchange_fee\": \"0\",\n \"scheme_fee\": \"0\",\n \"markup_fee\": \"0\",\n \"interchange_fee_estimate\": \"0\",\n \"scheme_fee_estimate\": \"0\",\n \"currency\": \"EUR\"\n },\n \"estimated_fee\": \"1.5\",\n \"refunds\": null,\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\"\n },\n \"is_on_us\": null,\n \"processout_fee\": \"0\",\n \"subscription_id\": null,\n \"duplicate_distance_seconds\": null\n }\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Operations expanded",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"transaction": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_msUOyQgmJp8UduKANzblNwa5hrjQGag5"
},
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"routing_tags": {
"type": "array",
"items": {
"type": "string",
"example": "rule-2-route"
}
},
"fraud_service_results": {},
"operations": {},
"name": {
"type": "string",
"example": "Amazing Product"
},
"currency": {
"type": "string",
"example": "EUR"
},
"details": {
"type": "object",
"properties": {
"country": {
"type": "string",
"example": "GB"
}
}
},
"metadata": {
"type": "object",
"properties": {
"fruit": {
"type": "string",
"example": "banana"
}
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T15:19:08.653492Z"
},
"invoice_id": {
"type": "string",
"example": "iv_cyxGn7nrOHuqQO4X5jbbwv16eN7GkZvB"
},
"gateway_name": {
"type": "string",
"example": "sandbox"
},
"status": {
"type": "string",
"example": "authorized"
},
"three_d_s_status": {
"type": "string",
"example": "unchecked"
},
"three_d_s_version": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"token_id": {},
"card_id": {
"type": "string",
"example": "card_DOekWV1nHVVloKxjqDOuZFr4CmSGj5rx"
},
"error_code": {},
"error_message": {},
"three_d_s": {},
"payment_type": {
"type": "string",
"example": "card"
},
"eci": {},
"mcc": {},
"merchant_account_id": {},
"cvc_check": {
"type": "string",
"example": "passed"
},
"avs_check": {
"type": "string",
"example": "passed"
},
"card_checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "passed"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "passed"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "passed"
},
"avs_name_check_reason": {}
}
},
"amount": {
"type": "string",
"example": "29"
},
"amount_local": {
"type": "string",
"example": "32.18"
},
"authorized_amount": {
"type": "string",
"example": "29"
},
"authorized_amount_local": {
"type": "string",
"example": "32.18"
},
"captured_amount": {
"type": "string",
"example": "0"
},
"captured_amount_local": {
"type": "string",
"example": "0"
},
"available_amount": {
"type": "string",
"example": "0"
},
"available_amount_local": {
"type": "string",
"example": "0"
},
"incremented_amount": {
"type": "string",
"example": "0"
},
"incremented_amount_local": {
"type": "string",
"example": "0"
},
"refunded_amount": {
"type": "string",
"example": "0"
},
"refunded_amount_local": {
"type": "string",
"example": "0"
},
"currency_fee": {},
"gateway_fee": {
"type": "string",
"example": "0"
},
"gateway_fee_local": {
"type": "string",
"example": "0"
},
"authorized_at": {
"type": "string",
"example": "2023-04-22T15:19:13.048765Z"
},
"captured_at": {},
"refunded_at": {},
"voided_at": {},
"chargedback_at": {},
"received_fraud_notification": {
"type": "boolean",
"example": false,
"default": true
},
"received_retrieval_request": {
"type": "boolean",
"example": false,
"default": true
},
"acquirer_name": {},
"attempts_count": {
"type": "integer",
"example": 1,
"default": 0
},
"authorized": {
"type": "boolean",
"example": true,
"default": true
},
"captured": {
"type": "boolean",
"example": false,
"default": true
},
"refunded": {
"type": "boolean",
"example": false,
"default": true
},
"voided": {
"type": "boolean",
"example": false,
"default": true
},
"chargedback": {
"type": "boolean",
"example": false,
"default": true
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"scheme_id": {
"type": "string",
"example": "5196843282"
},
"initial_scheme_transaction_id": {},
"sca": {},
"subscription_cycle": {},
"error_recommendations": {
"type": "array"
},
"gateway_fee_details": {
"type": "object",
"properties": {
"processing_fee": {
"type": "string",
"example": "0"
},
"exchange_fee": {
"type": "string",
"example": "0"
},
"refund_fee": {
"type": "string",
"example": "0"
},
"interchange_fee": {
"type": "string",
"example": "0"
},
"scheme_fee": {
"type": "string",
"example": "0"
},
"markup_fee": {
"type": "string",
"example": "0"
},
"interchange_fee_estimate": {
"type": "string",
"example": "0"
},
"scheme_fee_estimate": {
"type": "string",
"example": "0"
}
}
},
"external_details": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"last_name": {
"type": "string",
"example": ""
},
"first_name": {
"type": "string",
"example": ""
},
"address1": {
"type": "string",
"example": ""
},
"address2": {
"type": "string",
"example": ""
},
"state": {
"type": "string",
"example": ""
},
"city": {
"type": "string",
"example": ""
},
"zip": {
"type": "string",
"example": ""
},
"country_code": {
"type": "string",
"example": ""
},
"phone_number": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
}
}
},
"shipping": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": ""
},
"address2": {
"type": "string",
"example": ""
},
"state": {
"type": "string",
"example": ""
},
"city": {
"type": "string",
"example": ""
},
"zip": {
"type": "string",
"example": ""
},
"country_code": {
"type": "string",
"example": ""
}
}
}
}
},
"estimated_fee": {
"type": "string",
"example": "1.17"
},
"refunds": {},
"buyer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
},
"address": {
"type": "string",
"example": ""
},
"phone": {
"type": "string",
"example": ""
}
}
},
"is_on_us": {},
"processout_fee": {
"type": "string",
"example": "0"
},
"subscription_id": {},
"duplicate_distance_seconds": {}
}
}
}
},
{
"title": "Payout Items expanded",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"transaction": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_RbYZcNz86hRLVNOGKOGmIyyibguwFds5"
},
"project_id": {
"type": "string",
"example": "proj_nC8kogl1spXADQdfWjnKa1qz2cOebyvH"
},
"customer_id": {
"type": "string",
"example": "cust_4d5OfJzmyMt1dsLLk1mbNGrNGJkdpmjd"
},
"payout_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "payt_itm_v8ml10kZ7CKSv2Tn0ThbRuwjBJ0yTgsn"
},
"project_id": {
"type": "string",
"example": "proj_nC8kogl1spXADQdfWjnKa1qz2cOebyvH"
},
"payout_id": {
"type": "string",
"example": "payt_6qb4XAzPbQcA8pcVtQyTsMjU8AA44YHD"
},
"transaction_id": {
"type": "string",
"example": "tr_RbYZcNz86hRLVNOGKOGmIyyibguwFds5"
},
"type": {
"type": "string",
"example": "sale"
},
"payment_provider_type": {
"type": "string",
"example": "SettledInstallment"
},
"gateway_resource_id": {
"type": "string",
"example": "EXAMPLE123"
},
"amount": {
"type": "string",
"example": "40"
},
"fees": {
"type": "string",
"example": "-5.8"
},
"metadata": {
"type": "object",
"properties": {
"batch_number": {
"type": "string",
"example": "602"
},
"settlement_type": {
"type": "string",
"example": "SettledInstallment"
}
}
},
"breakdown": {
"type": "object",
"properties": {
"scheme_fee": {
"type": "string",
"example": "-0.4"
},
"interchange_fee": {
"type": "string",
"example": "-5"
},
"gateway_fee": {},
"markup_fee": {
"type": "string",
"example": "-0.4"
},
"acquirer_fee": {},
"other_fee": {}
}
},
"created_at": {
"type": "string",
"example": "2024-02-22T18:30:30Z"
}
}
}
},
"payout_summary": {
"type": "object",
"properties": {
"currency": {},
"is_settled": {
"type": "boolean",
"example": true,
"default": true
},
"settled_at": {
"type": "string",
"example": "2024-02-22T18:30:30Z"
},
"total_amount": {
"type": "string",
"example": "40"
},
"settled_amount": {
"type": "string",
"example": "40"
},
"settled_amount_local": {
"type": "string",
"example": "43.3291992"
},
"fees": {
"type": "string",
"example": "-5.8"
},
"fees_local": {
"type": "string",
"example": "-6.282733884"
},
"fees_breakdown": {
"type": "object",
"properties": {
"scheme_fee": {
"type": "string",
"example": "-0.4"
},
"interchange_fee": {
"type": "string",
"example": "-5"
},
"gateway_fee": {
"type": "string",
"example": "0"
},
"markup_fee": {
"type": "string",
"example": "-0.4"
},
"acquirer_fee": {
"type": "string",
"example": "0"
},
"other_fee": {
"type": "string",
"example": "0"
}
}
},
"settlement_status": {
"type": "string",
"example": "settled"
}
}
},
"routing_tags": {
"type": "array",
"items": {
"type": "string",
"example": "rule-2-route"
}
},
"fraud_service_results": {},
"operations": {},
"name": {
"type": "string",
"example": "adyen_report_test"
},
"currency": {
"type": "string",
"example": "EUR"
},
"details": {
"type": "object",
"properties": {
"country": {
"type": "string",
"example": "PL"
}
}
},
"metadata": {
"type": "object",
"properties": {}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2024-02-26T08:20:38.77234Z"
},
"invoice_id": {
"type": "string",
"example": "iv_xILrHuS1UQQCGSkbTxf6v6YF6DHzMT3Z"
},
"gateway_name": {
"type": "string",
"example": "adyen"
},
"status": {
"type": "string",
"example": "completed"
},
"three_d_s_status": {
"type": "string",
"example": "unchecked"
},
"three_d_s_version": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_6mds752ax40tscbca43qbw1r263u1y55"
},
"token_id": {},
"card_id": {
"type": "string",
"example": "card_MdpvCTbTyNvd0RBIZYg0xqIRl212aKt0"
},
"error_code": {},
"error_message": {},
"three_d_s": {},
"payment_type": {
"type": "string",
"example": "card"
},
"eci": {
"type": "string",
"example": "N/A"
},
"mcc": {},
"merchant_account_id": {
"type": "string",
"example": ""
},
"cvc_check": {
"type": "string",
"example": "unchecked"
},
"avs_check": {
"type": "string",
"example": "failed"
},
"card_checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "unchecked"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "failed"
},
"avs_postal_check": {
"type": "string",
"example": "failed"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "failed"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "unknown"
},
"avs_name_check_reason": {}
}
},
"amount": {
"type": "string",
"example": "40"
},
"amount_local": {
"type": "string",
"example": "43.33"
},
"authorized_amount": {
"type": "string",
"example": "40"
},
"authorized_amount_local": {
"type": "string",
"example": "43.33"
},
"captured_amount": {
"type": "string",
"example": "40"
},
"captured_amount_local": {
"type": "string",
"example": "43.33"
},
"available_amount": {
"type": "string",
"example": "40"
},
"available_amount_local": {
"type": "string",
"example": "43.33"
},
"incremented_amount": {
"type": "string",
"example": "0"
},
"incremented_amount_local": {
"type": "string",
"example": "0"
},
"refunded_amount": {
"type": "string",
"example": "0"
},
"refunded_amount_local": {
"type": "string",
"example": "0"
},
"voided_amount": {
"type": "string",
"example": "0"
},
"voided_amount_local": {
"type": "string",
"example": "0"
},
"currency_fee": {
"type": "string",
"example": "EUR"
},
"gateway_fee": {
"type": "string",
"example": "0"
},
"gateway_fee_local": {
"type": "string",
"example": "0"
},
"authorized_at": {
"type": "string",
"example": "2024-02-26T08:20:45.804061Z"
},
"captured_at": {
"type": "string",
"example": "2024-02-26T08:20:50Z"
},
"refunded_at": {},
"voided_at": {},
"chargedback_at": {},
"received_fraud_notification": {
"type": "boolean",
"example": false,
"default": true
},
"received_retrieval_request": {
"type": "boolean",
"example": false,
"default": true
},
"acquirer_name": {
"type": "string",
"example": ""
},
"attempts_count": {
"type": "integer",
"example": 1,
"default": 0
},
"authorized": {
"type": "boolean",
"example": true,
"default": true
},
"captured": {
"type": "boolean",
"example": true,
"default": true
},
"refunded": {
"type": "boolean",
"example": false,
"default": true
},
"voided": {
"type": "boolean",
"example": false,
"default": true
},
"chargedback": {
"type": "boolean",
"example": false,
"default": true
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"scheme_id": {
"type": "string",
"example": "285987934832252"
},
"initial_scheme_transaction_id": {},
"sca": {},
"external_details": {},
"subscription_cycle": {},
"error_recommendations": {
"type": "array"
},
"gateway_fee_details": {
"type": "object",
"properties": {
"processing_fee": {
"type": "string",
"example": "0"
},
"exchange_fee": {
"type": "string",
"example": "0"
},
"refund_fee": {
"type": "string",
"example": "0"
},
"interchange_fee": {
"type": "string",
"example": "0"
},
"scheme_fee": {
"type": "string",
"example": "0"
},
"markup_fee": {
"type": "string",
"example": "0"
},
"interchange_fee_estimate": {
"type": "string",
"example": "0"
},
"scheme_fee_estimate": {
"type": "string",
"example": "0"
},
"currency": {
"type": "string",
"example": "EUR"
}
}
},
"estimated_fee": {
"type": "string",
"example": "1.5"
},
"refunds": {},
"buyer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
},
"address": {
"type": "string",
"example": ""
},
"phone": {
"type": "string",
"example": ""
}
}
},
"is_on_us": {},
"processout_fee": {
"type": "string",
"example": "0"
},
"subscription_id": {},
"duplicate_distance_seconds": {}
}
}
}
}
]
}
},
"text/plain": {
"examples": {
"Operations expanded": {
"value": "{\n \"success\": true,\n \"transaction\": {\n \"id\": \"tr_msUOyQgmJp8UduKANzblNwa5hrjQGag5\",\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"customer_id\": \"cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA\",\n \"routing_tags\": [\n \"rule-2-route\",\n \"GB1\",\n \"rule-3-dynamic_3ds\",\n \"country == FR\",\n \"currency == EUR\",\n \"card_last4 == 0001\",\n \"rule-4-dynamic_3ds\",\n \"card_country == FR\",\n \"currency == EUR\",\n \"amount > 30\",\n \"rule-5-dynamic_3ds\",\n \"card_country == FR\",\n \"currency == EUR\",\n \"amount > 30\"\n ],\n \"fraud_service_results\": null,\n \"operations\": [\n {\n \"id\": \"tr_op_EVh8Ss7qmnWTVqna1CaU7HHbVopVdx1k\",\n \"transaction_id\": \"tr_msUOyQgmJp8UduKANzblNwa5hrjQGag5\",\n \"authenticated_transaction_id\": \"5196843282\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_DOekWV1nHVVloKxjqDOuZFr4CmSGj5rx\",\n \"amount\": \"29\",\n \"amount_local\": \"32.18\",\n \"currency\": \"EUR\",\n \"is_attempt\": false,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"request\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"acquirer_name\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"5196843282\",\n \"initial_scheme_transaction_id\": \"\",\n \"card_checks\": {\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"\",\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null\n },\n \"gateway_operation_id\": \"\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-22T15:19:13.048677Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n },\n {\n \"id\": \"tr_op_mk6jIB4Hd5IVTe58s5D2yoTVCch8WVx4\",\n \"transaction_id\": \"tr_msUOyQgmJp8UduKANzblNwa5hrjQGag5\",\n \"authenticated_transaction_id\": \"5196843282\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_DOekWV1nHVVloKxjqDOuZFr4CmSGj5rx\",\n \"amount\": \"29\",\n \"amount_local\": \"32.18\",\n \"currency\": \"EUR\",\n \"is_attempt\": true,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"authorization\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"acquirer_name\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"5196843282\",\n \"initial_scheme_transaction_id\": \"\",\n \"card_checks\": {\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"\",\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null\n },\n \"gateway_operation_id\": \"test-valid-17584ad826c34212\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-22T15:19:13.048722Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n },\n {\n \"id\": \"tr_op_WVcMoRwE3QFv5FpQf3xEwjoTqrwLUzVv\",\n \"transaction_id\": \"tr_msUOyQgmJp8UduKANzblNwa5hrjQGag5\",\n \"authenticated_transaction_id\": \"5196843282\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_DOekWV1nHVVloKxjqDOuZFr4CmSGj5rx\",\n \"amount\": \"29\",\n \"amount_local\": \"32.18\",\n \"currency\": \"EUR\",\n \"is_attempt\": false,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"authorization\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"acquirer_name\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"5196843282\",\n \"initial_scheme_transaction_id\": \"\",\n \"card_checks\": {\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"\",\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null\n },\n \"gateway_operation_id\": \"test-valid-17584ad826c34212\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-22T15:19:13.048765Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n }\n ],\n \"name\": \"Amazing Product\",\n \"currency\": \"EUR\",\n \"details\": {\n \"country\": \"GB\"\n },\n \"metadata\": {\n \"fruit\": \"banana\"\n },\n \"sandbox\": true,\n \"created_at\": \"2023-04-22T15:19:08.653492Z\",\n \"invoice_id\": \"iv_cyxGn7nrOHuqQO4X5jbbwv16eN7GkZvB\",\n \"gateway_name\": \"sandbox\",\n \"status\": \"authorized\",\n \"three_d_s_status\": \"unchecked\",\n \"three_d_s_version\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_DOekWV1nHVVloKxjqDOuZFr4CmSGj5rx\",\n \"error_code\": null,\n \"error_message\": null,\n \"three_d_s\": null,\n \"payment_type\": \"card\",\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"cvc_check\": \"passed\",\n \"avs_check\": \"passed\",\n \"card_checks\": {\n \"cvc_check\": \"passed\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"passed\",\n \"avs_postal_check\": \"passed\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"passed\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"passed\",\n \"avs_name_check_reason\": null\n },\n \"amount\": \"29\",\n \"amount_local\": \"32.18\",\n \"authorized_amount\": \"29\",\n \"authorized_amount_local\": \"32.18\",\n \"captured_amount\": \"0\",\n \"captured_amount_local\": \"0\",\n \"available_amount\": \"0\",\n \"available_amount_local\": \"0\",\n \"incremented_amount\": \"0\",\n \"incremented_amount_local\": \"0\",\n \"refunded_amount\": \"0\",\n \"refunded_amount_local\": \"0\",\n \"currency_fee\": null,\n \"gateway_fee\": \"0\",\n \"gateway_fee_local\": \"0\",\n \"authorized_at\": \"2023-04-22T15:19:13.048765Z\",\n \"captured_at\": null,\n \"refunded_at\": null,\n \"voided_at\": null,\n \"chargedback_at\": null,\n \"received_fraud_notification\": false,\n \"received_retrieval_request\": false,\n \"acquirer_name\": null,\n \"attempts_count\": 1,\n \"authorized\": true,\n \"captured\": false,\n \"refunded\": false,\n \"voided\": false,\n \"chargedback\": false,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"scheme_id\": \"5196843282\",\n \"initial_scheme_transaction_id\": null,\n \"sca\": null,\n \"subscription_cycle\": null,\n \"error_recommendations\": [],\n \"gateway_fee_details\": {\n \"processing_fee\": \"0\",\n \"exchange_fee\": \"0\",\n \"refund_fee\": \"0\",\n \"interchange_fee\": \"0\",\n \"scheme_fee\": \"0\",\n \"markup_fee\": \"0\",\n \"interchange_fee_estimate\": \"0\",\n \"scheme_fee_estimate\": \"0\"\n },\n \"estimated_fee\": \"1.17\",\n \"refunds\": null,\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\"\n },\n \"is_on_us\": null,\n \"processout_fee\": \"0\",\n \"subscription_id\": null,\n \"duplicate_distance_seconds\": null\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"transaction": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_msUOyQgmJp8UduKANzblNwa5hrjQGag5"
},
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"customer_id": {
"type": "string",
"example": "cust_D5BDaQQ8XL4xoUfKRjpBQjoEIwMA6asA"
},
"routing_tags": {
"type": "array",
"items": {
"type": "string",
"example": "rule-2-route"
}
},
"fraud_service_results": {},
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_op_EVh8Ss7qmnWTVqna1CaU7HHbVopVdx1k"
},
"transaction_id": {
"type": "string",
"example": "tr_msUOyQgmJp8UduKANzblNwa5hrjQGag5"
},
"authenticated_transaction_id": {
"type": "string",
"example": "5196843282"
},
"authorization_code": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"token_id": {},
"card_id": {
"type": "string",
"example": "card_DOekWV1nHVVloKxjqDOuZFr4CmSGj5rx"
},
"amount": {
"type": "string",
"example": "29"
},
"amount_local": {
"type": "string",
"example": "32.18"
},
"currency": {
"type": "string",
"example": "EUR"
},
"is_attempt": {
"type": "boolean",
"example": false,
"default": true
},
"has_failed": {
"type": "boolean",
"example": false,
"default": true
},
"is_accountable": {
"type": "boolean",
"example": false,
"default": true
},
"type": {
"type": "string",
"example": "request"
},
"metadata": {
"type": "object",
"properties": {
"is_sale": {
"type": "string",
"example": "false"
}
}
},
"error_code": {},
"error_message": {},
"payment_type": {
"type": "string",
"example": "card"
},
"acquirer_name": {},
"payment_data_three_d_s_request": {},
"payment_data_network_authentication": {},
"payment_data_three_d_s_authentication": {},
"payment_data_three_d_s_2_authentication": {},
"eci": {},
"mcc": {},
"merchant_account_id": {},
"is_on_us": {},
"arn": {},
"scheme_id": {
"type": "string",
"example": "5196843282"
},
"initial_scheme_transaction_id": {
"type": "string",
"example": ""
},
"card_checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": ""
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": ""
},
"avs_postal_check": {
"type": "string",
"example": ""
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": ""
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": ""
},
"avs_name_check_reason": {}
}
},
"gateway_operation_id": {
"type": "string",
"example": ""
},
"gateway_data": {
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "test-valid"
}
}
},
"chargeback_reason": {},
"created_at": {
"type": "string",
"example": "2023-04-22T15:19:13.048677Z"
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"challenge_indicator": {
"type": "string",
"example": "no-preference"
},
"sca_exemption_reason": {
"type": "string",
"example": ""
}
}
}
},
"name": {
"type": "string",
"example": "Amazing Product"
},
"currency": {
"type": "string",
"example": "EUR"
},
"details": {
"type": "object",
"properties": {
"country": {
"type": "string",
"example": "GB"
}
}
},
"metadata": {
"type": "object",
"properties": {
"fruit": {
"type": "string",
"example": "banana"
}
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T15:19:08.653492Z"
},
"invoice_id": {
"type": "string",
"example": "iv_cyxGn7nrOHuqQO4X5jbbwv16eN7GkZvB"
},
"gateway_name": {
"type": "string",
"example": "sandbox"
},
"status": {
"type": "string",
"example": "authorized"
},
"three_d_s_status": {
"type": "string",
"example": "unchecked"
},
"three_d_s_version": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"token_id": {},
"card_id": {
"type": "string",
"example": "card_DOekWV1nHVVloKxjqDOuZFr4CmSGj5rx"
},
"error_code": {},
"error_message": {},
"three_d_s": {},
"payment_type": {
"type": "string",
"example": "card"
},
"eci": {},
"mcc": {},
"merchant_account_id": {},
"cvc_check": {
"type": "string",
"example": "passed"
},
"avs_check": {
"type": "string",
"example": "passed"
},
"card_checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "passed"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "passed"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "passed"
},
"avs_name_check_reason": {}
}
},
"amount": {
"type": "string",
"example": "29"
},
"amount_local": {
"type": "string",
"example": "32.18"
},
"authorized_amount": {
"type": "string",
"example": "29"
},
"authorized_amount_local": {
"type": "string",
"example": "32.18"
},
"captured_amount": {
"type": "string",
"example": "0"
},
"captured_amount_local": {
"type": "string",
"example": "0"
},
"available_amount": {
"type": "string",
"example": "0"
},
"available_amount_local": {
"type": "string",
"example": "0"
},
"incremented_amount": {
"type": "string",
"example": "0"
},
"incremented_amount_local": {
"type": "string",
"example": "0"
},
"refunded_amount": {
"type": "string",
"example": "0"
},
"refunded_amount_local": {
"type": "string",
"example": "0"
},
"currency_fee": {},
"gateway_fee": {
"type": "string",
"example": "0"
},
"gateway_fee_local": {
"type": "string",
"example": "0"
},
"authorized_at": {
"type": "string",
"example": "2023-04-22T15:19:13.048765Z"
},
"captured_at": {},
"refunded_at": {},
"voided_at": {},
"chargedback_at": {},
"received_fraud_notification": {
"type": "boolean",
"example": false,
"default": true
},
"received_retrieval_request": {
"type": "boolean",
"example": false,
"default": true
},
"acquirer_name": {},
"attempts_count": {
"type": "integer",
"example": 1,
"default": 0
},
"authorized": {
"type": "boolean",
"example": true,
"default": true
},
"captured": {
"type": "boolean",
"example": false,
"default": true
},
"refunded": {
"type": "boolean",
"example": false,
"default": true
},
"voided": {
"type": "boolean",
"example": false,
"default": true
},
"chargedback": {
"type": "boolean",
"example": false,
"default": true
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"scheme_id": {
"type": "string",
"example": "5196843282"
},
"initial_scheme_transaction_id": {},
"sca": {},
"subscription_cycle": {},
"error_recommendations": {
"type": "array"
},
"gateway_fee_details": {
"type": "object",
"properties": {
"processing_fee": {
"type": "string",
"example": "0"
},
"exchange_fee": {
"type": "string",
"example": "0"
},
"refund_fee": {
"type": "string",
"example": "0"
},
"interchange_fee": {
"type": "string",
"example": "0"
},
"scheme_fee": {
"type": "string",
"example": "0"
},
"markup_fee": {
"type": "string",
"example": "0"
},
"interchange_fee_estimate": {
"type": "string",
"example": "0"
},
"scheme_fee_estimate": {
"type": "string",
"example": "0"
}
}
},
"estimated_fee": {
"type": "string",
"example": "1.17"
},
"refunds": {},
"buyer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
},
"address": {
"type": "string",
"example": ""
},
"phone": {
"type": "string",
"example": ""
}
}
},
"is_on_us": {},
"processout_fee": {
"type": "string",
"example": "0"
},
"subscription_id": {},
"duplicate_distance_seconds": {}
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.transaction.not-found\",\n \"message\": \"The transaction could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.transaction.not-found"
},
"message": {
"type": "string",
"example": "The transaction could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newTransaction().find(\"tr_ItJdKlhfaVn0SUGd9z1i9Jqe0STl4jxC\").then(\n function(transaction) {\n // Transaction was fetched\n }, function(err) {\n // An error occured\n });",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ntransaction = client.new_transaction().find(\"tr_ItJdKlhfaVn0SUGd9z1i9Jqe0STl4jxC\")"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ntransaction = client.transaction.find(\"tr_ItJdKlhfaVn0SUGd9z1i9Jqe0STl4jxC\")"
},
{
"language": "php",
"code": "newTransaction()->find(\"tr_ItJdKlhfaVn0SUGd9z1i9Jqe0STl4jxC\");"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\ntr, err := client.NewTransaction().Find(\"tr_ItJdKlhfaVn0SUGd9z1i9Jqe0STl4jxC\")"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/invoices/{invoice_id}/increment_authorization": {
"post": {
"summary": "Increment an authorization on an invoice",
"description": "",
"operationId": "increment-an-invoice",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
},
{
"name": "invoice_id",
"in": "path",
"description": "The invoice ID generated by ProcessOut during the invoice creation",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"description": "Amount to increment authorization by. Maximum 4 decimal places supported as per ISO 4217."
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": true,\n \"transaction\": {\n \"id\": \"tr_oiDEtfTa2HAoCzK5gaPqgQXygVXrnzvF\",\n \"project\": {\n \"id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"supervisor_project_id\": null,\n \"gateway_configurations\": null,\n \"name\": \"My Super US Project\",\n \"default_currency\": \"USD\",\n \"region_name\": \"aws-us-east-1\",\n \"applepay_settings\": {\n \"enabled\": true,\n \"has_certificates\": false,\n \"alternative_certificates_count\": 0,\n \"alternative_merchant_certificates\": null,\n \"merchant_id\": \"merchant.com.pierre.staging\",\n \"merchant_domain_names\": [],\n \"merchant_csr\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQ3FqQ0NBWklDQVFBd0pqRWtNQ0lHQTFVRUF4TWJiV1Z5WTJoaGJuUXVZMjl0TG5CcFpYSnlaUzV6ZEdGbgphVzVuTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUExbGdsaGhtOFpkNEpodmhVCjVJbGVINU1lMVFKNGFJZCtPcmhwWkVpaEFDZzh1NHQ0cWZEZmlGSkdJcFVuOGJ3YVd0dFBaalVhc29XK1gxNnkKeFNQbDNjRTBSdFBjVFI5VlFIZkFRN2tOOVFseloxbjV4OXh5TVV3TVFkTmZMYjhZMUo4VTdNVGRRTEVXNkptSQp0UGtRL3RVMnVaWFVyYXZIc3JBa2dXR0pnTEVVdzRha2JudlcyMDJJTHZJTEdLU1pnaC9LSUJDaTdGVWdjVHRBCm5zbGJiWUIxNWRhaTlrNU5XaGxNcldKZjUrYkEwUHZzK0JiclNnM3RyOUMzRjBMcCtrajJhWVdHTFc1YUQzUEYKZUY3OC9YU01wdld4VnF6K24reHRnclNlaFRNbzY5ZS95emxZRkhWd2xHWGdYeGk0cjR0QjBpQzNRZEpPbWFoQgpScndqSXdJREFRQUJvRDh3UFFZSktvWklodmNOQVFrT01UQXdMakFzQmdOVkhSRUVKVEFqZ1NGcGJuUmxjbTVoCmJDdGhjSEJzWlMxd1lYbEFjSEp2WTJWemMyOTFkQzVqYjIwd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFER2UKMGJrMDdWcnBzd0dNRXBhZllvcGd5N3h2aFlDdURhaUgzNmpmeno3Y2NYbkh4UTVPVTBDOTRKU1A2UFFYWWk2eAplWVh5RE9DOWpjemZnS0lLRTduZ2MzQnlTYlVhLzRzWXlvTU1iRkNEUm8reGkxUUtoZFJFWEowU0Y1a3d3cW9JCnlkUFlFT0VVZGFBR2RNL1NzZ3VWeFdiSzM4RjVRVWRSTEdDZTV3bTdaeUxJTU1oeCs1V2JBUGVWVXhmaFdJQTUKZWJaV3pnYk9qczFwa1QybUtFL3RCMldXMU02YitpYnpyZ09tTitrRnNvWGtwTTFzOTJCekNQeVE5Z1FteVJZRQpBRktLUzd1enJJRzEvOXBXakZpMjdyU3REVTJkSUgvZXlDd1FCZkJISXhLUDk1bHRBZy9oNjE3LzlnZS84TWFwCmJwQkNXeWhZTkwxQ3BYdVRCSUk9Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=\",\n \"processing_csr\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQklUQ0J4d0lCQURBbU1TUXdJZ1lEVlFRREV4dHRaWEpqYUdGdWRDNWpiMjB1Y0dsbGNuSmxMbk4wWVdkcApibWN3V1RBVEJnY3Foa2pPUFFJQkJnZ3Foa2pPUFFNQkJ3TkNBQVJoRFRFaUF1bzlYVktQdElIRlhoNzlkaXgwCklQWVZmTXhldFpqNW9lZGV2dmpGMmpzekN2b2w4cE03bDJxNi9HWDdDWngvWkNLVXVlRUg3eDR0T291dW9EOHcKUFFZSktvWklodmNOQVFrT01UQXdMakFzQmdOVkhSRUVKVEFqZ1NGcGJuUmxjbTVoYkN0aGNIQnNaUzF3WVhsQQpjSEp2WTJWemMyOTFkQzVqYjIwd0NnWUlLb1pJemowRUF3SURTUUF3UmdJaEFQY0hESytjWHliWEdHaVMxZmF3CmRIdHNCSW1nZXNGNzdjYXZQdFdxaGFQMUFpRUE4MTU4UENZZ1VvNm1ITFZtZ3JHS3lBdEQ2RUcxYldPYXpUZ24KL283WUVDND0KLS0tLS1FTkQgQ0VSVElGSUNBVEUgUkVRVUVTVC0tLS0tCg==\"\n },\n \"dunning_configuration\": [\n {\n \"action\": \"retry\",\n \"delay_in_days\": 3\n },\n {\n \"action\": \"retry\",\n \"delay_in_days\": 7\n },\n {\n \"action\": \"cancel\",\n \"delay_in_days\": 0\n }\n ],\n \"feature_flags\": [\n \"analytics-v2\",\n \"three-d-s-2\",\n \"allow-adyen\"\n ],\n \"created_at\": \"2019-03-07T13:34:34.818873Z\",\n \"is_pulling\": false,\n \"is_pulling_initial\": false\n },\n \"project_id\": \"proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S\",\n \"customer_id\": \"cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw\",\n \"routing_tags\": [\n \"rule-2-route\",\n \"GB1\",\n \"rule-3-dynamic_3ds\",\n \"country == FR\",\n \"currency == EUR\",\n \"card_last4 == 0001\",\n \"rule-4-dynamic_3ds\",\n \"card_country == FR\",\n \"currency == EUR\",\n \"amount > 30\",\n \"rule-5-dynamic_3ds\",\n \"card_country == FR\",\n \"currency == EUR\",\n \"amount > 30\"\n ],\n \"fraud_service_results\": null,\n \"operations\": [\n {\n \"id\": \"tr_op_ncyUBOsLhf6ogUkrbeOC5T8Zr4vHwzPf\",\n \"transaction_id\": \"tr_oiDEtfTa2HAoCzK5gaPqgQXygVXrnzvF\",\n \"authenticated_transaction_id\": \"6435312890\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_lDMuzlkUDZUnHriatuNj2MWnlk0WZcGS\",\n \"amount\": \"29\",\n \"amount_local\": \"31.83\",\n \"currency\": \"EUR\",\n \"is_attempt\": false,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"request\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"acquirer_name\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"6435312890\",\n \"initial_scheme_transaction_id\": \"\",\n \"card_checks\": {\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"\",\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null\n },\n \"gateway_operation_id\": \"\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-21T20:30:23.517447Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n },\n {\n \"id\": \"tr_op_OdQ8GW82m63xevctoxVbdJpzGosUEdyp\",\n \"transaction_id\": \"tr_oiDEtfTa2HAoCzK5gaPqgQXygVXrnzvF\",\n \"authenticated_transaction_id\": \"6435312890\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_lDMuzlkUDZUnHriatuNj2MWnlk0WZcGS\",\n \"amount\": \"29\",\n \"amount_local\": \"31.83\",\n \"currency\": \"EUR\",\n \"is_attempt\": true,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"authorization\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"acquirer_name\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"6435312890\",\n \"initial_scheme_transaction_id\": \"\",\n \"card_checks\": {\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"\",\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null\n },\n \"gateway_operation_id\": \"test-valid-17580d3ea41ff29e\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-21T20:30:23.517504Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n },\n {\n \"id\": \"tr_op_ebqd6JMGlgqQqe8dg1xhvGEmtSa3SqKe\",\n \"transaction_id\": \"tr_oiDEtfTa2HAoCzK5gaPqgQXygVXrnzvF\",\n \"authenticated_transaction_id\": \"6435312890\",\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_lDMuzlkUDZUnHriatuNj2MWnlk0WZcGS\",\n \"amount\": \"29\",\n \"amount_local\": \"31.83\",\n \"currency\": \"EUR\",\n \"is_attempt\": false,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"authorization\",\n \"metadata\": {\n \"is_sale\": \"false\"\n },\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"card\",\n \"acquirer_name\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": \"6435312890\",\n \"initial_scheme_transaction_id\": \"\",\n \"card_checks\": {\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"\",\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null\n },\n \"gateway_operation_id\": \"test-valid-17580d3ea41ff29e\",\n \"gateway_data\": {\n \"token\": \"test-valid\"\n },\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-21T20:30:23.517545Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"no-preference\",\n \"sca_exemption_reason\": \"\"\n },\n {\n \"id\": \"tr_op_T156akQQNZrnr2nkJNnNoXr6FiuaiTz5\",\n \"transaction_id\": \"tr_oiDEtfTa2HAoCzK5gaPqgQXygVXrnzvF\",\n \"authenticated_transaction_id\": null,\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": null,\n \"amount\": \"5\",\n \"amount_local\": \"5.4882995\",\n \"currency\": \"EUR\",\n \"is_attempt\": true,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"increment_authorization\",\n \"metadata\": {},\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"sandbox-apm\",\n \"acquirer_name\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": null,\n \"initial_scheme_transaction_id\": \"\",\n \"card_checks\": {\n \"cvc_check\": \"unavailable\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"\",\n \"avs_postal_check\": \"unavailable\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unavailable\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"unavailable\",\n \"avs_name_check_reason\": null\n },\n \"gateway_operation_id\": \"1c0d6e24-1c1a-4b0c-9aa9-f7ceb87e483f\",\n \"gateway_data\": null,\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-21T20:30:29.34960584Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"\",\n \"sca_exemption_reason\": \"\"\n },\n {\n \"id\": \"tr_op_rXYoZvJwidMpNdGbBX8oOR0SGwjpo7X3\",\n \"transaction_id\": \"tr_oiDEtfTa2HAoCzK5gaPqgQXygVXrnzvF\",\n \"authenticated_transaction_id\": null,\n \"authorization_code\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": null,\n \"amount\": \"5\",\n \"amount_local\": \"5.4882995\",\n \"currency\": \"EUR\",\n \"is_attempt\": false,\n \"has_failed\": false,\n \"is_accountable\": false,\n \"type\": \"increment_authorization\",\n \"metadata\": {},\n \"error_code\": null,\n \"error_message\": null,\n \"payment_type\": \"sandbox-apm\",\n \"acquirer_name\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"is_on_us\": null,\n \"arn\": null,\n \"scheme_id\": null,\n \"initial_scheme_transaction_id\": \"\",\n \"card_checks\": {\n \"cvc_check\": \"unavailable\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"\",\n \"avs_postal_check\": \"unavailable\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unavailable\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"unavailable\",\n \"avs_name_check_reason\": null\n },\n \"gateway_operation_id\": \"1c0d6e24-1c1a-4b0c-9aa9-f7ceb87e483f\",\n \"gateway_data\": null,\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-21T20:30:29.349665411Z\",\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"challenge_indicator\": \"\",\n \"sca_exemption_reason\": \"\"\n }\n ],\n \"name\": \"Amazing Product\",\n \"currency\": \"EUR\",\n \"details\": {\n \"country\": \"GB\"\n },\n \"metadata\": {\n \"fruit\": \"banana\"\n },\n \"sandbox\": true,\n \"created_at\": \"2023-04-21T20:30:02.68814Z\",\n \"invoice_id\": \"iv_XTgB6Olf48qD5CXF5FogwAstBjDa5mr6\",\n \"gateway_name\": \"sandbox\",\n \"status\": \"authorized\",\n \"three_d_s_status\": \"unchecked\",\n \"three_d_s_version\": null,\n \"gateway_configuration_id\": \"gway_conf_c23e011db34f4bac44e051840dfa3783\",\n \"token_id\": null,\n \"card_id\": \"card_lDMuzlkUDZUnHriatuNj2MWnlk0WZcGS\",\n \"error_code\": null,\n \"error_message\": null,\n \"three_d_s\": null,\n \"payment_type\": \"card\",\n \"eci\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"cvc_check\": \"passed\",\n \"avs_check\": \"passed\",\n \"card_checks\": {\n \"cvc_check\": \"passed\",\n \"cvc_check_reason\": null,\n \"avs_check\": \"passed\",\n \"avs_postal_check\": \"passed\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"passed\",\n \"avs_street_check_reason\": null,\n \"avs_name_check\": \"passed\",\n \"avs_name_check_reason\": null\n },\n \"amount\": \"34\",\n \"amount_local\": \"37.32\",\n \"authorized_amount\": \"34\",\n \"authorized_amount_local\": \"37.32\",\n \"captured_amount\": \"0\",\n \"captured_amount_local\": \"0\",\n \"available_amount\": \"0\",\n \"available_amount_local\": \"0\",\n \"incremented_amount\": \"5\",\n \"incremented_amount_local\": \"5.49\",\n \"refunded_amount\": \"0\",\n \"refunded_amount_local\": \"0\",\n \"currency_fee\": null,\n \"gateway_fee\": \"0\",\n \"gateway_fee_local\": \"0\",\n \"authorized_at\": \"2023-04-21T20:30:23.517545Z\",\n \"captured_at\": null,\n \"refunded_at\": null,\n \"voided_at\": null,\n \"chargedback_at\": null,\n \"received_fraud_notification\": false,\n \"received_retrieval_request\": false,\n \"acquirer_name\": null,\n \"attempts_count\": 1,\n \"authorized\": true,\n \"captured\": false,\n \"refunded\": false,\n \"voided\": false,\n \"chargedback\": false,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"scheme_id\": \"6435312890\",\n \"initial_scheme_transaction_id\": null,\n \"sca\": null,\n \"subscription_cycle\": null,\n \"error_recommendations\": [],\n \"gateway_fee_details\": {\n \"processing_fee\": \"0\",\n \"exchange_fee\": \"0\",\n \"refund_fee\": \"0\",\n \"interchange_fee\": \"0\",\n \"scheme_fee\": \"0\",\n \"markup_fee\": \"0\",\n \"interchange_fee_estimate\": \"0\",\n \"scheme_fee_estimate\": \"0\"\n },\n \"estimated_fee\": \"1.32\",\n \"refunds\": null,\n \"buyer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"phone\": \"\"\n },\n \"is_on_us\": null,\n \"processout_fee\": \"0\",\n \"subscription_id\": null,\n \"duplicate_distance_seconds\": null\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"transaction": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_oiDEtfTa2HAoCzK5gaPqgQXygVXrnzvF"
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"supervisor_project_id": {},
"gateway_configurations": {},
"name": {
"type": "string",
"example": "My Super US Project"
},
"default_currency": {
"type": "string",
"example": "USD"
},
"region_name": {
"type": "string",
"example": "aws-us-east-1"
},
"applepay_settings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"has_certificates": {
"type": "boolean",
"example": false,
"default": true
},
"alternative_certificates_count": {
"type": "integer",
"example": 0,
"default": 0
},
"alternative_merchant_certificates": {},
"merchant_id": {
"type": "string",
"example": "merchant.com.pierre.staging"
},
"merchant_domain_names": {
"type": "array"
},
"merchant_csr": {
"type": "string",
"example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQ3FqQ0NBWklDQVFBd0pqRWtNQ0lHQTFVRUF4TWJiV1Z5WTJoaGJuUXVZMjl0TG5CcFpYSnlaUzV6ZEdGbgphVzVuTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUExbGdsaGhtOFpkNEpodmhVCjVJbGVINU1lMVFKNGFJZCtPcmhwWkVpaEFDZzh1NHQ0cWZEZmlGSkdJcFVuOGJ3YVd0dFBaalVhc29XK1gxNnkKeFNQbDNjRTBSdFBjVFI5VlFIZkFRN2tOOVFseloxbjV4OXh5TVV3TVFkTmZMYjhZMUo4VTdNVGRRTEVXNkptSQp0UGtRL3RVMnVaWFVyYXZIc3JBa2dXR0pnTEVVdzRha2JudlcyMDJJTHZJTEdLU1pnaC9LSUJDaTdGVWdjVHRBCm5zbGJiWUIxNWRhaTlrNU5XaGxNcldKZjUrYkEwUHZzK0JiclNnM3RyOUMzRjBMcCtrajJhWVdHTFc1YUQzUEYKZUY3OC9YU01wdld4VnF6K24reHRnclNlaFRNbzY5ZS95emxZRkhWd2xHWGdYeGk0cjR0QjBpQzNRZEpPbWFoQgpScndqSXdJREFRQUJvRDh3UFFZSktvWklodmNOQVFrT01UQXdMakFzQmdOVkhSRUVKVEFqZ1NGcGJuUmxjbTVoCmJDdGhjSEJzWlMxd1lYbEFjSEp2WTJWemMyOTFkQzVqYjIwd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFER2UKMGJrMDdWcnBzd0dNRXBhZllvcGd5N3h2aFlDdURhaUgzNmpmeno3Y2NYbkh4UTVPVTBDOTRKU1A2UFFYWWk2eAplWVh5RE9DOWpjemZnS0lLRTduZ2MzQnlTYlVhLzRzWXlvTU1iRkNEUm8reGkxUUtoZFJFWEowU0Y1a3d3cW9JCnlkUFlFT0VVZGFBR2RNL1NzZ3VWeFdiSzM4RjVRVWRSTEdDZTV3bTdaeUxJTU1oeCs1V2JBUGVWVXhmaFdJQTUKZWJaV3pnYk9qczFwa1QybUtFL3RCMldXMU02YitpYnpyZ09tTitrRnNvWGtwTTFzOTJCekNQeVE5Z1FteVJZRQpBRktLUzd1enJJRzEvOXBXakZpMjdyU3REVTJkSUgvZXlDd1FCZkJISXhLUDk1bHRBZy9oNjE3LzlnZS84TWFwCmJwQkNXeWhZTkwxQ3BYdVRCSUk9Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
},
"processing_csr": {
"type": "string",
"example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQklUQ0J4d0lCQURBbU1TUXdJZ1lEVlFRREV4dHRaWEpqYUdGdWRDNWpiMjB1Y0dsbGNuSmxMbk4wWVdkcApibWN3V1RBVEJnY3Foa2pPUFFJQkJnZ3Foa2pPUFFNQkJ3TkNBQVJoRFRFaUF1bzlYVktQdElIRlhoNzlkaXgwCklQWVZmTXhldFpqNW9lZGV2dmpGMmpzekN2b2w4cE03bDJxNi9HWDdDWngvWkNLVXVlRUg3eDR0T291dW9EOHcKUFFZSktvWklodmNOQVFrT01UQXdMakFzQmdOVkhSRUVKVEFqZ1NGcGJuUmxjbTVoYkN0aGNIQnNaUzF3WVhsQQpjSEp2WTJWemMyOTFkQzVqYjIwd0NnWUlLb1pJemowRUF3SURTUUF3UmdJaEFQY0hESytjWHliWEdHaVMxZmF3CmRIdHNCSW1nZXNGNzdjYXZQdFdxaGFQMUFpRUE4MTU4UENZZ1VvNm1ITFZtZ3JHS3lBdEQ2RUcxYldPYXpUZ24KL283WUVDND0KLS0tLS1FTkQgQ0VSVElGSUNBVEUgUkVRVUVTVC0tLS0tCg=="
}
}
},
"dunning_configuration": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "retry"
},
"delay_in_days": {
"type": "integer",
"example": 3,
"default": 0
}
}
}
},
"feature_flags": {
"type": "array",
"items": {
"type": "string",
"example": "analytics-v2"
}
},
"created_at": {
"type": "string",
"example": "2019-03-07T13:34:34.818873Z"
},
"is_pulling": {
"type": "boolean",
"example": false,
"default": true
},
"is_pulling_initial": {
"type": "boolean",
"example": false,
"default": true
}
}
},
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"customer_id": {
"type": "string",
"example": "cust_MFW0Z4jtoXLfADjPKlVRl5LxWkCTUgRw"
},
"routing_tags": {
"type": "array",
"items": {
"type": "string",
"example": "rule-2-route"
}
},
"fraud_service_results": {},
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "tr_op_ncyUBOsLhf6ogUkrbeOC5T8Zr4vHwzPf"
},
"transaction_id": {
"type": "string",
"example": "tr_oiDEtfTa2HAoCzK5gaPqgQXygVXrnzvF"
},
"authenticated_transaction_id": {
"type": "string",
"example": "6435312890"
},
"authorization_code": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"token_id": {},
"card_id": {
"type": "string",
"example": "card_lDMuzlkUDZUnHriatuNj2MWnlk0WZcGS"
},
"amount": {
"type": "string",
"example": "29"
},
"amount_local": {
"type": "string",
"example": "31.83"
},
"currency": {
"type": "string",
"example": "EUR"
},
"is_attempt": {
"type": "boolean",
"example": false,
"default": true
},
"has_failed": {
"type": "boolean",
"example": false,
"default": true
},
"is_accountable": {
"type": "boolean",
"example": false,
"default": true
},
"type": {
"type": "string",
"example": "request"
},
"metadata": {
"type": "object",
"properties": {
"is_sale": {
"type": "string",
"example": "false"
}
}
},
"error_code": {},
"error_message": {},
"payment_type": {
"type": "string",
"example": "card"
},
"acquirer_name": {},
"payment_data_three_d_s_request": {},
"payment_data_network_authentication": {},
"payment_data_three_d_s_authentication": {},
"payment_data_three_d_s_2_authentication": {},
"eci": {},
"mcc": {},
"merchant_account_id": {},
"is_on_us": {},
"arn": {},
"scheme_id": {
"type": "string",
"example": "6435312890"
},
"initial_scheme_transaction_id": {
"type": "string",
"example": ""
},
"card_checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": ""
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": ""
},
"avs_postal_check": {
"type": "string",
"example": ""
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": ""
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": ""
},
"avs_name_check_reason": {}
}
},
"gateway_operation_id": {
"type": "string",
"example": ""
},
"gateway_data": {
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "test-valid"
}
}
},
"chargeback_reason": {},
"created_at": {
"type": "string",
"example": "2023-04-21T20:30:23.517447Z"
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"challenge_indicator": {
"type": "string",
"example": "no-preference"
},
"sca_exemption_reason": {
"type": "string",
"example": ""
}
}
}
},
"name": {
"type": "string",
"example": "Amazing Product"
},
"currency": {
"type": "string",
"example": "EUR"
},
"details": {
"type": "object",
"properties": {
"country": {
"type": "string",
"example": "GB"
}
}
},
"metadata": {
"type": "object",
"properties": {
"fruit": {
"type": "string",
"example": "banana"
}
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-21T20:30:02.68814Z"
},
"invoice_id": {
"type": "string",
"example": "iv_XTgB6Olf48qD5CXF5FogwAstBjDa5mr6"
},
"gateway_name": {
"type": "string",
"example": "sandbox"
},
"status": {
"type": "string",
"example": "authorized"
},
"three_d_s_status": {
"type": "string",
"example": "unchecked"
},
"three_d_s_version": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_c23e011db34f4bac44e051840dfa3783"
},
"token_id": {},
"card_id": {
"type": "string",
"example": "card_lDMuzlkUDZUnHriatuNj2MWnlk0WZcGS"
},
"error_code": {},
"error_message": {},
"three_d_s": {},
"payment_type": {
"type": "string",
"example": "card"
},
"eci": {},
"mcc": {},
"merchant_account_id": {},
"cvc_check": {
"type": "string",
"example": "passed"
},
"avs_check": {
"type": "string",
"example": "passed"
},
"card_checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "passed"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check": {
"type": "string",
"example": "passed"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "passed"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "passed"
},
"avs_name_check_reason": {}
}
},
"amount": {
"type": "string",
"example": "34"
},
"amount_local": {
"type": "string",
"example": "37.32"
},
"authorized_amount": {
"type": "string",
"example": "34"
},
"authorized_amount_local": {
"type": "string",
"example": "37.32"
},
"captured_amount": {
"type": "string",
"example": "0"
},
"captured_amount_local": {
"type": "string",
"example": "0"
},
"available_amount": {
"type": "string",
"example": "0"
},
"available_amount_local": {
"type": "string",
"example": "0"
},
"incremented_amount": {
"type": "string",
"example": "5"
},
"incremented_amount_local": {
"type": "string",
"example": "5.49"
},
"refunded_amount": {
"type": "string",
"example": "0"
},
"refunded_amount_local": {
"type": "string",
"example": "0"
},
"currency_fee": {},
"gateway_fee": {
"type": "string",
"example": "0"
},
"gateway_fee_local": {
"type": "string",
"example": "0"
},
"authorized_at": {
"type": "string",
"example": "2023-04-21T20:30:23.517545Z"
},
"captured_at": {},
"refunded_at": {},
"voided_at": {},
"chargedback_at": {},
"received_fraud_notification": {
"type": "boolean",
"example": false,
"default": true
},
"received_retrieval_request": {
"type": "boolean",
"example": false,
"default": true
},
"acquirer_name": {},
"attempts_count": {
"type": "integer",
"example": 1,
"default": 0
},
"authorized": {
"type": "boolean",
"example": true,
"default": true
},
"captured": {
"type": "boolean",
"example": false,
"default": true
},
"refunded": {
"type": "boolean",
"example": false,
"default": true
},
"voided": {
"type": "boolean",
"example": false,
"default": true
},
"chargedback": {
"type": "boolean",
"example": false,
"default": true
},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"recommendation_code": {},
"recommendation_reason": {},
"scheme_id": {
"type": "string",
"example": "6435312890"
},
"initial_scheme_transaction_id": {},
"sca": {},
"subscription_cycle": {},
"error_recommendations": {
"type": "array"
},
"gateway_fee_details": {
"type": "object",
"properties": {
"processing_fee": {
"type": "string",
"example": "0"
},
"exchange_fee": {
"type": "string",
"example": "0"
},
"refund_fee": {
"type": "string",
"example": "0"
},
"interchange_fee": {
"type": "string",
"example": "0"
},
"scheme_fee": {
"type": "string",
"example": "0"
},
"markup_fee": {
"type": "string",
"example": "0"
},
"interchange_fee_estimate": {
"type": "string",
"example": "0"
},
"scheme_fee_estimate": {
"type": "string",
"example": "0"
}
}
},
"estimated_fee": {
"type": "string",
"example": "1.32"
},
"refunds": {},
"buyer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
},
"address": {
"type": "string",
"example": ""
},
"phone": {
"type": "string",
"example": ""
}
}
},
"is_on_us": {},
"processout_fee": {
"type": "string",
"example": "0"
},
"subscription_id": {},
"duplicate_distance_seconds": {}
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.invoice.not-found\",\n \"message\": \"The invoice could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.invoice.not-found"
},
"message": {
"type": "string",
"example": "The invoice could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"410": {
"description": "410",
"content": {
"application/json": {
"examples": {
"Transaction error": {
"value": "{\n \"error_type\": \"card.do-not-honor\",\n \"message\": \"The bank has returned a do-not-honor error\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "card.do-not-honor"
},
"message": {
"type": "string",
"example": "The bank has returned a do-not-honor error"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ntransaction = invoice.increment_authorization(\"10.00\")",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\n# The source could also be a token tok_fKK4btSG7wd13ZZaevzhMcuNbpjcu1Zy\ntransaction = invoice.authorize(\"card_1jSEVrx7oaRta1KEdxoMWbiGkK2MijrZ\", {\n # optional if you want us to auto capture for you\n \"auto_capture_at\": \"2022-10-02T15:00:00Z\"\n})"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\ntransaction = invoice.increment_authorization(\"10.00\")"
},
{
"language": "php",
"code": "incrementAuthorization(\"10.00\");"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\ntr, _ := iv.IncrementAuthorization(\"10.00\")"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/payouts/{payout_id}/items": {
"get": {
"summary": "Listing payout items",
"description": "",
"operationId": "listing-payout-items",
"parameters": [
{
"name": "payout_id",
"in": "path",
"description": "ID of the payout, received via webhooks or fetched with the API",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"count\": 10,\n \"has_more\": true,\n \"items\": [\n {\n \"id\": \"payt_itm_UokoiqzvKDC3Ab1VTAyP07lE6Ebu7zMa\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXbqGY1kBCI7IQyjDGB8Ih\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:59:25Z\"\n },\n {\n \"id\": \"payt_itm_opEjabroBqashziWVbTWwfdT0Efv6dZ5\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_456e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXZ5GY1kBCI7IQlFp9E4ek\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:56:40Z\"\n },\n {\n \"id\": \"payt_itm_2bYYgllki6k6ozN1zzt5dPizabtKDmpA\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXX2GY1kBCI7IQRxTrZw9z\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:54:25Z\"\n },\n {\n \"id\": \"payt_itm_k28TTQvQUKXwt2nzEpyI8a4eCT7pEkxD\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXUNGY1kBCI7IQYn01EhgS\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:51:43Z\"\n },\n {\n \"id\": \"payt_itm_hmoYuFGmwPWHLaPoIwuUjVZEzOgwfnyG\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXS4GY1kBCI7IQNh8AMOaT\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:49:23Z\"\n },\n {\n \"id\": \"payt_itm_07I3UDtOIAKQeRDBcI6UbqcO1M1rZmmW\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXPPGY1kBCI7IQdDMhAoHe\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:46:44Z\"\n },\n {\n \"id\": \"payt_itm_A4BwCS4WsnuabEjBOFiwmjtv6IVK7c18\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXNBGY1kBCI7IQBV7R7MIU\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:44:19Z\"\n },\n {\n \"id\": \"payt_itm_Wpo6ZCeuG1GT8mbYprGxm2Kue7hOubdC\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXKUGY1kBCI7IQ9ADiiy4C\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:41:36Z\"\n },\n {\n \"id\": \"payt_itm_yitkEAVd6Lle1Wtk5A1PmtCY1D82cMKg\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXIIGY1kBCI7IQc2Hg9h3y\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:39:16Z\"\n },\n {\n \"id\": \"payt_itm_MHkO7Ls54sFxuFxGjnwl0RLKPU7gaCFy\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"payout_id\": \"payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe\",\n \"transaction_id\": null,\n \"report_id\": \"rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW\",\n \"type\": \"sale\",\n \"payment_provider_type\": null,\n \"gateway_resource_id\": \"pi_XXXXFdGY1kBCI7IQNcs7VbCq\",\n \"amount\": \"9\",\n \"fees\": \"-0.38\",\n \"breakdown\": {\n \"scheme_fee\": null,\n \"interchange_fee\": null,\n \"gateway_fee\": null,\n \"markup_fee\": null,\n \"acquirer_fee\": null,\n \"other_fee\": \"-0.38\"\n },\n \"metadata\": {},\n \"created_at\": \"2020-04-16T23:36:39Z\"\n }\n ],\n \"limit\": 10,\n \"order\": \"desc\",\n \"success\": true,\n \"total_count\": 14451\n}"
}
},
"schema": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 10,
"default": 0
},
"has_more": {
"type": "boolean",
"example": true,
"default": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "payt_itm_UokoiqzvKDC3Ab1VTAyP07lE6Ebu7zMa"
},
"project_id": {
"type": "string",
"example": "proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh"
},
"payout_id": {
"type": "string",
"example": "payt_TThsHEiq4UzgnUZGXTP8oDjJQtxjWgJe"
},
"transaction_id": {},
"report_id": {
"type": "string",
"example": "rep_123e5RDbW3zf0eu73bkeeeSc1d0D6aiW"
},
"type": {
"type": "string",
"example": "sale"
},
"payment_provider_type": {},
"gateway_resource_id": {
"type": "string",
"example": "pi_XXXXbqGY1kBCI7IQyjDGB8Ih"
},
"amount": {
"type": "string",
"example": "9"
},
"fees": {
"type": "string",
"example": "-0.38"
},
"breakdown": {
"type": "object",
"properties": {
"scheme_fee": {},
"interchange_fee": {},
"gateway_fee": {},
"markup_fee": {},
"acquirer_fee": {},
"other_fee": {
"type": "string",
"example": "-0.38"
}
}
},
"metadata": {
"type": "object",
"properties": {}
},
"created_at": {
"type": "string",
"example": "2020-04-16T23:59:25Z"
}
}
}
},
"limit": {
"type": "integer",
"example": 10,
"default": 0
},
"order": {
"type": "string",
"example": "desc"
},
"success": {
"type": "boolean",
"example": true,
"default": true
},
"total_count": {
"type": "integer",
"example": 14451,
"default": 0
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\":\"resource.payout.not-found\",\n \"message\":\"The payout could not be found.\",\n \"success\":false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.payout.not-found"
},
"message": {
"type": "string",
"example": "The payout could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\npayout.fetchItems({\n limit: 20,\n order: \"asc\"\n}).then(function(payoutItems) {\n // Payout items were fetched\n}, function(err) {\n // An error occured\n});",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\npayout_items = payout.fetch_items()({\n \"limit\": 20,\n \"order\": \"asc\"\n})\n"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\npayout_items = payout.fetch_items(\n limit: 20,\n order: \"asc\"\n)"
},
{
"language": "php",
"code": "fetchItems(array(\n \"limit\" => 20,\n \"order\" => \"asc\"\n));"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\npayoutItems, err := payout.FetchItems(processout.PayoutFetchItemsParameters{\n Options: &processout.Options{\n Limit: 20,\n Order: \"asc\",\n },\n})"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/payouts": {
"get": {
"summary": "Listing payouts",
"description": "",
"operationId": "listing-payouts",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"count\": 3,\n \"has_more\": false,\n \"limit\": 10,\n \"order\": \"desc\",\n \"payouts\": [\n {\n \"id\": \"payt_xrrP1uGvDRkP0aAXtqqehDdFhqIgXJ30\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_configuration\": {\n \"id\": \"gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_id\": 6,\n \"gateway_name\": \"stripe\",\n \"name\": \"Stripe US Account\",\n \"default_currency\": \"USD\",\n \"processing_region\": null,\n \"merchant_account_country_code\": null,\n \"enabled\": true,\n \"sub_accounts_enabled\": [\n \"stripe\"\n ],\n \"public_keys\": {\n \"public_key\": \"pk_test_pmXXEEFGFlFeFFTRd33\"\n },\n \"is_pulling\": false,\n \"config_entries\": null,\n \"sandbox\": false,\n \"created_at\": \"2017-12-12T16:25:49.238147Z\",\n \"enabled_at\": \"2017-12-12T16:25:50.553585Z\"\n },\n \"gateway_configuration_id\": \"gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2\",\n \"gateway_resource_id\": \"po_1GaXWaGY1kBCI7IQirV34GFM\",\n \"status\": \"received\",\n \"failure_reason_code\": null,\n \"failure_reason\": null,\n \"metadata\": {},\n \"amount\": \"5402.93\",\n \"currency\": \"EUR\",\n \"bank_name\": \"N26 BANK GMBH\",\n \"bank_summary\": \"\",\n \"sales_transactions\": 625,\n \"sales_volume\": \"5640.43\",\n \"sales_fees\": \"-237.5\",\n \"refunds_transactions\": 0,\n \"refunds_volume\": \"0\",\n \"refunds_fees\": \"0\",\n \"chargebacks_transactions\": 0,\n \"chargebacks_volume\": \"0\",\n \"chargebacks_fees\": \"0\",\n \"fees\": \"-234.46\",\n \"adjustments\": \"0\",\n \"adjustments_volume\": \"0\",\n \"adjustments_fees\": \"0\",\n \"reserve\": \"0\",\n \"reserve_volume\": \"0\",\n \"reserve_fees\": \"0\",\n \"settled_at\": \"2020-04-20T23:57:14Z\",\n \"created_at\": \"2020-04-22T01:47:58.250171Z\"\n },\n {\n \"id\": \"payt_uuVSsvmuGdxqVR1YoquQxLUt3cBw74gc\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_configuration\": {\n \"id\": \"gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_id\": 6,\n \"gateway_name\": \"stripe\",\n \"name\": \"Adyen\",\n \"default_currency\": \"USD\",\n \"processing_region\": null,\n \"merchant_account_country_code\": null,\n \"enabled\": true,\n \"sub_accounts_enabled\": [\n \"stripe\"\n ],\n \"public_keys\": {\n \"public_key\": \"pk_test_pmXXEEFGFlFeFFTRd33\"\n },\n \"is_pulling\": false,\n \"config_entries\": null,\n \"sandbox\": false,\n \"created_at\": \"2017-12-12T16:25:49.238147Z\",\n \"enabled_at\": \"2017-12-12T16:25:50.553585Z\"\n },\n \"gateway_configuration_id\": \"gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2\",\n \"gateway_resource_id\": \"po_1GaAfVGY1kBCI7IQ2DxffZUN\",\n \"status\": \"received\",\n \"failure_reason_code\": null,\n \"failure_reason\": null,\n \"metadata\": {},\n \"amount\": \"5367.86\",\n \"currency\": \"EUR\",\n \"bank_name\": \"N26 BANK GMBH\",\n \"bank_summary\": \"\",\n \"sales_transactions\": 622,\n \"sales_volume\": \"5604.22\",\n \"sales_fees\": \"-236.36\",\n \"refunds_transactions\": 0,\n \"refunds_volume\": \"0\",\n \"refunds_fees\": \"0\",\n \"chargebacks_transactions\": 0,\n \"chargebacks_volume\": \"0\",\n \"chargebacks_fees\": \"0\",\n \"fees\": \"-234.46\",\n \"adjustments\": \"0\",\n \"adjustments_volume\": \"0\",\n \"adjustments_fees\": \"0\",\n \"reserve\": \"0\",\n \"reserve_volume\": \"0\",\n \"reserve_fees\": \"0\",\n \"settled_at\": \"2020-04-19T23:58:54Z\",\n \"created_at\": \"2020-04-21T01:17:58.583458Z\"\n },\n {\n \"id\": \"payt_Q4LcEBbnjppQqYn5rxJzOYoml07ODnaM\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_configuration\": {\n \"id\": \"gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_id\": 6,\n \"gateway_name\": \"stripe\",\n \"name\": \"Adyen\",\n \"default_currency\": \"USD\",\n \"processing_region\": null,\n \"merchant_account_country_code\": null,\n \"enabled\": true,\n \"sub_accounts_enabled\": [\n \"stripe\"\n ],\n \"public_keys\": {\n \"public_key\": \"pk_test_pmXXEEFGFlFeFFTRd33\"\n },\n \"is_pulling\": false,\n \"config_entries\": null,\n \"sandbox\": false,\n \"created_at\": \"2017-12-12T16:25:49.238147Z\",\n \"enabled_at\": \"2017-12-12T16:25:50.553585Z\"\n },\n \"gateway_configuration_id\": \"gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2\",\n \"gateway_resource_id\": \"po_1GZobgGY1kBCI7IQB7bpVoT2\",\n \"status\": \"received\",\n \"failure_reason_code\": null,\n \"failure_reason\": null,\n \"metadata\": {},\n \"amount\": \"5350.78\",\n \"currency\": \"EUR\",\n \"bank_name\": \"N26 BANK GMBH\",\n \"bank_summary\": \"\",\n \"sales_transactions\": 620,\n \"sales_volume\": \"5586.38\",\n \"sales_fees\": \"-235.6\",\n \"refunds_transactions\": 0,\n \"refunds_volume\": \"0\",\n \"refunds_fees\": \"0\",\n \"chargebacks_transactions\": 0,\n \"chargebacks_volume\": \"0\",\n \"chargebacks_fees\": \"0\",\n \"fees\": \"-234.46\",\n \"adjustments\": \"0\",\n \"adjustments_volume\": \"0\",\n \"adjustments_fees\": \"0\",\n \"reserve\": \"0\",\n \"reserve_volume\": \"0\",\n \"reserve_fees\": \"0\",\n \"settled_at\": \"2020-04-18T23:59:57Z\",\n \"created_at\": \"2020-04-20T01:47:16.05964Z\"\n }\n ],\n \"success\": true,\n \"total_count\": 2\n}"
}
},
"schema": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 3,
"default": 0
},
"has_more": {
"type": "boolean",
"example": false,
"default": true
},
"limit": {
"type": "integer",
"example": 10,
"default": 0
},
"order": {
"type": "string",
"example": "desc"
},
"payouts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "payt_xrrP1uGvDRkP0aAXtqqehDdFhqIgXJ30"
},
"project_id": {
"type": "string",
"example": "proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh"
},
"gateway_configuration": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2"
},
"project_id": {
"type": "string",
"example": "proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh"
},
"gateway_id": {
"type": "integer",
"example": 6,
"default": 0
},
"gateway_name": {
"type": "string",
"example": "stripe"
},
"name": {
"type": "string",
"example": "Stripe US Account"
},
"default_currency": {
"type": "string",
"example": "USD"
},
"processing_region": {},
"merchant_account_country_code": {},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"sub_accounts_enabled": {
"type": "array",
"items": {
"type": "string",
"example": "stripe"
}
},
"public_keys": {
"type": "object",
"properties": {
"public_key": {
"type": "string",
"example": "pk_test_pmXXEEFGFlFeFFTRd33"
}
}
},
"is_pulling": {
"type": "boolean",
"example": false,
"default": true
},
"config_entries": {},
"sandbox": {
"type": "boolean",
"example": false,
"default": true
},
"created_at": {
"type": "string",
"example": "2017-12-12T16:25:49.238147Z"
},
"enabled_at": {
"type": "string",
"example": "2017-12-12T16:25:50.553585Z"
}
}
},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_p7yr1ns1py9nie3ipxidxc2wz6uxq34m-2"
},
"gateway_resource_id": {
"type": "string",
"example": "po_1GaXWaGY1kBCI7IQirV34GFM"
},
"status": {
"type": "string",
"example": "received"
},
"failure_reason_code": {},
"failure_reason": {},
"metadata": {
"type": "object",
"properties": {}
},
"amount": {
"type": "string",
"example": "5402.93"
},
"currency": {
"type": "string",
"example": "EUR"
},
"bank_name": {
"type": "string",
"example": "N26 BANK GMBH"
},
"bank_summary": {
"type": "string",
"example": ""
},
"sales_transactions": {
"type": "integer",
"example": 625,
"default": 0
},
"sales_volume": {
"type": "string",
"example": "5640.43"
},
"sales_fees": {
"type": "string",
"example": "-237.5"
},
"refunds_transactions": {
"type": "integer",
"example": 0,
"default": 0
},
"refunds_volume": {
"type": "string",
"example": "0"
},
"refunds_fees": {
"type": "string",
"example": "0"
},
"chargebacks_transactions": {
"type": "integer",
"example": 0,
"default": 0
},
"chargebacks_volume": {
"type": "string",
"example": "0"
},
"chargebacks_fees": {
"type": "string",
"example": "0"
},
"fees": {
"type": "string",
"example": "-234.46"
},
"adjustments": {
"type": "string",
"example": "0"
},
"adjustments_volume": {
"type": "string",
"example": "0"
},
"adjustments_fees": {
"type": "string",
"example": "0"
},
"reserve": {
"type": "string",
"example": "0"
},
"reserve_volume": {
"type": "string",
"example": "0"
},
"reserve_fees": {
"type": "string",
"example": "0"
},
"settled_at": {
"type": "string",
"example": "2020-04-20T23:57:14Z"
},
"created_at": {
"type": "string",
"example": "2020-04-22T01:47:58.250171Z"
}
}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
},
"total_count": {
"type": "integer",
"example": 2,
"default": 0
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newPayout().all({\n limit: 20,\n order: \"asc\"\n}).then(function(payouts) {\n // Payouts were fetched\n}, function(err) {\n // An error occured\n});",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\npayouts = client.new_payout().all({\n \"limit\": 20,\n \"order\": \"asc\"\n})"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\npayouts = client.payout.all(\n limit: 20,\n order: \"asc\"\n)"
},
{
"language": "php",
"code": "newPayout()->all(array(\n \"limit\" => 20,\n \"order\" => \"asc\"\n));"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\npayouts, err := client.NewPayout().All(processout.PayoutAllParameters{\n Options: &processout.Options{\n Limit: 20,\n Order: \"asc\",\n },\n})"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
},
"/uploads/reports": {
"get": {
"summary": "Listing reports",
"description": "",
"operationId": "listing-reports",
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"count\": 2,\n \"has_more\": false,\n \"limit\": 10,\n \"order\": \"desc\",\n \"reports\": [\n {\n \"id\": \"rep_123CLedNlW2WSdqEF0DlxWJtBOZfvMK0\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_configuration_id\": \"gway_conf_123exd5kivrg3iwpdt2rcbovgx9ixa7\",\n \"gateway_resource_id\": null,\n \"description\": \"file1.csv\",\n \"error\": null,\n \"is_processed\": true,\n \"payload_size_bytes\": 65901,\n \"processed_bytes\": 65901,\n \"status\": \"processed\",\n \"progress_percentage\": 100,\n \"contains_data_from\": null,\n \"contains_data_to\": null,\n \"created_at\": \"2024-07-25T09:36:21.144754Z\"\n },\n {\n \"id\": \"rep_456CLedNlW2WSdqEF0DlxWJtBOZfvMK0\",\n \"project_id\": \"proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh\",\n \"gateway_configuration_id\": \"gway_conf_456exd5kivrg3iwpdt2rcbovgx9ixa7\",\n \"gateway_resource_id\": null,\n \"description\": \"file2.csv\",\n \"error\": null,\n \"is_processed\": true,\n \"payload_size_bytes\": 1109,\n \"processed_bytes\": 1109,\n \"status\": \"processed\",\n \"progress_percentage\": 100,\n \"contains_data_from\": null,\n \"contains_data_to\": null,\n \"created_at\": \"2024-07-24T12:23:00.433922Z\"\n }\n ],\n \"success\": true,\n \"total_count\": 2\n}"
}
},
"schema": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 2,
"default": 0
},
"has_more": {
"type": "boolean",
"example": false,
"default": true
},
"limit": {
"type": "integer",
"example": 10,
"default": 0
},
"order": {
"type": "string",
"example": "desc"
},
"reports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "rep_123CLedNlW2WSdqEF0DlxWJtBOZfvMK0"
},
"project_id": {
"type": "string",
"example": "proj_BCdhW7DG55F5SyxFgR70XFz5CBEfWokh"
},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_123exd5kivrg3iwpdt2rcbovgx9ixa7"
},
"gateway_resource_id": {},
"description": {
"type": "string",
"example": "file1.csv"
},
"error": {},
"is_processed": {
"type": "boolean",
"example": true,
"default": true
},
"payload_size_bytes": {
"type": "integer",
"example": 65901,
"default": 0
},
"processed_bytes": {
"type": "integer",
"example": 65901,
"default": 0
},
"status": {
"type": "string",
"example": "processed"
},
"progress_percentage": {
"type": "integer",
"example": 100,
"default": 0
},
"contains_data_from": {},
"contains_data_to": {},
"created_at": {
"type": "string",
"example": "2024-07-25T09:36:21.144754Z"
}
}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
},
"total_count": {
"type": "integer",
"example": 2,
"default": 0
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
}
},
"/network-tokens": {
"post": {
"summary": "Provisioning Network Token for card",
"description": "",
"operationId": "provisioning-network-token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"card_id"
],
"properties": {
"card_id": {
"type": "string",
"description": "ID of the tokenized card"
}
}
}
}
}
},
"responses": {
"202": {
"description": "202",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"network_token\": {\n \"status\": \"pending\"\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"network_token": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "pending"
}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"request.validation.provisioning-not-possible\",\n \"message\": \"network token status is active: provisioning not possible\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "request.validation.provisioning-not-possible"
},
"message": {
"type": "string",
"example": "network token status is active: provisioning not possible"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
}
},
"/invoices/{invoice_id}/refunds": {
"post": {
"summary": "Refund an invoice",
"description": "",
"operationId": "refund-an-invoice",
"parameters": [
{
"name": "invoice_id",
"in": "path",
"description": "The invoice ID generated by ProcessOut during the invoice creation",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "string",
"description": "Refund amount applied to the transaction."
},
"reason": {
"type": "string",
"description": "Reason for the refund (`customer_request`, `duplicate`, `fraud` or `other`).",
"default": "other"
},
"metadata": {
"type": "object",
"description": "Metadata related to the refund, in the form of key-value pairs (string - string).",
"properties": {}
},
"split_allocations": {
"type": "array",
"items": {
"properties": {
"provider_recipient_reference": {
"type": "string",
"description": "The unique identifier for the recipient's account. This is the destination account that will receive this portion of the funds."
},
"type": {
"type": "string",
"description": "Defines the purpose of the split. It determines how the funds are categorized and processed.",
"enum": [
"PURCHASE",
"VAT",
"FEE",
"COMMISSION",
"SHIPPING",
"MARKETPLACE"
]
},
"amount": {
"type": "string",
"description": "The specific amount of money for this individual split. Maximum 4 decimal places supported as per ISO 4217."
},
"currency": {
"type": "string",
"description": "Currency for payment of the individual split, in ISO 4217 format (for example, USD). Must be a valid ISO 4217 currency code with 3 characters"
},
"description": {
"type": "string",
"description": "A short, human-readable description for this split. This description will appear in transaction reports and can be useful for reconciliation."
},
"payment_reference": {
"type": "string",
"description": "Your own unique reference ID for this specific split. Providing a unique reference is critical for tracking the status of each individual split via webhooks and for reconciling your accounts. Recommended to include."
}
},
"type": "object",
"required": [
"provider_recipient_reference",
"type",
"amount",
"currency"
]
},
"description": "An array of allocation objects that defines how this refund payment should be divided among different recipients. Each object in this array represents one \"split\" of the total invoice amount. This object will override the invoice's default split allocations.An array of allocation objects that defines how this refund payment should be divided among different recipients. Each object in this array represents one \"split\" of the total invoice amount. This object will override the invoice's default split allocations."
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"refund\": {\n \"id\": \"refd_F5rkWLrLw2KmzwTovfqG5YcRvtrxrjOb\",\n \"transaction_id\": \"tr_WlfUgjdJRXGzNy6EQqPuQYpjkXwqogYM\",\n \"amount\": \"29\",\n \"metadata\": {},\n \"reason\": \"customer_request\",\n \"information\": \"\",\n \"funding_source\": \"\",\n \"has_failed\": false,\n \"sandbox\": true,\n \"created_at\": \"2023-04-24T16:19:42.771525314Z\",\n \"invoice_detail_ids\": null\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"refund": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "refd_F5rkWLrLw2KmzwTovfqG5YcRvtrxrjOb"
},
"transaction_id": {
"type": "string",
"example": "tr_WlfUgjdJRXGzNy6EQqPuQYpjkXwqogYM"
},
"amount": {
"type": "string",
"example": "29"
},
"metadata": {
"type": "object",
"properties": {}
},
"reason": {
"type": "string",
"example": "customer_request"
},
"information": {
"type": "string",
"example": ""
},
"funding_source": {
"type": "string",
"example": ""
},
"has_failed": {
"type": "boolean",
"example": false,
"default": true
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-24T16:19:42.771525314Z"
},
"invoice_detail_ids": {}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"request.validation.invalid-amount\",\n \"message\": \"No amount is available on the transaction to be refunded.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "request.validation.invalid-amount"
},
"message": {
"type": "string",
"example": "No amount is available on the transaction to be refunded."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.invoice.not-found\",\n \"message\": \"The invoice could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.invoice.not-found"
},
"message": {
"type": "string",
"example": "The invoice could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false
}
},
"/cards/{card_id}": {
"put": {
"summary": "Updating a card",
"description": "",
"operationId": "updating-a-card",
"parameters": [
{
"name": "card_id",
"in": "path",
"description": "ID of the card tokenized",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cvc2": {
"type": "string",
"description": "CVC of the card"
},
"preferred_scheme": {
"type": "string",
"description": "Preferred scheme defined by the Customer. This gets priority when processing the Transaction. If you wish to update this back to empty, you can use the value `none`."
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": {
"card": {
"project_id": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S",
"update_type": "new-cvc2",
"update_reason_code": "request",
"scheme": "visa",
"co_scheme": null,
"preferred_scheme": null,
"type": "credit",
"bank_name": null,
"brand": null,
"category": null,
"iin": "400000",
"last_4_digits": "0101",
"fingerprint": "0f041fb914a50c7555df2318df1a9f9571cc96305c07b4f944e29fd17bfd1691",
"exp_month": 11,
"exp_year": 2026,
"cvc_check": "unavailable",
"avs_check": "unavailable",
"checks": {
"cvc_check": "unavailable",
"cvc_check_reason": null,
"avs_check": "unavailable",
"avs_postal_check": "unavailable",
"avs_postal_check_reason": null,
"avs_street_check": "unavailable",
"avs_street_check_reason": null,
"avs_name_check": "unavailable",
"avs_name_check_reason": null
},
"token_type": null,
"name": "Mat\u00e9o Garnier",
"address1": "133 rue Lamarck",
"address2": "Cedex 7",
"city": "Paris",
"state": "Ile De France",
"country_code": "US",
"billing_country_code": "FR",
"zip": "75018",
"ip_address": "1.2.3.4",
"user_agent": "PostmanRuntime/7.32.2",
"header_accept": "*/*",
"app_color_depth": null,
"app_java_enabled": null,
"app_language": null,
"app_screen_height": null,
"app_screen_width": null,
"app_timezone_offset": null,
"header_referer": null,
"expires_soon": false,
"metadata": {},
"used": null,
"sandbox": true,
"created_at": "2023-04-22T10:10:21.019103Z",
"updated_at": "2023-04-22T10:22:11.46316117Z",
"id": "card_zZAeVmdrJjN58PbB8lVSrqh3rqEuH3Ai",
"cvc_tokenized": true,
"tokenization_method": null,
"payment_source_detail": null
},
"success": true
}
}
},
"schema": {
"type": "object",
"properties": {
"card": {
"type": "object",
"properties": {
"project_id": {
"type": "string",
"example": "proj_IFCgGTmyClrgTOzsschN1y7GJttHVQ7S"
},
"update_type": {
"type": "string",
"example": "new-cvc2"
},
"update_reason_code": {
"type": "string",
"example": "request"
},
"scheme": {
"type": "string",
"example": "visa"
},
"co_scheme": {},
"preferred_scheme": {},
"type": {
"type": "string",
"example": "credit"
},
"bank_name": {},
"brand": {},
"category": {},
"iin": {
"type": "string",
"example": "400000"
},
"last_4_digits": {
"type": "string",
"example": "0101"
},
"fingerprint": {
"type": "string",
"example": "0f041fb914a50c7555df2318df1a9f9571cc96305c07b4f944e29fd17bfd1691"
},
"exp_month": {
"type": "integer",
"example": 11,
"default": 0
},
"exp_year": {
"type": "integer",
"example": 2026,
"default": 0
},
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"checks": {
"type": "object",
"properties": {
"cvc_check": {
"type": "string",
"example": "unavailable"
},
"cvc_check_reason": {},
"avs_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check": {
"type": "string",
"example": "unavailable"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unavailable"
},
"avs_street_check_reason": {},
"avs_name_check": {
"type": "string",
"example": "unavailable"
},
"avs_name_check_reason": {}
}
},
"token_type": {},
"name": {
"type": "string",
"example": "Mat\u00e9o Garnier"
},
"address1": {
"type": "string",
"example": "133 rue Lamarck"
},
"address2": {
"type": "string",
"example": "Cedex 7"
},
"city": {
"type": "string",
"example": "Paris"
},
"state": {
"type": "string",
"example": "Ile De France"
},
"country_code": {
"type": "string",
"example": "US"
},
"billing_country_code": {
"type": "string"
},
"zip": {
"type": "string",
"example": "75018"
},
"ip_address": {
"type": "string",
"example": "1.2.3.4"
},
"user_agent": {
"type": "string",
"example": "PostmanRuntime/7.32.2"
},
"header_accept": {
"type": "string",
"example": "*/*"
},
"app_color_depth": {},
"app_java_enabled": {},
"app_language": {},
"app_screen_height": {},
"app_screen_width": {},
"app_timezone_offset": {},
"header_referer": {},
"expires_soon": {
"type": "boolean",
"example": false,
"default": true
},
"metadata": {
"type": "object",
"properties": {}
},
"used": {},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2023-04-22T10:10:21.019103Z"
},
"updated_at": {
"type": "string",
"example": "2023-04-22T10:22:11.46316117Z"
},
"id": {
"type": "string",
"example": "card_zZAeVmdrJjN58PbB8lVSrqh3rqEuH3Ai"
},
"cvc_tokenized": {
"type": "boolean",
"example": true,
"default": true
},
"tokenization_method": {},
"payment_source_detail": {}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"resource.card.not-found\",\n \"message\": \"The card could not be found.\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.card.not-found"
},
"message": {
"type": "string",
"example": "The card could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
}
}
},
"/events/{event_id}": {
"get": {
"summary": "Fetching an event",
"description": "",
"operationId": "fetching-an-event",
"parameters": [
{
"name": "event_id",
"in": "path",
"description": "ID of the event received on the webhook endpoint",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Unique key to your request that will be used for idempotency",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"event\": {\n \"id\": \"ev_rV1yRUxr8IZ4p5sumcW2fbLxRy4FTB3C\",\n \"project_id\": \"proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r\",\n \"webhooks\": null,\n \"name\": \"transaction.failed\",\n \"data\": {\n \"name\": \"transaction.failed\",\n \"sandbox\": true,\n \"transaction\": {\n \"acquirer_name\": null,\n \"amount\": \"10\",\n \"amount_local\": \"11.1\",\n \"attempts_count\": 1,\n \"authorized\": false,\n \"authorized_amount\": \"0\",\n \"authorized_amount_local\": \"0\",\n \"authorized_at\": null,\n \"available_amount\": \"0\",\n \"available_amount_local\": \"0\",\n \"avs_check\": \"unknown\",\n \"buyer\": {\n \"address\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\"\n },\n \"captured\": false,\n \"captured_amount\": \"0\",\n \"captured_amount_local\": \"0\",\n \"captured_at\": null,\n \"card\": {\n \"address1\": null,\n \"address2\": null,\n \"app_color_depth\": 24,\n \"app_java_enabled\": false,\n \"app_language\": \"en-US\",\n \"app_screen_height\": 1080,\n \"app_screen_width\": 2560,\n \"app_timezone_offset\": -60,\n \"avs_check\": \"unknown\",\n \"bank_name\": \"STRIPE PAYMENTS UK LIMITED\",\n \"brand\": \"visa classic\",\n \"category\": \"consumer\",\n \"checks\": {\n \"avs_check\": \"unknown\",\n \"avs_name_check\": \"unknown\",\n \"avs_name_check_reason\": null,\n \"avs_postal_check\": \"unknown\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unknown\",\n \"avs_street_check_reason\": null,\n \"cvc_check\": \"failed\",\n \"cvc_check_reason\": null\n },\n \"city\": null,\n \"co_scheme\": null,\n \"country_code\": \"GB\",\n \"created_at\": \"2023-04-22T15:48:53.701681Z\",\n \"cvc_check\": \"failed\",\n \"cvc_tokenized\": true,\n \"exp_month\": 12,\n \"exp_year\": 2026,\n \"expires_soon\": false,\n \"fingerprint\": \"f83990dd8700010a2fa3b658bfb11c2570e8c99807d609ab9864854909063096\",\n \"header_accept\": \"*/*\",\n \"header_referer\": \"https://checkout.processout.com/\",\n \"id\": \"card_2qT1ms6dp7lgkaxa4gu6u6kRWL1cEO2L\",\n \"iin\": \"424242\",\n \"ip_address\": \"176.27.120.213\",\n \"last_4_digits\": \"4242\",\n \"metadata\": {},\n \"name\": \"zefze\",\n \"payment_source_detail\": null,\n \"preferred_scheme\": null,\n \"project_id\": \"proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r\",\n \"sandbox\": true,\n \"scheme\": \"visa\",\n \"state\": null,\n \"token_type\": null,\n \"tokenization_method\": null,\n \"type\": \"credit\",\n \"update_reason_code\": null,\n \"update_type\": null,\n \"updated_at\": \"2023-04-22T15:48:55.165556Z\",\n \"used\": null,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.4 Safari/605.1.15\",\n \"zip\": null\n },\n \"card_checks\": {\n \"avs_check\": \"unknown\",\n \"avs_name_check\": \"unknown\",\n \"avs_name_check_reason\": null,\n \"avs_postal_check\": \"unknown\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"unknown\",\n \"avs_street_check_reason\": null,\n \"cvc_check\": \"failed\",\n \"cvc_check_reason\": null\n },\n \"card_id\": \"card_2qT1ms6dp7lgkaxa4gu6u6kRWL1cEO2L\",\n \"chargedback\": false,\n \"chargedback_at\": null,\n \"created_at\": \"2023-04-22T15:48:40.90936Z\",\n \"currency\": \"EUR\",\n \"currency_fee\": null,\n \"customer_id\": null,\n \"cvc_check\": \"failed\",\n \"details\": {\n \"country\": \"GB\"\n },\n \"duplicate_distance_seconds\": null,\n \"eci\": null,\n \"error_code\": \"card.failed-cvc\",\n \"error_message\": \"Bad Track Data\",\n \"error_recommendations\": [],\n \"estimated_fee\": \"0.6\",\n \"fraud_service_results\": null,\n \"gateway_configuration\": {\n \"config_entries\": null,\n \"created_at\": \"2021-08-17T09:30:16.805364Z\",\n \"default_currency\": \"USD\",\n \"enabled\": true,\n \"enabled_at\": \"2022-09-09T09:04:29.794495Z\",\n \"gateway_id\": 11,\n \"gateway_name\": \"checkoutcom\",\n \"id\": \"gway_conf_ndv31saui5hu84u3iwantt2oc8w79x2n\",\n \"is_pulling\": false,\n \"merchant_account_country_code\": null,\n \"name\": \"Checkout.com Testing Account\",\n \"processing_region\": null,\n \"project_id\": \"proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r\",\n \"public_keys\": {\n \"public_key\": \"pk_test_7a6c1f88-5fa0-4a38-af89-d9b847dcd233\"\n },\n \"sandbox\": true,\n \"sub_accounts_enabled\": [\n \"checkoutcom\",\n \"checkoutcomgiropay\",\n \"checkoutcomsofort\",\n \"checkoutcomalipay\",\n \"checkoutcomboleto\",\n \"checkoutcommultibanco\",\n \"checkoutcombcmc\",\n \"checkoutcompoli\"\n ]\n },\n \"gateway_configuration_id\": \"gway_conf_ndv31saui5hu84u3iwantt2oc8w79x2n\",\n \"gateway_fee\": \"0\",\n \"gateway_fee_details\": {\n \"exchange_fee\": \"0\",\n \"interchange_fee\": \"0\",\n \"interchange_fee_estimate\": \"0\",\n \"markup_fee\": \"0\",\n \"processing_fee\": \"0\",\n \"refund_fee\": \"0\",\n \"scheme_fee\": \"0\",\n \"scheme_fee_estimate\": \"0\"\n },\n \"gateway_fee_local\": \"0\",\n \"gateway_name\": \"checkoutcom\",\n \"id\": \"tr_NcIZWFdUQhfOQdfefQov14vN77tRa2Yn\",\n \"incremented_amount\": \"0\",\n \"incremented_amount_local\": \"0\",\n \"initial_scheme_transaction_id\": null,\n \"invoice\": {\n \"amount\": \"10\",\n \"cancel_url\": null,\n \"card_verification\": null,\n \"challenge_indicator\": null,\n \"created_at\": \"2023-04-22T15:48:40.908045Z\",\n \"currency\": \"EUR\",\n \"customer_id\": null,\n \"details\": null,\n \"device\": {\n \"channel\": null,\n \"id\": null,\n \"ip_address\": null\n },\n \"exemption_reason_3ds2\": null,\n \"gateway_data\": {},\n \"id\": \"iv_gDvoOlsMlUSlGbBf7XEaZtNhMu3qcxRB\",\n \"incremental\": null,\n \"initiation_type\": null,\n \"merchant_initiator_type\": null,\n \"metadata\": {},\n \"name\": \"test\",\n \"payment_intent\": null,\n \"payment_type\": null,\n \"project_id\": \"proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r\",\n \"require_backend_capture\": null,\n \"return_url\": null,\n \"risk\": {\n \"is_legit\": null,\n \"score\": null,\n \"skip_gateway_rules\": null\n },\n \"sandbox\": true,\n \"sca_exemption_reason\": null,\n \"shipping\": {\n \"address1\": null,\n \"address2\": null,\n \"amount\": \"0\",\n \"city\": null,\n \"country_code\": null,\n \"delay\": null,\n \"expects_shipping_at\": null,\n \"method\": null,\n \"phone_number\": null,\n \"provider\": null,\n \"relay_store_name\": null,\n \"state\": null,\n \"zip\": null\n },\n \"statement_descriptor\": \"test\",\n \"subscription_id\": null,\n \"tax\": {\n \"amount\": null,\n \"rate\": null\n },\n \"token_id\": null,\n \"transaction_id\": \"tr_NcIZWFdUQhfOQdfefQov14vN77tRa2Yn\",\n \"url\": \"https://checkout.processout.com/test-proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r/iv_gDvoOlsMlUSlGbBf7XEaZtNhMu3qcxRB\",\n \"webhook_url\": null\n },\n \"invoice_id\": \"iv_gDvoOlsMlUSlGbBf7XEaZtNhMu3qcxRB\",\n \"is_on_us\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"metadata\": {},\n \"name\": \"test\",\n \"operations\": [\n {\n \"acquirer_name\": null,\n \"amount\": \"10\",\n \"amount_local\": \"11.1\",\n \"arn\": null,\n \"authenticated_transaction_id\": null,\n \"authorization_code\": null,\n \"card_checks\": {\n \"avs_check\": \"\",\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null,\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null\n },\n \"card_id\": \"card_2qT1ms6dp7lgkaxa4gu6u6kRWL1cEO2L\",\n \"challenge_indicator\": \"\",\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-22T15:48:55.165458Z\",\n \"currency\": \"EUR\",\n \"eci\": null,\n \"error_code\": null,\n \"error_message\": null,\n \"gateway_configuration_id\": \"gway_conf_ndv31saui5hu84u3iwantt2oc8w79x2n\",\n \"gateway_data\": {\n \"auth_code\": \"060924\",\n \"response_code\": \"20087\",\n \"response_summary\": \"Bad Track Data\",\n \"risk_flagged\": \"false\"\n },\n \"gateway_operation_id\": \"\",\n \"has_failed\": false,\n \"id\": \"tr_op_sB4MK0VrvMICvImDtCClnOPJIHPYAQuX\",\n \"initial_scheme_transaction_id\": \"\",\n \"is_accountable\": false,\n \"is_attempt\": false,\n \"is_on_us\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"metadata\": {},\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_type\": \"card\",\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"sca_exemption_reason\": \"\",\n \"scheme_id\": null,\n \"token_id\": null,\n \"transaction_id\": \"tr_NcIZWFdUQhfOQdfefQov14vN77tRa2Yn\",\n \"type\": \"request\"\n },\n {\n \"acquirer_name\": null,\n \"amount\": \"10\",\n \"amount_local\": \"11.1\",\n \"arn\": \"471171956026\",\n \"authenticated_transaction_id\": null,\n \"authorization_code\": \"060924\",\n \"card_checks\": {\n \"avs_check\": \"\",\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null,\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null\n },\n \"card_id\": \"card_2qT1ms6dp7lgkaxa4gu6u6kRWL1cEO2L\",\n \"challenge_indicator\": \"\",\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-22T15:48:55.165506Z\",\n \"currency\": \"EUR\",\n \"eci\": null,\n \"error_code\": \"card.failed-cvc\",\n \"error_message\": \"Bad Track Data\",\n \"gateway_configuration_id\": \"gway_conf_ndv31saui5hu84u3iwantt2oc8w79x2n\",\n \"gateway_data\": {\n \"auth_code\": \"060924\",\n \"response_code\": \"20087\",\n \"response_summary\": \"Bad Track Data\",\n \"risk_flagged\": \"false\"\n },\n \"gateway_operation_id\": \"pay_gqtryygdsxk2tfwrkrkcjl4ozy\",\n \"has_failed\": false,\n \"id\": \"tr_op_Jfp2qWayFXMeZmATKwBi5XecYYl0oIgD\",\n \"initial_scheme_transaction_id\": \"\",\n \"is_accountable\": false,\n \"is_attempt\": true,\n \"is_on_us\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"metadata\": {\n \"gateway_error_code\": \"20087\"\n },\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_type\": \"card\",\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"sca_exemption_reason\": \"\",\n \"scheme_id\": \"583169616534378\",\n \"token_id\": null,\n \"transaction_id\": \"tr_NcIZWFdUQhfOQdfefQov14vN77tRa2Yn\",\n \"type\": \"authorization\"\n },\n {\n \"acquirer_name\": null,\n \"amount\": \"10\",\n \"amount_local\": \"11.1\",\n \"arn\": \"471171956026\",\n \"authenticated_transaction_id\": null,\n \"authorization_code\": \"060924\",\n \"card_checks\": {\n \"avs_check\": \"\",\n \"avs_name_check\": \"\",\n \"avs_name_check_reason\": null,\n \"avs_postal_check\": \"\",\n \"avs_postal_check_reason\": null,\n \"avs_street_check\": \"\",\n \"avs_street_check_reason\": null,\n \"cvc_check\": \"\",\n \"cvc_check_reason\": null\n },\n \"card_id\": \"card_2qT1ms6dp7lgkaxa4gu6u6kRWL1cEO2L\",\n \"challenge_indicator\": \"\",\n \"chargeback_reason\": null,\n \"created_at\": \"2023-04-22T15:48:55.16555Z\",\n \"currency\": \"EUR\",\n \"eci\": null,\n \"error_code\": \"card.failed-cvc\",\n \"error_message\": \"Bad Track Data\",\n \"gateway_configuration_id\": \"gway_conf_ndv31saui5hu84u3iwantt2oc8w79x2n\",\n \"gateway_data\": {\n \"auth_code\": \"060924\",\n \"response_code\": \"20087\",\n \"response_summary\": \"Bad Track Data\",\n \"risk_flagged\": \"false\"\n },\n \"gateway_operation_id\": \"pay_gqtryygdsxk2tfwrkrkcjl4ozy\",\n \"has_failed\": true,\n \"id\": \"tr_op_B8xDqGpxiY85spnNo4e1z2ehgyiIbiLY\",\n \"initial_scheme_transaction_id\": \"\",\n \"is_accountable\": false,\n \"is_attempt\": false,\n \"is_on_us\": null,\n \"mcc\": null,\n \"merchant_account_id\": null,\n \"merchant_advice_code\": null,\n \"merchant_advice_reason\": null,\n \"metadata\": {\n \"gateway_error_code\": \"20087\"\n },\n \"payment_data_network_authentication\": null,\n \"payment_data_three_d_s_2_authentication\": null,\n \"payment_data_three_d_s_authentication\": null,\n \"payment_data_three_d_s_request\": null,\n \"payment_type\": \"card\",\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"sca_exemption_reason\": \"\",\n \"scheme_id\": \"583169616534378\",\n \"token_id\": null,\n \"transaction_id\": \"tr_NcIZWFdUQhfOQdfefQov14vN77tRa2Yn\",\n \"type\": \"authorization\"\n }\n ],\n \"payment_type\": \"card\",\n \"processout_fee\": \"0\",\n \"project_id\": \"proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r\",\n \"received_fraud_notification\": false,\n \"received_retrieval_request\": false,\n \"recommendation_code\": null,\n \"recommendation_reason\": null,\n \"refunded\": false,\n \"refunded_amount\": \"0\",\n \"refunded_amount_local\": \"0\",\n \"refunded_at\": null,\n \"refunds\": [],\n \"routing_tags\": [\n \"rule-2-route\"\n ],\n \"sandbox\": true,\n \"sca\": {\n \"challenge_result\": \"no-challenge-indicator-set\",\n \"exemption_result\": \"no-exemption-reason-set\",\n \"inscope_compliance\": \"not-applicable\",\n \"out_of_scope_reason\": \"unknown\",\n \"scope\": \"unknown\"\n },\n \"scheme_id\": \"583169616534378\",\n \"status\": \"failed\",\n \"subscription_cycle\": null,\n \"subscription_id\": null,\n \"three_d_s\": null,\n \"three_d_s_status\": \"unchecked\",\n \"three_d_s_version\": null,\n \"token_id\": null,\n \"voided\": false,\n \"voided_at\": null\n }\n },\n \"sandbox\": true,\n \"fired_at\": \"2023-04-22T15:48:57.55294073Z\"\n },\n \"success\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"event": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ev_rV1yRUxr8IZ4p5sumcW2fbLxRy4FTB3C"
},
"project_id": {
"type": "string",
"example": "proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r"
},
"webhooks": {},
"name": {
"type": "string",
"example": "transaction.failed"
},
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "transaction.failed"
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"transaction": {
"type": "object",
"properties": {
"acquirer_name": {},
"amount": {
"type": "string",
"example": "10"
},
"amount_local": {
"type": "string",
"example": "11.1"
},
"attempts_count": {
"type": "integer",
"example": 1,
"default": 0
},
"authorized": {
"type": "boolean",
"example": false,
"default": true
},
"authorized_amount": {
"type": "string",
"example": "0"
},
"authorized_amount_local": {
"type": "string",
"example": "0"
},
"authorized_at": {},
"available_amount": {
"type": "string",
"example": "0"
},
"available_amount_local": {
"type": "string",
"example": "0"
},
"avs_check": {
"type": "string",
"example": "unknown"
},
"buyer": {
"type": "object",
"properties": {
"address": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
},
"name": {
"type": "string",
"example": ""
},
"phone": {
"type": "string",
"example": ""
}
}
},
"captured": {
"type": "boolean",
"example": false,
"default": true
},
"captured_amount": {
"type": "string",
"example": "0"
},
"captured_amount_local": {
"type": "string",
"example": "0"
},
"captured_at": {},
"card": {
"type": "object",
"properties": {
"address1": {},
"address2": {},
"app_color_depth": {
"type": "integer",
"example": 24,
"default": 0
},
"app_java_enabled": {
"type": "boolean",
"example": false,
"default": true
},
"app_language": {
"type": "string",
"example": "en-US"
},
"app_screen_height": {
"type": "integer",
"example": 1080,
"default": 0
},
"app_screen_width": {
"type": "integer",
"example": 2560,
"default": 0
},
"app_timezone_offset": {
"type": "integer",
"example": -60,
"default": 0
},
"avs_check": {
"type": "string",
"example": "unknown"
},
"bank_name": {
"type": "string",
"example": "STRIPE PAYMENTS UK LIMITED"
},
"brand": {
"type": "string",
"example": "visa classic"
},
"category": {
"type": "string",
"example": "consumer"
},
"checks": {
"type": "object",
"properties": {
"avs_check": {
"type": "string",
"example": "unknown"
},
"avs_name_check": {
"type": "string",
"example": "unknown"
},
"avs_name_check_reason": {},
"avs_postal_check": {
"type": "string",
"example": "unknown"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unknown"
},
"avs_street_check_reason": {},
"cvc_check": {
"type": "string",
"example": "failed"
},
"cvc_check_reason": {}
}
},
"city": {},
"co_scheme": {},
"country_code": {
"type": "string",
"example": "GB"
},
"created_at": {
"type": "string",
"example": "2023-04-22T15:48:53.701681Z"
},
"cvc_check": {
"type": "string",
"example": "failed"
},
"cvc_tokenized": {
"type": "boolean",
"example": true,
"default": true
},
"exp_month": {
"type": "integer",
"example": 12,
"default": 0
},
"exp_year": {
"type": "integer",
"example": 2026,
"default": 0
},
"expires_soon": {
"type": "boolean",
"example": false,
"default": true
},
"fingerprint": {
"type": "string",
"example": "f83990dd8700010a2fa3b658bfb11c2570e8c99807d609ab9864854909063096"
},
"header_accept": {
"type": "string",
"example": "*/*"
},
"header_referer": {
"type": "string",
"example": "https://checkout.processout.com/"
},
"id": {
"type": "string",
"example": "card_2qT1ms6dp7lgkaxa4gu6u6kRWL1cEO2L"
},
"iin": {
"type": "string",
"example": "424242"
},
"ip_address": {
"type": "string",
"example": "176.27.120.213"
},
"last_4_digits": {
"type": "string",
"example": "4242"
},
"metadata": {
"type": "object",
"properties": {}
},
"name": {
"type": "string",
"example": "zefze"
},
"payment_source_detail": {},
"preferred_scheme": {},
"project_id": {
"type": "string",
"example": "proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r"
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"scheme": {
"type": "string",
"example": "visa"
},
"state": {},
"token_type": {},
"tokenization_method": {},
"type": {
"type": "string",
"example": "credit"
},
"update_reason_code": {},
"update_type": {},
"updated_at": {
"type": "string",
"example": "2023-04-22T15:48:55.165556Z"
},
"used": {},
"user_agent": {
"type": "string",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.4 Safari/605.1.15"
},
"zip": {}
}
},
"card_checks": {
"type": "object",
"properties": {
"avs_check": {
"type": "string",
"example": "unknown"
},
"avs_name_check": {
"type": "string",
"example": "unknown"
},
"avs_name_check_reason": {},
"avs_postal_check": {
"type": "string",
"example": "unknown"
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": "unknown"
},
"avs_street_check_reason": {},
"cvc_check": {
"type": "string",
"example": "failed"
},
"cvc_check_reason": {}
}
},
"card_id": {
"type": "string",
"example": "card_2qT1ms6dp7lgkaxa4gu6u6kRWL1cEO2L"
},
"chargedback": {
"type": "boolean",
"example": false,
"default": true
},
"chargedback_at": {},
"created_at": {
"type": "string",
"example": "2023-04-22T15:48:40.90936Z"
},
"currency": {
"type": "string",
"example": "EUR"
},
"currency_fee": {},
"customer_id": {},
"cvc_check": {
"type": "string",
"example": "failed"
},
"details": {
"type": "object",
"properties": {
"country": {
"type": "string",
"example": "GB"
}
}
},
"duplicate_distance_seconds": {},
"eci": {},
"error_code": {
"type": "string",
"example": "card.failed-cvc"
},
"error_message": {
"type": "string",
"example": "Bad Track Data"
},
"error_recommendations": {
"type": "array"
},
"estimated_fee": {
"type": "string",
"example": "0.6"
},
"fraud_service_results": {},
"gateway_configuration": {
"type": "object",
"properties": {
"config_entries": {},
"created_at": {
"type": "string",
"example": "2021-08-17T09:30:16.805364Z"
},
"default_currency": {
"type": "string",
"example": "USD"
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"enabled_at": {
"type": "string",
"example": "2022-09-09T09:04:29.794495Z"
},
"gateway_id": {
"type": "integer",
"example": 11,
"default": 0
},
"gateway_name": {
"type": "string",
"example": "checkoutcom"
},
"id": {
"type": "string",
"example": "gway_conf_ndv31saui5hu84u3iwantt2oc8w79x2n"
},
"is_pulling": {
"type": "boolean",
"example": false,
"default": true
},
"merchant_account_country_code": {},
"name": {
"type": "string",
"example": "Checkout.com Testing Account"
},
"processing_region": {},
"project_id": {
"type": "string",
"example": "proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r"
},
"public_keys": {
"type": "object",
"properties": {
"public_key": {
"type": "string",
"example": "pk_test_7a6c1f88-5fa0-4a38-af89-d9b847dcd233"
}
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"sub_accounts_enabled": {
"type": "array",
"items": {
"type": "string",
"example": "checkoutcom"
}
}
}
},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_ndv31saui5hu84u3iwantt2oc8w79x2n"
},
"gateway_fee": {
"type": "string",
"example": "0"
},
"gateway_fee_details": {
"type": "object",
"properties": {
"exchange_fee": {
"type": "string",
"example": "0"
},
"interchange_fee": {
"type": "string",
"example": "0"
},
"interchange_fee_estimate": {
"type": "string",
"example": "0"
},
"markup_fee": {
"type": "string",
"example": "0"
},
"processing_fee": {
"type": "string",
"example": "0"
},
"refund_fee": {
"type": "string",
"example": "0"
},
"scheme_fee": {
"type": "string",
"example": "0"
},
"scheme_fee_estimate": {
"type": "string",
"example": "0"
}
}
},
"gateway_fee_local": {
"type": "string",
"example": "0"
},
"gateway_name": {
"type": "string",
"example": "checkoutcom"
},
"id": {
"type": "string",
"example": "tr_NcIZWFdUQhfOQdfefQov14vN77tRa2Yn"
},
"incremented_amount": {
"type": "string",
"example": "0"
},
"incremented_amount_local": {
"type": "string",
"example": "0"
},
"initial_scheme_transaction_id": {},
"invoice": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"example": "10"
},
"cancel_url": {},
"card_verification": {},
"challenge_indicator": {},
"created_at": {
"type": "string",
"example": "2023-04-22T15:48:40.908045Z"
},
"currency": {
"type": "string",
"example": "EUR"
},
"customer_id": {},
"details": {},
"device": {
"type": "object",
"properties": {
"channel": {},
"id": {},
"ip_address": {}
}
},
"exemption_reason_3ds2": {},
"gateway_data": {
"type": "object",
"properties": {}
},
"id": {
"type": "string",
"example": "iv_gDvoOlsMlUSlGbBf7XEaZtNhMu3qcxRB"
},
"incremental": {},
"initiation_type": {},
"merchant_initiator_type": {},
"metadata": {
"type": "object",
"properties": {}
},
"name": {
"type": "string",
"example": "test"
},
"payment_intent": {},
"payment_type": {},
"project_id": {
"type": "string",
"example": "proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r"
},
"require_backend_capture": {},
"return_url": {},
"risk": {
"type": "object",
"properties": {
"is_legit": {},
"score": {},
"skip_gateway_rules": {}
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"sca_exemption_reason": {},
"shipping": {
"type": "object",
"properties": {
"address1": {},
"address2": {},
"amount": {
"type": "string",
"example": "0"
},
"city": {},
"country_code": {},
"delay": {},
"expects_shipping_at": {},
"method": {},
"phone_number": {},
"provider": {},
"relay_store_name": {},
"state": {},
"zip": {}
}
},
"statement_descriptor": {
"type": "string",
"example": "test"
},
"subscription_id": {},
"tax": {
"type": "object",
"properties": {
"amount": {},
"rate": {}
}
},
"token_id": {},
"transaction_id": {
"type": "string",
"example": "tr_NcIZWFdUQhfOQdfefQov14vN77tRa2Yn"
},
"url": {
"type": "string",
"example": "https://checkout.processout.com/test-proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r/iv_gDvoOlsMlUSlGbBf7XEaZtNhMu3qcxRB"
},
"webhook_url": {}
}
},
"invoice_id": {
"type": "string",
"example": "iv_gDvoOlsMlUSlGbBf7XEaZtNhMu3qcxRB"
},
"is_on_us": {},
"mcc": {},
"merchant_account_id": {},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"metadata": {
"type": "object",
"properties": {}
},
"name": {
"type": "string",
"example": "test"
},
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"acquirer_name": {},
"amount": {
"type": "string",
"example": "10"
},
"amount_local": {
"type": "string",
"example": "11.1"
},
"arn": {},
"authenticated_transaction_id": {},
"authorization_code": {},
"card_checks": {
"type": "object",
"properties": {
"avs_check": {
"type": "string",
"example": ""
},
"avs_name_check": {
"type": "string",
"example": ""
},
"avs_name_check_reason": {},
"avs_postal_check": {
"type": "string",
"example": ""
},
"avs_postal_check_reason": {},
"avs_street_check": {
"type": "string",
"example": ""
},
"avs_street_check_reason": {},
"cvc_check": {
"type": "string",
"example": ""
},
"cvc_check_reason": {}
}
},
"card_id": {
"type": "string",
"example": "card_2qT1ms6dp7lgkaxa4gu6u6kRWL1cEO2L"
},
"challenge_indicator": {
"type": "string",
"example": ""
},
"chargeback_reason": {},
"created_at": {
"type": "string",
"example": "2023-04-22T15:48:55.165458Z"
},
"currency": {
"type": "string",
"example": "EUR"
},
"eci": {},
"error_code": {},
"error_message": {},
"gateway_configuration_id": {
"type": "string",
"example": "gway_conf_ndv31saui5hu84u3iwantt2oc8w79x2n"
},
"gateway_data": {
"type": "object",
"properties": {
"auth_code": {
"type": "string",
"example": "060924"
},
"response_code": {
"type": "string",
"example": "20087"
},
"response_summary": {
"type": "string",
"example": "Bad Track Data"
},
"risk_flagged": {
"type": "string",
"example": "false"
}
}
},
"gateway_operation_id": {
"type": "string",
"example": ""
},
"has_failed": {
"type": "boolean",
"example": false,
"default": true
},
"id": {
"type": "string",
"example": "tr_op_sB4MK0VrvMICvImDtCClnOPJIHPYAQuX"
},
"initial_scheme_transaction_id": {
"type": "string",
"example": ""
},
"is_accountable": {
"type": "boolean",
"example": false,
"default": true
},
"is_attempt": {
"type": "boolean",
"example": false,
"default": true
},
"is_on_us": {},
"mcc": {},
"merchant_account_id": {},
"merchant_advice_code": {},
"merchant_advice_reason": {},
"metadata": {
"type": "object",
"properties": {}
},
"payment_data_network_authentication": {},
"payment_data_three_d_s_2_authentication": {},
"payment_data_three_d_s_authentication": {},
"payment_data_three_d_s_request": {},
"payment_type": {
"type": "string",
"example": "card"
},
"recommendation_code": {},
"recommendation_reason": {},
"sca_exemption_reason": {
"type": "string",
"example": ""
},
"scheme_id": {},
"token_id": {},
"transaction_id": {
"type": "string",
"example": "tr_NcIZWFdUQhfOQdfefQov14vN77tRa2Yn"
},
"type": {
"type": "string",
"example": "request"
}
}
}
},
"payment_type": {
"type": "string",
"example": "card"
},
"processout_fee": {
"type": "string",
"example": "0"
},
"project_id": {
"type": "string",
"example": "proj_jhgTvqTxNmyJVwAaKHDk3C4wqFFPah8r"
},
"received_fraud_notification": {
"type": "boolean",
"example": false,
"default": true
},
"received_retrieval_request": {
"type": "boolean",
"example": false,
"default": true
},
"recommendation_code": {},
"recommendation_reason": {},
"refunded": {
"type": "boolean",
"example": false,
"default": true
},
"refunded_amount": {
"type": "string",
"example": "0"
},
"refunded_amount_local": {
"type": "string",
"example": "0"
},
"refunded_at": {},
"refunds": {
"type": "array"
},
"routing_tags": {
"type": "array",
"items": {
"type": "string",
"example": "rule-2-route"
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"sca": {
"type": "object",
"properties": {
"challenge_result": {
"type": "string",
"example": "no-challenge-indicator-set"
},
"exemption_result": {
"type": "string",
"example": "no-exemption-reason-set"
},
"inscope_compliance": {
"type": "string",
"example": "not-applicable"
},
"out_of_scope_reason": {
"type": "string",
"example": "unknown"
},
"scope": {
"type": "string",
"example": "unknown"
}
}
},
"scheme_id": {
"type": "string",
"example": "583169616534378"
},
"status": {
"type": "string",
"example": "failed"
},
"subscription_cycle": {},
"subscription_id": {},
"three_d_s": {},
"three_d_s_status": {
"type": "string",
"example": "unchecked"
},
"three_d_s_version": {},
"token_id": {},
"voided": {
"type": "boolean",
"example": false,
"default": true
},
"voided_at": {}
}
}
}
},
"sandbox": {
"type": "boolean",
"example": true,
"default": true
},
"fired_at": {
"type": "string",
"example": "2023-04-22T15:48:57.55294073Z"
}
}
},
"success": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!\",\n \"error_type\": \"request.authentication.invalid\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "Could not read your project ID. Please make sure to use Basic HTTP authentication using your project ID as the username. If you have any questions, feel free to ask for help at help@processout.com!"
},
"error_type": {
"type": "string",
"example": "request.authentication.invalid"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\":\"resource.event.not-found\",\n \"message\":\"The event could not be found.\",\n \"success\":false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "resource.event.not-found"
},
"message": {
"type": "string",
"example": "The event could not be found."
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
},
"4XX": {
"description": "4XX",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error_type\": \"*Error code*\",\n \"message\": \"*Error message*\",\n \"success\": false\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error_type": {
"type": "string",
"example": "*Error code*"
},
"message": {
"type": "string",
"example": "*Error message*"
},
"success": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "node",
"code": "var ProcessOut = require(\"processout\");\nvar client = new ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\",\n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\");\n\nclient.newEvent().find(\"ev_T3wg9169RyGLnf1BIgTjLhrolEZU1DSb\").then(\n function(event) {\n // We may now access the event\n\n }, function(err) {\n // An error occured\n\n });",
"name": "node.js"
},
{
"language": "python",
"code": "import processout\nclient = processout.ProcessOut(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\nevent = client.new_event().find(\"ev_T3wg9169RyGLnf1BIgTjLhrolEZU1DSb\")"
},
{
"language": "ruby",
"code": "require \"processout\"\nclient = ProcessOut::Client.new(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\")\n\nevent = client.event.find(\"ev_T3wg9169RyGLnf1BIgTjLhrolEZU1DSb\")"
},
{
"language": "php",
"code": "newEvent()->find(\"ev_T3wg9169RyGLnf1BIgTjLhrolEZU1DSb\");"
},
{
"language": "go",
"code": "import \"github.com/processout/processout-go\"\n\nvar client = processout.New(\n \"test-proj_gAO1Uu0ysZJvDuUpOGPkUBeE3pGalk3x\", \n \"key_sandbox_mah31RDFqcDxmaS7MvhDbJfDJvjtsFTB\",\n)\n\nev, err := client.NewEvent().Find(\"ev_T3wg9169RyGLnf1BIgTjLhrolEZU1DSb\")"
}
],
"samples-languages": [
"node",
"python",
"ruby",
"php",
"go"
]
}
}
}
},
"components": {
"securitySchemes": {
"sec0": {
"type": "http",
"scheme": "basic"
}
},
"schemas": {}
}
}