PApaymentology
Ledger API - Cards

Link card with account or customer

<ul> <li class="docBullet">Ledger API version of the PWS <a href="https://developer.paymentology.com/bankinglive/reference/v2_pws_link_card_account">Link account card V2</a> call. Request and response use the same format, served by the Ledger API.</li> <li class="docBullet">The target account must be linked to a program.</li> </ul>
post/pty/account/v1/pws_link_card_acc

Request

  • Base URL
    https://api.uat.paymentology.com
  • URL
    https://api.uat.paymentology.com/pty/account/v1/pws_link_card_acc
  • Auth
    HTTP bearer

Request body

action0 | 1 | 2 required

Action type: 0 = Link card and account or customer 1 = Unlink card and account or customer (not yet available) 2 = Link card for replacement purpose

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

tokeninteger required

Public token for the card

user_idstring

User Id of the Customer who triggered the API request

remarksstring

Remarks for API request

old_tokeninteger

Existing public token Linking existing token with new blank token will serve as replacement. Required when action = 2

ac_idinteger

Account id Client can link account and customer id during account creation itself and pass while linking with card. Required when action = 0 Pass customer also id if an account is not linked to any customer yet

ac_ext_refstring

Account external reference Client can link ac_ext_ref/account and customer id during account creation itself and pass while linking with card. Required when action = 0 Client should use unique ac_ext_ref while linking with card Pass customer id also if an ac_ext_ref/account is not linked to any customer yet

cu_idinteger

Customer id. Pass a valid customer id, otherwise linking with the account or token is skipped. If no customer id is passed, make sure the account and customer are already linked.

inherit_rulesinteger

Inherit existing card rules. Based on value provide, it will either inherit existing rules or skip. 0 = Inherit 1 = Do not inherit Default value is 0 i.e. always inherit

Response

Request processed. Check header.error_id: 0 means success. Any other value is a business error, reported with HTTP 200 and an empty body. Common codes: 992 (invalid account id), 993 (invalid card token), 995 (validation failed), 1043 (account does not belong to the client), 1055 (invalid program_code), 1531 (invalid customer id).

Example response

{
  "header": {
    "error_desc": "success"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.