Asynchronous API

Allied Wallet – Asynchronous

TABLE OF CONTENTS

Revision History 1
Overview 2
What are Asynchronous transactions 2
Asynchronous Payment Transaction Flow 2
Asynchronous Transactions 3
Operation End-Point 3
Parameter Description 3
Transaction Result 6
Appendix A – Transaction Status Types 6
Appendix B – Confirm URL 6
Appendix C – Payment Types 7

REVISION HISTORY

1/20/2014 1 First Version
2/3/2016 2 Update sample form action
4/18/2016 3 Updated ‘Status’ to ‘TransactionStatus’
5/27/2016 4 Add ConfirmUrl
7/18/2016 5 Update statuses
3/5/2017 6 Added Appendix C
4/4/2017 7
4/19/2017 8 Spelling corrections
4/21/2017 9 Add AccessToken field

Overview
WHAT ARE ASYNCHRONOUS TRANSACTIONS

Asynchronous transactions are required when the processor requires the customer to complete the payment using the processor hosted payment site.

The merchant initiates the transactions and the server will return a response at a later time. In some cases a response is never sent. This happens when the customer abandons the transaction after being redirected to the hosted payment site.

The Allied Wallet Asynchronous API is designed as a single point of entry for all processors that require the customer to enter payment details on the banks hosted payment site. When the transaction is initiated the merchant passes a bank identifier for the bank they want the transaction processed through.

ASYNCHRONOUS PAYMENT TRANSACTION FLOW

  1. The merchant initiates an asynchronous transaction by submitting the form, as described below, to the
  2. Allied Wallet Asynchronous API.
  3. Allied Wallet prepares the data and redirects the customer to the bank host payment site.
  4. The bank redirects back to Allied Wallet.
  5. Allied Wallet redirects the customer back to the merchants ReturnUrl with transaction results.

asynchronous api

ASYNCHRONOUS TRANSACTIONS
OPERATION END-POINT

The URL to submit asynchronous transactions is as follows:
https://api.alliedwallet.com/merchants/<merchantid>/asyncsaletransactions

PARAMETER DESCRIPTION

The following table lists the common html form elements to initiate an asynchronous transaction:

Parameter Name Description Example
accessToken The access token
Unlimited Characters, mandatory		 Bearer 123456789
Provided by Allied Wallet
siteId Site ID assigned by Allied Wallet
Integer, mandatory		 12
Provided by Allied Wallet
amount Amount of the transaction 123.45
currency Transaction currency, in ISO 4217 format.
3 character, mandatory		 USD
firstName Customer’s first name
50 character max, mandatory		 John
lastName Customer’s last name
50 character max, mandatory		 Doe
phone Customer’s phone
20 character max, mandatory		 555-555-5555
addressLine1 Billing address
100 character max, mandatory		 123 Fake St.
addressLine2 Billing address
100 character max, optional		 Suite # 789
city Billing address city
50 character max, mandatory		 Hollywood
state Billing state
50 character max, mandatory		 California
countryId Billing country
2 character, mandatory
(see Appendix D for payment type specific country codes)		 US
postalCode Billing postal code
20 character max, mandatory		 90046
email Customer’s email address
100 character max, mandatory		 <identifier>@<domain>.<extension>
iPAddress Customer’s IP Address
20 character max, mandatory		 127.0.0.1
trackingId Merchant transaction identifier
100 character max, mandatory		 123456
returnUrl The merchant Url the user should be redirected back to after transaction completion.
Unlimited Characters, Mandatory		 https://<domain>/completetransaction/process.aspx
bankIdentifier Indicates which bank should process the transaction. Ex. Paysafecard, CUP, Sofort (see Appendix D) Paysafecard
confirmUrl A POST request will be submitted to the confirmUrl. https://<domain>/completetransaction/postback.aspx

The following table lists the additional html form elements required based on the bankIdentifier:

Parameter Name Description Example
dateOfBirth Date of Birth
8 character YYYYMMDD		 19710509
nationalId Consumer’s national id
30 character max		 123456789
iban Valid IBAN
bic Valid BIC

Html Format Example:


  <html>
  <head>
  <title></title>
  </head>
  <body onload='document.forms["form"].submit()'>
  <form name="form" method="post"
  action="http://<domain>/merchants/<merchantid>/asyncsaletransactions">
  <input name="accessToken" type="hidden" value=" ">
  <input name="siteId" type="hidden" value=" ">
  <input name="amount" type="hidden" value="">
  <input name="currency" type="hidden" value=" " />
  <input name="firstName" type="hidden" value=" ">
  <input name="lastName" type="hidden" value=" " />
  <input name="phone" type="hidden" value="" />
  <input name="addressLine1" type="hidden" value="" />
  <input name="addressLine2" type="hidden" value="" />
  <input name="city" type="hidden" value="" />
  <input name="state" type="hidden" value="" />
  <input name="countryId" type="hidden" value="" />
  <input name="postalCode" type="hidden" value="" />
  <input name="email" type="hidden" value="" />
  <input name="iPAddress" type="hidden" value="" />
  <input name="trackingID" type="hidden" value="" />
  <input name="BankIdentifier" type="hidden" value="" />
  <input name="ReturnUrl" type="hidden" value="" />
  <input name="ConfirmUrl" type="hidden" value="" />
  <input type="submit" value="Request Asynchronous Sale">
  </form>
  </body>
  </html>

Example of Access Token

Bearer AAEAAJkwQEjVDJl2lkhYNEvXQdETQjdMgrDyIcqqBd3oDldfOzmy2e2aQSEPg5TxaSZYP71lCETfrwqe
Pyxvs7as3NJ97tSThC7MKCDuXWx7HuBaXoOD3zVR-TAGoEDOwKumS9mNFrDAuSCC1rZw334kDZBgQxD
DH24w5o1pMXRtMwRLyqFBK2u_HZZU_IiJFa1qBEIwCqFFs9L0yhHZ68WeVt4UuRs0gGcbdem8cJpESrqRpI
0gm6yIh84bvcmTgSWbJIfmAWq3I76_tgjSf6TcFNKikYhRMlRr1Hyagfo6P80-sqvu88OMNpeBOMPZRs61Ns
kJY4RwyNiEX87CVKR0xWykAQAAAAEAAHoSiPLdrS42zorGXK11zQWBapZjiCViwNxnTosoPTPlKnr_40oiwN
2sPwHiIGQI0Q4cP2-EVj-TjJ4SO0PmSpSR0Z1-mcvVx6QymTSO7NE1hzdWh1U2SkPPkzyfgd_kiMpYbkWipz
K0S_Cf7_auykmdydni8apIhEcmVGpltjAeNfC02-_vP2mRwy6wsYzQ2zc1DdTyYb2TMSffbrII2NYfSB4ePqM1
miVQ84vT1SBSriLpd1ykyPLjAFNnKIotaqKW4SivKimLWSZIcG4m6vF-9HQd7s_3HeOCc--mWl0YQ4wGAfVD
UeJ0Go4FZC53PFbpRzoSFMZcWZ_ge_z_jQcXd3-5pwROBVXbaYoC5tImWTVitftqHfWVQbrvL3FW8Zwat2
q8R2yP60_hFdAAtJCQZIttD3iuFVvCAQnTt32sNKBtqNDx6p6AoItjapeIkPwWFQmISaG3u59gyB5uNx9cysu
azbFyvElvs2JJyA2W57lD40ARQtRkj2nSqgyhHMNIZfd1IRFf2LEuOMDy_Kwwz3IbCtezJWOCmb7CWKHk

TRANSACTION RESULT

After processing the information, we will redirect the customer back to the merchant website using the parameter
returnUrl. At the same time, we send the same transaction result via server-to-server communication.

The table below explains the parameters that are delivered by HTTP POST request:

Parameter Name Description Example
transactionId The tracking id submitted in the initial request.
Optional.		 123456
transactionstatus The status of the transaction. Ex.
Success, Decline, Error		 Success
amount The amount of the transaction
Optional.		 123.45
message Additional details about the transaction status Success

It is possible that an error status could not recover and/or create the transactionId, trackingId, or amount. In this case the values will empty or 0.

APPENDIX A – TRANSACTION STATUS TYPES

Pending The transaction has been processed by the bank, however a final status has not been received. In most cases a pending transaction will change to success or declined within a couple minutes.
Successful The transaction has completed successfully.
Declined The transaction has been declined
Error There was an error during the transaction process
Scrubbed The transaction was scrubbed.
Fraud The transaction was marked as fraud.
Abort The transaction has been aborted by the user.

APPENDIX B – CONFIRM URL

Parameter Name Description Example
TrackingId The tracking Id submitted in the initial request.
100 character max		 123456
Amount The amount of the transaction
Decimal		 123.45
TransactionId The transaction identifier
64-bit Integer		 42895
TransactionState The state of the transaction
20 character max		 Sale
TransactionStatus The status of the transaction.

(If a transaction status could not be assigned, this parameter will not be sent in the server-to-server post)
20 character max
ShippingFirstName Shipping First Name
50 character max		 Jane
ShippingLastName Shipping Last Name
50 character max		 Smith
ShippingAddress1 Shipping Address Line 1
100 character max		 123 XYZ Street
ShippingAddress2 Shipping Address Line 2
100 character max		 #7777
ShippingCity Shipping City
50 character max		 Miami
ShippingState Shipping State
50 character max		 FL
ShippingCountry Shipping Country
2 character max		 US
ShippingPostalCode Shipping Postal Code
20 character max		 55555
CustomerEmail Customer Email
100 character max		 <identifier>@<domain>.<extension>
CustomerFirstName Customer First Name
50 character max		 John
CustomerLastName Customer Last Name
50 character max		 Doe
CustomerAddress1 Customer Address Line 1
100 character max		 123 Fake St.
CustomerAddress2 Customer Address Line 2
100 character max		 Suite # 789
CustomerCity Customer City
50 character max		 Hollywood
CustomerState Customer State
50 character max		 CA
CustomerCountry Customer Country
2 character max		 US
CustomerPostalCode Customer Postal Code
20 character max		 90046
CustomerPhone Customer Phone
20 character max		 555-555-5555
SiteId Site ID assigned by Allied Wallet
Integer		 12

APPENDIX C – PAYMENT TYPES

Alipay

Bank Identifier: Alipay
Additional Fields: None
Country Codes: CN
Currencies: EUR

AstroPay Card

Bank Identifier: AstroPay Card
Additional Fields: None
Country Codes: AR, BO, BR, CL, CN, CO, CR, MX, PE, TR, UY, VE
Currencies: USD

AstroPay Direct

Bank Identifier: AstroPay Direct
Additional Fields:
Country Codes: AR, BR, CL, CN, CO, MX, PE, TY, UY
Currencies: USD

BBVA (Chile)

Bank Identifier: BBVA Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

BBVA (Columbia)

Bank Identifier: BBVA Columbia
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

BCI (Chile)

Bank Identifier: BCI Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Banamex (Mexico)

Bank Identifier: Banamex
Additional Fields: nationalId, dateOfBirth
Country Codes: MX
Currencies: USD

Banca Caja Social (Columbia)

Bank Identifier: Banca Caja Social CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Banco AV Villas (Columbia)

Bank Identifier: Banco AV Villas CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Banco Falabella (Colombia)

Bank Identifier: Banco Falabella CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Banco GNB Sudameris (Columbia)

Bank Identifier: Banco GNB Sud. CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Banco International (Chile)

Bank Identifier: Banco Intl Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Banco Popular (Colombia)

Bank Identifier: Banco Popular CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Banco Security (Chile)

Bank Identifier: Banco Security Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Banco de Bogotá (Colombia)

Bank Identifier: Banco de Bogota CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Banco de Chile (Chile)

Bank Identifier: Banco de Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Banco de Occidente Credencia (Colombia)

Bank Identifier: Banco de Occ Cre CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Banco do Brasil (Brazil)

Bank Identifier: Banco do Brasil
Additional Fields: nationalId, dateOfBirth
Country Codes: BR
Currencies: USD

BancoBice (Chile)

Bank Identifier: BancoBice Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

BancoEstado (Chile)

Bank Identifier: BancoEstado Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Bancolombia (Colombia)

Bank Identifier: Bancolombia CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Bancoomeva (Colombia)

Bank Identifier: Bancoomeva CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Boleto Bancario

Bank Identifier: Boleto Bancario
Additional Fields: nationalId, dateOfBirth
Country Codes: BR
Currencies: USD

China Union Pay

Bank Identifier: CUP
Additional Fields: None
Country Codes:
Currencies: CNY, RMB

Citi (Colombia)

Bank Identifier: Citi Columbia
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Colmena (Columbia)

Bank Identifier: Colmena Columbia
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Colpatria (Colombia)

Bank Identifier: Colpatria CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Corpbanca (Chile)

Bank Identifier: Corpbanca Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Davivienda (Colombia)

Bank Identifier: Davivienda Columbia
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Dinero Mail Efectivo

Bank Identifier: Dinero Mail Efectivo
Additional Fields: nationalId, dateOfBirth
Country Codes: AR
Currencies: USD

Dinero Mail Transfer

Bank Identifier: Dinero Mail Transfer
Additional Fields: nationalId, dateOfBirth
Country Codes: AR
Currencies: USD

EPS

Bank Identifier: EPS
Additional Fields: None
Country Codes: AT
Currencies: EUR

Efecty (Colombia)

Bank Identifier: Efecty Columbia
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

HSBC (Colombia)

Bank Identifier: HSBC Columbia
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Helm (Colombia)

Bank Identifier: Helm Columbia
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

IDEAL

Bank Identifier: Ideal
Additional Fields: None
Country Codes: NL
Currencies: EUR

Itaú (Chile)

Bank Identifier: Itau Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Bancontact/MisterCash

Bank Identifier: MisterCash
Additional Fields: None
Country Codes: BE
Currencies: EUR

OXXO

Bank Identifier: OXXO
Additional Fields: nationalId, dateOfBirth
Country Codes: MX
Currencies: USD

Pago Facil

Bank Identifier: Pago Facil
Additional Fields: nationalId, dateOfBirth
Country Codes: AR
Currencies: USD

paysafecard

Bank Identifier: Paysafecard
Additional Fields: None
Country Codes:
Currencies:

POLi

Bank Identifier: Poli
Additional Fields: None
Country Codes: NZ, AU
Currencies: NZD, AUD

Przelewy24

Bank Identifier: Przelewy24
Additional Fields: None
Country Codes: PL
Currencies: PLN, EUR

Rapi Pago (Argentina)

Bank Identifier: Rapi Pago
Additional Fields: nationalId, dateOfBirth
Country Codes: AR
Currencies: USD

Redpagos (Uruguay)

Bank Identifier: Redpagos
Additional Fields: nationalId, dateOfBirth
Country Codes: UR
Currencies: USD

SEPA DirectDebit

Bank Identifier: SEPA DirectDebit
Additional Fields: iban, bic
Country Codes: All SEPA Countries
Currencies: EUR

SafetyPay

Bank Identifier: SafetyPay
Additional Fields: None
Country Codes: AT, BR, CO, CR, DE, ES, GT, MX, NI, NL, PA, PE
Currencies: EUR, USD

Santander (Chile)

Bank Identifier: Santander Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Santander (Colombia)

Bank Identifier: Santander Columbia
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Santander (Mexico)

Bank Identifier: Santander Mexico
Additional Fields: nationalId, dateOfBirth
Country Codes: MX
Currencies: USD

Scotiabank (Colombia)

Bank Identifier: Scotiabank CO
Additional Fields: nationalId, dateOfBirth
Country Codes: CO
Currencies: USD

Scotiabank (Chile)

Bank Identifier: Scotiabank Chile
Additional Fields: nationalId, dateOfBirth
Country Codes: CL
Currencies: USD

Sofort Banking

Bank Identifier: Sofort
Additional Fields: None
Country Codes: AT, BE, FR, DE, GB, IT, NL, PL, ES, CH
Currencies: EUR

Teleingreso

Bank Identifier: Teleingreso
Additional Fields: None
Country Codes: AT, BE, FR, DE, GB, IT, NL, PL, ES, CH
Currencies: EUR

You might also like: