Request Details
Method |
Controller |
Resource |
Parameters |
GET |
card |
transfer |
SendingCardNo :ReceivingCardNo :Amount :CurrencyCode :Pin :Preview |
Parameters Guide
Parameter |
Accepts |
SendingCardNo |
int Card Number as supplied from BeepXtra
|
ReceivingCardNo |
int Card Number as supplied from BeepXtra |
Amount |
double Amount to be transfered e.g. 12.50 |
CurrencyCode |
string Currency code as supplied by BeepXtra e.g. gbp, eur, php etc |
Pin |
int Sender's 4digit pin number. IF Preview is set to 1 you can use dummy pin like 1234 |
Preview |
int 1 for default, will return a preview of transfer including transfer fees and amount the recipient will get (This will not execute the transfer). 0 will process the transfer |
Example Request Format
Direct Url |
https://api.beepxtra.com/card/transfer/1:53:1.00:eur:1234:1 |
Curl |
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|card" -X POST https://api.beepxtra.com/card/transfer/1:53:1.00:eur:1234:1 |
PHP SDK |
$beepapi->request('post', 'card', 'transfer/1:53:1.00:eur:1234:1'); |
Sample Response
Success
{
success: true,
request: {
method: "GET",
controller: "card",
resource: "transfer",
parameters: "/card/transfer/1:53:1000_00:php:1234:1",
url_elements: [
"card",
"transfer",
"1:53:1000.00:php:1234:1"
]
},
error: {
errorid: 0,
message: 0
},
data: {
success: 1,
fee: "3.000000",
recipient_amount: "997.000000",
rate: [
{
id: "282",
currency: "PHP",
from_USD: "51.526499",
to_USD: "0.019407489726791"
}
],
actual_in_usd: {
fee: "0.058222",
recipient_amount: "19.349267"
},
setNotification: true,
email: "success"
}
}
Error
{
success: false,
request: {
method: "GET",
controller: "card",
resource: "transfer",
parameters: "/card/transfer/123:53:1000_00:php:1234:1",
url_elements: [
"card",
"transfer",
"123:53:1000.00:php:1234:1"
]
},
error: {
errorid: 1000,
message: "insuficient balance"
},
data: {
error: "insuficient balance"
}
}
Response Guide
Parameter |
Type |
Details |
error |
String |
Contains the error message returned |
success |
boolean |
Returns true if successful |