{"_id":"5de85dbbb0b885003ddf3355","category":{"_id":"5de85dbbb0b885003ddf3334","pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"5de85dbbb0b885003ddf339f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"githubsync":"","user":"56e371538b32a10e00f79750","editedParams2":true,"editedParams":true,"project":"56e3719a591f620e00bf5095","__v":1,"parentDoc":null,"version":{"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Domain","version_clean":"1.5.0","version":"1.5"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-11T22:28:48.573Z","link_external":false,"link_url":"","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":7,"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 }}