Card API/Card API REFERENCE/SetBearerDetail

SetBearerDetail

Set the details of the bearer that is identified by the given tracking number

Request

Path parameters

terminalID

string, 10 characters , required

The Paymentology issued terminal ID of the terminal requesting the transaction

customerReference

string, 1-255 characters, required

Customer reference linked with this card

trackingNumber

string, 1-20 characters, required

Tracking number that identifies the card to be returned

transactionID

string, 1-255 characters, required

Transaction ID number generated by the calling client

transactionDate

string, required

Transaction date generated by the calling client

prefix

string, 1-10 characters, required

The salutation for the bearer (eg Mr, Mrs, Miss)

firstName

string, 1-50 characters, required

The first name of the bearer

middleName

string, 1-50 characters

The middle name of the bearer

lastName

string, 1-50 characters, required

The last name of the bearer

idNumber

string, 1-50 characters, required

The identification number for the bearer

mobilePhoneArea

string, 1-10 characters, required

The Mobile Phone Area of the bearer

mobilePhoneNumber

string, 1-10 characters, required

The Mobile Phone Number of the bearer

countryOfCitizenship

string, required

The country of citizenship (three-letter country code defined in ISO 3166-1)

dateOfBirth

string, 1-10000000 characters, required

The date of birth (YYYY-MM-DD)

screeningRequested

integer, required

Indicator for whether screening was requested (1 if requested)

image

string, required

The KYC Image for the Bearer

streetAddress

string, 5 characters, required

The street address of the card bearer. No special characters nor alphabetic, example “17014”

postalCode

string, 9 characters, required

The postal code of the card bearer. This value is left-justified with right-space-fill, example”12345 “,”123456789”

cityAddress

string, required

City or area of the card bearer.

countryAddress

string, 3 characters, required

ISO Alpha code indicating the country. eg. GBR.

emailAddress

string, required

Email address of the card bearer.

checksum

string, 1-255 characters, required

HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key

<methodCall>
  <methodName>SetBearerDetail</methodName>
  <params>
    <param>
      <value>
        <string>terminal_equipo_id</string>
      </value>
    </param>
    <param>
      <value>
        <string>customer_ref</string>
      </value>
    </param>
    <param>
      <value>
        <string>998489300000075</string>
      </value>
    </param>
    <param>
      <value>
        <string>SBD-0000001</string>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20221130T11:03:42</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <string></string>
      </value>
    </param>
    <param>
      <value>
        <string>Fulano</string>
      </value>
    </param>
    <param>
      <value>
        <string></string>
      </value>
    </param>
    <param>
      <value>
        <string>de Tal</string>
      </value>
    </param>
    <param>
      <value>
        <string>12345678901</string>
      </value>
    </param>
    <param>
      <value>
        <string>5514</string>
      </value>
    </param>
    <param>
      <value>
        <string>981927788</string>
      </value>
    </param>
    <param>
      <value>
        <string>Brazil</string>
      </value>
    </param>
    <param>
      <value>
        <string>1985-01-27</string>
      </value>
    </param>
    <param>
      <value>
        <int>0</int>
      </value>
    </param>
    <param>
      <value>
        <string></string>
      </value>
    </param>
    <param>
      <value>
        <string>22 Walnut St #23</string>
      </value>
    </param>
    <param>
      <value>
        <string>017404074</string>
      </value>
    </param>
    <param>
      <value>
        <string>Belo Horizonte</string>
      </value>
    </param>
    <param>
      <value>
        <string>BRA</string>
      </value>
    </param>
    <param>
      <value>
        <string>anonimous@mail.com</string>
      </value>
    </param>
    <param>
      <value>
        <string>F7324F6C44762237F3221D08A8D2E86A8DEA302EFDF3D9F6EF071ECB82239B1E</string>
      </value>
    </param>
  </params>
</methodCall>

Response

STATUS200 OK

Schema

resultCode

integer

Status code indicating transaction result

resultText

string

Text indicating transaction result

<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>clientTransactionID</name>
            <value>
              <string>fb8344c9-2fc9-467b-87e4-55eaf88d06f1</string>
            </value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>1</int>
            </value>
          </member>
          <member>
            <name>terminalID</name>
            <value>
              <string>0020787431</string>
            </value>
          </member>
          <member>
            <name>customerReference</name>
            <value>
              <string>Cyp001</string>
            </value>
          </member>
          <member>
            <name>resultText</name>
            <value>
              <string>Success</string>
            </value>
          </member>
          <member>
            <name>serverTransactionID</name>
            <value>
              <string>F7055AEA-155D-00FA-4D41AC43204172A1</string>
            </value>
          </member>
          <member>
            <name>trackingNumber</name>
            <value>
              <string>412084400000001</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

BACK TO CARD API MENU

Was this page helpful?

SetBearerDetail

Request

Path parameters

Response

STATUS200 OK

Schema

Are you ready to use our APIs