Reference for https://tokenize-v1.api-eu.bambora.com/scopes/{SCOPE}/paymentcards
Url: https://tokenize-v1.api-eu.bambora.com/scopes/{SCOPE}/paymentcards
HTTP Method: POST
Message direction | Format | Body |
---|---|---|
Request | Xml | Example,Schema |
Request | Json | Example |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example request Xml body:
<tokenizepaymentcard xmlns="EPay.Webservice.Tokenize.Request"> <description>String content</description> <reference>String content</reference> <paymentcard> <cardholder xmlns="EPay.Webservice.Common.Request"> <email xmlns="EPay.Webservice.Common">String content</email> <name xmlns="EPay.Webservice.Common">String content</name> <phone xmlns="EPay.Webservice.Common">String content</phone> </cardholder> <cardnumber xmlns="EPay.Webservice.Common.Request">String content</cardnumber> <cvc xmlns="EPay.Webservice.Common.Request">String content</cvc> <expmonth xmlns="EPay.Webservice.Common.Request">String content</expmonth> <expyear xmlns="EPay.Webservice.Common.Request">String content</expyear> </paymentcard> </tokenizepaymentcard>
The following is an example request Json body:
{ "description":"String content", "reference":"String content", "paymentcard":{ "cardholder":{ "email":"String content", "name":"String content", "phone":"String content" }, "cardnumber":"String content", "cvc":"String content", "expmonth":"String content", "expyear":"String content" } }
The following is an example response Xml body:
<scopedtokenizepaymentcardresponse xmlns="EPay.Webservice.Tokenize.Response"> <meta xmlns="EPay.Webservice.Common.Response"> <action> <code>String content</code> <source>String content</source> <type>String content</type> </action> <message> <enduser>String content</enduser> <merchant>String content</merchant> </message> <paging> <itemsreturned xmlns="EPay.Webservice.Common">9223372036854775807</itemsreturned> <lastevaluatedkey xmlns="EPay.Webservice.Common">String content</lastevaluatedkey> </paging> <result>true</result> </meta> <token> <created xmlns="EPay.Webservice.Tokenize">String content</created> <deleted xmlns="EPay.Webservice.Tokenize">String content</deleted> <description xmlns="EPay.Webservice.Tokenize">String content</description> <enabled xmlns="EPay.Webservice.Tokenize">true</enabled> <expiration xmlns="EPay.Webservice.Tokenize">String content</expiration> <reference xmlns="EPay.Webservice.Tokenize">String content</reference> <tokenid xmlns="EPay.Webservice.Tokenize">String content</tokenid> <tokenscopename xmlns="EPay.Webservice.Tokenize">String content</tokenscopename> <tokentype xmlns="EPay.Webservice.Tokenize">String content</tokentype> </token> <truncatedpaymentcard> <cardholder xmlns="EPay.Webservice.Tokenize"> <email xmlns="EPay.Webservice.Common">String content</email> <name xmlns="EPay.Webservice.Common">String content</name> <phone xmlns="EPay.Webservice.Common">String content</phone> </cardholder> <cardid xmlns="EPay.Webservice.Tokenize">9223372036854775807</cardid> <expmonth xmlns="EPay.Webservice.Tokenize">2147483647</expmonth> <expyear xmlns="EPay.Webservice.Tokenize">2147483647</expyear> <truncatedcardnumber xmlns="EPay.Webservice.Tokenize">String content</truncatedcardnumber> </truncatedpaymentcard> </scopedtokenizepaymentcardresponse>
The following is an example response Json body:
{ "meta":{ "action":{ "code":"String content", "source":"String content", "type":"String content" }, "message":{ "enduser":"String content", "merchant":"String content" }, "paging":{ "itemsreturned":9223372036854775807, "lastevaluatedkey":"String content" }, "result":true }, "token":{ "created":"String content", "deleted":"String content", "description":"String content", "enabled":true, "expiration":"String content", "reference":"String content", "tokenid":"String content", "tokenscopename":"String content", "tokentype":"String content" }, "truncatedpaymentcard":{ "cardholder":{ "email":"String content", "name":"String content", "phone":"String content" }, "cardid":9223372036854775807, "expmonth":2147483647, "expyear":2147483647, "truncatedcardnumber":"String content" } }
The following is the request Xml Schema:
<xs:schema xmlns:tns="EPay.Webservice.Tokenize.Request" elementFormDefault="qualified" targetNamespace="EPay.Webservice.Tokenize.Request" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="EPay.Webservice.Common.Request" /> <xs:complexType name="tokenizepaymentcard"> <xs:complexContent mixed="false"> <xs:extension base="tns:request"> <xs:sequence> <xs:element minOccurs="0" name="paymentcard" nillable="true" xmlns:q1="EPay.Webservice.Common.Request" type="q1:paymentcard" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="tokenizepaymentcard" nillable="true" type="tns:tokenizepaymentcard" /> <xs:complexType name="request"> <xs:sequence> <xs:element minOccurs="0" name="description" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="reference" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="request" nillable="true" type="tns:request" /> </xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="EPay.Webservice.Common.Request" elementFormDefault="qualified" targetNamespace="EPay.Webservice.Common.Request" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="EPay.Webservice.Common" /> <xs:complexType name="paymentcard"> <xs:sequence> <xs:element minOccurs="0" name="cardholder" nillable="true" xmlns:q1="EPay.Webservice.Common" type="q1:cardholder" /> <xs:element minOccurs="0" name="cardnumber" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="cvc" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="expmonth" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="expyear" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="paymentcard" nillable="true" type="tns:paymentcard" /> </xs:schema>
<xs:schema xmlns:tns="EPay.Webservice.Common" elementFormDefault="qualified" targetNamespace="EPay.Webservice.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="cardholder"> <xs:sequence> <xs:element minOccurs="0" name="email" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> <xs:element minOccurs="0" name="name" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> <xs:element minOccurs="0" name="phone" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:element name="cardholder" nillable="true" type="tns:cardholder" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="EPay.Webservice.Tokenize.Response" elementFormDefault="qualified" targetNamespace="EPay.Webservice.Tokenize.Response" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="EPay.Webservice.Tokenize" /> <xs:import namespace="EPay.Webservice.Common.Response" /> <xs:complexType name="scopedtokenizepaymentcardresponse"> <xs:complexContent mixed="false"> <xs:extension xmlns:q1="EPay.Webservice.Common.Response" base="q1:response"> <xs:sequence> <xs:element minOccurs="0" name="token" nillable="true" xmlns:q2="EPay.Webservice.Tokenize" type="q2:token" /> <xs:element minOccurs="0" name="truncatedpaymentcard" nillable="true" xmlns:q3="EPay.Webservice.Tokenize" type="q3:truncatedpaymentcard" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="scopedtokenizepaymentcardresponse" nillable="true" type="tns:scopedtokenizepaymentcardresponse" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="EPay.Webservice.Common.Response" elementFormDefault="qualified" targetNamespace="EPay.Webservice.Common.Response" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="EPay.Webservice.Common" /> <xs:complexType name="response"> <xs:sequence> <xs:element minOccurs="0" name="meta" nillable="true" type="tns:meta" /> </xs:sequence> </xs:complexType> <xs:element name="response" nillable="true" type="tns:response" /> <xs:complexType name="meta"> <xs:sequence> <xs:element minOccurs="0" name="action" nillable="true" type="tns:action" /> <xs:element minOccurs="0" name="message" nillable="true" type="tns:message" /> <xs:element minOccurs="0" name="paging" nillable="true" xmlns:q1="EPay.Webservice.Common" type="q1:paging"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> <xs:element minOccurs="0" name="result" type="xs:boolean" /> </xs:sequence> </xs:complexType> <xs:element name="meta" nillable="true" type="tns:meta" /> <xs:complexType name="action"> <xs:sequence> <xs:element minOccurs="0" name="code" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="source" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="type" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="action" nillable="true" type="tns:action" /> <xs:complexType name="message"> <xs:sequence> <xs:element minOccurs="0" name="enduser" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="merchant" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="message" nillable="true" type="tns:message" /> </xs:schema>
<xs:schema xmlns:tns="EPay.Webservice.Common" elementFormDefault="qualified" targetNamespace="EPay.Webservice.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="paging"> <xs:sequence> <xs:element minOccurs="0" name="itemsreturned" type="xs:long" /> <xs:element minOccurs="0" name="lastevaluatedkey" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="paging" nillable="true" type="tns:paging" /> <xs:complexType name="cardholder"> <xs:sequence> <xs:element minOccurs="0" name="email" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> <xs:element minOccurs="0" name="name" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> <xs:element minOccurs="0" name="phone" nillable="true" type="xs:string"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:element name="cardholder" nillable="true" type="tns:cardholder" /> </xs:schema>
<xs:schema xmlns:tns="EPay.Webservice.Tokenize" elementFormDefault="qualified" targetNamespace="EPay.Webservice.Tokenize" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="EPay.Webservice.Common" /> <xs:complexType name="token"> <xs:sequence> <xs:element minOccurs="0" name="created" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="deleted" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="description" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="enabled" type="xs:boolean" /> <xs:element minOccurs="0" name="expiration" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="reference" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="tokenid" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="tokenscopename" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="tokentype" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="token" nillable="true" type="tns:token" /> <xs:complexType name="truncatedpaymentcard"> <xs:sequence> <xs:element minOccurs="0" name="cardholder" nillable="true" xmlns:q1="EPay.Webservice.Common" type="q1:cardholder" /> <xs:element minOccurs="0" name="cardid" type="xs:long" /> <xs:element minOccurs="0" name="expmonth" type="xs:int" /> <xs:element minOccurs="0" name="expyear" type="xs:int" /> <xs:element minOccurs="0" name="truncatedcardnumber" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="truncatedpaymentcard" nillable="true" type="tns:truncatedpaymentcard" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>