Skip to main content
POST
/
v1
/
debit
Debitar al origen.
curl --request POST \
  --url https://bank.domain.com/v1/v1/debit \
  --header 'API_KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "<string>",
  "target": "<string>",
  "symbol": "<string>",
  "amount": "<string>",
  "snapshot": {
    "source": {
      "wallet": {
        "handle": "<string>",
        "labels": {
          "type": "<string>",
          "channelSms": "<string>"
        }
      },
      "signer": {
        "handle": "<string>",
        "labels": {
          "personType": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "mobile": "<string>",
          "identification": "<string>",
          "proprietary": "<string>",
          "countryOfResidence": "<string>",
          "bankAccountNumber": "<string>",
          "bankAccountType": "<string>",
          "bankBicfi": "<string>",
          "bankName": "<string>"
        }
      }
    },
    "target": {
      "wallet": {
        "handle": "<string>",
        "labels": {
          "type": "<string>",
          "channelSms": "<string>"
        }
      },
      "signer": {
        "handle": "<string>",
        "labels": {
          "personType": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "mobile": "<string>",
          "identification": "<string>",
          "proprietary": "<string>",
          "countryOfResidence": "<string>",
          "bankAccountNumber": "<string>",
          "bankAccountType": "<string>",
          "bankBicfi": "<string>",
          "bankName": "<string>"
        }
      }
    },
    "symbol": {
      "wallet": {
        "handle": "<string>",
        "labels": {
          "type": "<string>"
        }
      },
      "signer": {
        "handle": "<string>"
      }
    }
  },
  "labels": {
    "tx_ref": "<string>",
    "tx_id": "<string>",
    "type": "<string>",
    "description": "<string>",
    "transactionPurpose": "<string>",
    "sourceCreated": "<string>",
    "targetUpdated": "<string>",
    "created": "<string>",
    "numberOfTransactions": "<string>"
  },
  "error": {
    "code": 123,
    "message": "<string>"
  },
  "action_id": "<string>"
}
'
import requests

url = "https://bank.domain.com/v1/v1/debit"

payload = {
    "source": "<string>",
    "target": "<string>",
    "symbol": "<string>",
    "amount": "<string>",
    "snapshot": {
        "source": {
            "wallet": {
                "handle": "<string>",
                "labels": {
                    "type": "<string>",
                    "channelSms": "<string>"
                }
            },
            "signer": {
                "handle": "<string>",
                "labels": {
                    "personType": "<string>",
                    "firstName": "<string>",
                    "lastName": "<string>",
                    "email": "<string>",
                    "mobile": "<string>",
                    "identification": "<string>",
                    "proprietary": "<string>",
                    "countryOfResidence": "<string>",
                    "bankAccountNumber": "<string>",
                    "bankAccountType": "<string>",
                    "bankBicfi": "<string>",
                    "bankName": "<string>"
                }
            }
        },
        "target": {
            "wallet": {
                "handle": "<string>",
                "labels": {
                    "type": "<string>",
                    "channelSms": "<string>"
                }
            },
            "signer": {
                "handle": "<string>",
                "labels": {
                    "personType": "<string>",
                    "firstName": "<string>",
                    "lastName": "<string>",
                    "email": "<string>",
                    "mobile": "<string>",
                    "identification": "<string>",
                    "proprietary": "<string>",
                    "countryOfResidence": "<string>",
                    "bankAccountNumber": "<string>",
                    "bankAccountType": "<string>",
                    "bankBicfi": "<string>",
                    "bankName": "<string>"
                }
            }
        },
        "symbol": {
            "wallet": {
                "handle": "<string>",
                "labels": { "type": "<string>" }
            },
            "signer": { "handle": "<string>" }
        }
    },
    "labels": {
        "tx_ref": "<string>",
        "tx_id": "<string>",
        "type": "<string>",
        "description": "<string>",
        "transactionPurpose": "<string>",
        "sourceCreated": "<string>",
        "targetUpdated": "<string>",
        "created": "<string>",
        "numberOfTransactions": "<string>"
    },
    "error": {
        "code": 123,
        "message": "<string>"
    },
    "action_id": "<string>"
}
headers = {
    "API_KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {API_KEY: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source: '<string>',
    target: '<string>',
    symbol: '<string>',
    amount: '<string>',
    snapshot: {
      source: {
        wallet: {handle: '<string>', labels: {type: '<string>', channelSms: '<string>'}},
        signer: {
          handle: '<string>',
          labels: {
            personType: '<string>',
            firstName: '<string>',
            lastName: '<string>',
            email: '<string>',
            mobile: '<string>',
            identification: '<string>',
            proprietary: '<string>',
            countryOfResidence: '<string>',
            bankAccountNumber: '<string>',
            bankAccountType: '<string>',
            bankBicfi: '<string>',
            bankName: '<string>'
          }
        }
      },
      target: {
        wallet: {handle: '<string>', labels: {type: '<string>', channelSms: '<string>'}},
        signer: {
          handle: '<string>',
          labels: {
            personType: '<string>',
            firstName: '<string>',
            lastName: '<string>',
            email: '<string>',
            mobile: '<string>',
            identification: '<string>',
            proprietary: '<string>',
            countryOfResidence: '<string>',
            bankAccountNumber: '<string>',
            bankAccountType: '<string>',
            bankBicfi: '<string>',
            bankName: '<string>'
          }
        }
      },
      symbol: {
        wallet: {handle: '<string>', labels: {type: '<string>'}},
        signer: {handle: '<string>'}
      }
    },
    labels: {
      tx_ref: '<string>',
      tx_id: '<string>',
      type: '<string>',
      description: '<string>',
      transactionPurpose: '<string>',
      sourceCreated: '<string>',
      targetUpdated: '<string>',
      created: '<string>',
      numberOfTransactions: '<string>'
    },
    error: {code: 123, message: '<string>'},
    action_id: '<string>'
  })
};

fetch('https://bank.domain.com/v1/v1/debit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://bank.domain.com/v1/v1/debit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source' => '<string>',
    'target' => '<string>',
    'symbol' => '<string>',
    'amount' => '<string>',
    'snapshot' => [
        'source' => [
                'wallet' => [
                                'handle' => '<string>',
                                'labels' => [
                                                                'type' => '<string>',
                                                                'channelSms' => '<string>'
                                ]
                ],
                'signer' => [
                                'handle' => '<string>',
                                'labels' => [
                                                                'personType' => '<string>',
                                                                'firstName' => '<string>',
                                                                'lastName' => '<string>',
                                                                'email' => '<string>',
                                                                'mobile' => '<string>',
                                                                'identification' => '<string>',
                                                                'proprietary' => '<string>',
                                                                'countryOfResidence' => '<string>',
                                                                'bankAccountNumber' => '<string>',
                                                                'bankAccountType' => '<string>',
                                                                'bankBicfi' => '<string>',
                                                                'bankName' => '<string>'
                                ]
                ]
        ],
        'target' => [
                'wallet' => [
                                'handle' => '<string>',
                                'labels' => [
                                                                'type' => '<string>',
                                                                'channelSms' => '<string>'
                                ]
                ],
                'signer' => [
                                'handle' => '<string>',
                                'labels' => [
                                                                'personType' => '<string>',
                                                                'firstName' => '<string>',
                                                                'lastName' => '<string>',
                                                                'email' => '<string>',
                                                                'mobile' => '<string>',
                                                                'identification' => '<string>',
                                                                'proprietary' => '<string>',
                                                                'countryOfResidence' => '<string>',
                                                                'bankAccountNumber' => '<string>',
                                                                'bankAccountType' => '<string>',
                                                                'bankBicfi' => '<string>',
                                                                'bankName' => '<string>'
                                ]
                ]
        ],
        'symbol' => [
                'wallet' => [
                                'handle' => '<string>',
                                'labels' => [
                                                                'type' => '<string>'
                                ]
                ],
                'signer' => [
                                'handle' => '<string>'
                ]
        ]
    ],
    'labels' => [
        'tx_ref' => '<string>',
        'tx_id' => '<string>',
        'type' => '<string>',
        'description' => '<string>',
        'transactionPurpose' => '<string>',
        'sourceCreated' => '<string>',
        'targetUpdated' => '<string>',
        'created' => '<string>',
        'numberOfTransactions' => '<string>'
    ],
    'error' => [
        'code' => 123,
        'message' => '<string>'
    ],
    'action_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API_KEY: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://bank.domain.com/v1/v1/debit"

	payload := strings.NewReader("{\n  \"source\": \"<string>\",\n  \"target\": \"<string>\",\n  \"symbol\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"snapshot\": {\n    \"source\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\",\n          \"channelSms\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"personType\": \"<string>\",\n          \"firstName\": \"<string>\",\n          \"lastName\": \"<string>\",\n          \"email\": \"<string>\",\n          \"mobile\": \"<string>\",\n          \"identification\": \"<string>\",\n          \"proprietary\": \"<string>\",\n          \"countryOfResidence\": \"<string>\",\n          \"bankAccountNumber\": \"<string>\",\n          \"bankAccountType\": \"<string>\",\n          \"bankBicfi\": \"<string>\",\n          \"bankName\": \"<string>\"\n        }\n      }\n    },\n    \"target\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\",\n          \"channelSms\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"personType\": \"<string>\",\n          \"firstName\": \"<string>\",\n          \"lastName\": \"<string>\",\n          \"email\": \"<string>\",\n          \"mobile\": \"<string>\",\n          \"identification\": \"<string>\",\n          \"proprietary\": \"<string>\",\n          \"countryOfResidence\": \"<string>\",\n          \"bankAccountNumber\": \"<string>\",\n          \"bankAccountType\": \"<string>\",\n          \"bankBicfi\": \"<string>\",\n          \"bankName\": \"<string>\"\n        }\n      }\n    },\n    \"symbol\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\"\n      }\n    }\n  },\n  \"labels\": {\n    \"tx_ref\": \"<string>\",\n    \"tx_id\": \"<string>\",\n    \"type\": \"<string>\",\n    \"description\": \"<string>\",\n    \"transactionPurpose\": \"<string>\",\n    \"sourceCreated\": \"<string>\",\n    \"targetUpdated\": \"<string>\",\n    \"created\": \"<string>\",\n    \"numberOfTransactions\": \"<string>\"\n  },\n  \"error\": {\n    \"code\": 123,\n    \"message\": \"<string>\"\n  },\n  \"action_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API_KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://bank.domain.com/v1/v1/debit")
  .header("API_KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": \"<string>\",\n  \"target\": \"<string>\",\n  \"symbol\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"snapshot\": {\n    \"source\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\",\n          \"channelSms\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"personType\": \"<string>\",\n          \"firstName\": \"<string>\",\n          \"lastName\": \"<string>\",\n          \"email\": \"<string>\",\n          \"mobile\": \"<string>\",\n          \"identification\": \"<string>\",\n          \"proprietary\": \"<string>\",\n          \"countryOfResidence\": \"<string>\",\n          \"bankAccountNumber\": \"<string>\",\n          \"bankAccountType\": \"<string>\",\n          \"bankBicfi\": \"<string>\",\n          \"bankName\": \"<string>\"\n        }\n      }\n    },\n    \"target\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\",\n          \"channelSms\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"personType\": \"<string>\",\n          \"firstName\": \"<string>\",\n          \"lastName\": \"<string>\",\n          \"email\": \"<string>\",\n          \"mobile\": \"<string>\",\n          \"identification\": \"<string>\",\n          \"proprietary\": \"<string>\",\n          \"countryOfResidence\": \"<string>\",\n          \"bankAccountNumber\": \"<string>\",\n          \"bankAccountType\": \"<string>\",\n          \"bankBicfi\": \"<string>\",\n          \"bankName\": \"<string>\"\n        }\n      }\n    },\n    \"symbol\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\"\n      }\n    }\n  },\n  \"labels\": {\n    \"tx_ref\": \"<string>\",\n    \"tx_id\": \"<string>\",\n    \"type\": \"<string>\",\n    \"description\": \"<string>\",\n    \"transactionPurpose\": \"<string>\",\n    \"sourceCreated\": \"<string>\",\n    \"targetUpdated\": \"<string>\",\n    \"created\": \"<string>\",\n    \"numberOfTransactions\": \"<string>\"\n  },\n  \"error\": {\n    \"code\": 123,\n    \"message\": \"<string>\"\n  },\n  \"action_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://bank.domain.com/v1/v1/debit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["API_KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source\": \"<string>\",\n  \"target\": \"<string>\",\n  \"symbol\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"snapshot\": {\n    \"source\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\",\n          \"channelSms\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"personType\": \"<string>\",\n          \"firstName\": \"<string>\",\n          \"lastName\": \"<string>\",\n          \"email\": \"<string>\",\n          \"mobile\": \"<string>\",\n          \"identification\": \"<string>\",\n          \"proprietary\": \"<string>\",\n          \"countryOfResidence\": \"<string>\",\n          \"bankAccountNumber\": \"<string>\",\n          \"bankAccountType\": \"<string>\",\n          \"bankBicfi\": \"<string>\",\n          \"bankName\": \"<string>\"\n        }\n      }\n    },\n    \"target\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\",\n          \"channelSms\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"personType\": \"<string>\",\n          \"firstName\": \"<string>\",\n          \"lastName\": \"<string>\",\n          \"email\": \"<string>\",\n          \"mobile\": \"<string>\",\n          \"identification\": \"<string>\",\n          \"proprietary\": \"<string>\",\n          \"countryOfResidence\": \"<string>\",\n          \"bankAccountNumber\": \"<string>\",\n          \"bankAccountType\": \"<string>\",\n          \"bankBicfi\": \"<string>\",\n          \"bankName\": \"<string>\"\n        }\n      }\n    },\n    \"symbol\": {\n      \"wallet\": {\n        \"handle\": \"<string>\",\n        \"labels\": {\n          \"type\": \"<string>\"\n        }\n      },\n      \"signer\": {\n        \"handle\": \"<string>\"\n      }\n    }\n  },\n  \"labels\": {\n    \"tx_ref\": \"<string>\",\n    \"tx_id\": \"<string>\",\n    \"type\": \"<string>\",\n    \"description\": \"<string>\",\n    \"transactionPurpose\": \"<string>\",\n    \"sourceCreated\": \"<string>\",\n    \"targetUpdated\": \"<string>\",\n    \"created\": \"<string>\",\n    \"numberOfTransactions\": \"<string>\"\n  },\n  \"error\": {\n    \"code\": 123,\n    \"message\": \"<string>\"\n  },\n  \"action_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "source": "<string>",
  "target": "<string>",
  "symbol": "<string>",
  "amount": "<string>",
  "labels": {
    "tx_ref": "<string>",
    "tx_id": "<string>",
    "type": "<string>",
    "description": "<string>",
    "sourceCreated": "<string>",
    "hash": "<string>"
  },
  "error": {
    "code": 123,
    "message": "<string>"
  },
  "action_id": "<string>"
}
{
  "source": "<string>",
  "target": "<string>",
  "symbol": "<string>",
  "amount": "<string>",
  "labels": {
    "tx_ref": "<string>",
    "tx_id": "<string>",
    "type": "<string>",
    "description": "<string>",
    "sourceCreated": "<string>"
  },
  "error": {
    "code": 123,
    "message": "<string>"
  },
  "action_id": "<string>"
}
{
  "error": {
    "code": 123,
    "message": "<string>"
  }
}

Authorizations

​
API_KEY
string
header
required

Body

application/json
​
source
string
​
target
string
​
symbol
string
​
amount
string
​
snapshot
object
​
labels
object
​
error
object
​
action_id
string

Response

If the debit was processed locally and action was signed

​
source
string
​
target
string
​
symbol
string
​
amount
string
​
labels
object
​
error
object
​
action_id
string