{"_id":"570c25205fac770e00b67cd6","category":{"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"56e371538b32a10e00f79750","editedParams2":true,"editedParams":true,"project":"56e3719a591f620e00bf5095","__v":1,"parentDoc":null,"version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":2,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-11T22:28:48.573Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"status\": \"success\",\n    \"transactionID\": \"dks69s\"\n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Lead not found.","language":"text","status":409}]},"auth":"required","params":[{"_id":"570c25205fac770e00b67cde","ref":"","in":"body","required":true,"desc":"The unique ID of the lead","default":"","type":"string","name":"leadUid"},{"_id":"570c25205fac770e00b67cdd","ref":"","in":"body","required":true,"desc":"The amount of the transaction","default":"","type":"double","name":"amount"},{"_id":"570c25205fac770e00b67cdc","ref":"","in":"body","required":true,"desc":"The credit card number","default":"","type":"string","name":"card_number"},{"_id":"570c25205fac770e00b67cdb","ref":"","in":"body","required":true,"desc":"The expiration date, formatted MM/YY or MM/YYYY.","default":"","type":"string","name":"card_date"},{"_id":"570c25205fac770e00b67cd9","ref":"","in":"body","required":true,"desc":"The cvv code of the card","default":"","type":"string","name":"card_cvv"},{"_id":"570c25205fac770e00b67cd8","ref":"","in":"body","required":true,"desc":"The card holder name","default":"","type":"string","name":"card_name"},{"_id":"570c25205fac770e00b67cd7","ref":"","in":"body","required":true,"desc":"The postal code associated with the card","default":"","type":"string","name":"card_postalCode"}],"url":"/book"},"isReference":false,"order":5,"body":"","excerpt":"","slug":"book","type":"endpoint","title":"/book"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

leadUid:
required
string
The unique ID of the lead
amount:
required
double
The amount of the transaction
card_number:
required
string
The credit card number
card_date:
required
string
The expiration date, formatted MM/YY or MM/YYYY.
card_cvv:
required
string
The cvv code of the card
card_name:
required
string
The card holder name
card_postalCode:
required
string
The postal code associated with the card

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}