{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/book","auth":"required","settings":"","examples":{"codes":[]},"method":"post","params":[{"name":"leadUid","type":"string","default":"","desc":"The unique ID of the lead","required":true,"in":"body","ref":"","_id":"570c25205fac770e00b67cde"},{"name":"amount","type":"double","default":"","desc":"The amount of the transaction","required":true,"in":"body","ref":"","_id":"570c25205fac770e00b67cdd"},{"name":"card_number","type":"string","default":"","desc":"The credit card number","required":true,"in":"body","ref":"","_id":"570c25205fac770e00b67cdc"},{"name":"card_date","type":"string","default":"","desc":"The expiration date, formatted MM/YY or MM/YYYY.","required":true,"in":"body","ref":"","_id":"570c25205fac770e00b67cdb"},{"name":"card_cvv","type":"string","default":"","desc":"The cvv code of the card","required":true,"in":"body","ref":"","_id":"570c25205fac770e00b67cd9"},{"name":"card_name","type":"string","default":"","desc":"The card holder name","required":true,"in":"body","ref":"","_id":"570c25205fac770e00b67cd8"},{"name":"card_postalCode","type":"string","default":"","desc":"The postal code associated with the card","required":true,"in":"body","ref":"","_id":"570c25205fac770e00b67cd7"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"status\": \"success\",\n    \"transactionID\": \"dks69s\"\n}","name":""},{"status":400,"language":"text","code":"Orbirental API - Bad request.","name":""},{"status":409,"language":"text","code":"Orbirental API - Lead not found."}]}},"next":{"description":"","pages":[]},"title":"/book","type":"endpoint","slug":"book","excerpt":"","body":"","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3355","category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"githubsync":"","user":"56e371538b32a10e00f79750","editedParams2":true,"editedParams":true,"project":"56e3719a591f620e00bf5095","__v":1,"createdAt":"2016-04-11T22:28:48.573Z","parentDoc":null,"version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"}}

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 }}