Gift Transfer Service

Endpoints

Transfer Out

POST gifttransfer/transferOut.json

Transfer some balance out of a source account identified by printed card number to some destination

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID in which to perform the operation
  • fromPrintedCardNumber (String) – (required) Primary card number of the account the transfer is coming from
  • to (Object) – (required) Account the transfer is intended for, either TransferToAccount or TransferToExternal
  • walletCode (Integer) – (required) A numeric identifier for a specific type of reward, unique for a given merchant
  • transferMessage (String) – Optional message to be included with transfer
"result": "success"

Indicates that the operation succeeded

JSON Parameters:
 
  • result (String) – (required) success
  • transferInfo (Object) – (required) See TransferInfo for format of the object
"result": "failure"

Indicates that the operation did not complete successfully, and any adjustments were rolled back as best as possible (if necessary).

JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure
  • errorMessage (String) – (required) The (human readable) error message of the failure

Get Gifting Configuration

GET gifttransfer/giftingConfig.json

Fetch a list of all rewards for this merchant, integration, and card that are available for a guest to transfer as a gift

The following authentication methods are allowed for this endpoint:

Query Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID in which to perform the operation
  • cardTemplateCode (Integer) – (required) Paytronix-assigned card template code identifying the card type of the guest
"result": "success"

Indicates that the operation succeeded

JSON Parameters:
 
  • result (String) – (required) success
  • configs (List[Object]) – (required) See GiftingConfig for format of the object
"result": "failure"

Indicates that the operation did not complete successfully, and any adjustments were rolled back as best as possible (if necessary).

JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure
  • errorMessage (String) – (required) The (human readable) error message of the failure

Accept Transfer In

POST gifttransfer/acceptTransferIn.json

Accept a pending inbound transfer.

Note

The transfer must be destined for the particular account accepting it. If the transfer was to an external target, the account must have an external account matching the target of the transfer.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID in which to perform the operation in.
  • code (String) – (required) Unique code identifying the transfer from response body of TransferInfo
  • acceptingPrintedCardNumber (String) – (required) Primary card number of the account the transfer is going to
  • message (String) – Optional message to be included with transfer
"result": "success"

Indicates that the operation succeeded

JSON Parameters:
 
  • result (String) – (required) success
  • transferInfo (Object) – (required) See TransferInfo for format of the object
"result": "failure"

Indicates that the operation did not complete successfully, and any adjustments were rolled back as best as possible (if necessary).

JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure
  • errorMessage (String) – (required) The (human readable) error message of the failure

Reject Transfer In

POST gifttransfer/rejectTransferIn.json

Reject a pending inbound transfer

Note

The transfer must be destined for the particular account accepting it. If the transfer was to an external target, the account must have an external account matching the target of the transfer.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID in which to perform the operation in
  • code (String) – (required) Unique code identifying the transfer being rejected
  • rejectingPrintedCardNumber (String) – Primary card number of the account for which the transfer is being rejected
  • message (String) – Optional message to be included with rejected transfer
"result": "success"

Indicates that the operation succeeded

JSON Parameters:
 
  • result (String) – (required) success
  • transferInfo (Object) – (required) See TransferInfo for format of the object
"result": "failure"

Indicates that the operation did not complete successfully, and any adjustments were rolled back as best as possible (if necessary).

JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure
  • errorMessage (String) – (required) The (human readable) error message of the failure

Fetch Pending Transfer

GET gifttransfer/pendingTransfer.json

Fetch information about a pending transfer

The following authentication methods are allowed for this endpoint:

Query Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID in which to perform the operation in.
  • code (String) – (required) Unique code identifying the pending transfer
"result": "success"

Indicates that the operation succeeded

JSON Parameters:
 
  • result (String) – (required) success
  • transferInfo (Object) – (required) See TransferInfo for format of the object
"result": "failure"

Indicates that the operation did not complete successfully, and any adjustments were rolled back as best as possible (if necessary).

JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure
  • errorMessage (String) – (required) The (human readable) error message of the failure

Fetch Pending Transfers To Account

GET gifttransfer/pendingTransfersToAccount.json

Enumerate any pending transfers for an account identified by printed card number that are destined for either the particular account by ID or to any of the account’s linked external accounts

The following authentication methods are allowed for this endpoint:

Query Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID in which to perform the operation in.
  • printedCardNumber (String) – (required) The card of the guest.
"result": "success"

Indicates that the operation succeeded

JSON Parameters:
 
  • result (String) – (required) success
  • transferInfo (List[Object]) – (required) List of any pending transfers for an account, see TransferInfo for format of the object
"result": "failure"

Indicates that the operation did not complete successfully, and any adjustments were rolled back as best as possible (if necessary).

JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure
  • errorMessage (String) – (required) The (human readable) error message of the failure

Fetch Transfer History For Account

GET gifttransfer/transferHistoryForAccount.json

Enumerate all transfer activity related to a particular account for viewing a history of transfers

Note

Fetches all transfers transferred out of the given account, regardless of status, plus all transfers transferred into the given account, as long as they aren’t in the pending state

The following authentication methods are allowed for this endpoint:

Query Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID in which to perform the operation in.
  • printedCardNumber (String) – (required) The card of the guest.
"result": "success"

Indicates that the operation succeeded

JSON Parameters:
 
  • result (String) – (required) success
  • transferInfo (List[Object]) – (required) List of any transfers for an account, see TransferInfo for format of the object
"result": "failure"

Indicates that the operation did not complete successfully, and any adjustments were rolled back as best as possible (if necessary).

JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure
  • errorMessage (String) – (required) The (human readable) error message of the failure

Request Objects

TransferToAccount

Information about the Paytronix account the transfer is intended for

JSON Parameters:
 
  • accountCode (Long) – (required) Unique account code of account transfer is intended for
TransferToExternal

Information about the external account the transfer is intended for

JSON Parameters:
 
  • identifier (String) – (required) String identifying the external account to transfer to, either FacebookID or email address
  • name (String) – (required) Name of the person the gift transfer is intended for

Reply Objects

TransferInfo

Information about a successful transfer transaction

JSON Parameters:
 
  • inbound (Boolean) – (required) Indicates whether the transfer is inbound (true) or outbound (false)
  • status (String) – (required) One of "PENDING", "ACCEPTED", "REJECTED", "RETURNED", or "EXPIRED"
  • fromPrintedCardNumber (String) – (required) Primary card number of the account the transfer is coming from
  • fromUserInformation (Object) – (required) Limited set of UserFields including: salutation, first name, last name
  • toPrintedCardNumber (String) – Primary card number of the account the transfer is intended for
  • toUserInformation (Object) – Limited set of UserFields
  • externalTarget (Object) – See TransferTargetExternal for format of the object
  • balance (Object) – (required) See TransferredBalance for format of the object
  • transferOutTransactionId (Long) – (required) Unique identifier of the outbound transaction
  • transferInTransactionId (Long) – Unique identifier of the inbound transaction
  • voidTransferOutTransactionId (Long) – Unique identifier of the voided outbound transaction
  • transferDatetime (DateTime) – (required) Date and time at which the transfer occurred in the format yyyy-MM-dd HH:mm:ss Z, ex: 2012-05-23 16:29:22 -0400
  • transferMessage (String) – Message associated with the transfer
  • responseDatetime (DateTime) – Date and time of the transfer response in the format yyyy-MM-dd HH:mm:ss Z, ex: 2012-05-23 16:29:22 -0400
  • responseMessage (String) – Message associated with the response message to transfer
  • transferExpirationDays (Integer) – Number of days until the transfer expires
  • externalTargetLink (String) – If transferring to an external account, the link of the target external account
GiftingConfig

Information about a gift (reward) available to transfer

JSON Parameters:
 
  • descriptiveLabel (String) – (required) The name of the reward
  • walletCode (Integer) – (required) A numeric identifier for a specific type of discount, unique for a given merchant
  • quantityRequired (Decimal) – (required) Number of rewards points required for guest to make transfer of this reward
TransferTargetExternal

Information to identify the external account a transfer is intended for

JSON Parameters:
 
  • integration (Object) – (required) See IntegrationNames for format of the object
  • identifier (String) – (required) String identifying the external account to transfer to, typically a FacebookID or email address
  • name (String) – (required) Name of the person the gift transfer is intended for
IntegrationNames

Additional Information about the integration associated with the external account a transfer is intended for

JSON Parameters:
 
  • identifier (String) – (required) Unique code identifying the integration
  • name (String) – (required) Informal name of the integration
  • reportingName (String) – (required) Reporting name of the integration
  • detail (String) – Optional detail identifying the integration
TransferredBalance

Information about the reward being transferred

JSON Parameters:
 
  • sourceWalletCode (Integer) – (required) A numeric identifier for a specific type of reward, unique for a given merchant from the account the tranfer is sent from
  • sourceWalletName (String) – (required) Informal name attributed to the sourceWalletCode
  • sourceAmount (Decimal) – (required) Amount being transferred out of source account
  • destinationWalletCode (Integer) – (required) A numeric identifier for a specific type of reward, unique for a given merchant for the account the tranfer is intended for
  • destinationWalletName (String) – (required) Informal name attributed to the destinationWalletCode
  • destinationWalletPluralName (String) – (required) Flural form of informal name attributed to the destinationWalletCode
  • destinationAmount (Decimal) – (required) Amount being transferred into destination account
  • expirationDate (Date) – Date that the transfer will expire in the format yyyy-mm-dd
  • expirationDays (Integer) – Number of days until expiration
  • destinationWalletNameTiny (String) – Tiny version of destinationWalletName
  • destinationWalletNameShort (String) – Short version of destinationWalletName
  • destinationWalletNameLong (String) – Long version of destinationWalletName