--- updatedAt: 2026-04-27T16:35:50.000Z agentTools: projectIndex: https://docs.aerocrs.com/llms.txt --- # useDeposit This method will allow to pay (full or partial amount) with customers deposit via API. > 📘 Important > > After full payment, no need to use TicketBooking. ## Request parameters | Parameter | Type | Description | | :--------- | :----- | :------------------------------------------------------------------ | | bookingid | Number | Booking ID (from createBooking) | | customerid | Number | Customer ID (from getCustomerDataNew) - For direct customer booking | | agentid | Number | Agent ID - For agent booking | | currency | String | Deposit Currency code | | amount | Number | Amount of the deposit to use; positive values only | > ❗️ - Mandatory parameters ## Response This method will respond with a list of customers, including personal details and additional information. | Parameter | Type | Description | | :------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------- | | success | String | true/false | | custid | Number | Customer ID | | email | E-mail | Customer E-mail | | name | String | First and last name of the customer | | phone | Number | Phone number of the customer | | passport | Number | Customer passport number | | ffnumber | Number | Customer frequent flyer number | | fflevel | String | Customer frequent flyer level name | | | | | | ffcategory | Element | Customer frequent flyer category Points | | status | Number | Amount of Status Points | | bonus | Number | Amount of Bonus Points | | award | Number | Amount of Award Points | | dob | Date | YYYY/MM/DD date of customer birth date | | city | String | City of the customer | | zipcode | Number | Customer zip code | | company | String | Company of the customer (if applicable) | | vatNumber | Number | VAT of the customer (if applicable) | | | | | | totalDeposit | Element | Customer Total Deposit details per Currency | | rtname | String | Deposit Currency 3 letters code | | rtsymbol | String | Deposit Currency symbol | | rtdecimals | Number | Deposit Currency decimals | | rtconvert | Number | Deposit Currency Conversion Rate | | rtid | Number | Deposit Currency ID | | dpcurrencyamount | Number | Total amount of Deposit with the mentioned currency | | depositTransactionsHistory | Element | Customer Deposit Transactions History | | dpamount | Number | Deposit Amount: in case of payment, display negative amount. In case of adding Amount, display positive Amount. | | rtname | String | Deposit Currency name | | pnrref | Number | PNR number of the adding or using refund | | pnrcreateddate | Date | PNR creation date | | | | | | trips | Element | The list Customer PNRs | | pnrref | Number | Customer PNR number | | status | String | Confirmed/Pending/Cancelled | | createddate | Date | PNR creation date | | dstfromname | String | From destination name | | dstfromcode | String | From destination code | | dsttoname | String | To destination name | | dsttocode | String | To destination code | | departuredate | Date | Departure date | | arrivaldate | Date | Arrival date |
| Optional error messages: | | :------------------------------------------------------------------------------------------------------------------------------------------------ | | No `{field name}` defined on segment `{i}` | | mandatory fields misssing: `{fields name}` | | Your booking ID does not match the records | | You do not have permission to do this action | | Currency doesn’t match the records. please check currency already set in CRS system | | There are no funds on this currency, please pay using a currency which have available deposit. | | The received amount is larger than the PNR current balance. You have `{amount}` left to pay | | There are not enough funds on this currency, please pay using a currency which have available deposit, or pay by parts. You have `{amount}` left. | | The amount parameter must be greater than zero | | PNR is not valid for this operation, please check your PNR | | Multiple pending PNRs found, please contact support | | Unexpected error, please try again later | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "aerocrs-v5", "version": "5.0" }, "servers": [ { "url": "https://api.aerocrs.com/v5" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "auth_id" }, "sec1": { "type": "apiKey", "in": "header", "name": "auth_password" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/useDeposit": { "post": { "summary": "useDeposit", "description": "This method will allow to pay (full or partial amount) with customers deposit via API.", "operationId": "usedeposit", "parameters": [ { "name": "auth_id", "in": "header", "description": "ID provided to you by AeroCRS", "required": true, "schema": { "type": "string" } }, { "name": "auth_password", "in": "header", "description": "Password provided to you by AeroCRS", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "RAW_BODY" ], "properties": { "RAW_BODY": { "type": "string", "description": "The method accepts the XML / JSON input as POST, response format will be according to the sent format. You can try JSON, put the post in the following input and click \"Try It\"", "format": "json" } } }, "examples": { "Request Example": { "value": { "aerocrs": { "parms": { "bookingid": 49472444, "customerid": 3398419, "currency": "EUR", "amount": 50 } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "JSON": { "value": "{\n \"aerocrs\": {\n \"success\": true,\n \"custid\": 2197854,\n \"email\": \"ds.live.user@test.test\",\n \"name\": \"Santoss Burnette\",\n \"phone\": \"255745575244\",\n \"passport\": \"123456997\",\n \"ffnumber\": \"\",\n \"fflevel\": \"\",\n \"ffcategory\": {\n \"status\": \".0000\",\n \"bonus\": \".0000\",\n \"award\": \".0000\"\n },\n \"dob\": \"1984/12/08\",\n \"city\": \"dsfs\",\n \"zipcode\": \"3244324\",\n \"company\": \"rima\",\n \"vatNumber\": \"12345\",\n \"totalDeposit\": [\n {\n \"rtname\": \"USD\",\n \"rtsymbol\": \"$\",\n \"rtdecimals\": 2,\n \"rtconvert\": \"1.0000\",\n \"rtid\": 1,\n \"dpcurrencyamount\": \"9675.15\"\n },\n {\n \"rtname\": \"ZAR\",\n \"rtsymbol\": null,\n \"rtdecimals\": 2,\n \"rtconvert\": \"9.0000\",\n \"rtid\": 625,\n \"dpcurrencyamount\": \"1395.82\"\n }\n ],\n \"depositTransactionsHistory\": [\n {\n \"dpamount\": \"-112.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"28800024\",\n \"pnrcreateddate\": \"2024-07-11 09:10:36\"\n },\n {\n \"dpamount\": \"-53.5000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2889EF3F\",\n \"pnrcreateddate\": \"2024-07-11 06:26:00\"\n },\n {\n \"dpamount\": \"-122.1000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"28800021\",\n \"pnrcreateddate\": \"2024-07-11 06:25:21\"\n },\n {\n \"dpamount\": \"-53.5000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"28829E0C\",\n \"pnrcreateddate\": \"2024-06-26 12:42:37\"\n },\n {\n \"dpamount\": \"10000.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"\",\n \"pnrcreateddate\": \"\"\n },\n {\n \"dpamount\": \"147.6000\",\n \"rtname\": \"ZAR\",\n \"pnrref\": \"2886126E\",\n \"pnrcreateddate\": \"2024-04-11 05:25:19\"\n },\n {\n \"dpamount\": \"-208.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2885EDB8\",\n \"pnrcreateddate\": \"2024-04-10 14:38:28\"\n },\n {\n \"dpamount\": \"32.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2885ED35\",\n \"pnrcreateddate\": \"2024-04-10 14:29:58\"\n },\n {\n \"dpamount\": \"-1872.0000\",\n \"rtname\": \"ZAR\",\n \"pnrref\": \"2885ED35\",\n \"pnrcreateddate\": \"2024-04-10 14:29:58\"\n },\n {\n \"dpamount\": \"-288.0000\",\n \"rtname\": \"ZAR\",\n \"pnrref\": \"2885EC32\",\n \"pnrcreateddate\": \"2024-04-10 14:16:12\"\n },\n {\n \"dpamount\": \"32.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2885EC32\",\n \"pnrcreateddate\": \"2024-04-10 14:16:12\"\n },\n {\n \"dpamount\": \"-1872.0000\",\n \"rtname\": \"ZAR\",\n \"pnrref\": \"2885EC32\",\n \"pnrcreateddate\": \"2024-04-10 14:16:12\"\n },\n {\n \"dpamount\": \"16.4000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2885E19D\",\n \"pnrcreateddate\": \"2024-04-10 12:23:39\"\n },\n {\n \"dpamount\": \"-208.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2885E19D\",\n \"pnrcreateddate\": \"2024-04-10 12:23:39\"\n },\n {\n \"dpamount\": \"-30.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288AD442\",\n \"pnrcreateddate\": \"2023-11-08 14:30:48\"\n },\n {\n \"dpamount\": \"-278.3000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288AD403\",\n \"pnrcreateddate\": \"2023-11-08 14:28:45\"\n },\n {\n \"dpamount\": \"-308.3000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288AD3B9\",\n \"pnrcreateddate\": \"2023-11-08 14:25:53\"\n },\n {\n \"dpamount\": \"-81.2000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2888C4B8\",\n \"pnrcreateddate\": \"2023-11-01 09:42:03\"\n },\n {\n \"dpamount\": \"-1237.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2888C3EF\",\n \"pnrcreateddate\": \"2023-11-01 09:33:21\"\n },\n {\n \"dpamount\": \"247.5000\",\n \"rtname\": \"ZAR\",\n \"pnrref\": \"2883922C\",\n \"pnrcreateddate\": \"2023-10-12 16:59:59\"\n },\n {\n \"dpamount\": \"-94.1000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2882671C\",\n \"pnrcreateddate\": \"2023-10-09 12:14:55\"\n },\n {\n \"dpamount\": \"-30.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288266D9\",\n \"pnrcreateddate\": \"2023-10-09 12:13:00\"\n },\n {\n \"dpamount\": \"-83.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288814C7\",\n \"pnrcreateddate\": \"2023-09-03 12:15:28\"\n },\n {\n \"dpamount\": \"-10.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288814D2\",\n \"pnrcreateddate\": \"2023-09-03 12:16:21\"\n },\n {\n \"dpamount\": \"-112.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288814C7\",\n \"pnrcreateddate\": \"2023-09-03 12:15:28\"\n },\n {\n \"dpamount\": \"-78.5000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"28880BAF\",\n \"pnrcreateddate\": \"2023-09-03 09:00:37\"\n },\n {\n \"dpamount\": \"53.5000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"28880BC5\",\n \"pnrcreateddate\": \"2023-09-03 09:02:15\"\n },\n {\n \"dpamount\": \"53.5000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"28880BAF\",\n \"pnrcreateddate\": \"2023-09-03 09:00:37\"\n },\n {\n \"dpamount\": \"-53.5000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"28880BC5\",\n \"pnrcreateddate\": \"2023-09-03 09:02:15\"\n },\n {\n \"dpamount\": \"-30.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"28880BAF\",\n \"pnrcreateddate\": \"2023-09-03 09:00:37\"\n },\n {\n \"dpamount\": \"-53.5000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2886AF33\",\n \"pnrcreateddate\": \"2023-08-29 06:31:01\"\n },\n {\n \"dpamount\": \"-30.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"2886AF1C\",\n \"pnrcreateddate\": \"2023-08-29 06:30:00\"\n },\n {\n \"dpamount\": \"-10.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288662E3\",\n \"pnrcreateddate\": \"2023-08-28 06:40:01\"\n },\n {\n \"dpamount\": \"-55.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288E5E62\",\n \"pnrcreateddate\": \"2023-07-30 09:14:32\"\n },\n {\n \"dpamount\": \"-121.0000\",\n \"rtname\": \"USD\",\n \"pnrref\": \"288E5E62\",\n \"pnrcreateddate\": \"2023-07-30 09:14:32\"\n }\n ],\n \"trips\": [\n {\n \"pnrref\": \"2886126E\",\n \"status\": \"Confirmed\",\n \"createddate\": \"11 Apr 2024\",\n \"dstfromname\": \"Zurich\",\n \"dstfromcode\": \"ZRH\",\n \"dsttoname\": \"Tel Aviv\",\n \"dsttocode\": \"TLV\",\n \"departuredate\": \"02 May 2024\",\n \"arrivaldate\": \"02 May 2024\"\n },\n {\n \"pnrref\": \"2885EDB8\",\n \"status\": \"Confirmed\",\n \"createddate\": \"10 Apr 2024\",\n \"dstfromname\": \"Zurich\",\n \"dstfromcode\": \"ZRH\",\n \"dsttoname\": \"Tel Aviv\",\n \"dsttocode\": \"TLV\",\n \"departuredate\": \"28 Apr 2024\",\n \"arrivaldate\": \"28 Apr 2024\"\n },\n {\n \"pnrref\": \"2885EC32\",\n \"status\": \"Confirmed\",\n \"createddate\": \"10 Apr 2024\",\n \"dstfromname\": \"Zurich\",\n \"dstfromcode\": \"ZRH\",\n \"dsttoname\": \"Tel Aviv\",\n \"dsttocode\": \"TLV\",\n \"departuredate\": \"27 Apr 2024\",\n \"arrivaldate\": \"27 Apr 2024\"\n },\n {\n \"pnrref\": \"2885E19D\",\n \"status\": \"Confirmed\",\n \"createddate\": \"10 Apr 2024\",\n \"dstfromname\": \"Zurich\",\n \"dstfromcode\": \"ZRH\",\n \"dsttoname\": \"Tel Aviv\",\n \"dsttocode\": \"TLV\",\n \"departuredate\": \"26 Apr 2024\",\n \"arrivaldate\": \"26 Apr 2024\"\n },\n {\n \"pnrref\": \"2885ED35\",\n \"status\": \"Confirmed\",\n \"createddate\": \"10 Apr 2024\",\n \"dstfromname\": \"Zurich\",\n \"dstfromcode\": \"ZRH\",\n \"dsttoname\": \"Tel Aviv\",\n \"dsttocode\": \"TLV\",\n \"departuredate\": \"25 Apr 2024\",\n \"arrivaldate\": \"25 Apr 2024\"\n },\n {\n \"pnrref\": \"28829CAE\",\n \"status\": \"Confirmed\",\n \"createddate\": \"26 Jun 2024\",\n \"dstfromname\": \"Tel Aviv\",\n \"dstfromcode\": \"TLV\",\n \"dsttoname\": \"Zurich\",\n \"dsttocode\": \"ZRH\",\n \"departuredate\": \"16 Jul 2024\",\n \"arrivaldate\": \"16 Jul 2024\"\n },\n {\n \"pnrref\": \"28829CAE\",\n \"status\": \"Confirmed\",\n \"createddate\": \"26 Jun 2024\",\n \"dstfromname\": \"Zurich\",\n \"dstfromcode\": \"ZRH\",\n \"dsttoname\": \"Tel Aviv\",\n \"dsttocode\": \"TLV\",\n \"departuredate\": \"23 Jul 2024\",\n \"arrivaldate\": \"23 Jul 2024\"\n },\n {\n \"pnrref\": \"28800021\",\n \"status\": \"Confirmed\",\n \"createddate\": \"11 Jul 2024\",\n \"dstfromname\": \"Zurich\",\n \"dstfromcode\": \"ZRH\",\n \"dsttoname\": \"Tel Aviv\",\n \"dsttocode\": \"TLV\",\n \"departuredate\": \"19 Aug 2024\",\n \"arrivaldate\": \"19 Aug 2024\"\n },\n {\n \"pnrref\": \"28800024\",\n \"status\": \"Confirmed\",\n \"createddate\": \"11 Jul 2024\",\n \"dstfromname\": \"Zurich\",\n \"dstfromcode\": \"ZRH\",\n \"dsttoname\": \"Tel Aviv\",\n \"dsttocode\": \"TLV\",\n \"departuredate\": \"20 Aug 2024\",\n \"arrivaldate\": \"20 Aug 2024\"\n }\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "aerocrs": { "type": "object", "properties": { "success": { "type": "boolean", "example": true, "default": true }, "custid": { "type": "integer", "example": 2197854, "default": 0 }, "email": { "type": "string", "example": "ds.live.user@test.test" }, "name": { "type": "string", "example": "Santoss Burnette" }, "phone": { "type": "string", "example": "255745575244" }, "passport": { "type": "string", "example": "123456997" }, "ffnumber": { "type": "string", "example": "" }, "fflevel": { "type": "string", "example": "" }, "ffcategory": { "type": "object", "properties": { "status": { "type": "string", "example": ".0000" }, "bonus": { "type": "string", "example": ".0000" }, "award": { "type": "string", "example": ".0000" } } }, "dob": { "type": "string", "example": "1984/12/08" }, "city": { "type": "string", "example": "dsfs" }, "zipcode": { "type": "string", "example": "3244324" }, "company": { "type": "string", "example": "rima" }, "vatNumber": { "type": "string", "example": "12345" }, "totalDeposit": { "type": "array", "items": { "type": "object", "properties": { "rtname": { "type": "string", "example": "USD" }, "rtsymbol": { "type": "string", "example": "$" }, "rtdecimals": { "type": "integer", "example": 2, "default": 0 }, "rtconvert": { "type": "string", "example": "1.0000" }, "rtid": { "type": "integer", "example": 1, "default": 0 }, "dpcurrencyamount": { "type": "string", "example": "9675.15" } } } }, "depositTransactionsHistory": { "type": "array", "items": { "type": "object", "properties": { "dpamount": { "type": "string", "example": "-112.0000" }, "rtname": { "type": "string", "example": "USD" }, "pnrref": { "type": "string", "example": "28800024" }, "pnrcreateddate": { "type": "string", "example": "2024-07-11 09:10:36" } } } }, "trips": { "type": "array", "items": { "type": "object", "properties": { "pnrref": { "type": "string", "example": "2886126E" }, "status": { "type": "string", "example": "Confirmed" }, "createddate": { "type": "string", "example": "11 Apr 2024" }, "dstfromname": { "type": "string", "example": "Zurich" }, "dstfromcode": { "type": "string", "example": "ZRH" }, "dsttoname": { "type": "string", "example": "Tel Aviv" }, "dsttocode": { "type": "string", "example": "TLV" }, "departuredate": { "type": "string", "example": "02 May 2024" }, "arrivaldate": { "type": "string", "example": "02 May 2024" } } } } } } } } } } } }, "deprecated": false, "security": [] } } }, "x-readme": { "headers": [], "explorer-enabled": false, "proxy-enabled": true }, "x-readme-fauxas": true } ```