NAV Navbar
json

Introduction

  _____                   _
 |  __ \            /\   | |
 | |__) | __ ___   /  \  | |__   ___  _ __   ___
 |  ___/ '__/ _ \ / /\ \ | '_ \ / _ \| '_ \ / _ \
 | |   | | | (_) / ____ \| |_) | (_) | | | | (_) |
 |_|   |_|  \___/_/    \_\_.__/ \___/|_| |_|\___/

Welcome to the documentation of the ProAbono API Backoffice - Special Payment Gateways.

This documentation extends the documentation of ProAbono API Backoffice.

This API Documentation is dedicated to developers who need to manage at least one these following subjects :

Card Dummy

CardDummy Account Specifics

Example Request : Create/Declare a CardDummy Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "CardDummy",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false  
}

There is no extra data needed for a "CardDummy" payment gateway account.

See GatewayAccount Resource

CardDummy Permission Specifics

Example Request : Create/Declare a CardDummy Card Permission 
POST https://via.proabono.com/Gateway/GatewayPermissions
{
    "IdBusiness": 2,
    "IdCustomer": 123456,
    "IdAccount": 27,
    "TypeGateway": "CardDummy",
    "TypePayment": "Card",
    "Country": "FR",
    "DateExpiration": "2028-10-01T00:00:00.00Z",
    "MaskNumber": "xxxx-xxxx-xxxx-1234",
    "TypeCard": "Dummy",
    "CardDummy" : { 
        StatusNextRequest : "Success"
    }      
}

A CardDummy defines all parameters of a valid card permission for the Dummy Payment Gateway.

Parameter Required? Description Type
StatusNextRequest Yes Status of the Next Request. Use "Success". String

See GatewayPermission Resource

CardDummy Request Specifics

See GatewayRequest Resource

CardDummy Transaction Specifics

See GatewayTransaction Resource

DirectDebit Dummy

DirectDebit Account Specifics

Example Request : Create/Declare a DirectDebitDummy Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "DirectDebitDummy",
    "Currency": "GBP",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false  
}

There is no extra data needed for a "DirectDebitDummy" payment gateway account.

See GatewayAccount Resource

DirectDebit Permission Specifics

See GatewayPermission Resource

DirectDebit Request Specifics

See GatewayRequest Resource

DirectDebit Transaction Specifics

See GatewayTransaction Resource

DirectDebit Dummy (Sepa)

DummySepa Account Specifics

Example Request : Create/Declare a DirectDebitDummySepa Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "DirectDebitDummySepa",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false  
}

There is no extra data needed for a "DirectDebitDummySepa" payment gateway account.

See GatewayAccount Resource

DummySepa Permission Specifics

See GatewayPermission Resource

DummySepa Request Specifics

See GatewayRequest Resource

DummySepa Transaction Specifics

See GatewayTransaction Resource

GoCardless (Sepa)

GoCardless Sepa Account Specifics

Example Request : Create/Declare a GoCardless Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "DirectDebitGoCardlessSepa",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false,
    "DirectDebitGoCardlessSepa": {
        "AccessToken": "9vI9h9638JpaXK66HWI7MJjUdj5GA4R1",
        "PublishableAccessToken": "36QguEg3DCZBbQ37QdmJzKmPH3bhq96K",
        "CreditorKey": "GB12ABDC12345678901234",
        "CreditorName": "MyCompany .Inc",
        "CreditorAddress": "40 Dover Road, WEST WILLIAMSTON, SA68 1GS",
        "Reference": "MyCompany"
    }   
}
Notice: The values in the sample above are fake. Get the real values from your GoCardless account.
Parameter Required? Description Type
AccessToken Yes Access Token of the GoCardless account String
PublishableAccessToken Yes Publishable Access Token of the GoCardless account String
CreditorKey Yes The Creditor Key String
CreditorName Yes Name of the Creditor String
CreditorAddress Yes Address of the Creditor String
Reference Yes Reference displayed in the bank statement of the Customers String

Each payment taken through the API is linked to a "Creditor", to whom the payment is then paid out. In most cases your organisation will have a single "creditor".

See GatewayAccount Resource

GoCardless Sepa Permission Specifics

Example Request : Create/Declare a GoCardless Mandate Permission 
POST https://via.proabono.com/Gateway/GatewayPermissions
{
    "IdBusiness": 2,
    "IdCustomer": 65487,
    "IdAccount": 197, 
    "TypeGateway": "DirectDebitGoCardlessSepa",
    "TypePayment": "DirectDebit",
    "MaskIban": "************************",
    "Country": "FR", 
    "DirectDebitGoCardlessSepa": {
        "KeyCustomer": "CU0000C9DVFF12",
        "KeyBankAccount": "BA0000A8NH4FK9",
        "KeyMandate": "MD0000AFR6YAN4"
    }
}
Notice: The values in the sample above are fake. Get the real values from your GoCardless account.

A DirectDebitGoCardlessSepa defines all parameters of a valid mandate permission for the GoCardless Payment Gateway.

Parameter Required? Description Type
KeyCustomer Yes Key of the Customer in the GoCardless account String
KeyBankAccount Yes Key of the Bank Account in the GoCardless account String
KeyMandate Yes Key of the Mandate in the GoCardless account String

See GatewayPermission Resource

       

GoCardless Sepa Request Specifics

       

See GatewayRequest Resource

        

GoCardless Sepa Transaction Specifics

        

See GatewayTransaction Resource

        

Paybox

Paybox Account Specifics

Example Request : Create/Declare a Paybox Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "CardPaybox",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false,
    "CardPaybox": {
        "Site": "12345678",
        "Rang": "12",
        "Cle": "123"
    }   
}
Notice: The values in the sample above are fake. Get the real values from Paybox.

A CardPaybox defines all parameters and credentials needed of a valid account for the Paybox Payment Gateway.

Parameter Required? Description Type
Site Yes 'Site' of the Paybox account String
Rang Yes 'Rang' of the Paybox account String
Cle Yes 'Cle' of the Paybox account String

See GatewayAccount Resource

Paybox Permission Specifics

Example Request : Create/Declare a Paybox Card Permission 
POST https://via.proabono.com/Gateway/GatewayPermissions
{
    "IdBusiness": 2,
    "IdCustomer": 65487,
    "IdAccount": 165,
    "TypeGateway": "CardPaybox",
    "TypePayment": "Card",
    "Country": "FR",
    "DateExpiration": "2019-10-01T00:00:00.00Z",
    "MaskNumber": "xxxx-xxxx-xxxx-4444",
    "TypeCard": "Undefined",
    "CardPaybox": {
        "RefAbonne": "PA-2.3.65592.0b01b721",
        "Porteur": "SLDLsdsLMPC",
        "DateVal": "1017",
        "TypeCard": "cb2a5.2"
    }
}
Notice: The values in the sample above are fake. Get the real values from your Paybox account.

A CardPaybox defines all parameters of a valid card permission for the Paybox Payment Gateway.

Parameter Required? Description Type
RefAbonne Yes RefAbonne of the Customer in the Stripe account String
Porteur Yes Porteur of the Card in the Paybox account String
DateVal Yes Validation Date of the Card (Date format : MMYY) String
TypeCard Yes Type of the Card in the Paybox account String

See GatewayPermission Resource

       

Paybox Request Specifics

       

See GatewayRequest Resource

       

Paybox Transaction Specifics

       

See GatewayTransaction Resource

       

Stripe

Stripe Account Specifics

Example Request : Create/Declare a Stripe Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "CardStripe",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false,
    "CardStripe": {
        "KeyPublic": "pk_test_Ga9qnjxLiew2c_fake",
        "KeySecret": "sk_test_UbhQ41NtXxDgW_fake"
    }   
}
Notice: The values in the sample above are fake. Get the real values from your Stripe account.

A CardStripe defines all parameters and credentials needed of a valid account for the Stripe Payment Gateway.

Parameter Required? Description Type
KeyPublic Yes Public key of the Stripe account String
KeySecret Yes Secret key of the Stripe account String

See GatewayAccount Resource

Stripe Permission Specifics

Example Request : Create/Declare a Stripe Card Permission 
POST https://via.proabono.com/Gateway/GatewayPermissions
{
    "IdBusiness": 2,
    "IdCustomer": 65487,
    "IdAccount": 165,
    "TypeGateway": "CardStripe",
    "TypePayment": "Card",
    "Country": "US",
    "DateExpiration": "2019-11-01T00:00:00.00Z",
    "MaskNumber": "****-****-****-4242",
    "TypeCard": "Undefined",
    "CardStripe": {
        "KeyCustomer": "cus_77XzAa9n31Z4re",
        "KeyCard": "card_16tIt6H3X5T2tXqXq02j358W"
    }
}
Notice: The values in the sample above are fake. Get the real values from your Stripe account.

A CardStripe defines all parameters of a valid card permission for the Stripe Payment Gateway.

Parameter Required? Description Type
KeyCustomer Yes Key of the Customer in the Stripe account String
KeyCard Yes Key of the Card in the Stripe account String

See GatewayPermission Resource

Stripe Request Specifics

       

See GatewayRequest Resource

       

Stripe Transaction Specifics

       

See GatewayTransaction Resource

       

Braintree

Braintree Account Specifics

Example Request : Create/Declare a Braintree Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "CardBraintree",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false,
    "CardBraintree": {
        "IdMerchant": "2V604jd2o3813aR_fake",
        "KeyPublic": "Ga9qnjxLiew2c_fake",
        "KeySecret": "UbhQ41NtXxDgW_fake"
    }   
}
Notice: The values in the sample above are fake. Get the real values from your Braintree account.

A CardBraintree defines all parameters and credentials needed of a valid account for the Braintree Payment Gateway.

Parameter Required? Description Type
IdMerchant Yes Id of the Braintree Merchant account String
KeyPublic Yes Public key of the Braintree account String
KeySecret Yes Secret key of the Braintree account String

See GatewayAccount Resource

Braintree Permission Specifics

Example Request : Create/Declare a Braintree Card Permission 
POST https://via.proabono.com/Gateway/GatewayPermissions
{
    "IdBusiness": 2,
    "IdCustomer": 65487,
    "IdAccount": 165,
    "TypeGateway": "CardBraintree",
    "TypePayment": "Card",
    "Country": "US",
    "DateExpiration": "2019-11-01T00:00:00.00Z",
    "MaskNumber": "****-****-****-**42",
    "TypeCard": "Undefined",
    "CardBraintree": {
        "Token": "dwrzg4m"
    }
}
Notice: The values in the sample above are fake. Get the real values from your Braintree account.

A CardBraintree defines all parameters of a valid card permission for the Braintree Payment Gateway.

Parameter Required? Description Type
Token Yes Token of the Card in the Braintree account String

See GatewayPermission Resource

Braintree Request Specifics

       

See GatewayRequest Resource

       

Braintree Transaction Specifics

       

See GatewayTransaction Resource

       

Slimpay (Sepa)

Slimpay Sepa Account Specifics

Example Request : Create/Declare a Slimpay Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "DirectDebitSlimpaySepa",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false,
    "DirectDebitSlimpaySepa": {
        "AppId": "NameOfYourApp",
        "AppSecret": "36QguEg3DCZBbQ37QdmJzKmPH3bhq96K",
        "CreditorReference": "MyCompany"
    }   
}
Notice: The values in the sample above are fake. Get the real values from your Slimpay account.
Parameter Required? Description Type
AppId Yes Id of the App in the Slimpay account String
AppSecret Yes Secret key of the App in the Slimpay account String
CreditorReference Yes Reference displayed in the bank statement of the Customers String

See GatewayAccount Resource

Slimpay Sepa Permission Specifics

Example Request : Create/Declare a Slimpay Mandate Permission 
POST https://via.proabono.com/Gateway/GatewayPermissions
{
    "IdBusiness": 2,
    "IdCustomer": 65487,
    "IdAccount": 197, 
    "TypeGateway": "DirectDebitSlimpaySepa",
    "TypePayment": "DirectDebit",
    "MaskIban": "************************",
    "Country": "FR", 
    "DirectDebitSlimpaySepa": {
        "AppId": "NameOfYourApp",
        "AppSecret": "36QguEg3DCZBbQ37QdmJzKmPH3bhq96K",
        "CreditorReference": "MyCompany"
    }
}
Notice: The values in the sample above are fake. Get the real values from your Slimpay account.

A DirectDebitSlimpaySepa defines all parameters of a valid mandate permission for the Slimpay Payment Gateway.

Parameter Required? Description Type
AppId Yes Id of the App in the Slimpay account String
AppSecret Yes Secret key of the App in the Slimpay account String
CreditorReference Yes Reference displayed in the bank statement of the Customers String

See GatewayPermission Resource

       

Slimpay Sepa Request Specifics

       

See GatewayRequest Resource

        

Slimpay Sepa Transaction Specifics

        

See GatewayTransaction Resource

        

Adyen (Card)

Adyen Card Account Specifics

Example Request : Create/Declare a Adyen Card Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "CardAdyen",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false,
    "CardAdyen": {
        "TokenLibrary": "Ga9qnjxLiew2c_fake",
        "MerchantAccount": "testCOM_fake",
        "WsUsername": "ws@Company.testCOM_fake",
        "WsPassword": "Yuw2cJ,Y89_fake",
        "Is3dsecure": false
    }   

}
Notice: The values in the sample above are fake. Get the real values from your Adyen Card account.

A CardAdyen defines all parameters and credentials needed of a valid account for the Adyen Card Payment Gateway.

Parameter Required? Description Type
TokenLibrary Yes Library Token of the Adyen merchant account String
MerchantAccount Yes Merchant Account of the Adyen Card account String
WsUsername Yes Username of the Adyen Card account String
WsPassword Yes Password of the Adyen Card account String
Is3dsecure Yes True to force 3DSecure Boolean

See GatewayAccount Resource

Adyen Card Permission Specifics

Example Request : Create/Declare a Adyen Card Permission 
POST https://via.proabono.com/Gateway/GatewayPermissions
{
    "IdBusiness": 2,
    "IdCustomer": 65487,
    "IdAccount": 165,
    "TypeGateway": "CardAdyen",
    "TypePayment": "Card",
    "Country": "US",
    "DateExpiration": "2019-11-01T00:00:00.00Z",
    "MaskNumber": "****-****-****-4242",
    "TypeCard": "Visa",
    "CardAdyen": {
        "ShopperReference": "1234567890",
        "RecurringDetailReference": "098765432123456"
    }
}
Notice: The values in the sample above are fake. Get the real values from your Adyen Card account.

A CardAdyen defines all parameters of a valid card permission for the Adyen Card Payment Gateway.

Parameter Required? Description Type
ShopperReference Yes The shopper's reference for the payment transaction. String
RecurringDetailReference Yes The reference that uniquely identifies the recurring detail. String

See GatewayPermission Resource

Adyen Card Request Specifics

       

See GatewayRequest Resource

       

Adyen Card Transaction Specifics

       

See GatewayTransaction Resource

       

Adyen (Sepa)

Adyen Sepa Account Specifics

Example Request : Create/Declare a Adyen Sepa Account 
POST https://via.proabono.com/Gateway/GatewayAccounts
{
    "IdBusiness": 2,
    "TypeGateway": "DirectDebitAdyenSepa",
    "Currency": "EUR",
    "Name": "My Gateway Account #1",
    "IsInRealMoney": false,
    "DirectDebitAdyenSepa": {
        "TokenLibrary": "Ga9qnjxLiew2c_fake",
        "MerchantAccount": "testCOM_fake",
        "WsUsername": "ws@Company.testCOM_fake",
        "WsPassword": "Yuw2cJ,Y89_fake",
        "CreditorKey": "GB12ABDC12345678901234",
        "CreditorName": "MyCompany .Inc",
        "CreditorAddress": "40 Dover Road, WEST WILLIAMSTON, SA68 1GS",
    }   

}
Notice: The values in the sample above are fake. Get the real values from your Adyen Sepa account.

A DirectDebitAdyenSepa defines all parameters and credentials needed of a valid account for the Adyen Sepa Payment Gateway.

Parameter Required? Description Type
TokenLibrary Yes Library Token of the Adyen merchant account String
MerchantAccount Yes Merchant Account of the Adyen Sepa account String
WsUsername Yes Username of the Adyen Sepa account String
WsPassword Yes Password of the Adyen Sepa account String
CreditorKey Yes The Creditor Key String
CreditorName Yes Name of the Creditor String
CreditorAddress Yes Address of the Creditor String

See GatewayAccount Resource

Adyen Sepa Permission Specifics

Example Request : Create/Declare a Adyen Sepa Mandate Permission 
POST https://via.proabono.com/Gateway/GatewayPermissions
{
    "IdBusiness": 2,
    "IdCustomer": 65487,
    "IdAccount": 197, 
    "TypeGateway": "DirectDebitAdyenSepa",
    "TypePayment": "DirectDebit",
    "MaskIban": "************************",
    "Country": "FR", 
    "DirectDebitAdyenSepa": {
        "ShopperReference": "1234567890",
        "RecurringDetailReference": "098765432123456"
        "DateOfSignature": "2019-11-01T00:00:00.00Z",
        "MandateId" : 4567
    }
}
Notice: The values in the sample above are fake. Get the real values from your Adyen Sepa account.

A DirectDebitAdyenSepa defines all parameters of a valid card permission for the Adyen Sepa Payment Gateway.

Parameter Required? Description Type
ShopperReference Yes The shopper's reference for the payment transaction String
RecurringDetailReference Yes The reference that uniquely identifies the recurring detail String
DateOfSignature Yes Date of the Signature of the mandate DateTime
MandateId Yes Id of the mandate Integer

See GatewayPermission Resource

Adyen Sepa Request Specifics

       

See GatewayRequest Resource

       

Adyen Sepa Transaction Specifics

       

See GatewayTransaction Resource